path: root/src/gui/kernel/qstylehints.cpp

// Copyright (C) 2016 The Qt Company Ltd.// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only#include <qstylehints.h>#include"qstylehints_p.h"#include <qpa/qplatformintegration.h>#include <qpa/qplatformtheme.h>#include <private/qguiapplication_p.h>#include <qdebug.h> QT_BEGIN_NAMESPACE staticinline QVariant hint(QPlatformIntegration::StyleHint h){returnQGuiApplicationPrivate::platformIntegration()->styleHint(h);}staticinline QVariant themeableHint(QPlatformTheme::ThemeHint th,QPlatformIntegration::StyleHint ih){if(!QCoreApplication::instance()) {qWarning("Must construct a QGuiApplication before accessing a platform theme hint.");returnQVariant();}if(const QPlatformTheme *theme =QGuiApplicationPrivate::platformTheme()) {const QVariant themeHint = theme->themeHint(th);if(themeHint.isValid())return themeHint;}returnQGuiApplicationPrivate::platformIntegration()->styleHint(ih);}staticinline QVariant themeableHint(QPlatformTheme::ThemeHint th){if(!QCoreApplication::instance()) {qWarning("Must construct a QGuiApplication before accessing a platform theme hint.");returnQVariant();}if(const QPlatformTheme *theme =QGuiApplicationPrivate::platformTheme()) {const QVariant themeHint = theme->themeHint(th);if(themeHint.isValid())return themeHint;}returnQPlatformTheme::defaultThemeHint(th);}/*! \class QStyleHints \since 5.0 \brief The QStyleHints class contains platform specific hints and settings. \inmodule QtGui An object of this class, obtained from QGuiApplication, provides access to certain global user interface parameters of the current platform. Access to most settings is read only. The platform itself usually provides the user with ways to tune these parameters. Authors of custom user interface components should read relevant settings to allow the components to exhibit the same behavior and feel as other components. \sa QGuiApplication::styleHints() */QStyleHints::QStyleHints():QObject(*newQStyleHintsPrivate(),nullptr){}/*! Sets the \a mouseDoubleClickInterval. \internal \sa mouseDoubleClickInterval() \since 5.3*/voidQStyleHints::setMouseDoubleClickInterval(int mouseDoubleClickInterval){Q_D(QStyleHints);if(d->m_mouseDoubleClickInterval == mouseDoubleClickInterval)return; d->m_mouseDoubleClickInterval = mouseDoubleClickInterval; emit mouseDoubleClickIntervalChanged(mouseDoubleClickInterval);}/*! \property QStyleHints::mouseDoubleClickInterval \brief the time limit in milliseconds that distinguishes a double click from two consecutive mouse clicks.*/intQStyleHints::mouseDoubleClickInterval()const{Q_D(const QStyleHints);return d->m_mouseDoubleClickInterval >=0? d->m_mouseDoubleClickInterval :themeableHint(QPlatformTheme::MouseDoubleClickInterval,QPlatformIntegration::MouseDoubleClickInterval).toInt();}/*! \property QStyleHints::mouseDoubleClickDistance \brief the maximum distance, in pixels, that the mouse can be moved between two consecutive mouse clicks and still have it detected as a double-click \since 5.14*/intQStyleHints::mouseDoubleClickDistance()const{Q_D(const QStyleHints);return d->m_mouseDoubleClickDistance >=0? d->m_mouseDoubleClickDistance :themeableHint(QPlatformTheme::MouseDoubleClickDistance,QPlatformIntegration::MouseDoubleClickDistance).toInt();}/*! \property QStyleHints::touchDoubleTapDistance \brief the maximum distance, in pixels, that a finger can be moved between two consecutive taps and still have it detected as a double-tap \since 5.14*/intQStyleHints::touchDoubleTapDistance()const{Q_D(const QStyleHints);return d->m_touchDoubleTapDistance >=0? d->m_touchDoubleTapDistance :themeableHint(QPlatformTheme::TouchDoubleTapDistance).toInt();}/*! \property QStyleHints::colorScheme \brief the color scheme used by the application. By default, this follows the system's default color scheme (also known as appearance), and changes when the system color scheme changes (e.g. during dusk or dawn). Setting the color scheme to an explicit value will override the system setting and ignore any changes to the system's color scheme. However, doing so is a hint to the system, and overriding the color scheme is not supported on all platforms. Resetting this property, or setting it to \l{Qt::ColorScheme::Unknown}, will remove the override and make the application follow the system default again. The property value will change to the color scheme the system currently has. When this property changes, Qt will read the system palette and update the default palette, but won't overwrite palette entries that have been explicitly set by the application. When the colorSchemeChange() signal gets emitted, the old palette is still in effect. Application-specific colors should be selected to work well with the effective palette, taking the current color scheme into account. To update application- specific colors when the effective palette changes, handle \l{QEvent::}{PaletteChange} or \l{QEvent::}{ApplicationPaletteChange} events. \sa Qt::ColorScheme, QGuiApplication::palette(), QEvent::PaletteChange \since 6.5*/Qt::ColorScheme QStyleHints::colorScheme()const{Q_D(const QStyleHints);return d->colorScheme();}/*! \since 6.8 Sets the color scheme used by the application to an explicit \a scheme, or revert to the system's current color scheme if \a scheme is Qt::ColorScheme::Unknown.*/voidQStyleHints::setColorScheme(Qt::ColorScheme scheme){if(!QCoreApplication::instance()) {qWarning("Must construct a QGuiApplication before accessing a platform theme hint.");return;}if(QPlatformTheme *theme =QGuiApplicationPrivate::platformTheme()) theme->requestColorScheme(scheme);}/*! \fn void QStyleHints::unsetColorScheme() \since 6.8 Restores the color scheme to the system's current color scheme.*//*! Sets the \a mousePressAndHoldInterval. \internal \sa mousePressAndHoldInterval() \since 5.7*/voidQStyleHints::setMousePressAndHoldInterval(int mousePressAndHoldInterval){Q_D(QStyleHints);if(d->m_mousePressAndHoldInterval == mousePressAndHoldInterval)return; d->m_mousePressAndHoldInterval = mousePressAndHoldInterval; emit mousePressAndHoldIntervalChanged(mousePressAndHoldInterval);}/*! \property QStyleHints::mousePressAndHoldInterval \brief the time limit in milliseconds that activates a press and hold. \since 5.3*/intQStyleHints::mousePressAndHoldInterval()const{Q_D(const QStyleHints);return d->m_mousePressAndHoldInterval >=0? d->m_mousePressAndHoldInterval :themeableHint(QPlatformTheme::MousePressAndHoldInterval,QPlatformIntegration::MousePressAndHoldInterval).toInt();}/*! Sets the \a startDragDistance. \internal \sa startDragDistance() \since 5.3*/voidQStyleHints::setStartDragDistance(int startDragDistance){Q_D(QStyleHints);if(d->m_startDragDistance == startDragDistance)return; d->m_startDragDistance = startDragDistance; emit startDragDistanceChanged(startDragDistance);}/*! \property QStyleHints::startDragDistance \brief the distance, in pixels, that the mouse must be moved with a button held down before a drag and drop operation will begin. If you support drag and drop in your application, and want to start a drag and drop operation after the user has moved the cursor a certain distance with a button held down, you should use this property's value as the minimum distance required. For example, if the mouse position of the click is stored in \c startPos and the current position (e.g. in the mouse move event) is \c currentPos, you can find out if a drag should be started with code like this: \snippet code/src_gui_kernel_qapplication.cpp 6 \sa startDragTime, QPoint::manhattanLength(), {Drag and Drop}*/intQStyleHints::startDragDistance()const{Q_D(const QStyleHints);return d->m_startDragDistance >=0? d->m_startDragDistance :themeableHint(QPlatformTheme::StartDragDistance,QPlatformIntegration::StartDragDistance).toInt();}/*! Sets the \a startDragDragTime. \internal \sa startDragTime() \since 5.3*/voidQStyleHints::setStartDragTime(int startDragTime){Q_D(QStyleHints);if(d->m_startDragTime == startDragTime)return; d->m_startDragTime = startDragTime; emit startDragTimeChanged(startDragTime);}/*! \property QStyleHints::startDragTime \brief the time, in milliseconds, that a mouse button must be held down before a drag and drop operation will begin. If you support drag and drop in your application, and want to start a drag and drop operation after the user has held down a mouse button for a certain amount of time, you should use this property's value as the delay. \sa startDragDistance, {Drag and Drop}*/intQStyleHints::startDragTime()const{Q_D(const QStyleHints);return d->m_startDragTime >=0? d->m_startDragTime :themeableHint(QPlatformTheme::StartDragTime,QPlatformIntegration::StartDragTime).toInt();}/*! \property QStyleHints::startDragVelocity \brief the limit for the velocity, in pixels per second, that the mouse may be moved, with a button held down, for a drag and drop operation to begin. A value of 0 means there is no such limit. \sa startDragDistance, {Drag and Drop}*/intQStyleHints::startDragVelocity()const{returnthemeableHint(QPlatformTheme::StartDragVelocity,QPlatformIntegration::StartDragVelocity).toInt();}/*! Sets the \a keyboardInputInterval. \internal \sa keyboardInputInterval() \since 5.3*/voidQStyleHints::setKeyboardInputInterval(int keyboardInputInterval){Q_D(QStyleHints);if(d->m_keyboardInputInterval == keyboardInputInterval)return; d->m_keyboardInputInterval = keyboardInputInterval; emit keyboardInputIntervalChanged(keyboardInputInterval);}/*! \property QStyleHints::keyboardInputInterval \brief the time limit, in milliseconds, that distinguishes a key press from two consecutive key presses.*/intQStyleHints::keyboardInputInterval()const{Q_D(const QStyleHints);return d->m_keyboardInputInterval >=0? d->m_keyboardInputInterval :themeableHint(QPlatformTheme::KeyboardInputInterval,QPlatformIntegration::KeyboardInputInterval).toInt();}#if QT_DEPRECATED_SINCE(6, 5)/*! \property QStyleHints::keyboardAutoRepeatRate \brief the rate, in events per second, in which additional repeated key presses will automatically be generated if a key is being held down. \deprecated [6.5] Use keyboardAutoRepeatRateF() instead*/intQStyleHints::keyboardAutoRepeatRate()const{returnthemeableHint(QPlatformTheme::KeyboardAutoRepeatRate,QPlatformIntegration::KeyboardAutoRepeatRate).toInt();}#endif/*! \property QStyleHints::keyboardAutoRepeatRateF \since 6.5 \brief the rate, in events per second, in which additional repeated key presses will automatically be generated if a key is being held down.*/ qreal QStyleHints::keyboardAutoRepeatRateF()const{returnthemeableHint(QPlatformTheme::KeyboardAutoRepeatRate,QPlatformIntegration::KeyboardAutoRepeatRate).toReal();}/*! Sets the \a cursorFlashTime. \internal \sa cursorFlashTime() \since 5.3*/voidQStyleHints::setCursorFlashTime(int cursorFlashTime){Q_D(QStyleHints);if(d->m_cursorFlashTime == cursorFlashTime)return; d->m_cursorFlashTime = cursorFlashTime; emit cursorFlashTimeChanged(cursorFlashTime);}/*! \property QStyleHints::cursorFlashTime \brief the text cursor's flash (blink) time in milliseconds. The flash time is the time used to display, invert and restore the caret display. Usually the text cursor is displayed for half the cursor flash time, then hidden for the same amount of time.*/intQStyleHints::cursorFlashTime()const{Q_D(const QStyleHints);return d->m_cursorFlashTime >=0? d->m_cursorFlashTime :themeableHint(QPlatformTheme::CursorFlashTime,QPlatformIntegration::CursorFlashTime).toInt();}/*! \property QStyleHints::showIsFullScreen \brief whether the platform defaults to fullscreen windows. This property is \c true if the platform defaults to windows being fullscreen, otherwise \c false. \note The platform may still choose to show certain windows non-fullscreen, such as popups or dialogs. This property only reports the default behavior. \sa QWindow::show(), showIsMaximized()*/boolQStyleHints::showIsFullScreen()const{returnhint(QPlatformIntegration::ShowIsFullScreen).toBool();}/*! \property QStyleHints::showIsMaximized \brief whether the platform defaults to maximized windows. This property is \c true if the platform defaults to windows being maximized, otherwise \c false. \note The platform may still choose to show certain windows non-maximized, such as popups or dialogs. This property only reports the default behavior. \sa QWindow::show(), showIsFullScreen() \since 5.6*/boolQStyleHints::showIsMaximized()const{returnhint(QPlatformIntegration::ShowIsMaximized).toBool();}/*! \property QStyleHints::showShortcutsInContextMenus \since 5.10 \brief \c true if the platform normally shows shortcut key sequences in context menus, otherwise \c false. Since Qt 5.13, the setShowShortcutsInContextMenus() function can be used to override the platform default. \sa Qt::AA_DontShowShortcutsInContextMenus*/boolQStyleHints::showShortcutsInContextMenus()const{Q_D(const QStyleHints);return d->m_showShortcutsInContextMenus >=0? d->m_showShortcutsInContextMenus !=0:themeableHint(QPlatformTheme::ShowShortcutsInContextMenus,QPlatformIntegration::ShowShortcutsInContextMenus).toBool();}voidQStyleHints::setShowShortcutsInContextMenus(bool s){Q_D(QStyleHints);if(s !=showShortcutsInContextMenus()) { d->m_showShortcutsInContextMenus = s ?1:0; emit showShortcutsInContextMenusChanged(s);}}/*! \property QStyleHints::contextMenuTrigger \since 6.8 \brief mouse event used to trigger a context menu event. The default on UNIX systems is to show context menu on mouse button press event, while on Windows it is the mouse button release event. This property can be used to override the default platform behavior. \note Developers must use this property with great care, as it changes the default interaction mode that their users will expect on the platform that they are running on. \sa Qt::ContextMenuTrigger*/Qt::ContextMenuTrigger QStyleHints::contextMenuTrigger()const{Q_D(const QStyleHints);if(d->m_contextMenuTrigger == -1) {returnthemeableHint(QPlatformTheme::ContextMenuOnMouseRelease).toBool()?Qt::ContextMenuTrigger::Release :Qt::ContextMenuTrigger::Press;}returnQt::ContextMenuTrigger(d->m_contextMenuTrigger);}voidQStyleHints::setContextMenuTrigger(Qt::ContextMenuTrigger contextMenuTrigger){Q_D(QStyleHints);constQt::ContextMenuTrigger currentTrigger =this->contextMenuTrigger(); d->m_contextMenuTrigger =int(contextMenuTrigger);if(currentTrigger != contextMenuTrigger) emit contextMenuTriggerChanged(contextMenuTrigger);}/*! \property QStyleHints::menuSelectionWraps \since 6.10 \brief menu selection wraps around. Returns \c true if menu selection wraps. That is, whether key navigation moves the selection to the first menu item again after the last menu item has been reached, and vice versa.*/boolQStyleHints::menuSelectionWraps()const{returnthemeableHint(QPlatformTheme::MenuSelectionWraps).toBool();}/*! \property QStyleHints::passwordMaskDelay \brief the time, in milliseconds, a typed letter is displayed unshrouded in a text input field in password mode.*/intQStyleHints::passwordMaskDelay()const{returnthemeableHint(QPlatformTheme::PasswordMaskDelay,QPlatformIntegration::PasswordMaskDelay).toInt();}/*! \property QStyleHints::passwordMaskCharacter \brief the character used to mask the characters typed into text input fields in password mode.*/ QChar QStyleHints::passwordMaskCharacter()const{returnthemeableHint(QPlatformTheme::PasswordMaskCharacter,QPlatformIntegration::PasswordMaskCharacter).toChar();}/*! \property QStyleHints::fontSmoothingGamma \brief the gamma value used in font smoothing.*/ qreal QStyleHints::fontSmoothingGamma()const{returnhint(QPlatformIntegration::FontSmoothingGamma).toReal();}/*! \property QStyleHints::useRtlExtensions \brief the writing direction. This property is \c true if right-to-left writing direction is enabled, otherwise \c false.*/boolQStyleHints::useRtlExtensions()const{returnhint(QPlatformIntegration::UseRtlExtensions).toBool();}/*! \property QStyleHints::setFocusOnTouchRelease \brief the event that should set input focus on focus objects. This property is \c true if focus objects (line edits etc) should receive input focus after a touch/mouse release. This is normal behavior on touch platforms. On desktop platforms, the standard is to set focus already on touch/mouse press.*/boolQStyleHints::setFocusOnTouchRelease()const{returnthemeableHint(QPlatformTheme::SetFocusOnTouchRelease,QPlatformIntegration::SetFocusOnTouchRelease).toBool();}/*! \property QStyleHints::tabFocusBehavior \since 5.5 \brief The focus behavior on press of the tab key. \note Do not bind this value in QML because the change notifier signal is not implemented yet.*/Qt::TabFocusBehavior QStyleHints::tabFocusBehavior()const{Q_D(const QStyleHints);returnQt::TabFocusBehavior(d->m_tabFocusBehavior >=0? d->m_tabFocusBehavior :themeableHint(QPlatformTheme::TabFocusBehavior,QPlatformIntegration::TabFocusBehavior).toInt());}/*! Sets the \a tabFocusBehavior. \internal \sa tabFocusBehavior() \since 5.7*/voidQStyleHints::setTabFocusBehavior(Qt::TabFocusBehavior tabFocusBehavior){Q_D(QStyleHints);if(d->m_tabFocusBehavior == tabFocusBehavior)return; d->m_tabFocusBehavior = tabFocusBehavior; emit tabFocusBehaviorChanged(tabFocusBehavior);}/*! \property QStyleHints::singleClickActivation \brief whether items are activated by single or double click. This property is \c true if items should be activated by single click, \c false if they should be activated by double click instead. \since 5.5*/boolQStyleHints::singleClickActivation()const{returnthemeableHint(QPlatformTheme::ItemViewActivateItemOnSingleClick,QPlatformIntegration::ItemViewActivateItemOnSingleClick).toBool();}/*! \property QStyleHints::useHoverEffects \brief whether UI elements use hover effects. This property is \c true if UI elements should use hover effects. This is the standard behavior on desktop platforms with a mouse pointer, whereas on touch platforms the overhead of hover event delivery can be avoided. \since 5.8*/boolQStyleHints::useHoverEffects()const{Q_D(const QStyleHints);return(d->m_uiEffects >=0? d->m_uiEffects :themeableHint(QPlatformTheme::UiEffects,QPlatformIntegration::UiEffects).toInt()) &QPlatformTheme::HoverEffect;}voidQStyleHints::setUseHoverEffects(bool useHoverEffects){Q_D(QStyleHints);if(d->m_uiEffects >=0&& useHoverEffects ==bool(d->m_uiEffects &QPlatformTheme::HoverEffect))return;if(d->m_uiEffects == -1) d->m_uiEffects =0;if(useHoverEffects) d->m_uiEffects |=QPlatformTheme::HoverEffect;else d->m_uiEffects &= ~QPlatformTheme::HoverEffect; emit useHoverEffectsChanged(useHoverEffects);}/*! \property QStyleHints::wheelScrollLines \brief Number of lines to scroll by default for each wheel click. \since 5.9*/intQStyleHints::wheelScrollLines()const{Q_D(const QStyleHints);if(d->m_wheelScrollLines >0)return d->m_wheelScrollLines;returnthemeableHint(QPlatformTheme::WheelScrollLines,QPlatformIntegration::WheelScrollLines).toInt();}/*! Sets the \a wheelScrollLines. \internal \sa wheelScrollLines() \since 5.9*/voidQStyleHints::setWheelScrollLines(int scrollLines){Q_D(QStyleHints);if(d->m_wheelScrollLines == scrollLines)return; d->m_wheelScrollLines = scrollLines; emit wheelScrollLinesChanged(scrollLines);}/*! Sets the mouse quick selection threshold. \internal \sa mouseQuickSelectionThreshold() \since 5.11*/voidQStyleHints::setMouseQuickSelectionThreshold(int threshold){Q_D(QStyleHints);if(d->m_mouseQuickSelectionThreshold == threshold)return; d->m_mouseQuickSelectionThreshold = threshold; emit mouseQuickSelectionThresholdChanged(threshold);}/*! \property QStyleHints::mouseQuickSelectionThreshold \brief Quick selection mouse threshold in QLineEdit. This property defines how much the mouse cursor should be moved along the y axis to trigger a quick selection during a normal QLineEdit text selection. If the property value is less than or equal to 0, the quick selection feature is disabled. \since 5.11*/intQStyleHints::mouseQuickSelectionThreshold()const{Q_D(const QStyleHints);if(d->m_mouseQuickSelectionThreshold >=0)return d->m_mouseQuickSelectionThreshold;returnthemeableHint(QPlatformTheme::MouseQuickSelectionThreshold,QPlatformIntegration::MouseQuickSelectionThreshold).toInt();}/*! \internal QStyleHintsPrivate::updateColorScheme - set a new color scheme. This function is called by the QPA plugin when the system theme changes. This in turn might be the result of an explicit request of a color scheme via setColorScheme. Set \a colorScheme as the new color scheme of the QStyleHints. The colorSchemeChanged signal will be emitted if present and new color scheme differ. */voidQStyleHintsPrivate::updateColorScheme(Qt::ColorScheme colorScheme){if(m_colorScheme == colorScheme)return; m_colorScheme = colorScheme;Q_Q(QStyleHints); emit q->colorSchemeChanged(colorScheme);} QStyleHintsPrivate *QStyleHintsPrivate::get(QStyleHints *q){Q_ASSERT(q);return q->d_func();} QT_END_NAMESPACE #include"moc_qstylehints.cpp"