CFx SDK Documentation  2020SP3
Public Types | Public Member Functions | Protected Member Functions | List of all members
CFxDesignResourceModel Class Referenceabstract

#include <FxDesignResourceModel.h>

Public Types

enum  ItemType {
  eNoneItem = -1, eRootItem = 0, eShortCutItem, eFolderItem,
  eDrawingItem, eImageItem, eLinkItem, eNetworkComputer,
  eBlockTable, eDimStyleTable, eLayerTable, eLineStyleTable,
  eXrefDrawings, eSheets, eTableStyles, eTextStyleTable,
  eMLeaderStyles, eBlock, eDimStyle, eLayer,
  eLineStyle, eXrefDrawing, eSheet, eTableStyle,
  eTextStyle, eMLeaderStyle, eLastStyle
}
 
enum  DrawignSubItemVisibilty {
  eNone = 0, eBlocksVisible = 1, eDimStylesVisible = 2, eLayersVisible = 4,
  eLineStylesVisible = 8, eXrefDrawingsVisible = 16, eSheetsVisible = 32, eTableStylesVisible = 64,
  eTextStylesVisible = 128, eMLeaderStylesVisible = 256, eAll
}
 
enum  Operation {
  eOpenInApplication = 0, eInsertAsBlock, eAttachAsXref, eInsertBlock,
  eAddDimStyle, eAddLayer, eAddLineStyle, eAttachXref,
  eAddSheet, eAddTableStyle, eAddTextStyle, eAddMLeaderStyle,
  eAttachImage, eRefreshSource, eExplore
}
 
enum  DataType { eInt = 0, eDouble, eString, eDate }
 

Public Member Functions

virtual ~CFxDesignResourceModel (void)
 
virtual CFxDesignDataItemCreateItem (const CFxString &sText, CFxDesignResourceModel::ItemType type, bool bExpandable=true) const =0
 
virtual CFxDesignDataItemItemAt (CFxDesignDataItem *pParent, int iIndex) const =0
 
virtual bool AppendChild (CFxDesignDataItem *pParent, CFxDesignDataItem *pChild)=0
 
virtual int GetChildCount (const CFxDesignDataItem *pItem) const =0
 
virtual bool RemoveAllChildren (CFxDesignDataItem *pParent)=0
 
virtual bool RemoveItem (CFxDesignDataItem *pItem)=0
 
virtual CFxDesignDataItemGetParentItem (const CFxDesignDataItem *pItem) const =0
 
virtual bool IsDrawingSubItem (CFxString &sURL)=0
 
virtual bool RemoveDatabaseFromCache (const CFxString &sURL)=0
 
virtual CFxDesignDataItemGetExploredItem ()=0
 
virtual void ExploreItem (CFxDesignDataItem *pItem)=0
 

Protected Member Functions

 CFxDesignResourceModel ()
 

Detailed Description

Definition at line 26 of file FxDesignResourceModel.h.

Member Enumeration Documentation

◆ DataType

Description: For Detail View Column Contents Data type.

Enumerator
eInt 
eDouble 
eString 
eDate 

Definition at line 109 of file FxDesignResourceModel.h.

◆ DrawignSubItemVisibilty

Description: Flags to control Drawing Sub Items visibility

Enumerator
eNone 
eBlocksVisible 
eDimStylesVisible 
eLayersVisible 
eLineStylesVisible 
eXrefDrawingsVisible 
eSheetsVisible 
eTableStylesVisible 
eTextStylesVisible 
eMLeaderStylesVisible 
eAll 

Definition at line 68 of file FxDesignResourceModel.h.

◆ ItemType

Description: Design Resource supported Item Types

Enumerator
eNoneItem 
eRootItem 
eShortCutItem 
eFolderItem 
eDrawingItem 
eImageItem 
eLinkItem 
eNetworkComputer 
eBlockTable 
eDimStyleTable 
eLayerTable 
eLineStyleTable 
eXrefDrawings 
eSheets 
eTableStyles 
eTextStyleTable 
eMLeaderStyles 
eBlock 
eDimStyle 
eLayer 
eLineStyle 
eXrefDrawing 
eSheet 
eTableStyle 
eTextStyle 
eMLeaderStyle 
eLastStyle 

Definition at line 32 of file FxDesignResourceModel.h.

◆ Operation

Description: Flags to control item's context menu operations.

Enumerator
eOpenInApplication 
eInsertAsBlock 
eAttachAsXref 
eInsertBlock 
eAddDimStyle 
eAddLayer 
eAddLineStyle 
eAttachXref 
eAddSheet 
eAddTableStyle 
eAddTextStyle 
eAddMLeaderStyle 
eAttachImage 
eRefreshSource 
eExplore 

Definition at line 87 of file FxDesignResourceModel.h.

Constructor & Destructor Documentation

◆ ~CFxDesignResourceModel()

virtual CFxDesignResourceModel::~CFxDesignResourceModel ( void  )
virtual

◆ CFxDesignResourceModel()

CFxDesignResourceModel::CFxDesignResourceModel ( )
protected

Member Function Documentation

◆ AppendChild()

virtual bool CFxDesignResourceModel::AppendChild ( CFxDesignDataItem pParent,
CFxDesignDataItem pChild 
)
pure virtual

Description: Append given child at specified parent item. Arguments:

Parameters
CFxDesignDataItem*Parent Item pointer if NULL then append item as root item.
CFxDesignDataItem*Child Item to Append

Return Value: true if it succeeds, false if it fails.

◆ CreateItem()

virtual CFxDesignDataItem* CFxDesignResourceModel::CreateItem ( const CFxString sText,
CFxDesignResourceModel::ItemType  type,
bool  bExpandable = true 
) const
pure virtual

Description: Create new item of following type: eRootItem , eShortCutItem, eFolderItem , eDrawingItem ,
eImageItem , eLinkItem , eNetworkComputer,

Arguments:

Parameters
CFxStringDisplay name of the item
CFxDesignResourceModel::ItemTypeItem type
boolMake it expandable if true

Return Value: NULL if it fails, else the created item.

◆ ExploreItem()

virtual void CFxDesignResourceModel::ExploreItem ( CFxDesignDataItem pItem)
pure virtual

Description: Explore or select specified item in Source view and make it current item. Arguments:

Parameters
CFxDesignDataItem*Item to explore.

◆ GetChildCount()

virtual int CFxDesignResourceModel::GetChildCount ( const CFxDesignDataItem pItem) const
pure virtual

Description: Get child count of specified item. Arguments:

Parameters
CFxDesignDataItem*Item if NULL then get root items count

Return Value: child count.

◆ GetExploredItem()

virtual CFxDesignDataItem* CFxDesignResourceModel::GetExploredItem ( )
pure virtual

Description: Returns Current explored or selected item in Source view.

◆ GetParentItem()

virtual CFxDesignDataItem* CFxDesignResourceModel::GetParentItem ( const CFxDesignDataItem pItem) const
pure virtual

Description: Get parent item of specified item. Arguments:

Parameters
CFxDesignDataItem*Item whose parent item required.

Return Value: NULL if specified item is root item, else the parent item.

◆ IsDrawingSubItem()

virtual bool CFxDesignResourceModel::IsDrawingSubItem ( CFxString sURL)
pure virtual

Description: Returns true If specified URL points to Drawing Sub Item. Arguments:

Parameters
CFxStringReturns URL of Parent item of Drawing Sub Item.

◆ ItemAt()

virtual CFxDesignDataItem* CFxDesignResourceModel::ItemAt ( CFxDesignDataItem pParent,
int  iIndex 
) const
pure virtual

Description: Get item at specified position of parent item. Arguments:

Parameters
CFxDesignDataItem*Parent Item if NULL then get root item at specified index.
intItem position index

Return Value: NULL if it fails, else the found item.

◆ RemoveAllChildren()

virtual bool CFxDesignResourceModel::RemoveAllChildren ( CFxDesignDataItem pParent)
pure virtual

Description: Remove all childes of given item. Arguments:

Parameters
CFxDesignDataItem*Item whose child has to remove.

Return Value: true if it succeeds, false if it fails.

◆ RemoveDatabaseFromCache()

virtual bool CFxDesignResourceModel::RemoveDatabaseFromCache ( const CFxString sURL)
pure virtual

Description: Remove database from cache for specified URL if already cached. Arguments:

Parameters
CFxStringSpecified Database URL.

Return Value: true if it succeeds, false if it fails.

See also
CFxDesignDataSource::LoadDatabase

◆ RemoveItem()

virtual bool CFxDesignResourceModel::RemoveItem ( CFxDesignDataItem pItem)
pure virtual

Description: Remove specified item from its parent item. Arguments:

Parameters
CFxDesignDataItem*Item to remove.

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