org.kde.koala

Class KIconLoader

public class KIconLoader extends Object implements QtSupport

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, 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.
  • KIcon.Desktop: Icons in the iconview of konqueror, kdesktop and similar apps.
  • KIcon.Toolbar: Icons in toolbars.
  • KIcon.MainToolbar: Icons in the main toolbars.
  • KIcon.Small: Various small (typical 16x16) places: titlebars, listviews and menu entries.
  • KIcon.Panel: Icons in kicker's panel
  • 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".

    UNKNOWN: Iconloader for KDE.

    Constructor Summary
    protected KIconLoader(Class dummy)
    KIconLoader(String appname, KStandardDirs dirs)
    Constructs an iconloader.
    KIconLoader(String appname)
    KIconLoader()
    Method Summary
    voidaddAppDir(String appname)
    Adds appname to the list of application specific directories.
    voidaddExtraDesktopThemes()
    Adds all the default themes from other desktops at the end of the list of icon themes.
    intcurrentSize(int group)
    Returns the current size of the group.
    voiddispose()
    Delete the wrapped C++ instance ahead of finalize()
    voidenableDelayedIconSetLoading(boolean enable)
    Enables on-demand icon loading for QIconSets using QIconFactory.
    booleanextraDesktopThemesAdded()
    Returns if the default icon themes of other desktops have been added to the list of icon themes where icons are searched.
    protected voidfinalize()
    Deletes the wrapped C++ instance
    KIconEffecticonEffect()
    Returns a pointer to the KIconEffect object used by the icon loader.
    StringiconPath(String name, int group_or_size, boolean canReturnNull)
    Returns the path of an icon.
    StringiconPath(String name, int group_or_size)
    booleanisDelayedIconSetLoadingEnabled()
    Checks whether delayed loading for QIconSet is enabled.
    booleanisDisposed()
    Has the wrapped C++ instance been deleted?
    ArrayListloadAnimated(String name, int group, int size)
    Loads an animated icon as a series of still frames.
    ArrayListloadAnimated(String name, int group)
    QPixmaploadIcon(String name, int group, int size, int state, StringBuffer path_store, boolean canReturnNull)
    Loads an icon.
    QPixmaploadIcon(String name, int group, int size, int state, StringBuffer path_store)
    QPixmaploadIcon(String name, int group, int size, int state)
    QPixmaploadIcon(String name, int group, int size)
    QPixmaploadIcon(String name, int group)
    QIconSetloadIconSet(String name, int group, int size, boolean canReturnNull, boolean immediateExistenceCheck)
    Creates an icon set, that will do on-demand loading of the icon.
    QIconSetloadIconSet(String name, int group, int size, boolean canReturnNull)
    Creates an icon set, that will do on-demand loading of the icon.
    QIconSetloadIconSet(String name, int group, int size)
    Creates an icon set, that will do on-demand loading of the icon.
    QIconSetloadIconSet(String name, int group)
    QMovieloadMovie(String name, int group, int size)
    Loads an animated icon.
    QMovieloadMovie(String name, int group)
    StringmoviePath(String name, int group, int size)
    Returns the path to an animated icon.
    StringmoviePath(String name, int group)
    ArrayListqueryIcons(int group_or_size, int context)
    Queries all available icons for a specific group, having a specific context.
    ArrayListqueryIcons(int group_or_size)
    ArrayListqueryIconsByContext(int group_or_size, int context)
    Queries all available icons for a specific context.
    ArrayListqueryIconsByContext(int group_or_size)
    ArrayListqueryIconsByDir(String iconsDir)
    Returns a list of all icons (.png or .xpm extension) in the given directory.
    voidreconfigure(String _appname, KStandardDirs _dirs)
    Called by KInstance.newIconLoader to reconfigure the icon loader.
    static QPixmapunknown()
    Returns the unknown icon.

    Constructor Detail

    KIconLoader

    protected KIconLoader(Class dummy)

    KIconLoader

    public KIconLoader(String appname, KStandardDirs dirs)
    Constructs an 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. dirs the KStandardDirs object to use. If null the global one is used Usually, you use the default iconloader, which can be accessed via KGlobal.iconLoader(), so you hardly ever have to create an iconloader object yourself. That one is the current KInstance's (typically KApplication's) iconloader.

    See Also: KGlobal KInstance

    UNKNOWN: Constructs an iconloader.

    KIconLoader

    public KIconLoader(String appname)

    KIconLoader

    public KIconLoader()

    Method Detail

    addAppDir

    public void addAppDir(String appname)
    Adds appname to the list of application specific directories.

    Parameters: appname The application name.

    UNKNOWN: Adds appname to the list of application specific directories.

    addExtraDesktopThemes

    public void addExtraDesktopThemes()
    Adds all the default themes from other desktops at the end of the list of icon themes.

    UNKNOWN: Adds all the default themes from other desktops at the end of the list of icon themes.

    currentSize

    public int currentSize(int group)
    Returns the current size of the group.

    Parameters: group the group to check.

    Returns: the current size for an icon group.

    UNKNOWN: Returns the current size of the group.

    dispose

    public void dispose()
    Delete the wrapped C++ instance ahead of finalize()

    enableDelayedIconSetLoading

    public void enableDelayedIconSetLoading(boolean enable)
    Enables on-demand icon loading for QIconSets using QIconFactory. Icons loaded via loadIconSet() will be loaded as soon as they need to be displayed, not earlier. Note that enabling or disabling this only affects loadIconSet() calls after this setting is changed. The default is disabled, as the iconloader object must not be destroyed before all those iconsets are destroyed. (Some broken applications use temporary KIconLoader objects). Every KInstance 's iconloader has this feature enabled.

    Parameters: enable true to enable delayed icon loading, false to disable

    See Also: KIconLoader org.kde.qt.QIconFactory

    UNKNOWN: Enables on-demand icon loading for QIconSets using QIconFactory.

    extraDesktopThemesAdded

    public boolean extraDesktopThemesAdded()
    Returns if the default icon themes of other desktops have been added to the list of icon themes where icons are searched.

    UNKNOWN: Returns if the default icon themes of other desktops have been added to the list of icon themes where icons are searched.

    finalize

    protected void finalize()
    Deletes the wrapped C++ instance

    iconEffect

    public KIconEffect iconEffect()
    Returns a pointer to the KIconEffect object used by the icon loader.

    Returns: the KIconEffect.

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

    iconPath

    public String iconPath(String name, int group_or_size, boolean canReturnNull)
    Returns the path of an icon.

    Parameters: name The name of the icon, without extension. If an absolute path is supplied for this parameter, iconPath will return it directly. 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. See KIcon.Group and KIcon.StdSizes canReturnNull Can 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.

    UNKNOWN: Returns the path of an icon.

    iconPath

    public String iconPath(String name, int group_or_size)

    isDelayedIconSetLoadingEnabled

    public boolean isDelayedIconSetLoadingEnabled()
    Checks whether delayed loading for QIconSet is enabled.

    Returns: whether icons for QIconSets will be loaded on demand.

    See Also: KIconLoader org.kde.qt.QIconFactory

    UNKNOWN: Checks whether delayed loading for QIconSet is enabled.

    isDisposed

    public boolean isDisposed()
    Has the wrapped C++ instance been deleted?

    loadAnimated

    public ArrayList loadAnimated(String name, int group, int size)
    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: name The name of the icon. group The icon group. See loadIcon(). size Override the default size for group. See KIcon.StdSizes.

    Returns: An ArrayList containing the absolute path of all the frames making up the animation.

    UNKNOWN: Loads an animated icon as a series of still frames.

    loadAnimated

    public ArrayList loadAnimated(String name, int group)

    loadIcon

    public QPixmap loadIcon(String name, int group, int size, int state, StringBuffer path_store, boolean canReturnNull)
    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: 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. See KIcon.StdSizes. 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.

    Returns: the QPixmap. Can be null when not found, depending on canReturnNull.

    UNKNOWN: Loads an icon.

    loadIcon

    public QPixmap loadIcon(String name, int group, int size, int state, StringBuffer path_store)

    loadIcon

    public QPixmap loadIcon(String name, int group, int size, int state)

    loadIcon

    public QPixmap loadIcon(String name, int group, int size)

    loadIcon

    public QPixmap loadIcon(String name, int group)

    loadIconSet

    public QIconSet loadIconSet(String name, int group, int size, boolean canReturnNull, boolean immediateExistenceCheck)
    Creates an icon set, that will do on-demand loading of the icon. Loading itself is done by calling loadIcon .

    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. See KIcon.StdSizes. canReturnNull Can return a null iconset? If false, iconset containing the "unknown" pixmap is returned when no appropriate icon has been found. immediateExistenceCheck If true on-demand icon loading will be disabled for canReturnNull and a null iconset may be returned immediately

    Returns: the icon set. Can be null when not found, depending on canReturnNull.

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

    loadIconSet

    public QIconSet loadIconSet(String name, int group, int size, boolean canReturnNull)
    Creates an icon set, that will do on-demand loading of the icon. Loading itself is done by calling loadIcon .

    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. See KIcon.StdSizes. canReturnNull Can 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.

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

    loadIconSet

    public QIconSet loadIconSet(String name, int group, int size)
    Creates an icon set, that will do on-demand loading of the icon. Loading itself is done by calling loadIcon .

    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. See KIcon.StdSizes.

    Returns: the icon set. Can be null when not found

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

    loadIconSet

    public QIconSet loadIconSet(String name, int group)

    loadMovie

    public QMovie loadMovie(String name, int group, int size)
    Loads an animated icon.

    Parameters: name The name of the icon. group The icon group. See loadIcon(). size Override the default size for group. See KIcon.StdSizes.

    Returns: A QMovie object. Can be null if not found.

    UNKNOWN: Loads an animated icon.

    loadMovie

    public QMovie loadMovie(String name, int group)

    moviePath

    public String moviePath(String name, int group, int size)
    Returns the path to an animated icon.

    Parameters: name The name of the icon. group The icon group. See loadIcon(). size Override the default size for group. See KIcon.StdSizes.

    Returns: the full path to the movie, ready to be passed to QMovie's constructor. Empty string if not found.

    UNKNOWN: Returns the path to an animated icon.

    moviePath

    public String moviePath(String name, int group)

    queryIcons

    public ArrayList queryIcons(int group_or_size, int context)
    Queries all available icons for a specific group, having a specific context.

    Parameters: 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. See KIcon.Group and KIcon.StdSizes context The icon context.

    Returns: a list of all icons

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

    queryIcons

    public ArrayList queryIcons(int group_or_size)

    queryIconsByContext

    public ArrayList queryIconsByContext(int group_or_size, int context)
    Queries all available icons for a specific context.

    Parameters: group_or_size The 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 KIcon.Group and KIcon.StdSizes context The icon context.

    Returns: An ArrayList containing the icon names available for that context

    UNKNOWN: Queries all available icons for a specific context.

    queryIconsByContext

    public ArrayList queryIconsByContext(int group_or_size)

    queryIconsByDir

    public ArrayList queryIconsByDir(String iconsDir)
    Returns a list of all icons (.png or .xpm extension) in the given directory.

    Parameters: iconsDir the directory to search in

    Returns: An ArrayList containing the icon paths

    UNKNOWN: Returns a list of all icons ( .

    reconfigure

    public void reconfigure(String _appname, KStandardDirs _dirs)
    Called by KInstance.newIconLoader to reconfigure the icon loader.

    Parameters: _appname the new application name _dirs the new standard directories. If 0, the directories from KGlobal will be taken.

    UNKNOWN: Called by KInstance.newIconLoader to reconfigure the icon loader.

    unknown

    public static QPixmap unknown()
    Returns the unknown icon. An icon that is used when no other icon can be found.

    Returns: the unknown pixmap

    UNKNOWN: Returns the unknown icon.