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

FX::FXIconSource Class Reference

An icon source is a class that loads an icon of any type. More...

#include <FXIconSource.h>

Inheritance diagram for FX::FXIconSource:

FX::FXObject List of all members.

Public Member Functions

 FXIconSource (FXApp *a)
virtual FXIconloadIcon (const FXString &filename, const FXString &type=FXString::null) const
virtual FXIconloadIcon (const void *pixels, const FXString &type=FXString::null) const
virtual FXIconloadIcon (FXStream &store, const FXString &type=FXString::null) const
virtual FXImageloadImage (const FXString &filename, const FXString &type=FXString::null) const
virtual FXImageloadImage (const void *pixels, const FXString &type=FXString::null) const
virtual FXImageloadImage (FXStream &store, const FXString &type=FXString::null) const
virtual FXIconloadScaledIcon (const FXString &filename, FXint size=32, FXint qual=0, const FXString &type=FXString::null) const
virtual FXIconloadScaledIcon (const void *pixels, FXint size=32, FXint qual=0, const FXString &type=FXString::null) const
virtual FXIconloadScaledIcon (FXStream &store, FXint size=32, FXint qual=0, const FXString &type=FXString::null) const
virtual FXImageloadScaledImage (const FXString &filename, FXint size=32, FXint qual=0, const FXString &type=FXString::null) const
virtual FXImageloadScaledImage (const void *pixels, FXint size=32, FXint qual=0, const FXString &type=FXString::null) const
virtual FXImageloadScaledImage (FXStream &store, FXint size=32, FXint qual=0, const FXString &type=FXString::null) const
virtual void save (FXStream &store) const
virtual void load (FXStream &store)
virtual ~FXIconSource ()

Detailed Description

An icon source is a class that loads an icon of any type.

It exists purely for convenience, to make loading icons simpler by concentrating the knowledge of the supported icon formats in a single place. Needless to say, this class is subclassable, allowing users to add additional icon types and make them available to all widgets which deal with icons. Note, the icons are loaded, but NOT created (realized) yet; this allows users to manipulate the pixel data prior to realizing the icons.


Constructor & Destructor Documentation

FX::FXIconSource::FXIconSource FXApp a  ) 
 

Construct an icon source.

virtual FX::FXIconSource::~FXIconSource  )  [virtual]
 

Destroy.


Member Function Documentation

virtual FXIcon* FX::FXIconSource::loadIcon const FXString filename,
const FXString type = FXString::null
const [virtual]
 

Load an icon from the file filename.

By default, the file extension is stripped and used as the icon type; if an explicit icon type is forced, then that type is used and the extension is ignored. For example, loadIcon("icon","gif") will try to load a CompuServe GIF file, since the filename does not give any clue as to the type of the icon.

virtual FXIcon* FX::FXIconSource::loadIcon const void *  pixels,
const FXString type = FXString::null
const [virtual]
 

Load an icon of a given type (e.g.

"gif") from reswrapped data. Returns NULL if there's some error loading the icon. [The optional parameter is actually mandatory at the time of this writing; future versions will attempt to inspect the first few bytes of the stream to divine the icon format if the parameter is omitted].

virtual FXIcon* FX::FXIconSource::loadIcon FXStream store,
const FXString type = FXString::null
const [virtual]
 

Load an icon of a given type (e.g.

"gif") from an already open stream. Returns NULL if there's some error loading the icon. [The optional parameter is actually mandatory at the time of this writing; future versions will attempt to inspect the first few bytes of the stream to divine the icon format if the parameter is omitted].

virtual FXImage* FX::FXIconSource::loadImage const FXString filename,
const FXString type = FXString::null
const [virtual]
 

Load an image from the file filename.

By default, the file extension is stripped and used as the image type; if an explicit image type is forced, then that type is used and the extension is ignored. For example, loadImage("image","gif") will try to load a CompuServe GIF file, since the filename does not give any clue as to the type of the image.

virtual FXImage* FX::FXIconSource::loadImage const void *  pixels,
const FXString type = FXString::null
const [virtual]
 

Load an image of a given type (e.g.

"gif") from reswrapped data. Returns NULL if there's some error loading the icon. [The optional parameter is actually mandatory at the time of this writing; future versions will attempt to inspect the first few bytes of the stream to divine the icon format if the parameter is omitted].

virtual FXImage* FX::FXIconSource::loadImage FXStream store,
const FXString type = FXString::null
const [virtual]
 

Load an image of a given type (e.g.

"gif") from an already open stream. Returns NULL if there's some error loading the image. [The optional parameter is actually mandatory at the time of this writing; future versions will attempt to inspect the first few bytes of the stream to divine the image format if the parameter is omitted].

virtual FXIcon* FX::FXIconSource::loadScaledIcon const FXString filename,
FXint  size = 32,
FXint  qual = 0,
const FXString type = FXString::null
const [virtual]
 

Load icon and scale it such that its dimensions does not exceed given size.

virtual FXIcon* FX::FXIconSource::loadScaledIcon const void *  pixels,
FXint  size = 32,
FXint  qual = 0,
const FXString type = FXString::null
const [virtual]
 

Load icon and scale it such that its dimensions does not exceed given size.

virtual FXIcon* FX::FXIconSource::loadScaledIcon FXStream store,
FXint  size = 32,
FXint  qual = 0,
const FXString type = FXString::null
const [virtual]
 

Load icon and scale it such that its dimensions does not exceed given size.

virtual FXImage* FX::FXIconSource::loadScaledImage const FXString filename,
FXint  size = 32,
FXint  qual = 0,
const FXString type = FXString::null
const [virtual]
 

Load image and scale it such that its dimensions does not exceed given size.

virtual FXImage* FX::FXIconSource::loadScaledImage const void *  pixels,
FXint  size = 32,
FXint  qual = 0,
const FXString type = FXString::null
const [virtual]
 

Load image and scale it such that its dimensions does not exceed given size.

virtual FXImage* FX::FXIconSource::loadScaledImage FXStream store,
FXint  size = 32,
FXint  qual = 0,
const FXString type = FXString::null
const [virtual]
 

Load image and scale it such that its dimensions does not exceed given size.

virtual void FX::FXIconSource::save FXStream store  )  const [virtual]
 

Save to stream.

Reimplemented from FX::FXObject.

virtual void FX::FXIconSource::load FXStream store  )  [virtual]
 

Load from stream.

Reimplemented from FX::FXObject.

Copyright © 1997-2005 Jeroen van der Zijp