|
|
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 the 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 and Small. 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".
|
Construct the iconloader.
Parameters:
appname | Add 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. |
~ |
Cleanup
void |
Add appname to the list of application specific directories.
Parameters:
appname | The application name. |
QPixmap |
Load 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:
name | The name of the icon, without extension. |
group | The icon group. This will specify the size of and effects to be applied to the icon. |
size | If nonzero, this overrides the size specified by group. |
state | The 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_store | If not null, the path of the icon is stored here. |
canReturnNull | Can return a null pixmap? If false, the "unknown" pixmap is returned when no appropriate icon has been found. |
QString |
Returns the path of an icon.
Parameters:
name | The name of the icon, without extension. |
group_or_size | If positive, search icons whose size is specified by the icon group group_or_size. If negative, search icons whose size is - group_or_size. |
canReturnNull | Can return a null pixamp? |
QStringList |
Load an animated icon. In the future, this will be replaced by a routine which loads an MNG animation and returns a QMovie.
Parameters:
name | The name of the icon. |
group | The icon group. See loadIcon. |
size | Override the default size for group. |
Returns: A QStringList containing the absolute path of all the frames making up the animation.
QStringList |
Query all available icons for a specific group, having a specific context.
Parameters:
group_or_size | The icon group or size. See iconPath. |
context | The icon context. |
int |
Return the current size for an icon group.
KIconTheme * |
Returns a pointer to the current theme. Can be used to query available and default sizes for groups.
Generated by: root@porky.devel.redhat.com on Wed May 10 08:56:36 2000, using kdoc 2.0a35. |