TDEIcon Class Reference

#include <kicontheme.h>

Public Types
enum	Context {   Any , Action , Application , Device ,   FileSystem , MimeType , Animation , Category ,   Emblem , Emote , International , Place ,   StatusIcon }
enum	Type { Fixed , Scalable , Threshold }
enum	MatchType { MatchExact , MatchBest }
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 }

Public Member Functions
bool	isValid () const

Public Attributes
int	size
Context	context
Type	type
int	threshold
TQString	path

Detailed Description

One icon as found by TDEIconTheme.

Also serves as a namespace containing icon related constants.

See also

TDEIconEffect

TDEIconTheme

TDEIconLoader

Definition at line 36 of file kicontheme.h.

Member Enumeration Documentation

Context

enum TDEIcon::Context

Defines the context of the icon.

Enumerator
Any	Some icon with unknown purpose.
Action	An action icon (e.g. 'save', 'print').
Application	An icon that represents an application.
Device	An icon that represents a device.
FileSystem	An icon that represents a file system.
MimeType	An icon that represents a mime type (or file type).
Animation	An icon that is animated.
Category	An icon that represents a category.
Emblem	An icon that adds information to an existing icon.
Emote	An icon that expresses an emotion.
International	An icon that represents a country's flag.
Place	An icon that represents a location (e.g. 'home', 'trash').
StatusIcon	An icon that represents an event.

Definition at line 49 of file kicontheme.h.

Group

enum TDEIcon::Group

The group of the icon.

Enumerator
NoGroup	No group.
Desktop	Desktop icons.
FirstGroup	First group.
Toolbar	Toolbar icons.
MainToolbar	Main toolbar icons.
Small	Small icons.
Panel	Panel (Kicker) icons.
LastGroup	Last group.
User	User icons.

Definition at line 88 of file kicontheme.h.

MatchType

enum TDEIcon::MatchType

The type of a match.

Enumerator
MatchExact	Only try to find an exact match.
MatchBest	Take the best match if there is no exact match.

Definition at line 77 of file kicontheme.h.

Overlays

enum TDEIcon::Overlays

This defines an overlay, a semi-transparent image that is projected onto the icon.

They are used to show that the file represented by the icon is, for example, locked, zipped or hidden.

Enumerator
LockOverlay	a file is locked
ZipOverlay	a file is zipped
LinkOverlay	a file is a link
HiddenOverlay	a file is hidden
ShareOverlay	a file is shared

Definition at line 141 of file kicontheme.h.

States

enum TDEIcon::States

Defines the possible states of an icon.

Enumerator
DefaultState	The default state.
ActiveState	Icon is active.
DisabledState	Icon is disabled.
LastState	Last state (last constant)

Definition at line 130 of file kicontheme.h.

StdSizes

enum TDEIcon::StdSizes

These are the standard sizes for icons.

Enumerator
SizeSmall	small icons for menu entries
SizeSmallMedium	slightly larger small icons for toolbars, panels, etc
SizeMedium	medium sized icons for the desktop
SizeLarge	large sized icons for the panel
SizeHuge	huge sized icons for iconviews
SizeEnormous	enormous sized icons for iconviews

Definition at line 112 of file kicontheme.h.

Type

enum TDEIcon::Type

The type of the icon.

Enumerator
Fixed	Fixed-size icon.
Scalable	Scalable-size icon.
Threshold	A threshold icon.

Definition at line 68 of file kicontheme.h.

Constructor & Destructor Documentation

TDEIcon()

TDEIcon::TDEIcon ( )

inline

Definition at line 39 of file kicontheme.h.

Member Function Documentation

isValid()

bool TDEIcon::isValid ( ) const

inline

Return true if this icon is valid, false otherwise.

Definition at line 44 of file kicontheme.h.

Member Data Documentation

context

Context TDEIcon::context

The context of the icon.

Definition at line 158 of file kicontheme.h.

path

TQString TDEIcon::path

The full path of the icon.

Definition at line 173 of file kicontheme.h.

size

int TDEIcon::size

The size in pixels of the icon.

Definition at line 153 of file kicontheme.h.

threshold

int TDEIcon::threshold

The threshold in case type == Threshold.

Definition at line 168 of file kicontheme.h.

type

Type TDEIcon::type

The type of the icon: Fixed, Scalable or Threshold.

Definition at line 163 of file kicontheme.h.

---

The documentation for this class was generated from the following file:

• kicontheme.h