KIconLoader

Search for usage in LXR

#include <KIconLoader>

Inheritance diagram for KIconLoader:

Public Types

enum  Context {
  Any, Action, Application, Device,
  FileSystem, MimeType, Animation, Category,
  Emblem, Emote, International, Place,
  StatusIcon
}
 
enum  Group {
  NoGroup = -1, Desktop = 0, FirstGroup = 0, Toolbar,
  MainToolbar, Small, Panel, Dialog,
  LastGroup, User
}
 
enum  MatchType { MatchExact, MatchBest }
 
enum  States {
  DefaultState, ActiveState, DisabledState, SelectedState,
  LastState
}
 
enum  StdSizes {
  SizeSmall = 16, SizeSmallMedium = 22, SizeMedium = 32, SizeLarge = 48,
  SizeHuge = 64, SizeEnormous = 128
}
 
enum  Type { Fixed, Scalable, Threshold }
 

Signals

void iconChanged (int group)
 
void iconLoaderSettingsChanged ()
 

Public Slots

static void emitChange (Group group)
 
void newIconLoader ()
 

Public Member Functions

 KIconLoader (const QString &appname=QString(), const QStringList &extraSearchPaths=QStringList(), QObject *parent=nullptr)
 
 ~KIconLoader ()
 
void addAppDir (const QString &appname, const QString &themeBaseDir=QString())
 
bool alphaBlending (KIconLoader::Group group) const
 
int currentSize (KIconLoader::Group group) const
 
QPalette customPalette () const
 
void drawOverlays (const QStringList &overlays, QPixmap &pixmap, KIconLoader::Group group, int state=KIconLoader::DefaultState) const
 
bool hasContext (KIconLoader::Context context) const
 
bool hasCustomPalette () const
 
bool hasIcon (const QString &iconName) const
 
KIconEffecticonEffect () const
 
QString iconPath (const QString &name, int group_or_size, bool canReturnNull=false) const
 
QString iconPath (const QString &name, int group_or_size, bool canReturnNull, qreal scale) const
 
QStringList loadAnimated (const QString &name, KIconLoader::Group group, int size=0) const
 
QPixmap loadIcon (const QString &name, KIconLoader::Group group, int size=0, int state=KIconLoader::DefaultState, const QStringList &overlays=QStringList(), QString *path_store=nullptr, bool canReturnNull=false) const
 
QIcon loadIconSet (const QString &name, KIconLoader::Group group, int size=0, bool canReturnNull=false)
 
QPixmap loadMimeTypeIcon (const QString &iconName, KIconLoader::Group group, int size=0, int state=KIconLoader::DefaultState, const QStringList &overlays=QStringList(), QString *path_store=nullptr) const
 
QMovieloadMovie (const QString &name, KIconLoader::Group group, int size=0, QObject *parent=nullptr) const
 
KPixmapSequence loadPixmapSequence (const QString &iconName, int size=SizeSmall) const
 
QPixmap loadScaledIcon (const QString &name, KIconLoader::Group group, qreal scale, int size=0, int state=KIconLoader::DefaultState, const QStringList &overlays=QStringList(), QString *path_store=nullptr, bool canReturnNull=false) const
 
QPixmap loadScaledIcon (const QString &name, KIconLoader::Group group, qreal scale, const QSize &size={}, int state=KIconLoader::DefaultState, const QStringList &overlays=QStringList(), QString *path_store=nullptr, bool canReturnNull=false) const
 
QString moviePath (const QString &name, KIconLoader::Group group, int size=0) const
 
QStringList queryIcons (int group_or_size, KIconLoader::Context context=KIconLoader::Any) const
 
QStringList queryIconsByContext (int group_or_size, KIconLoader::Context context=KIconLoader::Any) const
 
QStringList queryIconsByDir (const QString &iconsDir) const
 
void reconfigure (const QString &appname, const QStringList &extraSearchPaths=QStringList())
 
void resetPalette ()
 
QStringList searchPaths () const
 
void setCustomPalette (const QPalette &palette)
 
KIconThemetheme () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Static Public Member Functions

static KIconLoaderglobal ()
 
static QPixmap unknown ()
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 

Related Functions

(Note that these are not member functions.)

KICONTHEMES_EXPORT QPixmap BarIcon (const QString &name, int size=0, int state=KIconLoader::DefaultState, const QStringList &overlays=QStringList())
 
KICONTHEMES_EXPORT QIcon BarIconSet (const QString &name, int size=0)
 
KICONTHEMES_EXPORT QPixmap DesktopIcon (const QString &name, int size=0, int state=KIconLoader::DefaultState, const QStringList &overlays=QStringList())
 
KICONTHEMES_EXPORT QIcon DesktopIconSet (const QString &name, int size=0)
 
KICONTHEMES_EXPORT QIcon icon (const QString &iconName, KIconLoader *iconLoader=nullptr)
 
KICONTHEMES_EXPORT QIcon icon (const QString &iconName, const QStringList &overlays, KIconLoader *iconLoader=nullptr)
 
KICONTHEMES_EXPORT int IconSize (KIconLoader::Group group)
 
KICONTHEMES_EXPORT QPixmap MainBarIcon (const QString &name, int size=0, int state=KIconLoader::DefaultState, const QStringList &overlays=QStringList())
 
KICONTHEMES_EXPORT QIcon MainBarIconSet (const QString &name, int size=0)
 
KICONTHEMES_EXPORT QPixmap SmallIcon (const QString &name, int size=0, int state=KIconLoader::DefaultState, const QStringList &overlays=QStringList())
 
KICONTHEMES_EXPORT QIcon SmallIconSet (const QString &name, int size=0)
 
KICONTHEMES_EXPORT QPixmap UserIcon (const QString &name, int state=KIconLoader::DefaultState, const QStringList &overlays=QStringList())
 
KICONTHEMES_EXPORT QIcon UserIconSet (const QString &name)
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

Iconloader for KDE.

KIconLoader will load the current icon theme and all its base themes. Icons will be searched in any of these themes. Additionally, it caches icons and applies effects according to the user's preferences.

In KDE, it is encouraged to load icons by "Group". An icon group is a location on the screen where icons are being used. Standard groups are: Desktop, Toolbar, MainToolbar, Small and Panel. Each group has some centrally configured properties bound to it, including the icon size and effects. This makes it possible to offer a consistent icon look in all KDE applications.

The standard groups are defined below.

The icons are stored on disk in an icon theme or in a standalone directory. The icon theme directories contain multiple sizes and/or depths for the same icon. The iconloader will load the correct one based on the icon group and the current theme. Icon themes are stored globally in share/icons, or, application specific in share/apps/$appdir/icons.

The standalone directories contain just one version of an icon. The directories that are searched are: $appdir/pics and $appdir/toolbar. Icons in these directories can be loaded by using the special group "User".

Definition at line 68 of file kiconloader.h.

Member Enumeration Documentation

Defines the context of the icon.

Enumerator
Any 

Some icon with unknown purpose.

Action 

An action icon (e.g. 'save', 'print').

Application 

An icon that represents an application.

Device 

An icon that represents a device.

FileSystem 

An icon that represents a file system.

Deprecated:
Since 4.8. Use Place instead.
MimeType 

An icon that represents a mime type (or file type).

Animation 

An icon that is animated.

Category 

An icon that represents a category.

Emblem 

An icon that adds information to an existing icon.

Emote 

An icon that expresses an emotion.

International 

An icon that represents a country's flag.

Place 

An icon that represents a location (e.g. 'home', 'trash').

StatusIcon 

An icon that represents an event.

Definition at line 76 of file kiconloader.h.

The group of the icon.

Enumerator
NoGroup 

No group.

Desktop 

Desktop icons.

FirstGroup 

First group.

Toolbar 

Toolbar icons.

MainToolbar 

Main toolbar icons.

Small 

Small icons, e.g. for buttons.

Panel 

Panel (Plasma Taskbar) icons.

Dialog 

Icons for use in dialog titles, page lists, etc.

LastGroup 

Last group.

User 

User icons.

Definition at line 120 of file kiconloader.h.

The type of a match.

Enumerator
MatchExact 

Only try to find an exact match.

MatchBest 

Take the best match if there is no exact match.

Definition at line 111 of file kiconloader.h.

Defines the possible states of an icon.

Enumerator
DefaultState 

The default state.

ActiveState 

Icon is active.

DisabledState 

Icon is disabled.

SelectedState 

Icon is selected.

Since
5.22
LastState 

Last state (last constant)

Definition at line 167 of file kiconloader.h.

These are the standard sizes for icons.

Enumerator
SizeSmall 

small icons for menu entries

SizeSmallMedium 

slightly larger small icons for toolbars, panels, etc

SizeMedium 

medium sized icons for the desktop

SizeLarge 

large sized icons for the panel

SizeHuge 

huge sized icons for iconviews

SizeEnormous 

enormous sized icons for iconviews

Definition at line 148 of file kiconloader.h.

The type of the icon.

Enumerator
Fixed 

Fixed-size icon.

Scalable 

Scalable-size icon.

Threshold 

A threshold icon.

Definition at line 101 of file kiconloader.h.

Constructor & Destructor Documentation

KIconLoader::KIconLoader ( const QString appname = QString(),
const QStringList extraSearchPaths = QStringList(),
QObject parent = nullptr 
)
explicit

Constructs an iconloader.

Parameters
appnameAdd the data directories of this application to the icon search path for the "User" group. The default argument adds the directories of the current application.
extraSearchPathsadditional search paths, either absolute or relative to GenericDataLocation

Usually, you use the default iconloader, which can be accessed via KIconLoader::global(), so you hardly ever have to create an iconloader object yourself. That one is the application's iconloader.

Definition at line 557 of file kiconloader.cpp.

KIconLoader::~KIconLoader ( )
default

Cleanup.

Member Function Documentation

void KIconLoader::addAppDir ( const QString appname,
const QString themeBaseDir = QString() 
)

Adds appname to the list of application specific directories with themeBaseDir as its base directory.

Assume the icons are in /home/user/app/icons/hicolor/48x48/my_app.png, the base directory would be /home/user/app/icons; KIconLoader automatically searches themeBaseDir + "/hicolor" This directory must contain a dir structure as defined by the XDG icons specification

Parameters
appnameThe application name.
themeBaseDirThe base directory of the application's theme (eg. "/home/user/app/icons")

Definition at line 659 of file kiconloader.cpp.

bool KIconLoader::alphaBlending ( KIconLoader::Group  group) const

Checks whether the user wants to blend the icons with the background using the alpha channel information for a given group.

Parameters
groupthe group to check
Returns
true if alpha blending is desired
Deprecated:
Since 3.1, no known users

Definition at line 1692 of file kiconloader.cpp.

int KIconLoader::currentSize ( KIconLoader::Group  group) const

Returns the current size of the icon group.

Using e.g. KIconLoader::SmallIcon will retrieve the icon size that is currently set from System Settings->Appearance->Icon sizes. SmallIcon for instance, would typically be 16x16, but the user could increase it and this setting would change as well.

Parameters
groupthe group to check.
Returns
the current size for an icon group.

Definition at line 1569 of file kiconloader.cpp.

QPalette KIconLoader::customPalette ( ) const

The colors that will be used for the svg stylesheet in case the loaded icons are svg-based, icons can be colored in different ways in different areas of the application.

Returns
the palette, if any, an invalid one if the user didn't set it
Since
5.39

Definition at line 1853 of file kiconloader.cpp.

void KIconLoader::drawOverlays ( const QStringList overlays,
QPixmap pixmap,
KIconLoader::Group  group,
int  state = KIconLoader::DefaultState 
) const

Draws overlays on the specified pixmap, it takes the width and height of the pixmap into consideration.

Parameters
overlaysList of up to 4 overlays to blend over the pixmap. The first overlay will be in the bottom right corner, followed by bottom left, top left and top right. An empty QString can be used to leave the specific position blank.
pixmapto draw on
Since
4.7

Definition at line 788 of file kiconloader.cpp.

void KIconLoader::emitChange ( KIconLoader::Group  g)
staticslot

Emits an iconChanged() signal on all the KIconLoader instances in the system indicating that a system's icon group has changed in some way.

It will also trigger a reload in all of them to update to the new theme.

group indicates the group that has changed

Since
5.0

Definition at line 1886 of file kiconloader.cpp.

KIconLoader * KIconLoader::global ( )
static

Returns the global icon loader initialized with the application name.

Returns
global icon loader

Definition at line 1871 of file kiconloader.cpp.

bool KIconLoader::hasContext ( KIconLoader::Context  context) const

Definition at line 1675 of file kiconloader.cpp.

bool KIconLoader::hasCustomPalette ( ) const
Returns
whether we have set a custom palette using setCustomPalette
Since
5.85
See also
resetPalette, setCustomPalette

Definition at line 1863 of file kiconloader.cpp.

void KIconLoader::iconChanged ( int  group)
signal

Emitted when the system icon theme changes.

Since
5.0
KIconEffect * KIconLoader::iconEffect ( ) const

Returns a pointer to the KIconEffect object used by the icon loader.

Returns
the KIconEffect.

Definition at line 1686 of file kiconloader.cpp.

void KIconLoader::iconLoaderSettingsChanged ( )
signal

Emitted by newIconLoader once the new settings have been loaded.

QString KIconLoader::iconPath ( const QString name,
int  group_or_size,
bool  canReturnNull = false 
) const

Returns the path of an icon.

Parameters
nameThe name of the icon, without extension. If an absolute path is supplied for this parameter, iconPath will return it directly.
group_or_sizeIf positive, search icons whose size is specified by the icon group group_or_size. If negative, search icons whose size is - group_or_size. See KIconLoader::Group and KIconLoader::StdSizes
canReturnNullCan return a null string? If not, a path to the "unknown" icon will be returned.
Returns
the path of an icon, can be null or the "unknown" icon when not found, depending on canReturnNull.

Definition at line 1177 of file kiconloader.cpp.

QString KIconLoader::iconPath ( const QString name,
int  group_or_size,
bool  canReturnNull,
qreal  scale 
) const

Returns the path of an icon.

Parameters
nameThe name of the icon, without extension. If an absolute path is supplied for this parameter, iconPath will return it directly.
group_or_sizeIf positive, search icons whose size is specified by the icon group group_or_size. If negative, search icons whose size is - group_or_size. See KIconLoader::Group and KIconLoader::StdSizes
canReturnNullCan return a null string? If not, a path to the "unknown" icon will be returned.
scaleThe scale of the icon group.
Returns
the path of an icon, can be null or the "unknown" icon when not found, depending on canReturnNull.
Since
5.48

Definition at line 1182 of file kiconloader.cpp.

QStringList KIconLoader::loadAnimated ( const QString name,
KIconLoader::Group  group,
int  size = 0 
) const

Loads an animated icon as a series of still frames.

If you want to load a .mng animation as QMovie instead, please use loadMovie() instead.

Parameters
nameThe name of the icon.
groupThe icon group. See loadIcon().
sizeOverride the default size for group. See KIconLoader::StdSizes.
Returns
A QStringList containing the absolute path of all the frames making up the animation.

Definition at line 1510 of file kiconloader.cpp.

QPixmap KIconLoader::loadIcon ( const QString name,
KIconLoader::Group  group,
int  size = 0,
int  state = KIconLoader::DefaultState,
const QStringList overlays = QStringList(),
QString path_store = nullptr,
bool  canReturnNull = false 
) const

Loads an icon.

It will try very hard to find an icon which is suitable. If no exact match is found, a close match is searched. If neither an exact nor a close match is found, a null pixmap or the "unknown" pixmap is returned, depending on the value of the canReturnNull parameter.

Parameters
nameThe name of the icon, without extension.
groupThe icon group. This will specify the size of and effects to be applied to the icon.
sizeIf nonzero, this overrides the size specified by group. See KIconLoader::StdSizes.
stateThe icon state: DefaultState, ActiveState or DisabledState. Depending on the user's preferences, the iconloader may apply a visual effect to hint about its state.
overlaysa list of emblem icons to overlay, by name
See also
drawOverlays
Parameters
path_storeIf not null, the path of the icon is stored here, if the icon was found. If the icon was not found path_store is unaltered even if the "unknown" pixmap was returned.
canReturnNullCan return a null pixmap? If false, the "unknown" pixmap is returned when no appropriate icon has been found. Note: a null pixmap can still be returned in the event of invalid parameters, such as empty names, negative sizes, and etc.
Returns
the QPixmap. Can be null when not found, depending on canReturnNull.

Definition at line 1267 of file kiconloader.cpp.

QIcon KIconLoader::loadIconSet ( const QString name,
KIconLoader::Group  group,
int  size = 0,
bool  canReturnNull = false 
)

Creates an icon set, that will do on-demand loading of the icon.

Loading itself is done by calling loadIcon .

Parameters
nameThe name of the icon, without extension.
groupThe icon group. This will specify the size of and effects to be applied to the icon.
sizeIf nonzero, this overrides the size specified by group. See KIconLoader::StdSizes.
canReturnNullCan return a null iconset? If false, iconset containing the "unknown" pixmap is returned when no appropriate icon has been found.
Returns
the icon set. Can be null when not found, depending on canReturnNull.
Deprecated:
Since 5.0, use QIcon::fromTheme instead, which uses the iconloader internally

Definition at line 1707 of file kiconloader.cpp.

QPixmap KIconLoader::loadMimeTypeIcon ( const QString iconName,
KIconLoader::Group  group,
int  size = 0,
int  state = KIconLoader::DefaultState,
const QStringList overlays = QStringList(),
QString path_store = nullptr 
) const

Loads an icon for a mimetype.

This is basically like loadIcon except that extra desktop themes are loaded if necessary.

Consider using QIcon::fromTheme() with a fallback to "application-octet-stream" instead.

Parameters
iconNameThe name of the icon, without extension, usually from KMimeType.
groupThe icon group. This will specify the size of and effects to be applied to the icon.
sizeIf nonzero, this overrides the size specified by group. See KIconLoader::StdSizes.
stateThe icon state: DefaultState, ActiveState or DisabledState. Depending on the user's preferences, the iconloader may apply a visual effect to hint about its state.
path_storeIf not null, the path of the icon is stored here.
overlaysa list of emblem icons to overlay, by name
See also
drawOverlays
Returns
the QPixmap. Can not be null, the "unknown" pixmap is returned when no appropriate icon has been found.

Definition at line 1244 of file kiconloader.cpp.

QMovie * KIconLoader::loadMovie ( const QString name,
KIconLoader::Group  group,
int  size = 0,
QObject parent = nullptr 
) const

Loads an animated icon.

Parameters
nameThe name of the icon.
groupThe icon group. See loadIcon().
sizeOverride the default size for group. See KIconLoader::StdSizes.
parentThe parent object of the returned QMovie.
Returns
A QMovie object. Can be null if not found or not valid. Ownership is passed to the caller.

Definition at line 1443 of file kiconloader.cpp.

KPixmapSequence KIconLoader::loadPixmapSequence ( const QString iconName,
int  size = SizeSmall 
) const

Loads a pixmapSequence given the xdg icon name.

Parameters
iconNameThe name of the icon, without extension.
sizethe size/group to be used
Since
5.0

Definition at line 1438 of file kiconloader.cpp.

QPixmap KIconLoader::loadScaledIcon ( const QString name,
KIconLoader::Group  group,
qreal  scale,
int  size = 0,
int  state = KIconLoader::DefaultState,
const QStringList overlays = QStringList(),
QString path_store = nullptr,
bool  canReturnNull = false 
) const

Loads an icon.

It will try very hard to find an icon which is suitable. If no exact match is found, a close match is searched. If neither an exact nor a close match is found, a null pixmap or the "unknown" pixmap is returned, depending on the value of the canReturnNull parameter.

Parameters
nameThe name of the icon, without extension.
groupThe icon group. This will specify the size of and effects to be applied to the icon.
scaleThe scale of the icon group to use. If no icon exists in the scaled group, a 1x icon with its size multiplied by the scale will be loaded instead.
sizeIf nonzero, this overrides the size specified by group. See KIconLoader::StdSizes.
stateThe icon state: DefaultState, ActiveState or DisabledState. Depending on the user's preferences, the iconloader may apply a visual effect to hint about its state.
overlaysa list of emblem icons to overlay, by name
See also
drawOverlays
Parameters
path_storeIf not null, the path of the icon is stored here, if the icon was found. If the icon was not found path_store is unaltered even if the "unknown" pixmap was returned.
canReturnNullCan return a null pixmap? If false, the "unknown" pixmap is returned when no appropriate icon has been found. Note: a null pixmap can still be returned in the event of invalid parameters, such as empty names, negative sizes, and etc.
Returns
the QPixmap. Can be null when not found, depending on canReturnNull.
Since
5.48

Definition at line 1278 of file kiconloader.cpp.

QPixmap KIconLoader::loadScaledIcon ( const QString name,
KIconLoader::Group  group,
qreal  scale,
const QSize size = {},
int  state = KIconLoader::DefaultState,
const QStringList overlays = QStringList(),
QString path_store = nullptr,
bool  canReturnNull = false 
) const

Loads an icon.

It will try very hard to find an icon which is suitable. If no exact match is found, a close match is searched. If neither an exact nor a close match is found, a null pixmap or the "unknown" pixmap is returned, depending on the value of the canReturnNull parameter.

Parameters
nameThe name of the icon, without extension.
groupThe icon group. This will specify the size of and effects to be applied to the icon.
scaleThe scale of the icon group to use. If no icon exists in the scaled group, a 1x icon with its size multiplied by the scale will be loaded instead.
sizeIf nonzero, this overrides the size specified by group. See KIconLoader::StdSizes. The icon will be fit into size without changing the aspect ratio, which particularly matters for non-square icons.
stateThe icon state: DefaultState, ActiveState or DisabledState. Depending on the user's preferences, the iconloader may apply a visual effect to hint about its state.
overlaysa list of emblem icons to overlay, by name
See also
drawOverlays
Parameters
path_storeIf not null, the path of the icon is stored here, if the icon was found. If the icon was not found path_store is unaltered even if the "unknown" pixmap was returned.
canReturnNullCan return a null pixmap? If false, the "unknown" pixmap is returned when no appropriate icon has been found. Note: a null pixmap can still be returned in the event of invalid parameters, such as empty names, negative sizes, and etc.
Returns
the QPixmap. Can be null when not found, depending on canReturnNull.
Since
5.81

Definition at line 1290 of file kiconloader.cpp.

QString KIconLoader::moviePath ( const QString name,
KIconLoader::Group  group,
int  size = 0 
) const

Returns the path to an animated icon.

Parameters
nameThe name of the icon.
groupThe icon group. See loadIcon().
sizeOverride the default size for group. See KIconLoader::StdSizes.
Returns
the full path to the movie, ready to be passed to QMovie's constructor. Empty string if not found.

Definition at line 1462 of file kiconloader.cpp.

void KIconLoader::newIconLoader ( )
slot

Re-initialize the global icon loader.

Todo:
Check deprecation, still used internally.
Deprecated:
Since 5.0, use emitChange(Group)

Definition at line 1876 of file kiconloader.cpp.

QStringList KIconLoader::queryIcons ( int  group_or_size,
KIconLoader::Context  context = KIconLoader::Any 
) const

Queries all available icons for a specific group, having a specific context.

Parameters
group_or_sizeIf positive, search icons whose size is specified by the icon group group_or_size. If negative, search icons whose size is - group_or_size. See KIconLoader::Group and KIconLoader::StdSizes
contextThe icon context.
Returns
a list of all icons

Definition at line 1634 of file kiconloader.cpp.

QStringList KIconLoader::queryIconsByContext ( int  group_or_size,
KIconLoader::Context  context = KIconLoader::Any 
) const

Queries all available icons for a specific context.

Parameters
group_or_sizeThe icon preferred group or size. If available at this group or size, those icons will be returned, in other case, icons of undefined size will be returned. Positive numbers are groups, negative numbers are negated sizes. See KIconLoader::Group and KIconLoader::StdSizes
contextThe icon context.
Returns
A QStringList containing the icon names available for that context

Definition at line 1594 of file kiconloader.cpp.

QStringList KIconLoader::queryIconsByDir ( const QString iconsDir) const

Returns a list of all icons (*.png or *.xpm extension) in the given directory.

Parameters
iconsDirthe directory to search in
Returns
A QStringList containing the icon paths

Definition at line 1582 of file kiconloader.cpp.

void KIconLoader::reconfigure ( const QString appname,
const QStringList extraSearchPaths = QStringList() 
)

Reconfigure the icon loader, for instance to change the associated app name or extra search paths.

This also clears the in-memory pixmap cache (even if the appname didn't change, which is useful for unittests)

Parameters
appnamethe application name (empty for the global iconloader)
extraSearchPathsadditional search paths, either absolute or relative to GenericDataLocation

Definition at line 569 of file kiconloader.cpp.

void KIconLoader::resetPalette ( )

Resets the custom palette used by the KIconLoader to use the QGuiApplication::palette() again (and to follow it in case the application's palette changes)

Since
5.39

Definition at line 1858 of file kiconloader.cpp.

QStringList KIconLoader::searchPaths ( ) const

Returns all the search paths for this icon loader, either absolute or relative to GenericDataLocation.

Mostly internal (for KIconDialog).

Since
5.0

Definition at line 654 of file kiconloader.cpp.

void KIconLoader::setCustomPalette ( const QPalette palette)

Sets the colors for this KIconLoader.

NOTE: if you set a custom palette, if you are using some colors from application's palette, you need to track the application palette changes by yourself. If you no longer wish to use a custom palette, use resetPalette()

See also
resetPalette
Since
5.39

Definition at line 1847 of file kiconloader.cpp.

KIconTheme * KIconLoader::theme ( ) const

Returns a pointer to the current theme.

Can be used to query available and default sizes for groups.

Note
The KIconTheme will change if reconfigure() is called and therefore it's not recommended to store the pointer anywhere.
Returns
a pointer to the current theme. 0 if no theme set.

Definition at line 1560 of file kiconloader.cpp.

QPixmap KIconLoader::unknown ( )
static

Returns the unknown icon.

An icon that is used when no other icon can be found.

Returns
the unknown pixmap

Definition at line 1811 of file kiconloader.cpp.

Friends And Related Function Documentation

KICONTHEMES_EXPORT QPixmap BarIcon ( const QString name,
int  size = 0,
int  state = KIconLoader::DefaultState,
const QStringList overlays = QStringList() 
)
related

Load a toolbar icon.

Deprecated:
since 5.63. Prefer QIcon::fromTheme instead where possible, if you need a pixmap use QIcon::pixmap with KIconLoader::StdSizes, if you need the overlay, use KIconLoader::loadIcon.

Definition at line 1740 of file kiconloader.cpp.

KICONTHEMES_EXPORT QIcon BarIconSet ( const QString name,
int  size = 0 
)
related

Load a toolbar icon, and apply the necessary effects to get an IconSet.

Deprecated:
Since 5.0, use QIcon::fromTheme instead

Definition at line 1748 of file kiconloader.cpp.

KICONTHEMES_EXPORT QPixmap DesktopIcon ( const QString name,
int  size = 0,
int  state = KIconLoader::DefaultState,
const QStringList overlays = QStringList() 
)
related

Load a desktop icon.

Deprecated:
since 5.63. Prefer QIcon::fromTheme instead where possible, if you need a pixmap use QIcon::pixmap with KIconLoader::StdSizes, if you need the overlay, use KIconLoader::loadIcon.

Definition at line 1724 of file kiconloader.cpp.

KICONTHEMES_EXPORT QIcon DesktopIconSet ( const QString name,
int  size = 0 
)
related

Load a desktop icon, and apply the necessary effects to get an IconSet.

Deprecated:
Since 5.0, use QIcon::fromTheme instead

Definition at line 1732 of file kiconloader.cpp.

KICONTHEMES_EXPORT QIcon icon ( const QString iconName,
KIconLoader iconLoader = nullptr 
)
related

Returns a QIcon with an appropriate KIconEngine to perform loading and rendering. KIcons thus adhere to KDE style and effect standards.

Since
5.0
KICONTHEMES_EXPORT QIcon icon ( const QString iconName,
const QStringList overlays,
KIconLoader iconLoader = nullptr 
)
related

Returns a QIcon for the given icon, with additional overlays.

Since
5.0
KICONTHEMES_EXPORT int IconSize ( KIconLoader::Group  group)
related

Returns the current icon size for a specific group.

Deprecated:
since 5.66 Prefer QStyle::pixelMetric. If that's not an option for now, use KIconLoader::currentSize.

Definition at line 1804 of file kiconloader.cpp.

KICONTHEMES_EXPORT QPixmap MainBarIcon ( const QString name,
int  size = 0,
int  state = KIconLoader::DefaultState,
const QStringList overlays = QStringList() 
)
related

Load a main toolbar icon.

Deprecated:
since 5.63. Prefer QIcon::fromTheme instead where possible, if you need a pixmap use QIcon::pixmap with KIconLoader::StdSizes, if you need the overlay, use KIconLoader::loadIcon.

Definition at line 1772 of file kiconloader.cpp.

KICONTHEMES_EXPORT QIcon MainBarIconSet ( const QString name,
int  size = 0 
)
related

Load a main toolbar icon, and apply the effects to get an IconSet.

Deprecated:
Since 5.0, use QIcon::fromTheme instead

Definition at line 1780 of file kiconloader.cpp.

KICONTHEMES_EXPORT QPixmap SmallIcon ( const QString name,
int  size = 0,
int  state = KIconLoader::DefaultState,
const QStringList overlays = QStringList() 
)
related

Load a small icon.

Deprecated:
since 5.63. Prefer QIcon::fromTheme instead where possible, if you need a pixmap use QIcon::pixmap with KIconLoader::StdSizes, if you need the overlay, use KIconLoader::loadIcon.

Definition at line 1756 of file kiconloader.cpp.

KICONTHEMES_EXPORT QIcon SmallIconSet ( const QString name,
int  size = 0 
)
related

Load a small icon, and apply the necessary effects to get an IconSet.

Deprecated:
Since 5.0, use QIcon::fromTheme instead

Definition at line 1764 of file kiconloader.cpp.

KICONTHEMES_EXPORT QPixmap UserIcon ( const QString name,
int  state = KIconLoader::DefaultState,
const QStringList overlays = QStringList() 
)
related

Load a user icon. User icons are searched in $appdir/pics.

Deprecated:
since 5.65 Prefer qrc files over user icon themes. If that's not an option for now, use KIconLoader::loadIcon.

Definition at line 1788 of file kiconloader.cpp.

KICONTHEMES_EXPORT QIcon UserIconSet ( const QString name)
related

Load a user icon, and apply the effects to get an IconSet.

Deprecated:
Since 5.0, use QIcon::fromTheme instead

Definition at line 1796 of file kiconloader.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Mon Aug 2 2021 22:41:53 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.