QIcon: complete the documentation of ThemeIcons

Add missing \since 6.7, and document the purpose of each value based
on the description in the freedesktop specification.

Change-Id: Id88438abf152c317600454d7137a19b13aa0a3cc
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
(cherry picked from commit b5a0db53b5eac7c0be8bc99ba79097608bf3e71f)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
This commit is contained in:
Volker Hilsheimer 2024-02-20 11:10:25 +01:00 committed by Qt Cherry-pick Bot
parent cb24a119b9
commit e749540a24

View File

@ -1566,162 +1566,180 @@ static constexpr QLatin1StringView themeIconName(QIcon::ThemeIcon icon)
/*! /*!
\enum QIcon::ThemeIcon \enum QIcon::ThemeIcon
\since 6.7
This enum provides access to icons that are provided by most This enum provides access to icons that are provided by most
icon theme implementations. icon theme implementations.
\value AddressBookNew \value AddressBookNew The icon for the action to create a new address book.
\value ApplicationExit \value ApplicationExit The icon for exiting an application.
\value AppointmentNew \value AppointmentNew The icon for the action to create a new appointment.
\value CallStart \value CallStart The icon for initiating or accepting a call.
\value CallStop \value CallStop The icon for stopping a current call.
\value ContactNew \value ContactNew The icon for the action to create a new contact.
\value DocumentNew \value DocumentNew The icon for the action to create a new document.
\value DocumentOpen \value DocumentOpen The icon for the action to open a document.
\value DocumentOpenRecent \value DocumentOpenRecent The icon for the action to open a document that was recently opened.
\value DocumentPageSetup \value DocumentPageSetup The icon for the \e{page setup} action.
\value DocumentPrint \value DocumentPrint The icon for the \e{print} action.
\value DocumentPrintPreview \value DocumentPrintPreview The icon for the \e{print preview} action.
\value DocumentProperties \value DocumentProperties The icon for the action to view the properties of a document.
\value DocumentRevert \value DocumentRevert The icon for the action of reverting to a previous version of a document.
\value DocumentSave \value DocumentSave The icon for the \e{save} action.
\value DocumentSaveAs \value DocumentSaveAs The icon for the \e{save as} action.
\value DocumentSend \value DocumentSend The icon for the \e{send} action.
\value EditClear \value EditClear The icon for the \e{clear} action.
\value EditCopy \value EditCopy The icon for the \e{copy} action.
\value EditCut \value EditCut The icon for the \e{cut} action.
\value EditDelete \value EditDelete The icon for the \e{delete} action.
\value EditFind \value EditFind The icon for the \e{find} action.
\value EditPaste \value EditPaste The icon for the \e{paste} action.
\value EditRedo \value EditRedo The icon for the \e{redo} action.
\value EditSelectAll \value EditSelectAll The icon for the \e{select all} action.
\value EditUndo \value EditUndo The icon for the \e{undo} action.
\value FolderNew \value FolderNew The icon for creating a new folder.
\value FormatIndentLess \value FormatIndentLess The icon for the \e{decrease indent formatting} action.
\value FormatIndentMore \value FormatIndentMore The icon for the \e{increase indent formatting} action.
\value FormatJustifyCenter \value FormatJustifyCenter The icon for the \e{center justification formatting} action.
\value FormatJustifyFill \value FormatJustifyFill The icon for the \e{fill justification formatting} action.
\value FormatJustifyLeft \value FormatJustifyLeft The icon for the \e{left justification formatting} action.
\value FormatJustifyRight \value FormatJustifyRight The icon for the \e{right justification} action.
\value FormatTextDirectionLtr \value FormatTextDirectionLtr The icon for the \e{left-to-right text formatting} action.
\value FormatTextDirectionRtl \value FormatTextDirectionRtl The icon for the \e{right-to-left formatting} action.
\value FormatTextBold \value FormatTextBold The icon for the \e{bold text formatting} action.
\value FormatTextItalic \value FormatTextItalic The icon for the \e{italic text formatting} action.
\value FormatTextUnderline \value FormatTextUnderline The icon for the \e{underlined text formatting} action.
\value FormatTextStrikethrough \value FormatTextStrikethrough The icon for the \e{strikethrough text formatting} action.
\value GoDown \value GoDown The icon for the \e{go down in a list} action.
\value GoHome \value GoHome The icon for the \e{go to home location} action.
\value GoNext \value GoNext The icon for the \e{go to the next item in a list} action.
\value GoPrevious \value GoPrevious The icon for the \e{go to the previous item in a list} action.
\value GoUp \value GoUp The icon for the \e{go up in a list} action.
\value HelpAbout \value HelpAbout The icon for the \e{About} item in the Help menu.
\value HelpFaq \value HelpFaq The icon for the \e{FAQ} item in the Help menu.
\value InsertImage \value InsertImage The icon for the \e{insert image} action of an application.
\value InsertLink \value InsertLink The icon for the \e{insert link} action of an application.
\value InsertText \value InsertText The icon for the \e{insert text} action of an application.
\value ListAdd \value ListAdd The icon for the \e{add to list} action.
\value ListRemove \value ListRemove The icon for the \e{remove from list} action.
\value MailForward \value MailForward The icon for the \e{forward} action.
\value MailMarkImportant \value MailMarkImportant The icon for the \e{mark as important} action.
\value MailMarkRead \value MailMarkRead The icon for the \e{mark as read} action.
\value MailMarkUnread \value MailMarkUnread The icon for the \e{mark as unread} action.
\value MailMessageNew \value MailMessageNew The icon for the \e{compose new mail} action.
\value MailReplyAll \value MailReplyAll The icon for the \e{reply to all} action.
\value MailReplySender \value MailReplySender The icon for the \e{reply to sender} action.
\value MailSend \value MailSend The icon for the \e{send} action.
\value MediaEject \value MediaEject The icon for the \e{eject} action of a media player or file manager.
\value MediaPlaybackPause \value MediaPlaybackPause The icon for the \e{pause} action of a media player.
\value MediaPlaybackStart \value MediaPlaybackStart The icon for the \e{start playback} action of a media player.
\value MediaPlaybackStop \value MediaPlaybackStop The icon for the \e{stop} action of a media player.
\value MediaRecord \value MediaRecord The icon for the \e{record} action of a media application.
\value MediaSeekBackward \value MediaSeekBackward The icon for the \e{seek backward} action of a media player.
\value MediaSeekForward \value MediaSeekForward The icon for the \e{seek forward} action of a media player.
\value MediaSkipBackward \value MediaSkipBackward The icon for the \e{skip backward} action of a media player.
\value MediaSkipForward \value MediaSkipForward The icon for the \e{skip forward} action of a media player.
\value ObjectRotateLeft \value ObjectRotateLeft The icon for the \e{rotate left} action performed on an object.
\value ObjectRotateRight \value ObjectRotateRight The icon for the \e{rotate right} action performed on an object.
\value ProcessStop \value ProcessStop The icon for the \e{stop action in applications with} actions that
\value SystemLockScreen may take a while to process, such as web page loading in a browser.
\value SystemLogOut \value SystemLockScreen The icon for the \e{lock screen} action.
\value SystemSearch \value SystemLogOut The icon for the \e{log out} action.
\value SystemReboot \value SystemSearch The icon for the \e{search} action.
\value SystemShutdown \value SystemReboot The icon for the \e{reboot} action.
\value ToolsCheckSpelling \value SystemShutdown The icon for the \e{shutdown} action.
\value ViewFullscreen \value ToolsCheckSpelling The icon for the \e{check spelling} action.
\value ViewRefresh \value ViewFullscreen The icon for the \e{fullscreen} action.
\value ViewRestore \value ViewRefresh The icon for the \e{refresh} action.
\value WindowClose \value ViewRestore The icon for leaving the fullscreen view.
\value WindowNew \value WindowClose The icon for the \e{close window} action.
\value ZoomFitBest \value WindowNew The icon for the \e{new window} action.
\value ZoomIn \value ZoomFitBest The icon for the \e{best fit} action.
\value ZoomOut \value ZoomIn The icon for the \e{zoom in} action.
\value ZoomOut The icon for the \e{zoom out} action.
\value AudioCard \value AudioCard The icon for the audio rendering device.
\value AudioInputMicrophone \value AudioInputMicrophone The icon for the microphone audio input device.
\value Battery \value Battery The icon for the system battery device.
\value CameraPhoto \value CameraPhoto The icon for a digital still camera devices.
\value CameraVideo \value CameraVideo The icon for a video camera device.
\value CameraWeb \value CameraWeb The icon for a web camera device.
\value Computer \value Computer The icon for the computing device as a whole.
\value DriveHarddisk \value DriveHarddisk The icon for hard disk drives.
\value DriveOptical \value DriveOptical The icon for optical media drives such as CD and DVD.
\value InputGaming \value InputGaming The icon for the gaming input device.
\value InputKeyboard \value InputKeyboard The icon for the keyboard input device.
\value InputMouse \value InputMouse The icon for the mousing input device.
\value InputTablet \value InputTablet The icon for graphics tablet input devices.
\value MediaFlash \value MediaFlash The icon for flash media, such as a memory stick.
\value MediaOptical \value MediaOptical The icon for physical optical media such as CD and DVD.
\value MediaTape \value MediaTape The icon for generic physical tape media.
\value MultimediaPlayer \value MultimediaPlayer The icon for generic multimedia playing devices.
\value NetworkWired \value NetworkWired The icon for wired network connections.
\value NetworkWireless \value NetworkWireless The icon for wireless network connections.
\value Phone \value Phone The icon for phone devices.
\value Printer \value Printer The icon for a printer device.
\value Scanner \value Scanner The icon for a scanner device.
\value VideoDisplay \value VideoDisplay The icon for the monitor that video gets displayed on.
\value AppointmentMissed \value AppointmentMissed The icon for when an appointment was missed.
\value AppointmentSoon \value AppointmentSoon The icon for when an appointment will occur soon.
\value AudioVolumeHigh \value AudioVolumeHigh The icon used to indicate high audio volume.
\value AudioVolumeLow \value AudioVolumeLow The icon used to indicate low audio volume.
\value AudioVolumeMedium \value AudioVolumeMedium The icon used to indicate medium audio volume.
\value AudioVolumeMuted \value AudioVolumeMuted The icon used to indicate the muted state for audio playback.
\value BatteryCaution \value BatteryCaution The icon used when the battery is below 40%.
\value BatteryLow \value BatteryLow The icon used when the battery is below 20%.
\value DialogError \value DialogError The icon used when a dialog is opened to explain an error
\value DialogInformation condition to the user.
\value DialogPassword \value DialogInformation The icon used when a dialog is opened to give information to the
\value DialogQuestion user that may be pertinent to the requested action.
\value DialogWarning \value DialogPassword The icon used when a dialog requesting the authentication
\value FolderDragAccept credentials for a user is opened.
\value FolderOpen \value DialogQuestion The icon used when a dialog is opened to ask a simple question
\value FolderVisiting to the user.
\value ImageLoading \value DialogWarning The icon used when a dialog is opened to warn the user of
\value ImageMissing impending issues with the requested action.
\value MailAttachment \value FolderDragAccept The icon used for a folder while an acceptable object is being
\value MailUnread dragged onto it.
\value MailRead \value FolderOpen The icon used for folders, while their contents are being displayed
\value MailReplied within the same window.
\value MediaPlaylistRepeat \value FolderVisiting The icon used for folders, while their contents are being displayed
\value MediaPlaylistShuffle in another window.
\value NetworkOffline \value ImageLoading The icon used while another image is being loaded.
\value PrinterPrinting \value ImageMissing The icon used when another image could not be loaded.
\value SecurityHigh \value MailAttachment The icon for a message that contains attachments.
\value SecurityLow \value MailUnread The icon for an unread message.
\value SoftwareUpdateAvailable \value MailRead The icon for a read message.
\value SoftwareUpdateUrgent \value MailReplied The icon for a message that has been replied to.
\value SyncError \value MediaPlaylistRepeat The icon for the repeat mode of a media player.
\value SyncSynchronizing \value MediaPlaylistShuffle The icon for the shuffle mode of a media player.
\value UserAvailable \value NetworkOffline The icon used to indicate that the device is not connected to the
\value UserOffline network.
\value WeatherClear \value PrinterPrinting The icon used while a print job is successfully being spooled to a
\value WeatherClearNight printing device.
\value WeatherFewClouds \value SecurityHigh The icon used to indicate that the security level of an item is
\value WeatherFewCloudsNight known to be high.
\value WeatherFog \value SecurityLow The icon used to indicate that the security level of an item is
\value WeatherShowers known to be low.
\value WeatherSnow \value SoftwareUpdateAvailable The icon used to indicate that an update is available.
\value WeatherStorm \value SoftwareUpdateUrgent The icon used to indicate that an urgent update is available.
\value SyncError The icon used when an error occurs while attempting to synchronize
data across devices.
\value SyncSynchronizing The icon used while data is successfully synchronizing across
devices.
\value UserAvailable The icon used to indicate that a user is available.
\value UserOffline The icon used to indicate that a user is not available.
\value WeatherClear The icon used to indicate that the sky is clear.
\value WeatherClearNight The icon used to indicate that the sky is clear
during the night.
\value WeatherFewClouds The icon used to indicate that the sky is partly cloudy.
\value WeatherFewCloudsNight The icon used to indicate that the sky is partly cloudy
during the night.
\value WeatherFog The icon used to indicate that the weather is foggy.
\value WeatherShowers The icon used to indicate that rain showers are occurring.
\value WeatherSnow The icon used to indicate that snow is falling.
\value WeatherStorm The icon used to indicate that the weather is stormy.
\omitvalue NThemeIcons \omitvalue NThemeIcons