SingleApplication 项目使用教程

SingleApplication 项目使用教程

SingleApplication Replacement of QtSingleApplication for Qt 5 and Qt 6 with support for inter-instance communication. 项目地址: https://gitcode.com/gh_mirrors/si/SingleApplication

1. 项目目录结构及介绍

SingleApplication 项目的目录结构如下：

SingleApplication/
├── examples/
│   ├── basic/
│   ├── calculator/
│   └── sending_arguments/
├── src/
│   └── singleapplication/
├── .gitignore
├── CHANGELOG.md
├── CMakeLists.txt
├── LICENSE
├── README.md
├── SingleApplication.cpp
├── SingleApplication.h
├── SingleApplication.pri
├── SingleApplication_p.cpp
└── SingleApplication_p.h

目录结构介绍

• examples/: 包含三个示例项目，分别是 basic、calculator 和 sending_arguments，展示了如何使用 SingleApplication 库。
• src/singleapplication/: 包含 SingleApplication 库的核心源代码文件。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被 Git 管理。
• CHANGELOG.md: 记录项目的变更日志，包含每个版本的更新内容。
• CMakeLists.txt: CMake 构建配置文件，用于配置项目的构建过程。
• LICENSE: 项目的开源许可证文件，本项目使用 MIT 许可证。
• README.md: 项目的主文档文件，包含项目的介绍、使用方法和示例。
• SingleApplication.cpp: SingleApplication 库的主要实现文件。
• SingleApplication.h: SingleApplication 库的头文件，包含类的声明和公共接口。
• SingleApplication.pri: QMake 项目的配置文件，用于在 QMake 项目中包含 SingleApplication 库。
• SingleApplication_p.cpp: SingleApplication 库的私有实现文件。
• SingleApplication_p.h: SingleApplication 库的私有头文件。

2. 项目启动文件介绍

SingleApplication 项目的启动文件是 SingleApplication.cpp 和 SingleApplication.h。这两个文件定义了 SingleApplication 类，该类继承自 QCoreApplication 或 QGuiApplication，用于确保应用程序只有一个实例运行。

主要功能

• 单实例管理: 确保应用程序只有一个实例运行，如果尝试启动第二个实例，则会终止并通知第一个实例。
• 实例间通信: 支持主实例与次实例之间的通信，次实例可以向主实例发送消息。

使用示例

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

int main(int argc, char *argv[]) {
    SingleApplication app(argc, argv);
    return app.exec();
}

3. 项目配置文件介绍

SingleApplication 项目的配置文件主要包括 CMakeLists.txt 和 SingleApplication.pri。

CMakeLists.txt

CMakeLists.txt 是 CMake 构建系统的配置文件，用于配置项目的构建过程。以下是主要内容：

cmake_minimum_required(VERSION 3.24)

project(SingleApplication)

set(QAPPLICATION_CLASS QApplication CACHE STRING "Inheritance class for SingleApplication")

add_subdirectory(src/singleapplication)

target_link_libraries(${PROJECT_NAME} SingleApplication::SingleApplication)

SingleApplication.pri

SingleApplication.pri 是 QMake 项目的配置文件，用于在 QMake 项目中包含 SingleApplication 库。以下是主要内容：

include(singleapplication/singleapplication.pri)

DEFINES += QAPPLICATION_CLASS=QApplication

通过这两个配置文件，可以方便地将 SingleApplication 库集成到不同的构建系统中。

SingleApplication Replacement of QtSingleApplication for Qt 5 and Qt 6 with support for inter-instance communication. 项目地址: https://gitcode.com/gh_mirrors/si/SingleApplication