Main Page   Modules   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   Related Pages  

KIcon Class Reference

#include <kicontheme.h>

List of all members.

Public Types

enum  Context {
  Any, Action, Application, Device,
  FileSystem, MimeType
}
enum  Type { Fixed, Scalable, Threshold }
enum  MatchType { MatchExact, MatchBest }
enum  Group
enum  StdSizes { SizeSmall = 16, SizeMedium = 32, SizeLarge = 48 }
enum  States { DefaultState, ActiveState, DisabledState, LastState }
enum  Overlays {
  LockOverlay = 0x100, ZipOverlay = 0x200, LinkOverlay = 0x400, HiddenOverlay = 0x800,
  ShareOverlay = 0x1000
}

Public Methods

bool isValid () const

Public Attributes

int size
Context context
Type type
int threshold
QString path


Detailed Description

One icon as found by KIconTheme. Also serves as a namespace containing icon related constants.
See also:
KIconEffect , KIconTheme , KIconLoader

Definition at line 36 of file kicontheme.h.


Member Enumeration Documentation

enum KIcon::Context
 

Defines the context of the icon.

Enumeration values:
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).

Definition at line 49 of file kicontheme.h.

enum KIcon::Group
 

The group an an icon.

Definition at line 81 of file kicontheme.h.

Referenced by KURLBarItem::iconGroup(), and KDEDesktopMimeType::pixmap().

enum KIcon::MatchType
 

The type of a match.

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

Definition at line 70 of file kicontheme.h.

enum KIcon::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.

Enumeration values:
LockOverlay  a file is locked
ZipOverlay  a file is zipped
LinkOverlay  a fileis a link
HiddenOverlay  a file is hidden
ShareOverlay  a file is shared

Definition at line 109 of file kicontheme.h.

enum KIcon::States
 

Defines the possible states of an icon.

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

Definition at line 98 of file kicontheme.h.

enum KIcon::StdSizes
 

These are the standard sizes for icons.

Enumeration values:
SizeSmall  small icons for menu entries
SizeMedium  medium sized icons for the desktop
SizeLarge  large sized icons for the panel

Definition at line 87 of file kicontheme.h.

enum KIcon::Type
 

The type of the icon.

Enumeration values:
Fixed  Fixed-size icon.
Scalable  Scalable-size icon.
Threshold  A threshold icon.

Definition at line 61 of file kicontheme.h.


Member Function Documentation

bool KIcon::isValid   const [inline]
 

Return true if this icon is valid, false otherwise.

Definition at line 44 of file kicontheme.h.

References size.


Member Data Documentation

Context KIcon::context
 

The context of the icon.

Definition at line 126 of file kicontheme.h.

QString KIcon::path
 

The full path of the icon.

Definition at line 141 of file kicontheme.h.

int KIcon::size
 

The size in pixels of the icon.

Definition at line 121 of file kicontheme.h.

Referenced by isValid().

int KIcon::threshold
 

The threshold in case type == Threshold

Definition at line 136 of file kicontheme.h.

Type KIcon::type
 

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

Definition at line 131 of file kicontheme.h.


The documentation for this class was generated from the following file:
Generated on Wed Aug 13 23:30:15 2003 for kdelibs by doxygen1.2.18