kiconloader.h

/*
 *
 * This file is part of the KDE project, module tdecore.
 * Copyright (C) 2000 Geert Jansen <jansen@kde.org>
 *                    Antonio Larrosa <larrosa@kde.org>
 *
 * 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 __TDEIconLoader_h_Included__
#define __TDEIconLoader_h_Included__
 
#include <tqstring.h>
#include <tqpixmap.h>
#include <tqiconset.h>
 
// Grmbl, X headers.....
#ifdef Status
#define TDEIconLoaderXStatus Status
#undef Status
#endif
#include <tqmovie.h>
#ifdef TDEIconLoaderXStatus
#define Status int
#undef TDEIconLoaderXStatus
#endif
 
#include <tdeglobal.h>
#include <tdeinstance.h>
#include <kicontheme.h>
 
struct TDEIconGroup;
class TDEIconThemeNode;
class TDEConfig;
struct TDEIconLoaderPrivate;
class TDEStandardDirs;
class TDEIconEffect;
 

class TDECORE_EXPORT TDEIconLoader
{
public:

    TDEIconLoader(const TQString& appname=TQString::null, TDEStandardDirs *dirs = 0);

    ~TDEIconLoader();

    void addAppDir(const TQString& appname);

    TQPixmap loadIcon(const TQString& name, TDEIcon::Group group, int size=0,
             int state=TDEIcon::DefaultState, TQString *path_store=0L,
             bool canReturnNull=false) const;

    TQIconSet loadIconSet(const TQString& name, TDEIcon::Group group, int size,
                         bool canReturnNull, bool immediateExistenceCheck);
 
    // KDE4 merge as (const TQString&,TDEIcon::Group,int=0,bool=false,bool=true);
    TQIconSet loadIconSet(const TQString& name, TDEIcon::Group group, int size,
                         bool canReturnNull);
 
    // KDE4 merge as (const TQString&,TDEIcon::Group,int=0,bool=false,bool=true);
    TQIconSet loadIconSet(const TQString& name, TDEIcon::Group group, int size=0);

    TQString iconPath(const TQString& name, int group_or_size,
             bool canReturnNull=false) const;

    TQMovie loadMovie(const TQString& name, TDEIcon::Group group, int size=0) const;

    TQString moviePath(const TQString& name, TDEIcon::Group group, int size=0) const;

    TQStringList loadAnimated(const TQString& name, TDEIcon::Group group, int size=0) const;

    TQStringList queryIcons(int group_or_size, TDEIcon::Context context=TDEIcon::Any) const;

    TQStringList queryIconsByContext(int group_or_size,
                    TDEIcon::Context context=TDEIcon::Any) const;

    bool hasContext( TDEIcon::Context context ) const;

    TQStringList queryIconsByDir( const TQString& iconsDir ) const;

    int currentSize(TDEIcon::Group group) const;

    TDEIconTheme *theme() const;

    TDEIconEffect *iconEffect() const;

    void reconfigure( const TQString& _appname, TDEStandardDirs *_dirs );

    static TQPixmap unknown();

    bool alphaBlending( TDEIcon::Group group ) const;

    void addExtraDesktopThemes();

    bool extraDesktopThemesAdded() const;

    void enableDelayedIconSetLoading( bool enable );

    bool isDelayedIconSetLoadingEnabled() const;
 
 
 private:
    void init( const TQString& _appname, TDEStandardDirs *_dirs );

    TDEIcon findMatchingIcon(const TQString& name, int size) const;

     TQImage *loadOverlay(const TQString& name, int size) const;

    void addAppThemes(const TQString& appname);

    void addBaseThemes(TDEIconThemeNode *node, const TQString &appname);

    TQString unknownIconPath( int size ) const;

    TQString removeIconExtension(const TQString &name) const;

    TQString removeIconExtensionInternal(const TQString &name) const;

    TQIconSet loadIconSetNonDelayed( const TQString& name, TDEIcon::Group group,
                                    int size, bool canReturnNull );
 
    // @internal the data object
    TDEIconLoaderPrivate *d;
};

TDECORE_EXPORT TQPixmap DesktopIcon(const TQString& name, int size=0,
            int state=TDEIcon::DefaultState,
            TDEInstance *instance=TDEGlobal::instance());

TDECORE_EXPORT TQPixmap DesktopIcon(const TQString& name, TDEInstance *instance);

TDECORE_EXPORT TQIconSet DesktopIconSet(const TQString& name, int size=0,
            TDEInstance *instance=TDEGlobal::instance());

TDECORE_EXPORT TQPixmap BarIcon(const TQString& name, int size=0, int state=TDEIcon::DefaultState,
    TDEInstance *instance=TDEGlobal::instance());

TDECORE_EXPORT TQPixmap BarIcon(const TQString& name, TDEInstance *instance);

TDECORE_EXPORT TQIconSet BarIconSet(const TQString& name, int size=0,
            TDEInstance *instance=TDEGlobal::instance());

TDECORE_EXPORT TQPixmap SmallIcon(const TQString& name, int size=0,
          int state=TDEIcon::DefaultState,
          TDEInstance *instance=TDEGlobal::instance());

TDECORE_EXPORT TQPixmap SmallIcon(const TQString& name, TDEInstance *instance);

TDECORE_EXPORT TQIconSet SmallIconSet(const TQString& name, int size=0,
            TDEInstance *instance=TDEGlobal::instance());

TDECORE_EXPORT TQPixmap MainBarIcon(const TQString& name, int size=0,
            int state=TDEIcon::DefaultState,
            TDEInstance *instance=TDEGlobal::instance());

TDECORE_EXPORT TQPixmap MainBarIcon(const TQString& name, TDEInstance *instance);

TDECORE_EXPORT TQIconSet MainBarIconSet(const TQString& name, int size=0,
            TDEInstance *instance=TDEGlobal::instance());

TDECORE_EXPORT TQPixmap UserIcon(const TQString& name, int state=TDEIcon::DefaultState,
    TDEInstance *instance=TDEGlobal::instance());

TDECORE_EXPORT TQPixmap UserIcon(const TQString& name, TDEInstance *instance);

TDECORE_EXPORT TQIconSet UserIconSet(const TQString& name,
    TDEInstance *instance=TDEGlobal::instance());

TDECORE_EXPORT int IconSize(TDEIcon::Group group, TDEInstance *instance=TDEGlobal::instance());
 
#endif // __TDEIconLoader_h_Included__