Implementation of the data object for use in CORBA-based SALOME modules.

#include <SalomeApp_DataObject.h>

Inheritance diagram for SalomeApp_DataObject:

Public Types
enum	{ ValueId = RefEntryId + 1, IORId, LastId }
	Column id. More...

Public Types inherited from LightApp_DataObject
enum	{ EntryId = VisibilityId + 1, RefEntryId }
	Column id. More...

Public Member Functions
	SalomeApp_DataObject (SUIT_DataObject *=0)
	Constructor. More...

	SalomeApp_DataObject (const _PTR(SObject)&, SUIT_DataObject *=0)
	Constructor. More...

virtual	~SalomeApp_DataObject ()
	Destructor. More...

virtual QString	name () const
	Get data object name. More...

virtual QString	entry () const
	Get object string identifier. More...

virtual QString	text (const int=NameId) const
	Get object text data for the specified column. More...

virtual QPixmap	icon (const int=NameId) const
	Get data object icon for the specified column. More...

virtual QColor	color (const ColorRole, const int=NameId) const
	Get data object color for the specified column. More...

virtual QString	toolTip (const int=NameId) const
	Get data object tooltip for the specified column. More...

virtual QFont	font (const int=NameId) const
	Get font to be used for data object rendering in the item views. More...

virtual	_PTR (SObject) object() const

virtual QString	refEntry () const
	Returns the string identifier of the data objects referenced by this one. More...

virtual bool	isReference () const
	Check if the data object is a reference. More...

	_PTR (SObject) referencedObject() const

bool	hasChildren () const
	Check if object has children. More...

bool	expandable () const
	Check if the object is expandable (e.g. in the data tree view) More...

virtual bool	isVisible () const
	Check if the object is visible. More...

virtual QString	componentDataType () const
	Get component type. More...

virtual bool	customSorting (const int=NameId) const
	Check if the specified column supports custom sorting. More...

virtual bool	compare (const QVariant &, const QVariant &, const int=NameId) const
	Compares data from two items for sorting purposes. More...

virtual void	insertChildAtTag (SalomeApp_DataObject *, int)

virtual void	updateItem ()

Public Member Functions inherited from LightApp_DataObject
	LightApp_DataObject (SUIT_DataObject *=0)
	Constructor. More...

virtual	~LightApp_DataObject ()
	Destructor. More...

virtual SUIT_DataObjectKey *	key () const
	Get the data object unique key. More...

virtual SUIT_DataObject *	componentObject () const
	Get the component object. More...

virtual int	groupId () const
	return unique group identificator More...

virtual QVariant	customData (Qtx::CustomDataType type)
	return custom data for data object More...

virtual bool	isDraggable () const
	Check if the object is draggable. More...

virtual bool	isDropAccepted () const
	Check if the drop operation fo this object is possible. More...

virtual bool	renameAllowed (const int=NameId) const
	Check if this object is can't be renamed in place. More...

virtual bool	setName (const QString &)
	Set name of the this object. More...

Public Member Functions inherited from CAM_DataObject
	CAM_DataObject (SUIT_DataObject *=0)
	Constructor. More...

virtual	~CAM_DataObject ()
	Destructor. More...

CAM_Module *	module () const
	Get CAM module. More...

virtual CAM_DataModel *	dataModel () const
	Get CAM data model. More...

Public Member Functions inherited from SUIT_DataObject
	SUIT_DataObject (SUIT_DataObject *=0)
	Constructor. More...

virtual	~SUIT_DataObject ()
	Destructor. More...

SUIT_DataObject *	root () const
	Get the root object. More...

SUIT_DataObject *	lastChild () const
	Get the last child object. More...

SUIT_DataObject *	firstChild () const
	Get the first child object. More...

int	childCount () const
	Get the number of the child objects. More...

int	childPos (const SUIT_DataObject *) const
	Get the index of the specified object in the child list. More...

void	moveChildPos (SUIT_DataObject *, int)
	Moves the child position from current to new one. More...

SUIT_DataObject *	childObject (const int) const
	Get child object by the specified index. More...

int	level () const
	Get the object level in the tree structure. More...

int	position () const
	Get the position of the data object in its parent's children list. More...

void	setPosition (int)
	Sets new position of the object in parent's list. More...

SUIT_DataObject *	nextBrother () const
	Get the next sibling data object in the children list. More...

SUIT_DataObject *	prevBrother () const
	Get the previous sibling data object in the children list. More...

bool	autoDeleteChildren () const
	Get "auto-delete children" flag. More...

virtual void	setAutoDeleteChildren (const bool)
	Set "auto-delete children" flag. More...

virtual void	children (DataObjectList &, const bool=false) const
	Get all children. More...

virtual DataObjectList	children (const bool=false)
	Get all children. . More...

void	appendChild (SUIT_DataObject *)
	Add new child object to the end of the children list. More...

virtual void	insertChild (SUIT_DataObject *, int)
	Insert new child object to the list of the children. More...

virtual void	removeChild (SUIT_DataObject *, const bool=false)
	Remove the specified child object reference. More...

bool	replaceChild (SUIT_DataObject , SUIT_DataObject , const bool=false)
	Replace the specified child object by another object. More...

void	reparentChildren (const SUIT_DataObject *)
	Change the parent for all children from specified object to this one. More...

virtual SUIT_DataObject *	parent () const
	Get the parent object. More...

virtual void	setParent (SUIT_DataObject *)
	Change the parent object. More...

virtual void	assignParent (SUIT_DataObject *)

void	insertChildAtPos (SUIT_DataObject *obj, int position)
	Insert new child object into the list of the children (faster version of insertChild without signal). More...

bool	modified ()

virtual void	setModified (bool modified)
	Sets modification state of the object. More...

virtual QString	statusTip (const int=NameId) const
	Get data object status tip for the specified column. More...

virtual QString	whatsThis (const int=NameId) const
	Get data object "what's this" information for the specified column. More...

virtual int	alignment (const int=NameId) const
	Get data object text alignment for the specified column. More...

virtual bool	isEnabled () const
	Check if this object is enabled. More...

virtual bool	isSelectable () const
	Check if this object is selectable. More...

virtual bool	isCheckable (const int=NameId) const
	Check if this object is checkable for the specified column. More...

virtual bool	isOn (const int=NameId) const
	Get the checked state of the object (if it is checkable) for the specified column. More...

virtual void	setOn (const bool, const int=NameId)
	Set the checked state of the object (if it is checkable) for the specified column. More...

virtual bool	isOpen () const
	Get the "opened" state of the object. More...

virtual void	setOpen (const bool)
	Set the "opened" state of the object. More...

virtual void	update ()
	Updates necessary internal fields of data object. More...

void	deleteLater ()
	Schedule this object for the late deleting. More...

void	dump (const int indent=2) const
	Dump the object tree recursively to the standard output. More...

Private Member Functions
QString	ior (const _PTR(SObject)&) const
	Get data object IOR. More...

QString	entry (const _PTR(SObject)&) const
	Get data object entry identifier. More...

QString	value (const _PTR(SObject)&) const
	Get data object value. More...

	_PTR (SObject) myObject

Additional Inherited Members
Static Public Member Functions inherited from SUIT_DataObject
static Signal *	signal ()
	Get global signal handler. More...

static bool	connect (const char , QObject , const char *)
	Connect to the signal handlerx. More...

static bool	disconnect (const char , QObject , const char *)
	Disconnect from the signal handler. More...

Protected Attributes inherited from LightApp_DataObject
QString	myCompDataType

SUIT_DataObject *	myCompObject

Member Enumeration Documentation

anonymous enum

Enumerator
ValueId	value column
IORId	IOR column.
LastId	indicates last Id value

Constructor & Destructor Documentation

SalomeApp_DataObject::SalomeApp_DataObject ( SUIT_DataObject * parent = 0 )

Parameters

parent parent data object

SalomeApp_DataObject::SalomeApp_DataObject	(	const _PTR(SObject)&	sobj,
		SUIT_DataObject *	parent = `0`
	)

Parameters

sobj	SALOMEDS object
parent	parent data object

SalomeApp_DataObject::~SalomeApp_DataObject ( )

virtual

Member Function Documentation

virtual SalomeApp_DataObject::_PTR ( SObject ) const

virtual

SalomeApp_DataObject::_PTR ( SObject ) const

SalomeApp_DataObject::_PTR ( SObject )

private

QColor SalomeApp_DataObject::color	(	const ColorRole	role,
		const int	id = `NameId`
	)		const

virtual

Parameters

role	color role
id	column id (not used)

Returns: object color for the specified column

Reimplemented from LightApp_DataObject.

Reimplemented in SalomeApp_RootObject.

References _PTR(), LightApp_DataObject::color(), SUIT_DataObject::Foreground, GetName(), SUIT_DataObject::Highlight, isReference(), and SUIT_DataObject::Text.

bool SalomeApp_DataObject::compare	(	const QVariant &	left,
		const QVariant &	right,
		const int	id = `NameId`
	)		const

virtual

This method is called only for those columns for which customSorting() method returns true.

Parameters

left	first data to compare
right	second data to compare
id	column id

Returns: result of the comparison

See Also: customSorting()

Reimplemented from LightApp_DataObject.

References LightApp_DataObject::compare(), LightApp_DataObject::EntryId, and LightApp_DataObject::RefEntryId.

QString SalomeApp_DataObject::componentDataType ( ) const

virtual

Returns: component type

Reimplemented from LightApp_DataObject.

References _PTR(), LightApp_DataObject::componentObject(), and LightApp_DataObject::myCompDataType.

bool SalomeApp_DataObject::customSorting ( const int id = NameId ) const

virtual

Parameters

id column id

Returns: true if column sorting should be customized

See Also: compare()

Reimplemented from LightApp_DataObject.

References LightApp_DataObject::customSorting(), LightApp_DataObject::EntryId, and LightApp_DataObject::RefEntryId.

QString SalomeApp_DataObject::entry ( ) const

virtual

Returns: object ID

Reimplemented from LightApp_DataObject.

Reimplemented in SalomeApp_RootObject.

QString SalomeApp_DataObject::entry ( const _PTR(SObject)& obj ) const

private

Parameters

obj	data object

Returns: data object entry identifier or empty object does not have entry

bool SalomeApp_DataObject::expandable ( ) const

virtual

Returns: true if object is expandable and false otherwise

Reimplemented from SUIT_DataObject.

References _PTR().

QFont SalomeApp_DataObject::font ( const int id = NameId ) const

virtual

Parameters

id column id

Returns: font to be used for the item rendering

Reimplemented from SUIT_DataObject.

References expandable(), SUIT_DataObject::font(), hasChildren(), and SUIT_DataObject::NameId.

bool SalomeApp_DataObject::hasChildren ( ) const

Returns: true if object has at least one child sub-object and false otherwise

References _PTR().

QPixmap SalomeApp_DataObject::icon ( const int id = NameId ) const

virtual

Parameters

id column id

Returns: object icon for the specified column

Reimplemented from SUIT_DataObject.

Reimplemented in SalomeApp_RootObject, and SalomeApp_ModuleObject.

References _PTR(), componentDataType(), SUIT_DataObject::icon(), QtxResourceMgr::loadPixmap(), SUIT_DataObject::NameId, and SUIT_DataObject::root().

void SalomeApp_DataObject::insertChildAtTag	(	SalomeApp_DataObject *	obj,
		int	tag
	)

virtual

References SUIT_DataObject::childCount(), SUIT_DataObject::childObject(), and SUIT_DataObject::insertChildAtPos().

QString SalomeApp_DataObject::ior ( const _PTR(SObject)& obj ) const

private

Parameters

obj	data object

Returns: data object IOR or null string if IOR is empty

References _PTR().

bool SalomeApp_DataObject::isReference ( ) const

virtual

Re-implemented from LightApp_DataObject using SALOMEDS API.

Returns: true if this data object actually refers to another one

Reimplemented from LightApp_DataObject.

References _PTR().

bool SalomeApp_DataObject::isVisible ( ) const

virtual

Returns: true if this object is displayable or false otherwise

Reimplemented from LightApp_DataObject.

References _PTR(), isReference(), LightApp_DataObject::isVisible(), and name().

QString SalomeApp_DataObject::name ( ) const

virtual

Returns: object name

Reimplemented from SUIT_DataObject.

Reimplemented in SalomeApp_RootObject, and SalomeApp_ModuleObject.

References _PTR(), GetName(), and isReference().

virtual QString SalomeApp_DataObject::refEntry ( ) const

virtual

This method should be reimplemented in the subclasses. Default implementation returns null string.

Returns: ID string of the referenced data object

Reimplemented from LightApp_DataObject.

QString SalomeApp_DataObject::text ( const int id = NameId ) const

virtual

This method returns the data according to the specufied column id:

NameId : object name (by calling name() method)
EntryId : object entry (by calling entry() method)
ValueId : object value
IORId : object IOR
RefEntryId : object reference entry

Parameters

id column id

Returns: object text data

Reimplemented from LightApp_DataObject.

Reimplemented in SalomeApp_RootObject.

References LightApp_DataObject::componentObject(), ior(), IORId, LightApp_DataObject::text(), value(), and ValueId.

QString SalomeApp_DataObject::toolTip ( const int = NameId ) const

virtual

Parameters

id	column id (not used)

Returns: object tooltip for the specified column

Reimplemented from SUIT_DataObject.

Reimplemented in SalomeApp_RootObject, and SalomeApp_ModuleObject.

References SUIT_Session::activeApplication(), app, componentDataType(), LightApp_DataObject::componentObject(), entry(), SUIT_Study::id(), ior(), SalomeApp_Application::lcc(), name(), SUIT_DataObject::root(), SUIT_Session::session(), and LightApp_RootObject::study().

void SalomeApp_DataObject::updateItem ( )

virtual

References SUIT_DataObject::modified(), and SUIT_DataObject::setModified().

QString SalomeApp_DataObject::value ( const _PTR(SObject)& obj ) const

private

Parameters

obj	data object

Returns: data object value or empty string if there is no value associated to the object

References _PTR(), and SUIT_DataObject::root().

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

src/SalomeApp/SalomeApp_DataObject.h
src/SalomeApp/SalomeApp_DataObject.cxx

Public Types

Public Member Functions

Private Member Functions

Additional Inherited Members

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation