kicontheme.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 __TDEIconTheme_h_Included__
#define __TDEIconTheme_h_Included__
 
#include <tqstring.h>
#include <tqstringlist.h>
#include <tqptrlist.h>
#include <tqvaluelist.h>
#include "tdelibs_export.h"
 
class TDEConfig;
class TDEIconThemeDir;
 
class TDEIconThemePrivate;
 
class TDEIconPrivate;
 
class TDECORE_EXPORT TDEIcon
{
public:
    TDEIcon() { size = 0; }
 
    bool isValid() const { return size != 0; }
 
    enum Context {
      Any, 
      Action, 
      Application, 
      Device, 
      FileSystem, 
      MimeType, 
      Animation, 
      Category, 
      Emblem, 
      Emote, 
      International, 
      Place, 
      StatusIcon 
    };
 
    enum Type {
      Fixed, 
      Scalable, 
      Threshold 
    };
 
    enum MatchType {
      MatchExact, 
      MatchBest   
 
    };
 
    // if you add a group here, make sure to change the config reading in
    // TDEIconLoader too
    enum Group {
    NoGroup=-1,
    Desktop=0,
    FirstGroup=0,
    Toolbar,
        MainToolbar,
    Small,
    Panel,
    LastGroup,
    User
         };
 
    enum StdSizes {
        SizeSmall=16,
        SizeSmallMedium=22,
        SizeMedium=32,
        SizeLarge=48,
        SizeHuge=64,
        SizeEnormous=128
         };
 
    enum States { DefaultState, 
          ActiveState,  
          DisabledState, 
          LastState      
    };
 
    enum Overlays {
      LockOverlay=0x100, 
      ZipOverlay=0x200,  
      LinkOverlay=0x400, 
      HiddenOverlay=0x800, 
      ShareOverlay=0x1000, 
      OverlayMask = ~0xff
    };
 
    int size;
 
    Context context;
 
    Type type;
 
    int threshold;
 
    TQString path;
 
private:
    TDEIconPrivate *d;
};
 
inline TDEIcon::Group& operator++(TDEIcon::Group& group) { group = static_cast<TDEIcon::Group>(group+1); return group; }
inline TDEIcon::Group operator++(TDEIcon::Group& group,int) { TDEIcon::Group ret = group; ++group; return ret; }
 
class TDECORE_EXPORT TDEIconTheme
{
public:
    TDEIconTheme(const TQString& name, const TQString& appName=TQString::null);
    ~TDEIconTheme();
 
    TQString name() const { return mName; }
 
    TQString description() const { return mDesc; }
 
    TQString example() const;
 
    TQString screenshot() const;
 
    TQString linkOverlay() const;
 
    TQString zipOverlay() const;
 
    TQString lockOverlay() const;
 
    TQString shareOverlay () const;
 
    TQString dir() const { return mDir; }
 
    TQStringList inherits() const { return mInherits; }
 
    bool isValid() const;
 
    bool isHidden() const;
 
    int depth() const { return mDepth; }
 
    int defaultSize(TDEIcon::Group group) const;
 
    TQValueList<int> querySizes(TDEIcon::Group group) const;
 
    TQStringList queryIcons(int size, TDEIcon::Context context = TDEIcon::Any) const;
 
    TQStringList queryIconsByContext(int size, TDEIcon::Context context = TDEIcon::Any) const;
 
 
    TDEIcon iconPath(const TQString& name, int size, TDEIcon::MatchType match) const;
    
    bool hasContext( TDEIcon::Context context ) const;
 
    static TQStringList list();
 
    static TQString current();
 
    static void reconfigure();
 
    static TQString defaultThemeName();
 
private:
    int mDefSize[8];
    TQValueList<int> mSizes[8];
 
    int mDepth;
    TQString mDir, mName, mDesc;
    TQStringList mInherits;
    TQPtrList<TDEIconThemeDir> mDirs;
    TDEIconThemePrivate *d;
 
    static TQString *_theme;
    static TQStringList *_theme_list;
};
 
#endif