Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QCocoaTheme Class Reference

#include <qcocoatheme.h>

Inheritance diagram for QCocoaTheme:
Collaboration diagram for QCocoaTheme:

Public Member Functions

 QCocoaTheme ()
 ~QCocoaTheme ()
void reset ()
QPlatformMenuItem * createPlatformMenuItem () const override
QPlatformMenu * createPlatformMenu () const override
QPlatformMenuBar * createPlatformMenuBar () const override
QPlatformSystemTrayIcon * createPlatformSystemTrayIcon () const override
 Factory function for QSystemTrayIcon.
bool usePlatformNativeDialog (DialogType dialogType) const override
QPlatformDialogHelper * createPlatformDialogHelper (DialogType dialogType) const override
const QPalette * palette (Palette type=SystemPalette) const override
 Return a color palette for type type.
const QFont * font (Font type=SystemFont) const override
QPixmap standardPixmap (StandardPixmap sp, const QSizeF &size) const override
 Return a pixmap for standardPixmap, at the given size.
QIcon fileIcon (const QFileInfo &fileInfo, QPlatformTheme::IconOptions options={}) const override
 Return an icon for fileInfo, observing iconOptions.
QIconEngine * createIconEngine (const QString &iconName) const override
 Factory function for the QIconEngine used by QIcon::fromTheme().
QVariant themeHint (ThemeHint hint) const override
Qt::ColorScheme colorScheme () const override
Qt::ContrastPreference contrastPreference () const override
QString standardButtonText (int button) const override
 Returns the text of a standard button.
QKeySequence standardButtonShortcut (int button) const override
void requestColorScheme (Qt::ColorScheme scheme) override
void handleSystemThemeChange ()
QList< QKeySequence > keyBindings (QKeySequence::StandardKey key) const override
Public Member Functions inherited from QPlatformTheme
 QPlatformTheme ()
virtual ~QPlatformTheme ()
virtual void showPlatformMenuBar ()
QString name () const

Static Public Attributes

static const char * name = "cocoa"

Additional Inherited Members

Public Types inherited from QPlatformTheme
enum  ThemeHint {
  CursorFlashTime , KeyboardInputInterval , MouseDoubleClickInterval , StartDragDistance ,
  StartDragTime , KeyboardAutoRepeatRate , PasswordMaskDelay , StartDragVelocity ,
  TextCursorWidth , DropShadow , MaximumScrollBarDragDistance , ToolButtonStyle ,
  ToolBarIconSize , ItemViewActivateItemOnSingleClick , SystemIconThemeName , SystemIconFallbackThemeName ,
  IconThemeSearchPaths , StyleNames , WindowAutoPlacement , DialogButtonBoxLayout ,
  DialogButtonBoxButtonsHaveIcons , UseFullScreenForPopupMenu , KeyboardScheme , UiEffects ,
  SpellCheckUnderlineStyle , TabFocusBehavior , IconPixmapSizes , PasswordMaskCharacter ,
  DialogSnapToDefaultButton , ContextMenuOnMouseRelease , MousePressAndHoldInterval , MouseDoubleClickDistance ,
  WheelScrollLines , TouchDoubleTapDistance , ShowShortcutsInContextMenus , IconFallbackSearchPaths ,
  MouseQuickSelectionThreshold , InteractiveResizeAcrossScreens , ShowDirectoriesFirst , PreselectFirstFileInDirectory ,
  ButtonPressKeys , SetFocusOnTouchRelease , FlickStartDistance , FlickMaximumVelocity ,
  FlickDeceleration , MenuBarFocusOnAltPressRelease , MouseCursorTheme , MouseCursorSize ,
  UnderlineShortcut , ShowIconsInMenus , PreferFileIconFromTheme , MenuSelectionWraps ,
  ScrollSingleStepDistance
}
 This enum describes the available theme hints. More...
enum  DialogType { FileDialog , ColorDialog , FontDialog , MessageDialog }
enum  Palette {
  SystemPalette , ToolTipPalette , ToolButtonPalette , ButtonPalette ,
  CheckBoxPalette , RadioButtonPalette , HeaderPalette , ComboBoxPalette ,
  ItemViewPalette , MessageBoxLabelPelette , MessageBoxLabelPalette = MessageBoxLabelPelette , TabBarPalette ,
  LabelPalette , GroupBoxPalette , MenuPalette , MenuBarPalette ,
  TextEditPalette , TextLineEditPalette , NPalettes
}
enum  Font {
  SystemFont , MenuFont , MenuBarFont , MenuItemFont ,
  MessageBoxFont , LabelFont , TipLabelFont , StatusBarFont ,
  TitleBarFont , MdiSubWindowTitleFont , DockWidgetTitleFont , PushButtonFont ,
  CheckBoxFont , RadioButtonFont , ToolButtonFont , ItemViewFont ,
  ListViewFont , HeaderViewFont , ListBoxFont , ComboMenuItemFont ,
  ComboLineEditFont , SmallFont , MiniFont , FixedFont ,
  GroupBoxTitleFont , TabButtonFont , EditorFont , NFonts
}
enum  StandardPixmap {
  TitleBarMenuButton , TitleBarMinButton , TitleBarMaxButton , TitleBarCloseButton ,
  TitleBarNormalButton , TitleBarShadeButton , TitleBarUnshadeButton , TitleBarContextHelpButton ,
  DockWidgetCloseButton , MessageBoxInformation , MessageBoxWarning , MessageBoxCritical ,
  MessageBoxQuestion , DesktopIcon , TrashIcon , ComputerIcon ,
  DriveFDIcon , DriveHDIcon , DriveCDIcon , DriveDVDIcon ,
  DriveNetIcon , DirOpenIcon , DirClosedIcon , DirLinkIcon ,
  DirLinkOpenIcon , FileIcon , FileLinkIcon , ToolBarHorizontalExtensionButton ,
  ToolBarVerticalExtensionButton , FileDialogStart , FileDialogEnd , FileDialogToParent ,
  FileDialogNewFolder , FileDialogDetailedView , FileDialogInfoView , FileDialogContentsView ,
  FileDialogListView , FileDialogBack , DirIcon , DialogOkButton ,
  DialogCancelButton , DialogHelpButton , DialogOpenButton , DialogSaveButton ,
  DialogCloseButton , DialogApplyButton , DialogResetButton , DialogDiscardButton ,
  DialogYesButton , DialogNoButton , ArrowUp , ArrowDown ,
  ArrowLeft , ArrowRight , ArrowBack , ArrowForward ,
  DirHomeIcon , CommandLink , VistaShield , BrowserReload ,
  BrowserStop , MediaPlay , MediaStop , MediaPause ,
  MediaSkipForward , MediaSkipBackward , MediaSeekForward , MediaSeekBackward ,
  MediaVolume , MediaVolumeMuted , LineEditClearButton , DialogYesToAllButton ,
  DialogNoToAllButton , DialogSaveAllButton , DialogAbortButton , DialogRetryButton ,
  DialogIgnoreButton , RestoreDefaultsButton , TabCloseButton , NStandardPixmap ,
  CustomBase = 0xf0000000
}
enum  KeyboardSchemes {
  WindowsKeyboardScheme , MacKeyboardScheme , X11KeyboardScheme , KdeKeyboardScheme ,
  GnomeKeyboardScheme , CdeKeyboardScheme
}
enum  UiEffect {
  GeneralUiEffect = 0x1 , AnimateMenuUiEffect = 0x2 , FadeMenuUiEffect = 0x4 , AnimateComboUiEffect = 0x8 ,
  AnimateTooltipUiEffect = 0x10 , FadeTooltipUiEffect = 0x20 , AnimateToolBoxUiEffect = 0x40 , HoverEffect = 0x80
}
enum  IconOption { DontUseCustomDirectoryIcons = 0x01 }
Static Public Member Functions inherited from QPlatformTheme
static QVariant defaultThemeHint (ThemeHint hint)
static QString defaultStandardButtonText (int button)
static QString removeMnemonics (const QString &original)
Protected Member Functions inherited from QPlatformTheme
 QPlatformTheme (QPlatformThemePrivate *priv)
Protected Attributes inherited from QPlatformTheme
QScopedPointer< QPlatformThemePrivate > d_ptr

Detailed Description

Definition at line 16 of file qcocoatheme.h.

Constructor & Destructor Documentation

◆ QCocoaTheme()

QCocoaTheme::QCocoaTheme ( )

Definition at line 217 of file qcocoatheme.mm.

◆ ~QCocoaTheme()

QCocoaTheme::~QCocoaTheme ( )

Definition at line 232 of file qcocoatheme.mm.

Member Function Documentation

◆ colorScheme()

Qt::ColorScheme QCocoaTheme::colorScheme ( ) const
overridevirtual

Reimplemented from QPlatformTheme.

Definition at line 477 of file qcocoatheme.mm.

◆ contrastPreference()

Qt::ContrastPreference QCocoaTheme::contrastPreference ( ) const
overridevirtual

Reimplemented from QPlatformTheme.

Definition at line 517 of file qcocoatheme.mm.

◆ createIconEngine()

QIconEngine * QCocoaTheme::createIconEngine ( const QString & iconName) const
overridevirtual

Factory function for the QIconEngine used by QIcon::fromTheme().

By default this function returns a QIconLoaderEngine, but subclasses can reimplement it to provide their own.

It is especially useful to benefit from some platform specific facilities or optimizations like an inter-process cache in systems mostly built with Qt.

Since
5.1

Reimplemented from QPlatformTheme.

Definition at line 430 of file qcocoatheme.mm.

◆ createPlatformDialogHelper()

QPlatformDialogHelper * QCocoaTheme::createPlatformDialogHelper ( DialogType dialogType) const
overridevirtual

Reimplemented from QPlatformTheme.

Definition at line 272 of file qcocoatheme.mm.

◆ createPlatformMenu()

QPlatformMenu * QCocoaTheme::createPlatformMenu ( ) const
overridevirtual

Reimplemented from QPlatformTheme.

Definition at line 543 of file qcocoatheme.mm.

◆ createPlatformMenuBar()

QPlatformMenuBar * QCocoaTheme::createPlatformMenuBar ( ) const
overridevirtual

Reimplemented from QPlatformTheme.

Definition at line 550 of file qcocoatheme.mm.

◆ createPlatformMenuItem()

QPlatformMenuItem * QCocoaTheme::createPlatformMenuItem ( ) const
overridevirtual

Reimplemented from QPlatformTheme.

Definition at line 536 of file qcocoatheme.mm.

◆ createPlatformSystemTrayIcon()

QPlatformSystemTrayIcon * QCocoaTheme::createPlatformSystemTrayIcon ( ) const
overridevirtual

Factory function for QSystemTrayIcon.

This function will return 0 if the platform integration does not support creating any system tray icon.

Reimplemented from QPlatformTheme.

Definition at line 289 of file qcocoatheme.mm.

◆ fileIcon()

QIcon QCocoaTheme::fileIcon ( const QFileInfo & fileInfo,
QPlatformTheme::IconOptions iconOptions = {} ) const
overridevirtual

Return an icon for fileInfo, observing iconOptions.

This function is queried by QFileIconProvider and similar classes to obtain an icon for a file. If it does not return a non-null icon, fileIconPixmap() is queried for a specific size.

Since
5.8

Reimplemented from QPlatformTheme.

Definition at line 425 of file qcocoatheme.mm.

◆ font()

const QFont * QCocoaTheme::font ( Font type = SystemFont) const
overridevirtual

Reimplemented from QPlatformTheme.

Definition at line 319 of file qcocoatheme.mm.

◆ handleSystemThemeChange()

void QCocoaTheme::handleSystemThemeChange ( )

Definition at line 245 of file qcocoatheme.mm.

◆ keyBindings()

QList< QKeySequence > QCocoaTheme::keyBindings ( QKeySequence::StandardKey key) const
override

Definition at line 566 of file qcocoatheme.mm.

◆ palette()

const QPalette * QCocoaTheme::palette ( Palette type = SystemPalette) const
overridevirtual

Return a color palette for type type.

When relying on system color palette keep in mind that it is lazily initialized and cached. If it needs to be updated (i.e. due to ColorScheme changes), it's up to the caller to take care of it. See requestColorScheme.

Reimplemented from QPlatformTheme.

Definition at line 295 of file qcocoatheme.mm.

◆ requestColorScheme()

void QCocoaTheme::requestColorScheme ( Qt::ColorScheme scheme)
overridevirtual

Reimplemented from QPlatformTheme.

Definition at line 482 of file qcocoatheme.mm.

◆ reset()

void QCocoaTheme::reset ( )

Definition at line 237 of file qcocoatheme.mm.

◆ standardButtonShortcut()

QKeySequence QCocoaTheme::standardButtonShortcut ( int button) const
override

Definition at line 530 of file qcocoatheme.mm.

◆ standardButtonText()

QString QCocoaTheme::standardButtonText ( int button) const
overridevirtual

Returns the text of a standard button.

Since
5.3
See also
QPlatformDialogHelper::StandardButton

Reimplemented from QPlatformTheme.

Definition at line 523 of file qcocoatheme.mm.

◆ standardPixmap()

QPixmap QCocoaTheme::standardPixmap ( StandardPixmap standardPixmap,
const QSizeF & size ) const
overridevirtual

Return a pixmap for standardPixmap, at the given size.

The implementation should not take system DPR into account, and always return a pixmap with a DPR of 1. It's up to the consumer to account for DPR and request a pixmap of the right size.

Reimplemented from QPlatformTheme.

Definition at line 345 of file qcocoatheme.mm.

◆ themeHint()

QVariant QCocoaTheme::themeHint ( ThemeHint hint) const
overridevirtual

Reimplemented from QPlatformTheme.

Definition at line 435 of file qcocoatheme.mm.

◆ usePlatformNativeDialog()

bool QCocoaTheme::usePlatformNativeDialog ( DialogType dialogType) const
overridevirtual

Reimplemented from QPlatformTheme.

Definition at line 259 of file qcocoatheme.mm.

Member Data Documentation

◆ name

const char * QCocoaTheme::name = "cocoa"
static

Definition at line 47 of file qcocoatheme.h.

Referenced by QCocoaIntegration::createPlatformTheme(), testing.tools.encode_pdf_filter._PdfStream::RegisterByName(), and QCocoaIntegration::themeNames().

The documentation for this class was generated from the following files: