Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members

FX::FXIconDict Class Reference

The Icon Dictionary manages a collection of icons. More...

#include <FXIconDict.h>

Inheritance diagram for FX::FXIconDict:
FX::FXDict FX::FXObject

List of all members.

Public Member Functions

 FXIconDict (FXApp *app, const FXString &p=defaultIconPath)
 Construct icon dictionary, and set initial search path; also creates a default icon source object.
void setIconSource (FXIconSource *src)
 Change icon source.
FXIconSourcegetIconSource () const
 Return icon source.
void setIconPath (const FXString &p)
 Set icon search path.
const FXStringgetIconPath () const
 Return current icon search path.
FXIconinsert (const FXchar *name)
 Insert unique icon loaded from filename into dictionary.
FXIconreplace (const FXchar *name)
 Replace icon loaded from filename into dictionary.
FXIconremove (const FXchar *name)
 Remove icon from dictionary.
FXIconfind (const FXchar *name)
 Find icon by name.
FXIcondata (FXival pos) const
 Return icon at position pos.
virtual void save (FXStream &store) const
 Save to stream.
virtual void load (FXStream &store)
 Load from stream.
virtual ~FXIconDict ()
 Destroy the icon dict as well as the icon source.
- Public Member Functions inherited from FX::FXDict
 FXDict ()
 Construct an empty dictionary.
FXbool size (FXival m)
 Resize the table to the given size.
FXival size () const
 Return the size of the table, including the empty slots.
FXival no () const
 Return the total number of entries in the table.
void * insert (const FXchar *ky, void *ptr=NULL, FXbool mrk=false)
 Insert a new entry into the table given key and mark.
void * replace (const FXchar *ky, void *ptr=NULL, FXbool mrk=false)
 Replace data at key, if the entry's mark is less than or equal to the given mark.
void * find (const FXchar *ky) const
 Find data pointer given key.
FXbool empty (FXival pos) const
 Return true if slot is empty.
const FXchar * key (FXival pos) const
 Return key at position pos.
FXbool mark (FXival pos) const
 Return mark flag of entry at position pos.
FXival first () const
 Return position of first filled slot, or >= total.
FXival last () const
 Return position of last filled slot or -1.
FXival next (FXival pos) const
 Return position of next filled slot in hash table or a value greater than or equal to total if no filled slot was found.
FXival prev (FXival pos) const
 Return position of previous filled slot in hash table or a -1 if no filled slot was found.
void clear ()
 Clear all entries.
virtual ~FXDict ()
- Public Member Functions inherited from FX::FXObject
const FXchar * getClassName () const
 Get class name of some object.
FXbool isMemberOf (const FXMetaClass *metaclass) const
 Check if object is member of metaclass.
virtual long tryHandle (FXObject *sender, FXSelector sel, void *ptr)
 Try handle message safely, catching certain exceptions.
virtual long onDefault (FXObject *, FXSelector, void *)
 Called for unhandled messages.
virtual ~FXObject ()
 Virtual destructor.

Static Public Attributes

static const FXchar defaultIconPath []
 Default icon search path.

Protected Member Functions

virtual void * createData (void *)
 Overload this function in a derived class to return the data pointer given an input pointer; the default implementation just returns the input pointer.
virtual void deleteData (void *)
 Overload this function in a derived class to delete the pointer previously returned by createData(); the default implementation does nothing.

Additional Inherited Members

- Static Protected Member Functions inherited from FX::FXDict
static FXuint hash (const FXchar *str)
- Protected Attributes inherited from FX::FXDict
FXArray< Entrytable
FXival used
FXival free
- Static Protected Attributes inherited from FX::FXDict
static const Entry init

Detailed Description

The Icon Dictionary manages a collection of icons.

The icons are referenced by their file name. When first encountering a new file name, the icon is located by searching the icon search path for the icon file. If found, the services of the icon source object are used to load the icon from the file. A custom icon source may be installed to furnish support for additonal image file formats. Once the icon is loaded, an association between the icon name and the icon is entered into the icon dictionary. Subsequent searches for an icon with this name will be satisfied from the cached value. The lifetype of the icons is managed by the icon dictionary, and thus all icons will be deleted when the dictionary is deleted.

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

Copyright © 1997-2013 Jeroen van der Zijp