IlvManagerOutputFile Class Reference

Input/output class. More...

#include <ilviews/manager/io.h>

Inheritance diagram for IlvManagerOutputFile:

Public Member Functions
void	exportCSS (IlBoolean s)
	Turns on or off the ability to export CSS file. Toggles the ability for manager to export CSS stylesheet into a separate file if such a file hasn't been created yet. More...
const IlvManager *	getManager () const
	Returns a pointer to the manager saving the objects. More...
IlBoolean	isExportingCSS () const
	Status of the ability to export CSS file. More...
IlBoolean	isSavingAsApplicationStyle () const
	Status of whether this manager is saving CSS separately for view objects. More...
IlBoolean	isSavingCSS () const
	Status of the ability to save CSS stylesheets. More...
IlBoolean	isSavingLayers () const
	Status of the ability to save layers. More...
IlBoolean	isSavingViews () const
	Status of the ability to save views. More...
virtual void	saveAll (const IlvManager *manager, IlUInt count=0, IlvGraphic *const *objects=0)
	Writes an object description file. More...
void	saveCSS (IlBoolean s)
	Turns on or off the ability to save CSS stylesheets. More...
void	saveCSSAsApplicationStyle (IlBoolean s)
	Turns on or off the ability for this manager to save CSS for each view object separately. More...
void	saveLayers (IlBoolean s)
	Turns on or off the ability to save layers. More...
void	saveViews (IlBoolean s)
	Turns on or off the ability to save views. More...
virtual const char *	typeOf () const
	Returns the name of the class. More...
virtual void	writeObject (const IlvGraphic *object)
	Save a graphic object. More...

Detailed Description

Input/output class.

Library: ilvmgr

Manager objects and their properties can be saved from particular streams. To simplify the saving of a set of IlvGraphic objects, Rogue Wave Views defines the IlvManagerOutputFile class. This class is a subtype of IlvOutputFile. It adds only manager-specific information to the object description blocks. To save the objects of a manager, call the member function saveAll() of an instance of IlvManagerOutputFile with an array of objects.

See also

IlvGraphic, IlvManager, IlvManagerInputFile.

Member Function Documentation

exportCSS()

void IlvManagerOutputFile::exportCSS

(

IlBoolean

s

)

Turns on or off the ability to export CSS file. Toggles the ability for manager to export CSS stylesheet into a separate file if such a file hasn't been created yet.

Parameters

s	If IlTrue, the manager exports CSS files. Otherwise, it does not.

getManager()

const IlvManager* IlvManagerOutputFile::getManager

(

)

const

Returns a pointer to the manager saving the objects.

Returns

A pointer to the manager object from which to get the objects to be saved. This value is updated by the member function saveAll().

isExportingCSS()

IlBoolean IlvManagerOutputFile::isExportingCSS

(

)

const

Status of the ability to export CSS file.

Returns

IlTrue if the manager upon saving to stream will also write the associated CSS files if such files do not already exist. IlFalse if it will skip creating said files.

isSavingAsApplicationStyle()

IlBoolean IlvManagerOutputFile::isSavingAsApplicationStyle

(

)

const

Status of whether this manager is saving CSS separately for view objects.

Returns

IlTrue if the manager upon saving to stream will not be writing CSS information according to the views it's applied to. Only one CSS entry will be written - Application - for the whole application.

isSavingCSS()

IlBoolean IlvManagerOutputFile::isSavingCSS

(

)

const

Status of the ability to save CSS stylesheets.

Returns

IlTrue if the manager can save CSS or IlFalse if it cannot.

isSavingLayers()

IlBoolean IlvManagerOutputFile::isSavingLayers

(

)

const

Status of the ability to save layers.

Returns

IlTrue if the manager can save layers or IlFalse if it cannot.

isSavingViews()

IlBoolean IlvManagerOutputFile::isSavingViews

(

)

const

Status of the ability to save views.

Returns

IlTrue if the manager can save views or IlFalse if it cannot.

saveAll()

virtual void IlvManagerOutputFile::saveAll ( const IlvManager *  manager, IlUInt  count = 0, IlvGraphic *const *  objects = 0  )

virtual

Writes an object description file.

Writes a complete Views object description file with the full description of the count objects found in the objects array.

Parameters

manager	The IlvManager instance holding the graphic objects.
count	The number of elements in the array objects.
objects	The array of graphic objects.

saveCSS()

void IlvManagerOutputFile::saveCSS

(

IlBoolean

s

)

Turns on or off the ability to save CSS stylesheets.

Parameters

s	If IlTrue, the manager saves CSS. Otherwise, it does not.

saveCSSAsApplicationStyle()

void IlvManagerOutputFile::saveCSSAsApplicationStyle

(

IlBoolean

s

)

Turns on or off the ability for this manager to save CSS for each view object separately.

Parameters

s	If IlTrue, the manager will only write "Application" CSS entry. It will skip view objects Otherwise, it writes all views.

saveLayers()

void IlvManagerOutputFile::saveLayers

(

IlBoolean

s

)

Turns on or off the ability to save layers.

Parameters

s	If IlTrue, the manager saves layers. Otherwise, it does not.

saveViews()

void IlvManagerOutputFile::saveViews

(

IlBoolean

s

)

Turns on or off the ability to save views.

Parameters

s	If IlTrue, the manager saves the views. Otherwise, it does not.

typeOf()

virtual const char* IlvManagerOutputFile::typeOf ( ) const

virtual

Returns the name of the class.

Returns

A pointer to the string "\c IlvManagerOutput".

Reimplemented in IlvGadgetManagerOutputFile.

writeObject()

virtual void IlvManagerOutputFile::writeObject ( const IlvGraphic *  object )

virtual

Save a graphic object.

Writes the exact description of a graphic object in the output stream. It overloads the member function of the IlvOutputFile class to add manager-specific information for this object, such as layer information.
Do not directly call this member function. The saving mechanism is internally performed by saveAll().

Parameters

object

The graphic object.

Reimplemented from IlvOutputFile.

Reimplemented in IlvGadgetManagerOutputFile.