rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Prototypes Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvProtoGraphic Class Reference

Encapsulates an IlvGroup into a regular IlvGraphic. More...

#include <ilviews/protos/protogr.h>

Inheritance diagram for IlvProtoGraphic:
IlvGroupGraphic IlvSimpleGraphic IlvGraphic

List of all members.

Public Member Functions

 IlvProtoGraphic (IlvDisplay *display, const char *protoName, IlvPalette *palette=0)
 Creates a new prototype graphic that encapsulates an instance of a prototype.
 IlvProtoGraphic (IlvDisplay *display, IlvPrototype *proto, IlvPalette *palette=0)
 See below.
 IlvProtoGraphic (IlvDisplay *display, IlvGroup *group, IlBoolean owner=IlTrue)
 Creates a new prototype graphic that encapsulates a group.
IlvProtoInstancegetProtoGraphic ()
 Returns If the group held by this is a prototype instance, then return the instance.

Friends

class IlvProtoGraphicInteractor

Detailed Description

Encapsulates an IlvGroup into a regular IlvGraphic.

Library: ilvproto

IlvProtoGraphic is a subclass of IlvGraphic that encapsulates an IlvGroup. IlvProtoGraphic can be added to any manager or container, like any other Rogue Wave Views graphic object.

The recommended way to use the prototypes and IlvGroup features is to place an IlvGroup into an IlvProtoGraphic and use regular managers.

All calls to the changeValue, queryValue, and getAccessors methods are propagated to the internal group, so that handling an IlvProtoGraphic works exactly the same way as handling an IlvGroup.

Warning:
[code] Although the IlvProtoGraphic class inherits from the IlvGraphic class, the setInteractor function must NOT be used to change the interactor on an IlvProtoGraphic object, because IlvProtoGraphic objects each have their own internal interactor.
[note] An IlvProtoGraphic object cannot manage the focus correctly because it is an IlvGraphic object. Only the classes that inherit from IlvGadget class can manage the focus correctly.
See also:
IlvProtoGraphicInteractor, IlvProtoInstance, IlvPrototype

Constructor & Destructor Documentation

IlvProtoGraphic::IlvProtoGraphic ( IlvDisplay display,
IlvGroup group,
IlBoolean  owner = IlTrue 
)

Creates a new prototype graphic that encapsulates a group.

Parameters:
display Display used to initialize the object.
group Group to be encapsulated.
owner Flag set to IlTrue if the group is deleted when the object is deleted.
IlvProtoGraphic::IlvProtoGraphic ( IlvDisplay display,
const char *  protoName,
IlvPalette palette = 0 
)

Creates a new prototype graphic that encapsulates an instance of a prototype.

The instance encapsulated by the graphic object is created by the IlvProtoGraphic constructor. The prototype instance is always owned by the IlvProtoGraphic, that is, it will be destroyed when the graphic is destroyed.

Parameters:
display Display used to initialize the object.
proto Prototype to be instantiated as the encapsulated group.
protoName Name of the prototype to be instantiated as the encapsulated group.
owner Flag set to IlTrue if the group is deleted when the graphic object is deleted.
palette Unused parameter, left for compatibility reasons.

Member Function Documentation

IlvProtoInstance* IlvProtoGraphic::getProtoGraphic (  ) 

Returns If the group held by this is a prototype instance, then return the instance.

Returns:
If the group held by this is a prototype instance, then return the instance. Otherwise, returns 0.

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