rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Manager Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Member Functions
IlvManagerOutputFile Class Reference

Input/output class. More...

#include <ilviews/manager/io.h>

Inheritance diagram for IlvManagerOutputFile:
IlvOutputFile IlvGadgetManagerOutputFile

Public Member Functions

 IlvManagerOutputFile (ILVSTDPREF ostream &stream, const IlvManager *mgr=0)
 Constructor. More...
 
const IlvManagergetManager () const
 Returns a pointer to the manager saving the objects. 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 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.

Constructor & Destructor Documentation

IlvManagerOutputFile::IlvManagerOutputFile ( ILVSTDPREF ostream &  stream,
const IlvManager mgr = 0 
)

Constructor.

The constructor is the same as for the IlvOutputFile class.

Parameters
streamA valid output stream in which you are ready to write.

Member Function Documentation

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.
IlBoolean IlvManagerOutputFile::isSavingLayers ( ) const

Status of the ability to save layers.

Returns
IlTrue if the manager can save layers or IlFalse if it cannot.
IlBoolean IlvManagerOutputFile::isSavingViews ( ) const

Status of the ability to save views.

Returns
IlTrue if the manager can save views or IlFalse if it cannot.
virtual void IlvManagerOutputFile::saveAll ( const IlvManager manager,
IlUInt  count = 0,
IlvGraphic *const *  objects = 0 
)
virtual

Writes an object description file.

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

Parameters
managerThe IlvManager instance holding the graphic objects.
countThe number of elements in the array objects.
objectsThe array of graphic objects.
void IlvManagerOutputFile::saveLayers ( IlBoolean  s)

Turns on or off the ability to save layers.

Parameters
sIf IlTrue, the manager saves layers. Otherwise, it does not.
void IlvManagerOutputFile::saveViews ( IlBoolean  s)

Turns on or off the ability to save views.

Parameters
sIf IlTrue, the manager saves the views. Otherwise, it does not.
virtual const char* IlvManagerOutputFile::typeOf ( ) const
virtual

Returns the name of the class.

Returns
A pointer to the string "<code>IlvManagerOutput</code>".

Reimplemented in IlvGadgetManagerOutputFile.

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
objectThe graphic object.

Reimplemented from IlvOutputFile.

Reimplemented in IlvGadgetManagerOutputFile.


© Copyright 2012, 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.