/* vi: ts=8 sts=4 sw=4
*
* $Id: kiconloader_h.html 132191 2002-01-17 21:32:13Z dfaure $
*
* This file is part of the KDE project, module kdecore.
* Copyright (C) 2000 Geert Jansen
* Antonio Larrosa
*
* This is free software; it comes under the GNU Library General
* Public License, version 2. See the file "COPYING.LIB" for the
* exact licensing terms.
*/
#ifndef __KIconLoader_h_Included__
#define __KIconLoader_h_Included__
#include
#include
#include
#include
#include
#include
class KIconGroup;
class KIconThemeNode;
class KConfig;
class KIconLoaderPrivate;
class KStandardDirs;
class KIconEffect;
/**
* 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.
*
* @li KIcon::Desktop: Icons in the iconview of konqueror, kdesktop and similar apps.
* @li KIcon::Toolbar: Icons in toolbars.
* @li KIcon::MainToolbar: Icons in the main toolbars.
* @li KIcon::Small: Various small (typical 16x16) places: titlebars, listviews
* and menu entries.
* @li 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".
*
*/
class KIconLoader
{
public:
/**
* Construct the iconloader.
* @param 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.
* @param the KStandardDirs object to use. If null the global one is used
*/
KIconLoader(const QString& appname=QString::null, KStandardDirs *dirs = 0);
/** Cleanup */
~KIconLoader();
/**
* Add @p appname to the list of application specific directories.
* @param appname The application name.
*/
void addAppDir(const QString& appname);
/**
* 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
* @p canReturnNull parameter.
*
* @param name The name of the icon, without extension.
* @param group The icon group. This will specify the size of and effects to
* be applied to the icon.
* @param size If nonzero, this overrides the size specified by @p group.
* @param state The icon state: @p DefaultState, @p ActiveState or
* @p DisabledState. Depending on the user's preferences, the iconloader
* may apply a visual effect to hint about its state.
* @param path_store If not null, the path of the icon is stored here.
* @param canReturnNull Can return a null pixmap? If false, the
* "unknown" pixmap is returned when no appropriate icon has been found.
*/
QPixmap loadIcon(const QString& name, int group, int size=0,
int state=KIcon::DefaultState, QString *path_store=0L,
bool canReturnNull=false) const;
/**
* Returns the path of an icon.
* @param name The name of the icon, without extension.
* @param group_or_size If positive, search icons whose size is
* specified by the icon group @p group_or_size. If negative, search
* icons whose size is - @p group_or_size.
* @param canReturnNull Can return a null pixamp?
*/
QString iconPath(const QString& name, int group_or_size,
bool canReturnNull=false) const;
/**
* Load an animated icon. In the future, this will be replaced by a
* routine which loads an MNG animation and returns a QMovie.
* @param name The name of the icon.
* @param group The icon group. See @ref loadIcon().
* @param size Override the default size for @p group.
* @return A QStringList containing the absolute path of all the frames
* making up the animation.
*/
QStringList loadAnimated(const QString& name, int group, int size=0) const;
/**
* Query all available icons for a specific group, having a specific
* context.
* @param group_or_size The icon group or size. See @ref #iconPath.
* @param context The icon context.
*/
QStringList queryIcons(int group_or_size, int context=KIcon::Any) const;
/**
* Query all available icons for a specific context.
* @param 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.
* @param context The icon context.
* @return A QStringList containing the icon names
* available for that context
*/
QStringList queryIconsByContext(int group_or_size,
int context=KIcon::Any) const;
/**
* @return the current size for an icon group.
*/
int currentSize(int group);
/**
* Returns a pointer to the current theme. Can be used to query
* available and default sizes for groups.
*/
KIconTheme *theme();
/**
* Returns a pointer to the KIconEffect object used by the icon loader.
*/
KIconEffect *iconEffect();
/**
* Returns the image associated with a given serialNumber. You should
* use the serialNumber of a pixmap returned by loadIcon (or any of
* the [Group]Icon helper functions).
*/
QImage *image(int serialNumber) const;
/**
* Called by KInstance::newIconLoader to reconfigure the icon loader
*/
void reconfigure( const QString& _appname, KStandardDirs *_dirs );
/**
* Returns the unknown icon. An icon that is used when no other icon
* can be found.
*/
static QPixmap unknown();
/**
* Returns if the user wants to use blend the icons with the background
* using the alpha channel information for a given group.
*/
bool alphaBlending( int group ) const;
private:
/**
* @internal
*/
void init( const QString& _appname, KStandardDirs *_dirs );
/**
* @internal
* tries to find an icon with the name. It tries some extension and
* match strategies
*/
KIcon findMatchingIcon(const QString& name, int size) const;
/**
* @internal
* Loads and caches an overlay.
*/
QImage *loadOverlay(const QString& name, int size) const;
/**
* @internal
* adds themes installed in the application's directory. Only locolor
* and hicolor are currently supported to be installed in kde_datadir
**/
void addAppThemes(const QString& appname);
/**
* adds all themes that are part of this node and the themes
* below (the fallbacks of the theme) in the tree.
* @internal
*/
void addBaseThemes(KIconThemeNode *node, const QString &appname);
// @internal the data object
KIconLoaderPrivate *d;
};
/** Load a desktop icon. */
QPixmap DesktopIcon(const QString& name, int size=0,
int state=KIcon::DefaultState,
KInstance *instance=KGlobal::instance());
/** Load a desktop icon. */
QPixmap DesktopIcon(const QString& name, KInstance *instance);
/** Load a desktop icon, and apply the neccesary effects to get an IconSet. */
QIconSet DesktopIconSet(const QString& name, int size=0,
KInstance *instance=KGlobal::instance());
/** Load a toolbar icon. */
QPixmap BarIcon(const QString& name, int size=0, int state=KIcon::DefaultState,
KInstance *instance=KGlobal::instance());
/** Load a toolbar icon. */
QPixmap BarIcon(const QString& name, KInstance *instance);
/** Load a toolbar icon, and apply the neccesary effects to get an IconSet. */
QIconSet BarIconSet(const QString& name, int size=0,
KInstance *instance=KGlobal::instance());
/** Load a small icon. */
QPixmap SmallIcon(const QString& name, int size=0,
int state=KIcon::DefaultState,
KInstance *instance=KGlobal::instance());
/** Load a small icon. */
QPixmap SmallIcon(const QString& name, KInstance *instance);
/** Load a small icon, and apply the neccesary effects to get an IconSet. */
QIconSet SmallIconSet(const QString& name, int size=0,
KInstance *instance=KGlobal::instance());
/** Load a main toolbar icon. */
QPixmap MainBarIcon(const QString& name, int size=0,
int state=KIcon::DefaultState,
KInstance *instance=KGlobal::instance());
/** Load a main toolbar icon. */
QPixmap MainBarIcon(const QString& name, KInstance *instance);
/** Load a main toolbar icon, and apply the effects to get an IconSet. */
QIconSet MainBarIconSet(const QString& name, int size=0,
KInstance *instance=KGlobal::instance());
/** Load a user icon. */
QPixmap UserIcon(const QString& name, int state=KIcon::DefaultState,
KInstance *instance=KGlobal::instance());
/** Load a user icon. */
QPixmap UserIcon(const QString& name, KInstance *instance);
/** Load a user icon, and apply the effects to get an IconSet. */
QIconSet UserIconSet(const QString& name,
KInstance *instance=KGlobal::instance());
/** Returns the current icon size for a specific group. */
int IconSize(int group, KInstance *instance=KGlobal::instance());
#endif // __KIconLoader_h_Included__
| Generated by: dfaure on kde.faure.org on Thu Jan 17 22:15:01 2002, using kdoc 2.0a53. |