Version: 9.12.0
SalomeApp_ModuleObject Class Reference

This class is used for optimized access to the SALOMEDS-based data model from SalomeApp_DataObject class instances. More...

#include <SalomeApp_DataObject.h>

Inheritance diagram for SalomeApp_ModuleObject:
Inheritance graph

Public Member Functions

 SalomeApp_ModuleObject (SUIT_DataObject *=0)
 Constructor. More...
 
 SalomeApp_ModuleObject (const _PTR(SObject)&, SUIT_DataObject *=0)
 Constructor. More...
 
 SalomeApp_ModuleObject (CAM_DataModel *, const _PTR(SObject)&, SUIT_DataObject *=0)
 Constructor. More...
 
virtual ~SalomeApp_ModuleObject ()
 Destructor. More...
 
virtual QString name () const
 Get module name. More...
 
QPixmap icon (const int=NameId) const
 Get data object icon for the specified column. More...
 
QString toolTip (const int=NameId) const
 Get data object tooltip for the specified column. More...
 
- Public Member Functions inherited from SalomeApp_DataObject
 SalomeApp_DataObject (SUIT_DataObject *=0)
 Constructor. More...
 
 SalomeApp_DataObject (const _PTR(SObject)&, SUIT_DataObject *=0)
 Constructor. More...
 
virtual ~SalomeApp_DataObject ()
 Destructor. 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 QColor color (const ColorRole, const int=NameId) const
 Get data object color 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
 Tells if this data objects is a reference to some other or not. More...
 
 _PTR (SObject) referencedObject() const
 
bool hasChildren () const
 
bool expandable () const
 
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_DataObjectKeykey () const
 Get the data object unique key. More...
 
virtual SUIT_DataObjectcomponentObject () 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_Modulemodule () const
 Get CAM module. More...
 
- Public Member Functions inherited from SUIT_DataObject
 SUIT_DataObject (SUIT_DataObject *=0)
 Constructor. More...
 
virtual ~SUIT_DataObject ()
 Destructor. More...
 
SUIT_DataObjectroot () const
 Get the root object. More...
 
SUIT_DataObjectlastChild () const
 Get the last child object. More...
 
SUIT_DataObjectfirstChild () 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_DataObjectchildObject (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_DataObjectnextBrother () const
 Get the next sibling data object in the children list. More...
 
SUIT_DataObjectprevBrother () 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. \override. 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_DataObjectparent () 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...
 
- Public Member Functions inherited from CAM_ModuleObject
 CAM_ModuleObject (SUIT_DataObject *=0)
 Constructor. More...
 
 CAM_ModuleObject (CAM_DataModel *, SUIT_DataObject *=0)
 Constructor. More...
 
virtual ~CAM_ModuleObject ()
 Destructor. More...
 
virtual CAM_DataModeldataModel () const
 Get data model. More...
 
virtual void setDataModel (CAM_DataModel *)
 Set data model. More...
 

Additional Inherited Members

- Public Types inherited from SalomeApp_DataObject
enum  { ValueId = RefEntryId + 1 , IORId , LastId }
 Column id. More...
 
- Public Types inherited from LightApp_DataObject
enum  { EntryId = VisibilityId + 1 , RefEntryId }
 Column id. More...
 
- Public Types inherited from SUIT_DataObject
enum  ColorRole {
  Text , Base , Foreground , Background ,
  Highlight , HighlightedText
}
 Color role. More...
 
enum  { NameId , VisibilityId }
 Column id. More...
 
- Static Public Member Functions inherited from SUIT_DataObject
static Signalsignal ()
 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_DataObjectmyCompObject
 

Detailed Description

This class is used for optimized access to the SALOMEDS-based data model from SalomeApp_DataObject class instances.

See also
CAM_ModuleObject class

Constructor & Destructor Documentation

◆ SalomeApp_ModuleObject() [1/3]

SalomeApp_ModuleObject::SalomeApp_ModuleObject ( SUIT_DataObject parent = 0)

Constructor.

Parameters
parentparent data object

◆ SalomeApp_ModuleObject() [2/3]

SalomeApp_ModuleObject::SalomeApp_ModuleObject ( const _PTR(SObject)&  sobj,
SUIT_DataObject parent = 0 
)

Constructor.

Parameters
sobjSALOMEDS object
parentparent data object

◆ SalomeApp_ModuleObject() [3/3]

SalomeApp_ModuleObject::SalomeApp_ModuleObject ( CAM_DataModel dm,
const _PTR(SObject)&  sobj,
SUIT_DataObject parent = 0 
)

Constructor.

Parameters
dmdata model
sobjSALOMEDS object
parentparent data object

◆ ~SalomeApp_ModuleObject()

SalomeApp_ModuleObject::~SalomeApp_ModuleObject ( )
virtual

Destructor.

Member Function Documentation

◆ icon()

QPixmap SalomeApp_ModuleObject::icon ( const int  id = NameId) const
virtual

Get data object icon for the specified column.

Parameters
idcolumn id
Returns
object icon for the specified column
See also
CAM_ModuleObject class

Reimplemented from CAM_ModuleObject.

References SalomeApp_DataObject::icon(), and Qtx::scaleIcon().

◆ name()

QString SalomeApp_ModuleObject::name ( ) const
virtual

Get module name.

Returns
module name

Reimplemented from CAM_ModuleObject.

References SalomeApp_DataObject::name().

◆ toolTip()

QString SalomeApp_ModuleObject::toolTip ( const int  id = NameId) const
virtual

Get data object tooltip for the specified column.

Parameters
idcolumn id
Returns
object tooltip for the specified column

Reimplemented from CAM_ModuleObject.

References SalomeApp_DataObject::toolTip().


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