CFx SDK Documentation  2022 SP0
Public Types | Public Member Functions | Protected Member Functions | List of all members
CFxDesignDataItem Class Referenceabstract

#include <FxDesignDataItem.h>

Public Types

enum  ItemProperty { ItemIsDragDrop = 1 , ItemIsEnable = 2 }
 
enum  OperationFlags {
  eAddtoFavorites = 1 , eRemoveFromFavorites = 2 , eSetAsHome = 4 , eInsertAsBlock = 8 ,
  eAttachAsXref = 16 , eOpenInApplication = 32
}
 

Public Member Functions

virtual ~CFxDesignDataItem (void)
 
virtual CFxDesignResourceModel::ItemType Type () const =0
 
virtual CFxString GetName () const =0
 
virtual void SetName (const CFxString &)=0
 
virtual void SetTooltip (const CFxString &)=0
 
virtual CFxString GetURL () const =0
 
virtual void SetURL (const CFxString &)=0
 
virtual void SetIconImage (const QIcon &)=0
 
virtual void SetThumbnailImage (const QImage &)=0
 
virtual CFxString GetLink () const =0
 
virtual void SetLink (const CFxString &)=0
 
virtual void SetProperty (CFxDesignDataItem::ItemProperty, bool bEnable)=0
 
virtual bool IsPropertyEnabled (CFxDesignDataItem::ItemProperty) const =0
 
virtual void SetOperationAllowed (CFxDesignDataItem::OperationFlags, bool bAllow)=0
 
virtual bool IsOperationAllowed (CFxDesignDataItem::OperationFlags) const =0
 
virtual void SetDetailColumnData (int iColumn, const OdResBufPtr pData)=0
 
virtual void SetDetailColumnData (int iColumn, const OdDbDate pData)=0
 
virtual void GetDetailColumnData (int iColumn, OdResBufPtr &pData) const =0
 
virtual void GetDetailColumnData (int iColumn, OdDbDate &pData) const =0
 
virtual void SetDetailColumnDataPrefix (int iColumn, const CFxString &strPrefix)=0
 
virtual void GetDetailColumnDataPrefix (int iColumn, CFxString &strPrefix) const =0
 
virtual void SetDetailColumnDataSuffix (int iColumn, const CFxString &strSuffix)=0
 
virtual void GetDetailColumnDataSuffix (int iColumn, CFxString &strSuffix) const =0
 
virtual void SetCustomData (int identifier, const OdResBufPtr ptrData)=0
 
virtual OdResBufPtr GetCustomData (int identifier) const =0
 
virtual CFxDatabasePtr GetDatabase () const =0
 
virtual void Refresh ()=0
 
virtual CFxString GetStatusText () const =0
 
virtual void SetStatusText (const CFxString &sStatusText)=0
 

Protected Member Functions

 CFxDesignDataItem (void)
 

Detailed Description

Definition at line 34 of file FxDesignDataItem.h.

Member Enumeration Documentation

◆ ItemProperty

Description: Item Property which describes the Item behavior and set/reset by user as per requirement.

Enumerator
ItemIsDragDrop 
ItemIsEnable 

Definition at line 40 of file FxDesignDataItem.h.

◆ OperationFlags

Description: Item operation Flags control on item context menu item by enable/disable it.

Enumerator
eAddtoFavorites 
eRemoveFromFavorites 
eSetAsHome 
eInsertAsBlock 
eAttachAsXref 
eOpenInApplication 

Definition at line 49 of file FxDesignDataItem.h.

Constructor & Destructor Documentation

◆ ~CFxDesignDataItem()

virtual CFxDesignDataItem::~CFxDesignDataItem ( void  )
virtual

◆ CFxDesignDataItem()

CFxDesignDataItem::CFxDesignDataItem ( void  )
protected

Member Function Documentation

◆ GetCustomData()

virtual OdResBufPtr CFxDesignDataItem::GetCustomData ( int  identifier) const
pure virtual

◆ GetDatabase()

virtual CFxDatabasePtr CFxDesignDataItem::GetDatabase ( ) const
pure virtual

◆ GetDetailColumnData() [1/2]

virtual void CFxDesignDataItem::GetDetailColumnData ( int  iColumn,
OdDbDate pData 
) const
pure virtual

◆ GetDetailColumnData() [2/2]

virtual void CFxDesignDataItem::GetDetailColumnData ( int  iColumn,
OdResBufPtr pData 
) const
pure virtual

Description: Get Detail View Column Data. Arguments:

Parameters
intColumn number.
OdResBufPtr/OdDbDateGet column data that has set.

◆ GetDetailColumnDataPrefix()

virtual void CFxDesignDataItem::GetDetailColumnDataPrefix ( int  iColumn,
CFxString strPrefix 
) const
pure virtual

◆ GetDetailColumnDataSuffix()

virtual void CFxDesignDataItem::GetDetailColumnDataSuffix ( int  iColumn,
CFxString strSuffix 
) const
pure virtual

◆ GetLink()

virtual CFxString CFxDesignDataItem::GetLink ( ) const
pure virtual

Description: Get/Set item Link if any. Arguments:

Parameters
CFxStringLink URL string

Return Value: Link URL string.

◆ GetName()

virtual CFxString CFxDesignDataItem::GetName ( ) const
pure virtual

Description: Get or Set Item Display Name. Arguments:

Parameters
CFxStringName of the Item

Return Value: Item Name.

◆ GetStatusText()

virtual CFxString CFxDesignDataItem::GetStatusText ( ) const
pure virtual

Description: Get/Set item's text to display in palette's status bar, when this item is selected. Arguments:

Parameters
CFxStringStatus text string

Return Value: Status text string

◆ GetURL()

virtual CFxString CFxDesignDataItem::GetURL ( ) const
pure virtual

Description: Get/Set item URL. Arguments:

Parameters
CFxStringURL string

Return Value: URL String.

◆ IsOperationAllowed()

virtual bool CFxDesignDataItem::IsOperationAllowed ( CFxDesignDataItem::OperationFlags  ) const
pure virtual

◆ IsPropertyEnabled()

virtual bool CFxDesignDataItem::IsPropertyEnabled ( CFxDesignDataItem::ItemProperty  ) const
pure virtual

◆ Refresh()

virtual void CFxDesignDataItem::Refresh ( )
pure virtual

Description: Refresh this node by removing all its children and refill again.

◆ SetCustomData()

virtual void CFxDesignDataItem::SetCustomData ( int  identifier,
const OdResBufPtr  ptrData 
)
pure virtual

Description: Set/Get Custom data with item. Arguments:

Parameters
intUser defined custom data identifier.
OdResBufPtrdata stored with item.

Return Value: OdResBufPtr data if set with item else null.

◆ SetDetailColumnData() [1/2]

virtual void CFxDesignDataItem::SetDetailColumnData ( int  iColumn,
const OdDbDate  pData 
)
pure virtual

◆ SetDetailColumnData() [2/2]

virtual void CFxDesignDataItem::SetDetailColumnData ( int  iColumn,
const OdResBufPtr  pData 
)
pure virtual

Description: Set Detail View Column Data. Arguments:

Parameters
intColumn number.
OdResBufPtr/OdDbDateColumn Data to set.

◆ SetDetailColumnDataPrefix()

virtual void CFxDesignDataItem::SetDetailColumnDataPrefix ( int  iColumn,
const CFxString strPrefix 
)
pure virtual

Description: Set/Get Detail View Column Data Prefix. Arguments:

Parameters
intColumn number.
CFxStringcolumn data prefix string stored with item.

◆ SetDetailColumnDataSuffix()

virtual void CFxDesignDataItem::SetDetailColumnDataSuffix ( int  iColumn,
const CFxString strSuffix 
)
pure virtual

Description: Set/Get Detail View Column Data Suffix. Arguments:

Parameters
intColumn number.
CFxStringcolumn data suffix string stored with item.

◆ SetIconImage()

virtual void CFxDesignDataItem::SetIconImage ( const QIcon &  )
pure virtual

Description: Set item Icon/Thumbnail view Image. Arguments:

Parameters
CFxRasterImagePtrItem Icon/Thumbnail view Image

◆ SetLink()

virtual void CFxDesignDataItem::SetLink ( const CFxString )
pure virtual

◆ SetName()

virtual void CFxDesignDataItem::SetName ( const CFxString )
pure virtual

◆ SetOperationAllowed()

virtual void CFxDesignDataItem::SetOperationAllowed ( CFxDesignDataItem::OperationFlags  ,
bool  bAllow 
)
pure virtual

Description: Set/Get item Operation flags . Arguments:

Parameters
CFxDesignDataItem::OperationFlagsOperation flag to to control context menu on item
boolAllow or ignore operation.

Return Value: true if Operation allowed.

◆ SetProperty()

virtual void CFxDesignDataItem::SetProperty ( CFxDesignDataItem::ItemProperty  ,
bool  bEnable 
)
pure virtual

Description: Set/Get item property. Arguments:

Parameters
CFxDesignDataItem::ItemPropertyItem property type
boolFlag to enable/disable item property

Return Value: true if property enable.

◆ SetStatusText()

virtual void CFxDesignDataItem::SetStatusText ( const CFxString sStatusText)
pure virtual

◆ SetThumbnailImage()

virtual void CFxDesignDataItem::SetThumbnailImage ( const QImage &  )
pure virtual

◆ SetTooltip()

virtual void CFxDesignDataItem::SetTooltip ( const CFxString )
pure virtual

Description: Set Item Tooltip. Arguments:

Parameters
CFxStringTooltip of the Item

◆ SetURL()

virtual void CFxDesignDataItem::SetURL ( const CFxString )
pure virtual

◆ Type()

virtual CFxDesignResourceModel::ItemType CFxDesignDataItem::Type ( ) const
pure virtual

Description: Returns item type. Return Value: Item type.


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