Version: 8.3.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
SALOME_PYQT_DataObjectLight Class Reference

#include <SALOME_PYQT_DataObjectLight.h>

Inheritance diagram for SALOME_PYQT_DataObjectLight:
Inheritance graph

Public Member Functions

 SALOME_PYQT_DataObjectLight (SUIT_DataObject *=0)
 
virtual ~SALOME_PYQT_DataObjectLight ()
 
virtual QString entry () const
 Get object string identifier. More...
 
virtual QString refEntry () const
 Returns the string identifier of the data objects referenced by this one. More...
 
void setRefEntry (const QString &refEntry)
 
virtual QString name () const
 Get data object name. More...
 
virtual QPixmap icon (const int=NameId) const
 Get data object icon for the specified column. More...
 
virtual QString toolTip (const int=NameId) const
 Get data object tooltip for the specified column. More...
 
bool setName (const QString &name)
 Set name of the this object. More...
 
void setIcon (const QString &icon)
 
void setToolTip (const QString &tooltip)
 
virtual QColor color (const ColorRole, const int=NameId) const
 Get data object color for the specified column. More...
 
void setColor (const QColor &color)
 
- 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 bool isReference () const
 Tells if this data objects is a reference to some other or not. More...
 
virtual QString text (const int=NameId) const
 Get object text data for the specified column. More...
 
virtual SUIT_DataObjectcomponentObject () const
 Get the component object. 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 int groupId () const
 return unique group identificator More...
 
virtual QVariant customData (Qtx::CustomDataType type)
 return custom data for data object More...
 
virtual bool isVisible () const
 Check if the object is visible. 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...
 
- 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...
 
virtual CAM_DataModeldataModel () 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_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. . 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 QFont font (const int=NameId) const
 Get data object font for the specified column. More...
 
virtual int alignment (const int=NameId) const
 Get data object text alignment for the specified column. More...
 
virtual bool expandable () const
 
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 Attributes

QString myEntry
 
QString myRefEntry
 
QString myName
 
QString myToolTip
 
QPixmap myIcon
 
QColor myColor
 

Additional Inherited Members

- Public Types inherited from LightApp_DataObject
enum  { EntryId = VisibilityId + 1, RefEntryId }
 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

SALOME_PYQT_DataObjectLight - PYTHON LIGHT module's data object class

Constructor & Destructor Documentation

SALOME_PYQT_DataObjectLight::SALOME_PYQT_DataObjectLight ( SUIT_DataObject parent = 0)

References _ID, and myEntry.

SALOME_PYQT_DataObjectLight::~SALOME_PYQT_DataObjectLight ( )
virtual

Member Function Documentation

QColor SALOME_PYQT_DataObjectLight::color ( const ColorRole  role,
const int  id = NameId 
) const
virtual
Parameters
rolecolor role
idcolumn id (not used)
Returns
object color for the specified column

Reimplemented from LightApp_DataObject.

References LightApp_DataObject::color(), SUIT_DataObject::Foreground, LightApp_DataObject::isReference(), myColor, and SUIT_DataObject::Text.

QString SALOME_PYQT_DataObjectLight::entry ( ) const
virtual

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

Returns
object ID

Reimplemented from LightApp_DataObject.

References myEntry.

QPixmap SALOME_PYQT_DataObjectLight::icon ( const int  = NameId) const
virtual

This method can be re-implemented in the subclasses. Default implementation returns null pixmap.

The parameter id specifies the column identificator

Parameters
idcolumn id
Returns
object icon for the specified column

Reimplemented from SUIT_DataObject.

References SUIT_DataObject::icon(), myIcon, and SUIT_DataObject::NameId.

QString SALOME_PYQT_DataObjectLight::name ( ) const
virtual

This method should be re-implemented in the subclasses. Default implementation returns null string.

Returns
object name

Reimplemented from SUIT_DataObject.

References myName.

QString SALOME_PYQT_DataObjectLight::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.

References myRefEntry.

void SALOME_PYQT_DataObjectLight::setColor ( const QColor &  color)

References color(), and myColor.

bool SALOME_PYQT_DataObjectLight::setName ( const QString &  name)
virtual

This method can be re-implemented in the subclasses. Default implementation returns false.

Returns
true if rename operation finished successfully, false otherwise.

Reimplemented from LightApp_DataObject.

References myName, and name().

void SALOME_PYQT_DataObjectLight::setRefEntry ( const QString &  refEntry)

References myRefEntry, and refEntry().

void SALOME_PYQT_DataObjectLight::setToolTip ( const QString &  tooltip)

References myToolTip.

QString SALOME_PYQT_DataObjectLight::toolTip ( const int  = NameId) const
virtual

This method can be re-implemented in the subclasses. Default implementation returns null string.

The parameter id specifies the column identificator (to display, for example, in the tree view widget).

Parameters
idcolumn id
Returns
object tooltip for the specified column

Reimplemented from SUIT_DataObject.

References myToolTip.

Member Data Documentation

QColor SALOME_PYQT_DataObjectLight::myColor
private
QString SALOME_PYQT_DataObjectLight::myEntry
private
QPixmap SALOME_PYQT_DataObjectLight::myIcon
private
QString SALOME_PYQT_DataObjectLight::myName
private
QString SALOME_PYQT_DataObjectLight::myRefEntry
private
QString SALOME_PYQT_DataObjectLight::myToolTip
private

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