SingleApplication 技术文档

本文档旨在帮助用户安装、使用和详细了解 SingleApplication 项目。SingleApplication 是一个用于 Qt5 和 Qt6 的 QtSingleApplication 的替代品，它能够保持应用程序的主实例，并终止每个后续实例。如果启用，它还可以生成与主实例无关的辅助实例，并能从辅助实例向主实例发送数据。

1. 安装指南

要使用 SingleApplication，您可以通过以下方式将其作为 Git 子模块添加到项目中：

git submodule add https://github.com/itay-grudev/SingleApplication.git singleapplication

QMake

在您的 .pro 项目文件中包含 singleapplication.pri 文件：

include(singleapplication/singleapplication.pri)
DEFINES += QAPPLICATION_CLASS=QApplication

CMake

在您的 CMakeLists.txt 项目文件中包含子目录：

set(QAPPLICATION_CLASS QApplication CACHE STRING "Inheritance class for SingleApplication")
add_subdirectory(src/third-party/singleapplication)
target_link_libraries(${PROJECT_NAME} SingleApplication::SingleApplication)

另外，您还可以使用 CMake 的 FetchContent 模块，从版本 3.11 起可用。

cmake_minimum_required(VERSION 3.24)
include(FetchContent)
set(QT_DEFAULT_MAJOR_VERSION 6 CACHE STRING "Qt version to use, defaults to 6")
set(QAPPLICATION_CLASS QApplication CACHE STRING "Inheritance class for SingleApplication")
FetchContent_Declare(
  SingleApplication
  GIT_REPOSITORY https://github.com/itay-grudev/SingleApplication
  GIT_TAG        master
)
FetchContent_MakeAvailable(SingleApplication)
find_package(SingleApplication)
target_link_libraries(ClientePOS PRIVATE
    Qt${QT_VERSION_MAJOR}::Widgets
    Qt${QT_VERSION_MAJOR}::Network
    Qt${QT_VERSION_MAJOR}::Sql
    SingleApplication::SingleApplication
)

2. 项目使用说明

SingleApplication 类继承自您通过 QAPPLICATION_CLASS 宏指定的 Q[Core|Gui]Application 类（默认为 QCoreApplication）。您可以将该库用作任何其他 QCoreApplication 派生类：

#include <QApplication>
#include <SingleApplication.h>

int main( int argc, char* argv[] )
{
    SingleApplication app( argc, argv );

    return app.exec();
}

3. 项目API使用文档

SingleApplication 类实现了以下信号和函数：

• instanceStarted(): 当检测到启动了一个新的实例时，会发出该信号。
• isPrimary(): 返回当前实例是否是主实例。
• isSecondary(): 返回当前实例是否是辅助实例。
• sendMessage(const QString &message): 向主实例发送消息。

以下是如何绑定 instanceStarted() 信号的示例：

// window 是一个 QWindow 实例
QObject::connect(
    &app,
    &SingleApplication::instanceStarted,
    &window,
    &QWindow::raise
);

4. 项目安装方式

SingleApplication 的安装方式已在上一节“安装指南”中详细说明，可以通过 Git 子模块、QMake 或 CMake 进行安装。

以上就是 SingleApplication 的技术文档，希望对您的使用有所帮助。