IDLgrViewgroup

The IDLgrViewgroup object is a simple container object, very similar to the IDLgrScene object. It contains one or more IDLgrView objects and an IDLgrScene can contain one or more of these objects. This object is special in that it can also contain objects which do not have a Draw method (e.g. IDLgrPattern and IDLgrFont). An IDLgrViewgroup object cannot be returned by a call to the IDLgrWindow::Select method.

Superclasses

This class is a subclass of IDL_Container

Subclasses

This class has no subclasses.

Creation

See IDLgrViewgroup::Init

Methods

Intrinsic Methods

This class has the following methods:

Inherited Methods

This class inherits the following methods:

IDLgrViewgroup::Add

The IDLgrViewgroup:: Add function method verifies that the added item is not an instance of the IDLgrScene or IDLgrViewgroup object. If it is not, IDLgrViewgroup:Add adds the object to the specified viewgroup. IDLgrViewgroup is described above.

Calling Sequence

Obj -> [IDLgrViewgroup::] Add, Object

Arguments

Object

An instance of an object or a list of objects. Objects which subclass IDLgrScene or IDLgrViewGroup can not be added (avoiding circularity constraints). All other objects are allowed.

Keywords

POSITION

Set this keyword equal to the zero-based index of the position within the container at which the new object should be placed.

IDLgrViewgroup::Cleanup

The IDLgrViewgroup:: Cleanup procedure method performs all cleanup on the object. IDLgrViewgroup is described above.

NOTE: Cleanup methods are special lifecycle methods , and as such cannot be called outside the context of object destruction. This means that in most cases, you cannot call the Cleanup method directly. There is one exception to this rule: If you write your own subclass of this class, you can call the Cleanup method from within the Cleanup method of the subclass.

Calling Sequence

OBJ_DESTROY, Obj

Obj -> [IDLgrViewgroup::] Cleanup ( Only in subclass' Cleanup method .)

Arguments

There are no arguments for this method.

Keywords

There are no keywords for this method.

IDLgrViewgroup::GetByName

The IDLgrViewgroup:: GetByName function method finds contained objects by name. If the named object is not found, the GetByName function returns a null object reference.

NOTE: The GetByName function does not perform a recursive search through the object hierarchy. If a fully qualified object name is not specified, only the contents of the current container object are inspected for the named object.

IDLgrViewgroup is described above.

Calling Sequence

Result = Obj -> [IDLgrViewgroup::] GetByName( Name )

Arguments

Name

A string containing the name of the object to be returned.

Object naming syntax is very much like the syntax of a Unix filesystem. Objects contained by other objects can include the name of their parent object; this allows you to create a fully qualified name specification. For example, if object1 contains object2 , which in turn contains object3 , the string specifying the fully qualified object name of object3 would be 'object1/object2/object3' .

Object names are specified relative to the object on which the GetByName method is called. If used at the beginning of the name string, the / character represents the top of an object hierarchy. The string '..' represents the object one level "up" in the hierarchy.

Keywords

There are no keywords for this method.

IDLgrViewgroup::GetProperty

The IDLgrViewgroup:: GetProperty procedure method retrieves the value of a property or group of properties for the viewgroup object. IDLgrViewgroup is described above.

Calling Sequence

Obj -> [IDLgrViewgroup::] GetProperty

Arguments

There are no arguments for this method.

Keywords

Any keyword to IDLgrViewgroup::Init

ALL

Set this keyword to a named variable that will contain an anonymous structure containing the values of all of the retrievable properties associated with this object.

PARENT

Set this keyword to a named variable that will contain an object reference to the object that contains this viewgroup.

IDLgrViewgroup::Init

The IDLgrViewgroup:: Init function method initializes the viewgroup object. IDLgrViewgroup is described above.

NOTE: Init methods are special lifecycle methods , and as such cannot be called outside the context of object creation. This means that in most cases, you cannot call the Init method directly. There is one exception to this rule: If you write your own subclass of this class, you can call the Init method from within the Init method of the subclass.

Calling Sequence

Obj = OBJ_NEW('IDLgrViewgroup')

Result = Obj -> [IDLgrViewgroup::] Init() ( In a subclass' Init method only .)

Arguments

There are no arguments for this method.

Keywords

Properties retrievable via IDLgrViewgroup::GetProperty

HIDE (Get, Set)

Set this keyword to a boolean value to indicate whether this object should be drawn:

0 = Draw graphic (the default)
1 = Do not draw graphic

NAME (Get, Set)

Set this keyword to a string representing the name to be associated with this object. The default is the null string, ''.

UVALUE (Get, Set)

Set this keyword to a value of any type. You may use this value to contain any information you wish.

IDLgrViewgroup::Remove

The IDLgrViewgroup:: Remove procedure method removes an object from the viewgroup. IDLgrViewgroup is described above.

Calling Sequence

Obj -> [IDLgrViewgroup::] Remove, Object

Arguments

Object

An instance of the object to be removed from the viewgroup.

Keywords

ALL

Set this keyword to remove all object from the container. If this keyword is set, the Object argument is not required.

POSITION

Set this keyword equal to the zero-based index of the object to be removed. If the Object argument is supplied, this keyword is ignored.

IDLgrViewgroup::SetProperty

The IDLgrViewgroup:: SetProperty procedure method sets the value of a property or group of properties for the viewgroup. IDLgrViewgroup is described above.

Calling Sequence

Obj -> [IDLgrViewgroup::] SetProperty

Arguments

There are no arguments for this method.

Keywords

Any keyword to IDLgrViewgroup::Init