sptk::CFrames Class Reference

Frame images collection. More...

#include <CFrame.h>

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

Detailed Description

Frame images collection.

Member Function Documentation

clear()

void sptk::CFrames::clear

(

)

Clears the frame collection.

All the memory allocated for images is deleted

find() [1/2]

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

find() [2/2]

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

load()

void sptk::CFrames::load	(	Tar &	tar,
		const xdoc::SNode &	frameNode
	)

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

Parameters

tar	CTar&, tar archive with the images
frameNode	xml::Node*, XML description of the frames

registerFrame()

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 file:

• CFrame.h