此文会详细介绍如何构建和引入SARibbon

准备工作

SARibbon使用了QWindowkit作为无边框方案，同时也支持简单的无边框方案，如果你需要操作系统原生的窗口支持，如windows7以后的贴边处理，windows11的Snap Layout效果，建议开启QWindowkit库，QWindowkit库还能较好解决多屏幕移动问题

开启QWindowkit将能实现如下效果：

如果你要开启QWindowkit，需要先编译QWindowkit库，QWindowkit库作为SARibbon项目的submodules，如果在git clone时没有附带--recursive参数，需要执行submodule update命令:

git submodule update --init --recursive

编译QWindowkit库(如果不开启跳过此步)

QWindowkit库只提供了cmake的编译方式，必须使用cmake

为了简单，在src/SARibbonBar/3rdparty下提供了一个CMakeLists.txt文件，已经对此库的必要配置进行了设置，直接调用src/SARibbonBar/3rdparty/CMakeLists.txt文件编译即可

使用Qt Creator和使用visual studio构建和安装基本一样

使用Qt Creator构建和安装QWindowkit库

使用qt creator编译QWindowkit库，直接用qt creator打开src/SARibbonBar/3rdparty/CMakeLists.txt文件

点击运行（Ctrl+R）

切换到项目模式（Ctrl+5）

build步骤选择install

再点击运行（Ctrl+R）

这时你会在SARibbon根目录下看到形如bin_qt5.14.2_MSVC_x64这样的安装目录，这里自动把QWindowkit库安装在此目录下

此时完成QWindowkit库的编译和安装

使用visual studio构建和安装QWindowkit库

使用visual studio编译QWindowkit库，用visual studio打开->CMake，选择src/SARibbonBar/3rdparty/CMakeLists.txt文件

选中CMake菜单->全部生成（有些版本没有CMake菜单，可以在CMakeLists.txt点右键）

选中CMake菜单->安装（有些版本没有CMake菜单，可以在CMakeLists.txt点右键）

‍不同的vs操作有点不一样，没有CMake菜单的，可以在CMakeLists.txt点右键

这时你会在SARibbon根目录下看到形如bin_qt5.14.2_MSVC_x64这样的安装目录，这里自动把QWindowkit库安装在此目录下

此时完成QWindowkit库的编译和安装

构建SARibbonBar库

SARibbonBar库提供cmake和qmake两种方式构建，推荐使用cmake

‍qt6之后不再维护qmake，逐渐转移到cmake中，SARibbon的未来版本不排除移除qmake

基于`CMake`构建`SARibbonBar`库

vs下基于`cmake`的构建

如果要开启QWindowKit，在CMakeLists.txt中把SARIBBON_USE_FRAMELESS_LIB的option值手动改为ON

# `QWindowkit`能提供windows的窗口特效，如边缘吸附，且对高分屏多屏幕的支持更好

点击文件->打开->Cmake 选中CMakeLists.txt

将会形成如下的构建树

直接点击CMake菜单->全部生成

全部生成完成后，CMake菜单->安装->SARibbon

这时候你会看到源码的根目录下多出一个文件夹,文件夹命名方式为bin_qt{version}_[MSVC/GNU]_x[64/86]（前提是你没有改变CMAKE_INSTALL_PREFIX）

qtcreator下基于cmake的构建

点击文件->打开文件或项目选中CMakeLists.txt，加载完成后形成如下的构建树

Qt Creator可以在界面修改SARIBBON_USE_FRAMELESS_LIB值，也可以手动修改，在Qt Creator中，点击左侧边，切换到项目模式（Ctrl+5）,如下图，在Current Configuration中设置SARIBBON_USE_FRAMELESS_LIB为ON即可开启QWindowKit，前提是要先编译QWindowKit

点击运行按钮

运行结束，会弹出例子窗口，点击左侧边栏的项目标签，Build的步骤，选中install

再次点击运行按钮，这时候你会看到源码的根目录下多出一个文件夹,文件夹命名方式为bin_qt{version}_[MSVC/GNU]_x[64/86]（前提是你没有改变CMAKE_INSTALL_PREFIX）

使用SARibbon的所有内容都在这个文件夹下

基于QMake构建SARibbonBar

qmake构建SARibbonBar只需使用Qt Creator打开SARibbon.pro文件即可

‍注意，如果使用Qt Creator打开SARibbon.pro文件过程报错，那么你的账户可能是没有足够的写权限，不同版本的Qt Creator在不同操作系统由不一样的表现，建议使用cmake

使用SARibbonBar库

基于cmake引入SARibbonBar库

首先要通过cmake编译并执行安装，在自己的工程CMakeLists.txt按照如下步骤执行：

指定SARibbonBar的安装目录，把安装目录下的lib/cmake/SARibbonBar位置设置给SARibbonBar_DIR变量(CMake在执行find_package(xx)时，会先查看是否有xx_DIR变量，如果有，会先查询xx_DIR下是否有对应的xxConfig.cmake文件)

set(SARibbonBar_DIR "C:\src\Qt\SARibbon\bin_qt5.14.2_MSVC_x64\lib\cmake\SARibbonBar")

使用find_package找到SARibbonBar的Config文件，这个函数实际上是调用lib/cmake/SARibbonBar/SARibbonBarConfig.cmake文件，这里会把需要include的路径、预定义的宏，和需要添加的库给指定好，此时SARibbonBar_INCLUDE_DIR就是SARibbonBar的include文件路径

find_package(SARibbonBar)

最后调用target_link_libraries添加SARibbonBar库到自己的工程中,这里${myapp_target_name}是自己工程的target名字

target_link_libraries(${myapp_target_name} PUBLIC
    SARibbonBar
)

基于qmake引入SARibbonBar库

‍Qt6开始，不再推荐使用qmake，SARibbon未来的版本有可能会取消qmake的支持

qmake的编译过程会在SARibbon下生成bin_qt{Qt version}_{MSVC/GNU}_x{32/64}文件夹，库文件和dll文件都在此文件夹下，importSARibbonBarLib.pri会自动把这个文件夹下的库引用进来，在引入之前需要先进行配置，配置内容位于common.pri中

步骤如下：

先在你的工程中建立一个3rdparty文件夹，再把整个SARibbon文件夹拷贝过去

‍SARibbon内部已经有几个pri文件可以很方便的让你把工程引入到自己目录中，./importSARibbonBarLib.pri文件就是用于引入SARibbon库的

importSARibbonBarLib.pri文件按照本库目录结构引入了依赖和头文件，如果你自己需要调整目录结构，可参考此文件进行修改

配置common.pri文件

按照你实际的库的编译情况，配置SARibbon/common.pri文件，目前可选配置如下：

# SA_RIBBON_CONFIG+=use_frameless
#     此选项将使用frameless第三方库，这个选项在SARibbonBar.pri中会自动判断，如果，达到frameless的使用要求将会自动定义
#     frameless第三方库必须C++17且只有几个版本的qt可用，目前支持（qt5.14,qt5.15,qt6.4以上）
#     除了上诉版本SA_RIBBON_CONFIG中不会加入use_frameless
#     frameless库能实现Ubuntu下和mac下的显示，同时多屏幕的支持也较好
# 使用frameless库，需要定义QWindowKit的安装目录，默认在SARIBBON_BIN_DIR
# SA_RIBBON_QWindowKit_Install_DIR = $$SARIBBON_BIN_DIR
# 
# SA_RIBBON_CONFIG+=enable_snap_layout
#      此选项将允许开启windows11的snap layout效果，目前在qt6.5下是正常显示位置，其它已知qt版本的snap layout位置会有偏移
#      此选项必须在 SA_RIBBON_CONFIG+=use_frameless 下才有效

你根据实际情况打开配置项（把注释去掉）

在自己的Qt工程pro文件中加入如下语句即可

include($$PWD/3rdparty/SARibbon/importSARibbonBarLib.pri)

此时你的工程目录结构大致如下：

|-[you-project-dir]
|  |-you-project.pro
|  |-[3rdparty]
|     |-[SARibbon](直接把SARibbon完整复制过来)
|        |-importSARibbonBarLib.pri（这个是方面你的qmake工程导入的文件，实际是引入了SARibbonBar.pri）
|        |-SARibbonBar.pri（用于引入库和依赖）
|        |-common.pri（这里是你的配置内容）
|        |-[bin_qtx.x.x_{MSVC/GNU}_x{32/64}]
|        |-[src]
|        |   |-[SARibbonBar]

importSARibbonBarLib.pri、SARibbonBar.pri、common.pri这三个文件是引入工程的关键文件

‍再次声明：Qt6.0版本后已经放弃qmake，建议使用cmake来管理工程

公开的预定义宏

SARibbon在编译过程中有些预定义宏，这些宏在基于visual studio的库引入是必须的

SARIBBON_USE_3RDPARTY_FRAMELESSHELPER=1/0,此宏用来定义是否引入了QWindowkit库

SARIBBON_ENABLE_SNAP_LAYOUT=1/0,此宏在SARIBBON_USE_3RDPARTY_FRAMELESSHELPER=1时才有用，用于定义是否开始windows11的snap layout效果