github_mirror
/
framelesshelper
mirror of https://github.com/wangwenx190/framelesshelper.git
1
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity

Add documents

This commit is contained in:
Sine Striker 2023-09-03 18:51:32 +08:00
parent dfa12a1fbf
commit 4fc6bdc02e
4 changed files with 58 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doxygen/doxygen.cmake
View File

@ -151,7 +151,8 @@ function(setup_doxygen_command _target)
endif()
add_custom_target(${_target}
${_build_command}
COMMAND ${CMAKE_COMMAND} -E make_directory ${_doxy_output_dir}
COMMAND ${_build_command}
COMMENT "Build HTML documentation"
WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
VERBATIM

2
doxygen/extra-stylesheet.css
View File

@ -7,5 +7,5 @@ table.memname tr {
}
.memname tr:last-child:not(:first-child) {
margin-left: 0.75em
margin-left: -0.75em
}

53
src/core/framelesshelpercore_global.cpp
View File

@ -107,6 +107,16 @@ void FramelessHelperCoreInitResource()
}
#endif // FRAMELESSHELPER_CONFIG(bundle_resource)
/*!
\namespace wangwenx190
\brief The author's root namespace.
*/
/*!
\namespace wangwenx190::FramelessHelper
\brief FramelessHelper namespace.
*/
FRAMELESSHELPER_BEGIN_NAMESPACE
#if FRAMELESSHELPER_CONFIG(debug_output)
@ -122,8 +132,51 @@ FRAMELESSHELPER_BEGIN_NAMESPACE
# define CRITICAL QT_NO_QDEBUG_MACRO()
#endif
/*!
\namespace wangwenx190::FramelessHelper::Global
\brief FramelessHelper global namespace.
*/
using namespace Global;
/*!
\enum Global::Option
\brief FramelessHelper decoration options.
\var Global::Option::UseCrossPlatformQtImplementation
\brief Use pure Qt event system to emulate a frameless window.
\var Global::Option::ForceHideWindowFrameBorder
\brief Hide window frame border anyway.
\var Global::Option::ForceShowWindowFrameBorder
\brief Show window frame border anyway.
\var Global::Option::DisableWindowsSnapLayout
\brief Don't show snap layout, this option only works on Windows 11.
\var Global::Option::WindowUseRoundCorners
\brief Use round corners for windows anyway, this option only works on Windows 11.
\var Global::Option::CenterWindowBeforeShow
\brief Centralize the window before showing.
\var Global::Option::EnableBlurBehindWindow
\brief Show blur background.
\var Global::Option::ForceNonNativeBackgroundBlur
\brief Use non-native blur background anyway.
\var Global::Option::DisableLazyInitializationForMicaMaterial
\brief Disable lazy initialization for Mica Material.
\var Global::Option::ForceNativeBackgroundBlur
\brief Use native blur background anyway.
\var Global::Option::WindowUseSquareCorners
\brief Use square corners for windows anyway, this option only works on Windows 11.
*/
#ifdef Q_OS_WINDOWS
static_assert(std::size(WindowsVersions) == (static_cast<int>(WindowsVersion::Latest) + 1));
#endif

13
src/core/framelessmanager.cpp
View File

@ -289,11 +289,6 @@ void FramelessManagerPrivate::initialize()
/*!
\class FramelessManager
\brief FramelessHelper global manager, managing all frameless related resources.
\property FramelessManager::systemTheme
\property FramelessManager::systemAccentColor
\property FramelessManager::wallpaper
\property FramelessManager::wallpaperAspectStyle
*/
FramelessManager::FramelessManager(QObject *parent) :
@ -425,16 +420,12 @@ void FramelessManager::removeWindow(const WId windowId)
/*!
\fn void FramelessManager::systemThemeChanged()
This signal is emitted when the system theme changes externally.
\sa systemTheme()
\brief This signal is emitted when the system theme changes externally.
*/
/*!
\fn void FramelessManager::wallpaperChanged()
This signal is emitted when the system wallpaper changes externally.
\sa wallpaper()
\brief This signal is emitted when the system wallpaper changes externally.
*/
FRAMELESSHELPER_END_NAMESPACE