KIconTheme
#include <kicontheme.h>
Public Types | |
enum | ContextMenus { TextEditor, ReadOnlyText } |
Static Public Member Functions | |
static void | assignIconsToContextMenu (ContextMenus type, QList< QAction * > actions) |
static QString | current () |
static QString | defaultThemeName () |
static void | forceThemeForTests (const QString &themeName) |
static QStringList | list () |
static void | reconfigure () |
Detailed Description
Class to use/access icon themes in KDE. This class is used by the iconloader but can be used by others too.
- Warning
- You should not use this class externally. This class is exported because the KCM needs it.
- See also
- KIconLoader
Definition at line 33 of file kicontheme.h.
Member Enumeration Documentation
◆ ContextMenus
Defines the context menus that assignIconsToContextMenus is aware of.
For ReadOnlyText the menu is expected to have one entry.
TextEditor is expected to have the full complement of undo, redo, cut, copy, paste and clear.
- Deprecated:
- since 5.64 no longer needed
Definition at line 270 of file kicontheme.h.
Constructor & Destructor Documentation
◆ KIconTheme()
|
explicit |
Load an icon theme by name.
- Parameters
-
name the name of the theme (e.g. "hicolor" or "keramik") appName the name of the application. Can be null. This argument allows applications to have themed application icons. basePathHint optional hint where to search the app themes. This is appended at the end of the search paths
Definition at line 277 of file kicontheme.cpp.
Member Function Documentation
◆ assignIconsToContextMenu()
|
static |
Assigns standard icons to the various standard text edit context menus.
- Deprecated:
- since 5.64, no longer necessary, Qt assigns icon itself by now.
Definition at line 681 of file kicontheme.cpp.
◆ current()
|
static |
Returns the current icon theme.
- Returns
- the name of the current theme
Definition at line 583 of file kicontheme.cpp.
◆ defaultSize()
int KIconTheme::defaultSize | ( | KIconLoader::Group | group | ) | const |
The default size of this theme for a certain icon group.
- Parameters
-
group The icon group. See KIconLoader::Group.
- Returns
- The default size in pixels for the given icon group.
Definition at line 461 of file kicontheme.cpp.
◆ defaultThemeName()
|
static |
Returns the default icon theme.
- Returns
- the name of the default theme name
Definition at line 675 of file kicontheme.cpp.
◆ depth()
int KIconTheme::depth | ( | ) | const |
The minimum display depth required for this theme.
This can either be 8 or 32.
- Returns
- the minimum bpp (8 or 32)
Definition at line 456 of file kicontheme.cpp.
◆ description()
QString KIconTheme::description | ( | ) | const |
A description for the icon theme.
- Returns
- a human-readable description of the theme, QString() if there is none
Definition at line 421 of file kicontheme.cpp.
◆ dir()
QString KIconTheme::dir | ( | ) | const |
Returns the toplevel theme directory.
- Returns
- the directory of the theme
Definition at line 436 of file kicontheme.cpp.
◆ example()
QString KIconTheme::example | ( | ) | const |
Return the name of the "example" icon.
This can be used to present the theme to the user.
- Returns
- the name of the example icon, QString() if there is none
Definition at line 426 of file kicontheme.cpp.
◆ followsColorScheme()
bool KIconTheme::followsColorScheme | ( | ) | const |
If true, this theme is made of SVG icons that will be colorized following the system color scheme.
This is necessary for monochrome themes that should look visible on both light and dark color schemes.
- Returns
- true if the SVG will be colorized with a stylesheet.
- Since
- 5.22
Definition at line 560 of file kicontheme.cpp.
◆ forceThemeForTests()
|
static |
Force a current theme and disable automatic resolution of the current theme in favor of the forced theme.
To reset a forced theme, simply set an empty themeName.
- Parameters
-
themeName name of the theme to force as current theme, or an empty string to unset theme forcing.
- Note
- This should only be used when a very precise expectation about the current theme is present. Most notably in unit tests this can be used to force a given theme.
- Warning
- A forced theme persists across reconfigure() calls!
- See also
- current
- Since
- 5.23
Definition at line 615 of file kicontheme.cpp.
◆ hasContext()
bool KIconTheme::hasContext | ( | KIconLoader::Context | context | ) | const |
Returns true if the theme has any icons for the given context.
Definition at line 533 of file kicontheme.cpp.
◆ iconPath() [1/2]
QString KIconTheme::iconPath | ( | const QString & | name, |
int | size, | ||
KIconLoader::MatchType | match | ||
) | const |
Lookup an icon in the theme.
- Parameters
-
name The name of the icon, with extension. size The desired size of the icon. match The matching mode. KIconLoader::MatchExact returns an icon only if matches exactly. KIconLoader::MatchBest returns the best matching icon.
- Returns
- An absolute path to the file of the icon if it's found, QString() otherwise.
- See also
- KIconLoader::isValid will return true, and false otherwise.
Definition at line 565 of file kicontheme.cpp.
◆ iconPath() [2/2]
QString KIconTheme::iconPath | ( | const QString & | name, |
int | size, | ||
KIconLoader::MatchType | match, | ||
qreal | scale | ||
) | const |
Lookup an icon in the theme.
- Parameters
-
name The name of the icon, with extension. size The desired size of the icon. match The matching mode. KIconLoader::MatchExact returns an icon only if matches exactly. KIconLoader::MatchBest returns the best matching icon. scale The scale of the icon group.
- Returns
- An absolute path to the file of the icon if it's found, QString() otherwise.
- See also
- KIconLoader::isValid will return true, and false otherwise.
- Since
- 5.48
Definition at line 570 of file kicontheme.cpp.
◆ iconPathByName() [1/2]
QString KIconTheme::iconPathByName | ( | const QString & | name, |
int | size, | ||
KIconLoader::MatchType | match | ||
) | const |
Lookup an icon in the theme.
- Parameters
-
name The name of the icon, without extension. size The desired size of the icon. match The matching mode. KIconLoader::MatchExact returns an icon only if matches exactly. KIconLoader::MatchBest returns the best matching icon.
- Returns
- An absolute path to the file of the icon if it's found, QString() otherwise.
- See also
- KIconLoader::isValid will return true, and false otherwise.
- Since
- 5.22
Definition at line 544 of file kicontheme.cpp.
◆ iconPathByName() [2/2]
QString KIconTheme::iconPathByName | ( | const QString & | name, |
int | size, | ||
KIconLoader::MatchType | match, | ||
qreal | scale | ||
) | const |
Lookup an icon in the theme.
- Parameters
-
name The name of the icon, without extension. size The desired size of the icon. match The matching mode. KIconLoader::MatchExact returns an icon only if matches exactly. KIconLoader::MatchBest returns the best matching icon. scale The scale of the icon group.
- Returns
- An absolute path to the file of the icon if it's found, QString() otherwise.
- See also
- KIconLoader::isValid will return true, and false otherwise.
- Since
- 5.48
Definition at line 549 of file kicontheme.cpp.
◆ inherits()
QStringList KIconTheme::inherits | ( | ) | const |
The themes this icon theme falls back on.
- Returns
- a list of icon themes that are used as fall-backs
Definition at line 441 of file kicontheme.cpp.
◆ internalName()
QString KIconTheme::internalName | ( | ) | const |
The internal name of the icon theme (same as the name argument passed to the constructor).
- Returns
- the internal name of the theme
Definition at line 416 of file kicontheme.cpp.
◆ isHidden()
bool KIconTheme::isHidden | ( | ) | const |
The icon theme should be hidden to the user?
- Returns
- true if the icon theme is hidden
Definition at line 451 of file kicontheme.cpp.
◆ isValid()
bool KIconTheme::isValid | ( | ) | const |
The icon theme exists?
- Returns
- true if the icon theme is valid
Definition at line 446 of file kicontheme.cpp.
◆ list()
|
static |
List all icon themes installed on the system, global and local.
- Returns
- the list of all icon themes
Definition at line 622 of file kicontheme.cpp.
◆ name()
QString KIconTheme::name | ( | ) | const |
The stylized name of the icon theme.
- Returns
- the (human-readable) name of the theme
Definition at line 411 of file kicontheme.cpp.
◆ queryIcons()
QStringList KIconTheme::queryIcons | ( | int | size, |
KIconLoader::Context | context = KIconLoader::Any |
||
) | const |
Query available icons for a size and context.
- Parameters
-
size the size of the icons context the context of the icons
- Returns
- the list of icon names
Definition at line 484 of file kicontheme.cpp.
◆ queryIconsByContext()
QStringList KIconTheme::queryIconsByContext | ( | int | size, |
KIconLoader::Context | context = KIconLoader::Any |
||
) | const |
Query available icons for a context and preferred size.
- Parameters
-
size the size of the icons context the context of the icons
- Returns
- the list of icon names
Definition at line 505 of file kicontheme.cpp.
◆ querySizes()
QList< int > KIconTheme::querySizes | ( | KIconLoader::Group | group | ) | const |
Query available sizes for a group.
- Parameters
-
group The icon group. See KIconLoader::Group.
- Returns
- a list of available sizes for the given group
Definition at line 470 of file kicontheme.cpp.
◆ reconfigure()
|
static |
Reconfigure the theme.
Definition at line 668 of file kicontheme.cpp.
◆ screenshot()
QString KIconTheme::screenshot | ( | ) | const |
Return the name of the screenshot.
- Returns
- the name of the screenshot, QString() if there is none
Definition at line 431 of file kicontheme.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Tue Dec 5 2023 04:00:29 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.