CAM_DataObject Class Reference

#include <CAM_DataObject.h>

Inheritance diagram for CAM_DataObject:

Inheritance graph

Public Types

enum  CheckType { None, RadioButton, CheckBox }
enum  ColorRole {
  Text, Base, Foreground, Background,
  Highlight, HighlightedText
}

Public Member Functions

 CAM_DataObject (SUIT_DataObject *=0)
virtual ~CAM_DataObject ()
CAM_Modulemodule () const
virtual CAM_DataModeldataModel () const
SUIT_DataObjectroot () const
SUIT_DataObjectlastChild () const
SUIT_DataObjectfirstChild () const
int childCount () const
int childPos (const SUIT_DataObject *) const
SUIT_DataObjectchildObject (const int) const
int level () const
SUIT_DataObjectnextBrother () const
SUIT_DataObjectprevBrother () const
bool autoDeleteChildren () const
virtual void setAutoDeleteChildren (const bool)
virtual void children (DataObjectList &, const bool=false) const
virtual DataObjectList children (const bool=false)
void appendChild (SUIT_DataObject *)
virtual void removeChild (SUIT_DataObject *)
virtual void insertChild (SUIT_DataObject *, int thePosition)
bool replaceChild (SUIT_DataObject *, SUIT_DataObject *, const bool=false)
void reparentChildren (const SUIT_DataObject *)
virtual QString text (const int) const
virtual QColor color (const ColorRole) const
virtual QString name () const
virtual QPixmap icon () const
virtual QString toolTip () const
virtual SUIT_DataObjectparent () const
virtual void setParent (SUIT_DataObject *)
virtual bool isDragable () const
virtual bool isDropAccepted (SUIT_DataObject *obj)
virtual CheckType checkType () const
virtual bool isOn () const
virtual void setOn (const bool)
virtual bool isOpen () const
virtual void setOpen (const bool)
virtual SUIT_DataObjectKeykey () const
bool connect (QObject *, const char *)
bool disconnect (QObject *, const char *)
void deleteLater ()
void dump (const int indent=2) const

Friends

class SUIT_DataObject::Signal

Detailed Description

Provides only additional link to CAM_DataModel


Member Enumeration Documentation

enum SUIT_DataObject::CheckType [inherited]
 

Enumerator:
None 
RadioButton 
CheckBox 

enum SUIT_DataObject::ColorRole [inherited]
 

Enumerator:
Text 
Base 
Foreground 
Background 
Highlight 
HighlightedText 


Constructor & Destructor Documentation

CAM_DataObject::CAM_DataObject SUIT_DataObject parent = 0  ) 
 

Constructor. Sets parent object.

CAM_DataObject::~CAM_DataObject  )  [virtual]
 

Destructor.Do nothing


Member Function Documentation

CAM_Module * CAM_DataObject::module  )  const
 

Get module.

Return values:
const CAM_Module pointer - module

CAM_DataModel * CAM_DataObject::dataModel  )  const [virtual]
 

Get data model. Return 0 - if no parent obbject.

Return values:
const CAM_DataModel pointer - data model

Reimplemented in CAM_RootObject.

SUIT_DataObject * SUIT_DataObject::root  )  const [inherited]
 

Returns the root object.

SUIT_DataObject * SUIT_DataObject::lastChild  )  const [inherited]
 

Returns the last child object.

SUIT_DataObject * SUIT_DataObject::firstChild  )  const [inherited]
 

Returns the first child object.

int SUIT_DataObject::childCount  )  const [inherited]
 

Returns the number of the child objects.

int SUIT_DataObject::childPos const SUIT_DataObject obj  )  const [inherited]
 

Returns the index of the specified object in the child list or -1.

SUIT_DataObject * SUIT_DataObject::childObject const   int  )  const [inherited]
 

Returns the child object with specified index.

int SUIT_DataObject::level  )  const [inherited]
 

Returns the level of the object in the data tree. 0 means that object is top-level.

SUIT_DataObject * SUIT_DataObject::nextBrother  )  const [inherited]
 

Returns the next data object in the child list of the parent.

SUIT_DataObject * SUIT_DataObject::prevBrother  )  const [inherited]
 

Returns the previous data object in the child list of the parent.

bool SUIT_DataObject::autoDeleteChildren  )  const [inherited]
 

Returns 'true' if the object will delete children during destroying

void SUIT_DataObject::setAutoDeleteChildren const   bool  )  [virtual, inherited]
 

Specify should the object delete children during destroying

void SUIT_DataObject::children DataObjectList lst,
const   bool = false
const [virtual, inherited]
 

Returns the list of the child objects. if 'rec' is 'true' then function get all sub children.

DataObjectList SUIT_DataObject::children const   bool = false  )  [virtual, inherited]
 

Returns the list of the child objects. if 'rec' is 'true' then function get all sub children.

void SUIT_DataObject::appendChild SUIT_DataObject theObj  )  [inherited]
 

Append new child object to the end of the children list

void SUIT_DataObject::removeChild SUIT_DataObject theObj  )  [virtual, inherited]
 

Removes the specified child object reference.

void SUIT_DataObject::insertChild SUIT_DataObject theObj,
int  thePosition
[virtual, inherited]
 

Insert new child object to the children list at specified position

Reimplemented in LightApp_ModuleObject.

bool SUIT_DataObject::replaceChild SUIT_DataObject src,
SUIT_DataObject trg,
const   bool = false
[inherited]
 

Replaces the specified child object by another object.

void SUIT_DataObject::reparentChildren const SUIT_DataObject obj  )  [inherited]
 

Transfer the all children from specified object 'obj' to self.

QString SUIT_DataObject::text const   int  )  const [virtual, inherited]
 

Returns object text

Reimplemented in SalomeApp_DataObject.

QColor SUIT_DataObject::color const   ColorRole  )  const [virtual, inherited]
 

Returns object color

QString SUIT_DataObject::name  )  const [virtual, inherited]
 

Returns object name

Reimplemented in CAM_RootObject, LightApp_ModuleObject, SalomeApp_DataObject, SalomeApp_ModuleObject, SalomeApp_SavePointObject, and SalomeApp_SavePointRootObject.

QPixmap SUIT_DataObject::icon  )  const [virtual, inherited]
 

Returns object icon

Reimplemented in SalomeApp_DataObject, and SalomeApp_SavePointObject.

QString SUIT_DataObject::toolTip  )  const [virtual, inherited]
 

Returns object tool tip

Reimplemented in SalomeApp_DataObject, SalomeApp_SavePointObject, and SalomeApp_SavePointRootObject.

SUIT_DataObject * SUIT_DataObject::parent  )  const [virtual, inherited]
 

Returns the parent object.

void SUIT_DataObject::setParent SUIT_DataObject theParent  )  [virtual, inherited]
 

Set the parent object. Remove itself from current parent children and append itself to the new parent children list.

bool SUIT_DataObject::isDragable  )  const [virtual, inherited]
 

Returns 'true' if it is possible to drag this object

bool SUIT_DataObject::isDropAccepted SUIT_DataObject obj  )  [virtual, inherited]
 

Returns 'true' if it is possible to drop an object "obj" to this object.

SUIT_DataObject::CheckType SUIT_DataObject::checkType  )  const [virtual, inherited]
 

Returns type of check possibility.

bool SUIT_DataObject::isOn  )  const [virtual, inherited]
 

Returns the checked state of the object.

void SUIT_DataObject::setOn const   bool  )  [virtual, inherited]
 

Sets the checked state of the object.

bool SUIT_DataObject::isOpen  )  const [virtual, inherited]
 

Returns:
the opened state of the object (used in Object Browser).

void SUIT_DataObject::setOpen const   bool  )  [virtual, inherited]
 

Sets the opened state of the object (used in Object Browser).

SUIT_DataObjectKey * SUIT_DataObject::key  )  const [virtual, inherited]
 

Returns object personal indentification key.

Reimplemented in LightApp_DataObject.

bool SUIT_DataObject::connect QObject reciever,
const char *  slot
[inherited]
 

Connect to signal destroyed( SUIT_DataObject* ).

bool SUIT_DataObject::disconnect QObject reciever,
const char *  slot
[inherited]
 

Disconnect from signal destroyed( SUIT_DataObject* ).

void SUIT_DataObject::deleteLater  )  [inherited]
 

Returns object name

void SUIT_DataObject::dump const int  indent = 2  )  const [inherited]
 

Dump this data object and its children to cout


Friends And Related Function Documentation

friend class SUIT_DataObject::Signal [friend, inherited]