rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Studio Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvStContainerInfo Class Reference

Description class. More...

#include <ivstudio/continfo.h>

Inheritance diagram for IlvStContainerInfo:
IlvStNamedObject

List of all members.

Public Member Functions

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.
virtual IlvContainercreateContainer (IlvAbstractView *parent, const IlvRect &bbox, IlBoolean useacc, IlBoolean visible)=0
 Creates a container that is a child.
virtual const char * getFileCreatorClass () const =0
 Returns the class name of the container.

Protected Member Functions

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

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:
name The C++ class name of the container.

Member Function Documentation

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.

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

Parameters:
display The display instance.
name The name of the view.
title The title of this top window.
bbox The initial location and size of the view, relative to the root window of display.
properties The properties of the view.
useacc This optional Boolean parameter must be set to IlFalse if you do not want the default accelerators to be installed at creation time.
visible A Boolean value specifying whether the view is to be initially visible IlTrue or invisible IlFalse.
transientFor The 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 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:
parent The parent of the container.
bbox The bounding box of the container.
useacc This optional Boolean parameter must be set to IlFalse if you do not want the default accelerators to be installed at creation time.
visible A Boolean value specifying whether the view is to be initially visible IlTrue or invisible IlFalse.
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.

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

© 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.