SUIT_DataObject Class Reference

#include <SUIT_DataObject.h>

Inheritance diagram for SUIT_DataObject:


Public Types
enum	CheckType { None, RadioButton, CheckBox }
enum	ColorRole { Text, Base, Foreground, Background, Highlight, HighlightedText }
Public Member Functions
	SUIT_DataObject (SUIT_DataObject *=0)
virtual	~SUIT_DataObject ()
SUIT_DataObject *	root () const
SUIT_DataObject *	lastChild () const
SUIT_DataObject *	firstChild () const
int	childCount () const
int	childPos (const SUIT_DataObject *) const
SUIT_DataObject *	childObject (const int) const
int	level () const
SUIT_DataObject *	nextBrother () const
SUIT_DataObject *	prevBrother () 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_DataObject *	parent () 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_DataObjectKey *	key () const
bool	connect (QObject , const char )
bool	disconnect (QObject , const char )
void	deleteLater ()
void	dump (const int indent=2) const
Private Attributes
bool	myOpen
bool	myCheck
Signal *	mySignal
SUIT_DataObject *	myParent
DataObjectList	myChildren
Friends
class	SUIT_DataObject::Signal
class	SUIT_DataObjectIterator
Data Structures
class	Signal

Detailed Description

Data Object represents uniform data tree structure recommended to use in SUIT-based applications Many of standard classes (DataModel,ObjectBrowser) deal with SUIT_DataObjects

Member Enumeration Documentation

enum SUIT_DataObject::CheckType

Enumerator:

None

RadioButton

CheckBox

enum SUIT_DataObject::ColorRole

Enumerator:

Text

Base

Foreground

Background

Highlight

HighlightedText

Constructor & Destructor Documentation

SUIT_DataObject::SUIT_DataObject ( SUIT_DataObject * p = 0 )

Constructor

SUIT_DataObject::~SUIT_DataObject ( ) [virtual]

Destructor

Member Function Documentation

SUIT_DataObject * SUIT_DataObject::root ( ) const

Returns the root object.

SUIT_DataObject * SUIT_DataObject::lastChild ( ) const

Returns the last child object.

SUIT_DataObject * SUIT_DataObject::firstChild ( ) const

Returns the first child object.

int SUIT_DataObject::childCount ( ) const

Returns the number of the child objects.

int SUIT_DataObject::childPos ( const SUIT_DataObject * obj ) const

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

SUIT_DataObject * SUIT_DataObject::childObject ( const int ) const

Returns the child object with specified index.

int SUIT_DataObject::level ( ) const

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

SUIT_DataObject * SUIT_DataObject::nextBrother ( ) const

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

SUIT_DataObject * SUIT_DataObject::prevBrother ( ) const

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

bool SUIT_DataObject::autoDeleteChildren ( ) const

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

void SUIT_DataObject::setAutoDeleteChildren ( const bool ) [virtual]

Specify should the object delete children during destroying

void SUIT_DataObject::children ( DataObjectList & lst,

const bool = false

) const [virtual]

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]

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

void SUIT_DataObject::appendChild ( SUIT_DataObject * theObj )

Append new child object to the end of the children list

void SUIT_DataObject::removeChild ( SUIT_DataObject * theObj ) [virtual]

Removes the specified child object reference.

void SUIT_DataObject::insertChild ( SUIT_DataObject * theObj,

int thePosition

) [virtual]

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

)

Replaces the specified child object by another object.

void SUIT_DataObject::reparentChildren ( const SUIT_DataObject * obj )

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

QString SUIT_DataObject::text ( const int ) const [virtual]

Returns object text
Reimplemented in SalomeApp_DataObject.

QColor SUIT_DataObject::color ( const ColorRole ) const [virtual]

Returns object color

QString SUIT_DataObject::name ( ) const [virtual]

Returns object name
Reimplemented in CAM_RootObject, LightApp_ModuleObject, SalomeApp_DataObject, SalomeApp_ModuleObject, SalomeApp_SavePointObject, and SalomeApp_SavePointRootObject.

QPixmap SUIT_DataObject::icon ( ) const [virtual]

Returns object icon
Reimplemented in SalomeApp_DataObject, and SalomeApp_SavePointObject.

QString SUIT_DataObject::toolTip ( ) const [virtual]

Returns object tool tip
Reimplemented in SalomeApp_DataObject, SalomeApp_SavePointObject, and SalomeApp_SavePointRootObject.

SUIT_DataObject * SUIT_DataObject::parent ( ) const [virtual]

Returns the parent object.

void SUIT_DataObject::setParent ( SUIT_DataObject * theParent ) [virtual]

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]

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

bool SUIT_DataObject::isDropAccepted ( SUIT_DataObject * obj ) [virtual]

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

SUIT_DataObject::CheckType SUIT_DataObject::checkType ( ) const [virtual]

Returns type of check possibility.

bool SUIT_DataObject::isOn ( ) const [virtual]

Returns the checked state of the object.

void SUIT_DataObject::setOn ( const bool ) [virtual]

Sets the checked state of the object.

bool SUIT_DataObject::isOpen ( ) const [virtual]

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

void SUIT_DataObject::setOpen ( const bool ) [virtual]

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

SUIT_DataObjectKey * SUIT_DataObject::key ( ) const [virtual]

Returns object personal indentification key.
Reimplemented in LightApp_DataObject.

bool SUIT_DataObject::connect ( QObject * reciever,

const char * slot

)

Connect to signal destroyed( SUIT_DataObject* ).

bool SUIT_DataObject::disconnect ( QObject * reciever,

const char * slot

)

Disconnect from signal destroyed( SUIT_DataObject* ).

void SUIT_DataObject::deleteLater ( )

Returns object name

void SUIT_DataObject::dump ( const int indent = 2 ) const

Dump this data object and its children to cout

Friends And Related Function Documentation

friend class SUIT_DataObject::Signal [friend]

friend class SUIT_DataObjectIterator [friend]

Field Documentation

bool SUIT_DataObject.myOpen [private]

bool SUIT_DataObject.myCheck [private]

Signal* SUIT_DataObject.mySignal [private]

SUIT_DataObject* SUIT_DataObject.myParent [private]

DataObjectList SUIT_DataObject.myChildren [private]

SUIT_DataObject Class Reference

Public Types

Public Member Functions

Private Attributes