IlvManagerInputFile Class Reference

Input/output class. More...

#include <ilviews/manager/io.h>

Inheritance diagram for IlvManagerInputFile:

Public Member Functions
	IlvManagerInputFile (std::istream &stream, IlvManager *manager=0)
	Constructor. More...
IlvManager *	getManager () const
	Returns a pointer to the manager reading the objects. More...
virtual void	readAll (IlvManager *manager)
	Reads an object description file. More...
virtual void	readCssFile (IlUInt currentNViews, IlvView **currentViews)
	Reads css styling information and applies it to stylists. More...
virtual void	readLayer (int layer)
	Reads the properties of a layer. More...
virtual IlvGraphic *	readObject ()
	Reads a graphic object. More...
virtual void	readView (IlUInt currentNViews, IlvView **currentViews)
	Reads transformer information for a view. More...
const char *	typeOf () const override
	Returns the name of this class. More...

Detailed Description

Input/output class.

Library: ilvmgr

Manager objects and their properties can be read from particular streams. To make it easy to restore a set of IlvGraphic objects, Rogue Wave Views defines the IlvManagerInputFile class. This class is a subtype of IlvInputFile. It adds only manager-specific information to the object description blocks. To read a full Rogue Wave Views file in a given manager, call the member function readAll().

See also

IlvGraphic, IlvManager, IlvManagerOutputFile.

Constructor & Destructor Documentation

IlvManagerInputFile()

IlvManagerInputFile::IlvManagerInputFile	(	std::istream &	stream,
		IlvManager *	manager = 0
	)

Constructor.

The constructor is the same as for the IlvInputFile class. stream must be a valid input stream from which you are able to read information.

Parameters

stream	The input stream to read from.
manager	The manager.

Member Function Documentation

getManager()

IlvManager* IlvManagerInputFile::getManager

(

)

const

Returns a pointer to the manager reading the objects.

Returns

A pointer to the manager object in which a file is now being read. This value is updated by the member function readAll().

readAll()

virtual void IlvManagerInputFile::readAll ( IlvManager *  manager )

virtual

Reads an object description file.

Reads a Views object description file and stores the created objects in the manager parameter. It calls the member function readObjects() and reads specific object properties, such as object names. Read success status must be checked in the manager's holder. The file is properly loaded if manager->getHolder()->getError() == 0.

Parameters

manager

Pointer to the manager in which the graphic objects must be stored.

Reimplemented in IlvGadgetManagerInputFile.

readCssFile()

virtual void IlvManagerInputFile::readCssFile ( IlUInt  currentNViews, IlvView **  currentViews  )

virtual

Reads css styling information and applies it to stylists.

Parameters

currentNViews	The number of views in the array.
currentViews	The array of current views.

readLayer()

virtual void IlvManagerInputFile::readLayer ( int  layer )

virtual

Reads the properties of a layer.

Parameters

layer

The index of the layer.

readObject()

virtual IlvGraphic* IlvManagerInputFile::readObject ( )

virtual

Reads a graphic object.

Overloads the member function of IlvInputFile to add specific layer information in the description block of each object. Is called internally by readAll() and should never be called directly by the programmer.

Returns

A pointer to the graphic object read.

Reimplemented from IlvInputFile.

Reimplemented in IlvGadgetManagerInputFile.

readView()

virtual void IlvManagerInputFile::readView ( IlUInt  currentNViews, IlvView **  currentViews  )

virtual

Reads transformer information for a view.

Reads specific information for one view (name and transformer). If a view with the same name is found in the array of current views, the transformer is set on this view.

Parameters

currentNViews	The number of views in the array.
currentViews	The array of current views.

typeOf()

const char* IlvManagerInputFile::typeOf ( ) const

overridevirtual

Returns the name of this class.

Returns

A pointer to the string "IlvManagerInput".

Reimplemented from IlvInputFile.