Rogue Wave Views
Manager Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions
IlvManagerInputFile Class Reference

Input/output class. More...

#include <ilviews/manager/io.h>

Inheritance diagram for IlvManagerInputFile:
IlvInputFile IlvGadgetManagerInputFile

Public Member Functions

 IlvManagerInputFile (std::istream &stream, IlvManager *manager=0)
 Constructor. More...
 
IlvManagergetManager () const
 Returns a pointer to the manager reading the objects. More...
 
virtual void readAll (IlvManager *manager)
 Reads an object description file. More...
 
virtual void readLayer (int layer)
 Reads the properties of a layer. More...
 
virtual IlvGraphicreadObject ()
 Reads a graphic object. More...
 
virtual void readView (IlUInt currentNViews, IlvView **currentViews)
 Reads transformer information for a view. More...
 
virtual const char * typeOf () const
 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
streamThe input stream to read from.
managerThe 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 Rogue Wave 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.

Parameters
managerPointer to the manager in which the graphic objects must be stored.

Reimplemented in IlvGadgetManagerInputFile.

§ readLayer()

virtual void IlvManagerInputFile::readLayer ( int  layer)
virtual

Reads the properties of a layer.

Parameters
layerThe 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
currentNViewsThe number of views in the array.
currentViewsThe array of current views.

§ typeOf()

virtual const char* IlvManagerInputFile::typeOf ( ) const
virtual

Returns the name of this class.

Returns
A pointer to the string "IlvManagerInput".

Reimplemented from IlvInputFile.

Reimplemented in IlvGadgetManagerInputFile.


© Copyright 2017, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.