UIObject Class Reference

Search for all occurrences

#include <xsi_uiobject.h>

---

Class Description

The UIObject is the base class for Softimage UI objects such as UIPersistable and MenuItem. This class has no specific functions.

See also:

UIPersistable, MenuItem

Since:

4.0

Inheritance diagram for UIObject:

List of all members.

Public Member Functions
	UIObject ()
	~UIObject ()
	UIObject (const CRef &in_ref)
	UIObject (const UIObject &in_obj)
bool	IsA (siClassID in_ClassID) const
siClassID	GetClassID () const
UIObject &	operator= (const UIObject &in_obj)
UIObject &	operator= (const CRef &in_ref)

---

Constructor & Destructor Documentation

UIObject

(

)

Default constructor.

~UIObject

(

)

Default destructor.

UIObject

(

const CRef &

in_ref

)

Constructor.

Parameters:

in_ref

constant reference object.

UIObject

(

const UIObject &

in_obj

)

Copy constructor.

Parameters:

in_obj

constant class object.

---

Member Function Documentation

bool IsA

(

siClassID

in_ClassID

)

const [virtual]

Search for all occurrences

Returns true if a given class type is compatible with this API class.

Parameters:

in_ClassID

class type.

Returns:

true if the class is compatible, false otherwise.

Reimplemented from SIObject.

Reimplemented in Layout, MemoCamera, Menu, MenuItem, Schematic, SchematicNode, UIPersistable, and View.

siClassID GetClassID

(

)

const [virtual]

Search for all occurrences

Returns the type of the API class.

Returns:

The class type.

Reimplemented from SIObject.

Reimplemented in Layout, MemoCamera, Menu, MenuItem, Schematic, SchematicNode, UIPersistable, and View.

UIObject& operator=

(

const UIObject &

in_obj

)

Creates an object from another object. The newly created object is set to empty if the input object is not compatible.

Parameters:

in_obj

constant class object.

Returns:

The new UIObject object.

UIObject& operator=

(

const CRef &

in_ref

)

Creates an object from a reference object. The newly created object is set to empty if the input reference object is not compatible.

Parameters:

in_ref

constant class object.

Returns:

The new UIObject object.

Reimplemented from SIObject.

Reimplemented in Layout, MemoCamera, Menu, MenuItem, Schematic, SchematicNode, UIPersistable, and View.

---

The documentation for this class was generated from the following file:

• xsi_uiobject.h