FX::FXIconSource Class Reference

#include <FXIconSource.h>

Inheritance diagram for FX::FXIconSource:

[legend]

List of all members.

---

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.

Public Member Functions
	FXIconSource (FXApp *a)
virtual FXIcon *	loadIconFile (const FXString &filename, const FXString &type=FXString::null) const
virtual FXIcon *	loadIconData (const void *pixels, const FXString &type=FXString::null) const
virtual FXIcon *	loadIconStream (FXStream &store, const FXString &type=FXString::null) const
virtual FXImage *	loadImageFile (const FXString &filename, const FXString &type=FXString::null) const
virtual FXImage *	loadImageData (const void *pixels, const FXString &type=FXString::null) const
virtual FXImage *	loadImageStream (FXStream &store, const FXString &type=FXString::null) const
virtual FXIcon *	loadScaledIconFile (const FXString &filename, FXint size=32, FXint qual=0, const FXString &type=FXString::null) const
virtual FXIcon *	loadScaledIconData (const void *pixels, FXint size=32, FXint qual=0, const FXString &type=FXString::null) const
virtual FXIcon *	loadScaledIconStream (FXStream &store, FXint size=32, FXint qual=0, const FXString &type=FXString::null) const
virtual FXImage *	loadScaledImageFile (const FXString &filename, FXint size=32, FXint qual=0, const FXString &type=FXString::null) const
virtual FXImage *	loadScaledImageData (const void *pixels, FXint size=32, FXint qual=0, const FXString &type=FXString::null) const
virtual FXImage *	loadScaledImageStream (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 ()
virtual long	onDefault (FXObject *, FXSelector, void *)
const FXchar *	getClassName () const
bool	isMemberOf (const FXMetaClass *metaclass) const
virtual long	tryHandle (FXObject *sender, FXSelector sel, void *ptr)
QTransString	tr (const char *text, const char *hint=0)
virtual void *	getPythonObject () const
virtual void	decouplePythonObject () const
Protected Attributes
FXApp *	app

---

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::loadIconFile	(	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::loadIconData	(	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::loadIconStream	(	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::loadImageFile	(	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::loadImageData	(	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::loadImageStream	(	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::loadScaledIconFile	(	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::loadScaledIconData	(	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::loadScaledIconStream	(	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::loadScaledImageFile	(	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::loadScaledImageData	(	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::loadScaledImageStream	(	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.

virtual long FX::FXObject::onDefault	(	FXObject *	,
		FXSelector	,
		void *
	)			[virtual, inherited]

Called for unhandled messages.

Reimplemented in FX::FXDelegator, FX::FXGLViewer, FX::FXMDIChild, and FX::FXMDIClient.

const FXchar* FX::FXObject::getClassName

(

)

const [inherited]

Get class name of some object.

bool FX::FXObject::isMemberOf

(

const FXMetaClass *

metaclass

)

const [inherited]

Check if object is member of metaclass.

virtual long FX::FXObject::tryHandle	(	FXObject *	sender,
		FXSelector	sel,
		void *	ptr
	)			[virtual, inherited]

Try handle message safely.

QTransString FX::FXObject::tr	(	const char *	text,
		const char *	hint = 0
	)			[inherited]

Returns a human translated version of the text to the locale language (warning: uses a virtual method call, so can't use before construction)

virtual void* FX::FXObject::getPythonObject

(

)

const [inline, virtual, inherited]

Returns the python object representing this instance (if created in python).

virtual void FX::FXObject::decouplePythonObject

(

)

const [inline, virtual, inherited]

Causes decoupling of python object from this object (deletes self).

---

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

• FXIconSource.h