Rogue Wave Views Prototypes Package API Reference Guide |
Rogue Wave Views Documentation Home |
Abstract base class for containers and managers holding IlvGroup
s.
More...
#include <ilviews/protos/groupholder.h>
Public Member Functions | |
virtual void | addGroup (IlvGroup *group, IlBoolean unique=IlTrue) |
Adds an IlvGroup to the container or manager attached to the group holder. More... | |
virtual IlUInt | checkUniqueName (const char *name) const |
Checks that a given name is unique within an IlvGraphicHolder and returns the value used to provide the unique name if needed. More... | |
virtual IlvGroup * | getGroup (const char *name) const |
Returns the group with the name name. More... | |
virtual IlvGroup ** | getGroups (IlUInt &count) const |
Returns all the groups contained in the holder. More... | |
virtual void | removeGroup (IlvGroup *group, IlBoolean destroy=IlFalse) |
Removes an IlvGroup from the container or manager attached to the group holder. More... | |
Static Public Member Functions | |
static IlvGroupHolder * | Get (IlvContainer *ctn) |
See below. | |
static IlvGroupHolder * | Get (IlvManager *mgr) |
See below. | |
static IlvGroupHolder * | Get (IlvGraphicHolder *holder) |
Returns the group holder associated with the IlvGraphicHolder . More... | |
Abstract base class for containers and managers holding IlvGroup
s.
Library: ilvproto
This class lets you handle sets of IlvGroup
objects in a container or manager. Classes of name IlvProto*[Container|Manager|Grapher]
implement the same interface through specialized subclasses of IlvProtoHolderInterface
.
Adds an IlvGroup
to the container or manager attached to the group holder.
group | IlvGroup to be added. If the manager or container does not handle group objects directly, the group will be encapsulated in an IlvProtoGraphic object. If the name of the group already exists, it will assign the group a unique name. |
unique | If set to IlTrue , the name of the group may be modified to ensure that the object name is unique. |
|
virtual |
Checks that a given name is unique within an IlvGraphicHolder
and returns the value used to provide the unique name if needed.
name | Name to be checked for uniqueness. |
0
if the name is unique. Otherwise, it returns an integer that, concatenated to the given name, will ensure the name is unique. For instance, if on input name is "IlvGroup" and there are already objects of name "IlvGroup" and "IlvGroup_1" in the holder, the method will return 2
, indicating that the name "IlvGroup_2" is available to be assigned as a unique name.
|
static |
Returns the group holder associated with the IlvGraphicHolder
.
IlvGraphicHolder
. This holder will be deleted along with its associated container or manager if these are deleted.
|
virtual |
Returns the group with the name name.
name | Name of the group to be retrieved. IlvGroup objects should have a unique name allowing them to be identified within a manager or container. |
0
if none is found. Returns all the groups contained in the holder.
count | On return, this integer is set to the size of the returned array. |
IlvGroup
objects of size count. This array should be deleted with delete[]
when it is no longer needed. © 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.