Rogue Wave Views
Studio Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions | Protected Member Functions
IlvStContainerInfo Class Referenceabstract

Description class. More...

#include <ivstudio/continfo.h>

Inheritance diagram for IlvStContainerInfo:
IlvStNamedObject

Public Member Functions

virtual IlvContainercreateContainer (IlvAbstractView *parent, const IlvRect &bbox, IlBoolean useacc, IlBoolean visible)=0
 Creates a container that is a child. More...
 
virtual IlvContainercreateContainer (IlvDisplay *display, const char *name, const char *title, const IlvRect &bbox, IlUInt properties, IlBoolean useacc, IlBoolean visible, IlvSystemView transientFor)=0
 Creates a container that is a top window. More...
 
virtual const char * getFileCreatorClass () const =0
 Returns the class name of the container. More...
 
- Public Member Functions inherited from IlvStNamedObject
const char * getName () const
 Returns the name of the object. More...
 
virtual void setName (const char *name)
 Sets the name of the object. More...
 

Protected Member Functions

 IlvStContainerInfo (const char *name)
 Initializes an instance of IlvStContainerInfo. More...
 

Detailed Description

Description class.

Library: ivstudio

A buffer is a document that is edited in Rogue Wave Views Studio. It uses an IlvManager to display, edit, save and read its contents. If you need to subclass the manager to save more information concerning your objects, for example, you have to subclass a corresponding buffer. The IlvStBuffer class is defined to encapsulate the IlvManager.

See also
IlvStudio, IlvStBuffers.

Constructor & Destructor Documentation

IlvStContainerInfo::IlvStContainerInfo ( const char *  name)
protected

Initializes an instance of IlvStContainerInfo.

Parameters
nameThe C++ class name of the container.

Member Function Documentation

virtual IlvContainer* IlvStContainerInfo::createContainer ( IlvAbstractView parent,
const IlvRect bbox,
IlBoolean  useacc,
IlBoolean  visible 
)
pure virtual

Creates a container that is a child.

Must be defined by the subclasses to create a container that is a child of the specified parent.

Parameters
parentThe parent of the container.
bboxThe bounding box of the container.
useaccThis optional Boolean parameter must be set to IlFalse if you do not want the default accelerators to be installed at creation time.
visibleSpecifies whether the view is to be initially visible IlTrue or invisible IlFalse.
Returns
The created container.
virtual IlvContainer* IlvStContainerInfo::createContainer ( IlvDisplay display,
const char *  name,
const char *  title,
const IlvRect bbox,
IlUInt  properties,
IlBoolean  useacc,
IlBoolean  visible,
IlvSystemView  transientFor 
)
pure virtual

Creates a container that is a top window.

This method must be defined by the subclasses to create a container that is a top window.

Parameters
displayThe display instance.
nameThe name of the view.
titleThe title of this top window.
bboxThe initial location and size of the view, relative to the root window of display.
propertiesThe properties of the view.
useaccThis optional Boolean parameter must be set to IlFalse if you do not want the default accelerators to be installed at creation time.
visibleA Boolean value specifying whether the view is to be initially visible IlTrue or invisible IlFalse.
transientForThe possible system view for which this view is transient. If unspecified or set to 0, this view will not be transient for any view.
Returns
The created container.
virtual const char* IlvStContainerInfo::getFileCreatorClass ( ) const
pure virtual

Returns the class name of the container.

Must be defined by the subclasses to return the class name of the IlvOutputFile that is expected by the container created by the IlvStContainerInfo. For example, an IlvGadgetContainer expects to read the data files generated by an IlvGadgetManager. An IlvGadgetManager uses an IlvGadgetManagerOutputFile to generate its data files. Therefore the method getFileCreatorClass() of the container information class that creates instances of IlvGadgetContainer must return "IlvGadgetManagerOutputFile".

Returns
The class name.

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