sptk::CFrames Class Reference
[GUI Classes]

Frame images collection. More...

#include <CFrame.h>

List of all members.

Public Member Functions
	CFrames ()
	Constructor.
	~CFrames ()
	Destructor.
void	clear ()
	Clears the frame collection.
void	load (CTar &tar, CXmlNode *frameNode)
	Loads the frames from the tar archive by the XML description.
void	registerFrame (std::string frameName, CFrame *frame, Fl_Boxtype frameType=FL_NO_BOX)
	Registers a single frame image in the collection.
CFrame *	find (Fl_Boxtype frameType) const
	Returns a standard FLTK frame image, or NULL if not defined in the collection.
CFrame *	find (std::string frameName) const
	Returns a frame image, or NULL if not defined in the collection.
	CFrames ()
	Constructor.
	~CFrames ()
	Destructor.
void	clear ()
	Clears the frame collection.
void	load (CTar &tar, CXmlNode *frameNode)
	Loads the frames from the tar archive by the XML description.
void	registerFrame (std::string frameName, CFrame *frame, Fl_Boxtype frameType=FL_NO_BOX)
	Registers a single frame image in the collection.
CFrame *	find (Fl_Boxtype frameType) const
	Returns a standard FLTK frame image, or NULL if not defined in the collection.
CFrame *	find (std::string frameName) const
	Returns a frame image, or NULL if not defined in the collection.

---

Detailed Description

Frame images collection.

---

Member Function Documentation

void sptk::CFrames::clear

(

)

Clears the frame collection.

All the memory allocated for images is deleted

void sptk::CFrames::clear

(

)

Clears the frame collection.

All the memory allocated for images is deleted

Referenced by ~CFrames().

CFrame* sptk::CFrames::find

(

std::string

frameName

)

const

Returns a frame image, or NULL if not defined in the collection.

Parameters:

frameName

std::string, symbolic frame name

CFrame* sptk::CFrames::find

(

Fl_Boxtype

frameType

)

const

Returns a standard FLTK frame image, or NULL if not defined in the collection.

Parameters:

frameType

Fl_Boxtype, standard FLTK frame type to find

CFrame* sptk::CFrames::find

(

std::string

frameName

)

const

Returns a frame image, or NULL if not defined in the collection.

Parameters:

frameName

std::string, symbolic frame name

CFrame* sptk::CFrames::find

(

Fl_Boxtype

frameType

)

const

Returns a standard FLTK frame image, or NULL if not defined in the collection.

Parameters:

frameType

Fl_Boxtype, standard FLTK frame type to find

void sptk::CFrames::load	(	CTar &	tar,
		CXmlNode *	frameNode
	)

Loads the frames from the tar archive by the XML description.

Parameters:

	tar	CTar&, tar archive with the images
	frameNode	CXmlNode*, XML description of the frames

void sptk::CFrames::load	(	CTar &	tar,
		CXmlNode *	frameNode
	)

Loads the frames from the tar archive by the XML description.

Parameters:

	tar	CTar&, tar archive with the images
	frameNode	CXmlNode*, XML description of the frames

void sptk::CFrames::registerFrame	(	std::string	frameName,
		CFrame *	frame,
		Fl_Boxtype	frameType = FL_NO_BOX
	)

Registers a single frame image in the collection.

Parameters:

	frameName	std::string, symbolic name for the frame
	frame	CFrame*, a frame image
	frameType	Fl_Boxtype, FLTK frame type if applicable

void sptk::CFrames::registerFrame	(	std::string	frameName,
		CFrame *	frame,
		Fl_Boxtype	frameType = FL_NO_BOX
	)

Registers a single frame image in the collection.

Parameters:

	frameName	std::string, symbolic name for the frame
	frame	CFrame*, a frame image
	frameType	Fl_Boxtype, FLTK frame type if applicable

---

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

• CFrame.h
• gui/CFrame.h