You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
pytde/extra/kde300/kicontheme.h

218 lines
5.4 KiB

/* vi: ts=8 sts=4 sw=4
*
* $Id: kicontheme.h,v 1.19 2002/03/05 23:13:26 rich Exp $
*
* 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>
class TDEConfig;
//class TDEIconThemeDir;
class TDEIconThemePrivate;
class TDEIconPrivate;
/**
* One icon as found by TDEIconTheme. Also serves as a namespace containing
* icon related constants.
*/
class TDEIcon
{
public:
TDEIcon() { size = 0; }
/**
* Return true if this icon is valid, false otherwise.
*/
bool isValid() const { return size != 0; }
enum Context { Any, Action, Application, Device, FileSystem, MimeType };
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=Desktop, Toolbar,
MainToolbar, Small, Panel, LastGroup, User };
enum StdSizes { SizeSmall=16, SizeMedium=32, SizeLarge=48 };
enum States { DefaultState, ActiveState, DisabledState, LastState };
enum Overlays { LockOverlay=0x100, ZipOverlay=0x200, LinkOverlay=0x400,
HiddenOverlay=0x800, OverlayMask = ~0xff };
/**
* The size in pixels of the icon.
*/
int size;
/**
* The context of the icon.
*/
Context context;
/**
* The type of the icon: Fixed, Scalable or Threshold.
**/
Type type;
/**
* The threshold in case type == Threshold
*/
int threshold;
/**
* The full path of the icon.
*/
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 to use/access icon themes in KDE. This class is used by the
* iconloader but can be used by others too.
*/
class TDEIconTheme
{
public:
/**
* Load an icon theme by name.
*/
TDEIconTheme(const TQString& name, const TQString& appName=TQString::null);
~TDEIconTheme();
/**
* The stylized name of the icon theme.
*/
TQString name() const { return mName; }
/**
* A description for the icon theme.
*/
TQString description() const { return mDesc; }
/**
* Return the name of the "example" icon.
*/
TQString example() const;
/**
* Return the name of the screenshot.
*/
TQString screenshot() const;
/**
* Returns the name of this theme's link overlay.
*/
TQString linkOverlay() const;
/**
* Returns the name of this theme's zip overlay.
*/
TQString zipOverlay() const;
/**
* Returns the name of this theme's lock overlay.
*/
TQString lockOverlay() const;
/**
* Returns the toplevel theme directory.
*/
TQString dir() const { return mDir; }
/**
* The themes this icon theme falls back on.
*/
TQStringList inherits() const { return mInherits; }
/**
* The icon theme exists?
*/
bool isValid() const;
/**
* The minimum display depth required for this theme. This can either
* be 8 or 32.
*/
int depth() const { return mDepth; }
/**
* The default size of this theme for a certain icon group.
* @param group The icon group. See @ref #TDEIcon::Group.
* @return The default size in pixels for the given icon group.
*/
int defaultSize(TDEIcon::Group group) const;
/**
* Query available sizes for a group.
*/
TQValueList<int> querySizes(TDEIcon::Group group) const;
/**
* Query available icons for a size and context.
*/
TQStringList queryIcons(int size, TDEIcon::Context context = TDEIcon::Any) const;
/**
* Query available icons for a context and preferred size.
*/
TQStringList queryIconsByContext(int size, TDEIcon::Context context = TDEIcon::Any) const;
/**
* Lookup an icon in the theme.
* @param name The name of the icon, without extension.
* @param size The desired size of the icon.
* @param match The matching mode. TDEIcon::MatchExact returns an icon
* only if matches exactly. TDEIcon::MatchBest returns the best matching
* icon.
* @return A TDEIcon class that describes the icon. If an icon is found,
* @ref #TDEIcon::isValid will return true, and false otherwise.
*/
TDEIcon iconPath(const TQString& name, int size, TDEIcon::MatchType match) const;
/**
* List all icon themes installed on the system, global and local.
*/
static TQStringList list();
/**
* Returns the current icon theme.
*/
static TQString current();
static void reconfigure();
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