#include <FxUI.h>

Public Types
enum	_MenuType { eNormal , eMain , eContextDefault , eContextEditDefault , eContextCommandDefault , eContextObject , eContextCommand }

enum	_ToolbarType { eAction , eControl , eFlyout }

enum	_ButtonType { eClick , eShiftClick , eCtrlClick , eCtrlShiftClick }

enum	_Orientation { eLeft = 0x0001 , eRight = 0x0002 , eTop = 0x0004 , eBottom = 0x0008 , eFloating = 0x0010 , eAll = eFloating \| eTop \| eBottom \| eLeft \| eRight }

enum	_NavigationToolbarType { eFull = 0 , eMedium = 1 , eNarrow = 2 }

typedef enum CFxUI::_MenuType	MenuType

typedef enum CFxUI::_ToolbarType	ToolbarType

typedef enum CFxUI::_ButtonType	ButtonType

typedef enum CFxUI::_Orientation	Orientation

typedef enum CFxUI::_NavigationToolbarType	NavigationToolbarType

Public Member Functions
virtual	~CFxUI ()

virtual void	LoadInterface ()=0

virtual void	SaveInterface ()=0

virtual bool	LoadResourceFile (const CFxString &name, CFxUIGroup **pLoadedGroup=0)=0

virtual CFxUIItemDefinition *	FindItem (const CFxString &uiGroup, const CFxString &id)=0

virtual CFxUIItemDefinition *	CreateItemDefinition (const CFxString &id, CFxUIContext *pContext) const =0

virtual void	DestroyItemDefinition (CFxUIItemDefinition *pDefinition)=0

virtual bool	RemoveItemDefinition (CFxUIItemDefinition *pDefinition)=0

virtual bool	AddGroup (CFxUIGroup *pItem)=0

virtual bool	RemoveGroup (const CFxString &sGroupName)=0

virtual CFxUIGroup *	GetStartUpGroup ()=0

virtual CFxUIWorkspace *	GetStartUpWorkspace ()=0

virtual CFxUIGroup *	GetGroup (const CFxString &name)=0

virtual CFxUIGroupIterator *	CreateGroupIterator ()=0

virtual bool	AddWorkspace (CFxUIWorkspace *pItem)=0

virtual bool	RemoveWorkspace (CFxUIWorkspace *pItem)=0

virtual CFxUIWorkspace *	GetWorkspace (const CFxString &name)=0

virtual CFxUIWorkspaceIterator *	CreateWorkspaceIterator ()=0

virtual CFxUIWorkspace *	GetCurrentWorkspace ()=0

virtual void	SetCurrentWorkspace (CFxUIWorkspace *)=0

virtual CFxString	CreateUniqueID () const =0

virtual CFxUIGroup *	CreateGroup (const CFxString &groupName, const CFxString &fileName) const =0

virtual CFxUIGroup *	CreateRuntimeGroup (const CFxString &groupName) const =0

virtual CFxUIWorkspace *	CreateWorkspace (const CFxString &wsName, const CFxString &fileName) const =0

virtual CFxUIMenuItem *	CreateMenuItem (MenuType eType, const CFxString &pClass, const CFxString &command, const CFxString &id=CFxString()) const =0

virtual void	DestroyMenuItem (CFxUIMenuItem *pItem)=0

virtual CFxUIToolbarItem *	CreateToolbarItem (CFxUI::ToolbarType type=CFxUI::eAction, const CFxString &sUID=CFxString()) const =0

virtual void	DestroyToolbarItem (CFxUIToolbarItem *pItem)=0

virtual CFxUIRibbonTab *	CreateRibbonTabItem (const CFxString &sUID=CFxString()) const =0

virtual CFxUIRibbonPanel *	CreateRibbonPanelItem (const CFxString &sUID=CFxString()) const =0

virtual CFxUIRibbonRow *	CreateRibbonRowItem (const CFxString &sUID=CFxString()) const =0

virtual CFxUIRibbonRowItem *	CreateRibbonRowElementItem (CFxUIRibbonItem::RibbonItemType type, const CFxString &sUID=CFxString()) const =0

virtual CFxUIRibbonQuickAccessBar *	CreateRibbonQuickAccessBar (const CFxString &sUID=CFxString()) const =0

virtual CFxUIRibbonSystemMenuItem *	CreateRibbonSystemMenuItem (const CFxString &sUID=CFxString()) const =0

virtual CFxUIRibbonQuickAccessBarItem *	CreateRibbonQuickAccessBarItem (const CFxString &sUID=CFxString()) const =0

virtual CFxUIRibbonHelpMenuItem *	CreateRibbonHelpMenuItem (const CFxString &sUID=CFxString()) const =0

virtual void	DestroyRibbonTabItem (CFxUIRibbonTab *pTab)=0

virtual void	DestroyRibbonPanelItem (CFxUIRibbonPanel *pPanel)=0

virtual void	DestroyRibbonRowItem (CFxUIRibbonRow *pRow)=0

virtual void	DestroyRibbonRowElementItem (CFxUIRibbonRowItem *pItem)=0

virtual void	DestroyRibbonQuickAccessBar (CFxUIRibbonQuickAccessBar *pQuickAccessBar)=0

virtual void	DestroyRibbonSystemMenuItem (CFxUIRibbonSystemMenuItem *pSystemMenuItem)=0

virtual void	DestroyRibbonHelpMenuItem (CFxUIRibbonHelpMenuItem *pHelpMenuItem)=0

virtual void	DestroyRibbonQuickAccessBarItem (CFxUIRibbonQuickAccessBarItem *pQuickAccessBarItem)=0

virtual CFxUIDoubleClickAction *	CreateDoubleClickAction (const CFxString &className, const CFxString &sUID=CFxString()) const =0

virtual void	DestroyDoubleClickAction (CFxUIDoubleClickAction *pItem)=0

virtual CFxUIAccelerator *	CreateAccelerator (CFxUIItemDefinition *pDefinition, const CFxString &sUID=CFxString()) const =0

virtual void	DestroyAccelerator (CFxUIAccelerator *pItem)=0

virtual CFxUIButton *	CreateMouseButton (CFxUIItemDefinition *pDefinition, int iButtonNumber, const CFxString &sUID=CFxString()) const =0

virtual void	DestroyMouseButton (CFxUIButton *pItem)=0

virtual CFxUITabletMenu *	CreateTabletMenu () const =0

virtual void	DestroyTabletMenu (CFxUITabletMenu *pItem)=0

virtual CFxUITempOverrideKey *	CreateTempOverrideKey (const CFxString &sUID=CFxString()) const =0

virtual void	DestroyTempOverrideKey (CFxUITempOverrideKey *pItem)=0

virtual CFxUIImageItem *	CreateImageItem (const CFxString &sName, const CFxString &sUID=CFxString()) const =0

virtual void	DestroyImageItem (CFxUIImageItem *pItem)=0

virtual CFxString	CreateRuntimeToolbar (const CFxString &sToolbarName)=0

virtual CFxUIToolbarItem *	CreateRuntimeToolbar (const CFxString &sToolbarName, const CFxString &sGroupName)=0

virtual void	DestroyRuntimeToolbar (const CFxString &sObjectName)=0

virtual void	AddUserDefaultContextMenu (CFxUIContext *pContext)=0

virtual void	RemoveUserDefaultContextMenu (CFxUIContext *pContext)=0

virtual void	AddUserObjectContextMenu (const CFxString &pClass, CFxUIContext *pContext)=0

virtual void	RemoveUserObjectContextMenu (const CFxString &pClass, CFxUIContext *pContext)=0

virtual void	AddUserCommandContextMenu (const CFxString &strCommand, CFxUIContext *pContext)=0

virtual void	RemoveUserCommandContextMenu (const CFxString &strCommand, CFxUIContext *pContext)=0

virtual bool	DisplayContextMenu ()=0

virtual int	Menucmd (const CFxString &strCmd, CFxString &strResult)=0

virtual bool	CheckEvents (bool bMouseMove, bool bMouseWheel, bool bMouseButton, bool bAllKeyboard)=0

virtual void	ResetEvents ()=0

virtual void	Update (bool bFullUpdate=false)=0

virtual void	UpdateMenu ()=0

virtual void	UpdateRibbon ()=0

virtual CFxWidget *	UpdatePanelPreview (CFxUIRibbonPanel pRibbonPanelDef, CFxWidget parent, CFxRibbonPreviewProxy *pRibbonPreviewProxy, const CFxString &strUID)=0

virtual void	SetCleanScreenState (bool bValue)=0

virtual void	AddUIReactor (CFxUIReactor *pReactor)=0

virtual void	RemoveUIReactor (CFxUIReactor *pReactor)=0

virtual CFxUIItemDefinition *	CreateRuntimeItemDefinition (const CFxString &id, CFxUIContext *pContext) const =0

virtual void	DestroyRuntimeItemDefinition (CFxUIItemDefinition *pDefinition)=0

virtual CFxUIMenuItem *	CreateRuntimeMenuItem (MenuType eType, const CFxString &pClass, const CFxString &command, const CFxString &id=CFxString()) const =0

virtual void	DestroyRuntimeMenuItem (CFxUIMenuItem *pItem)=0

virtual CFxUIToolbarItem *	CreateRuntimeToolbarItem (CFxUI::ToolbarType type=CFxUI::eAction) const =0

virtual void	DestroyRuntimeToolbarItem (CFxUIToolbarItem *pItem)=0

virtual CFxUIMenuItemCollection *	GetVisibleMenuCollection ()=0

virtual CFxUIToolbarItemCollection *	GetVisibleToolbarCollection ()=0

virtual CFxUIRibbonTabCollection *	GetVisibleRibbonTabCollection ()=0

virtual CFxUIRibbonSystemMenuItem *	GetVisibleRibbonSystemMenu ()=0

virtual CFxUIRibbonQuickAccessBar *	GetVisibleRibbonQuickAccessBar ()=0

virtual CFxUIRibbonHelpMenuItemCollection *	GetVisibleRibbonHelpMenu ()=0

Detailed Description

Description: Represents the base class for user interface. Library: DDKERNEL

Definition at line 89 of file FxUI.h.

Member Typedef Documentation

◆ ButtonType

typedef enum CFxUI::_ButtonType CFxUI::ButtonType

Description: Values that represent _ButtonType.

◆ MenuType

typedef enum CFxUI::_MenuType CFxUI::MenuType

Description: Values that represent _MenuType.

◆ NavigationToolbarType

typedef enum CFxUI::_NavigationToolbarType CFxUI::NavigationToolbarType

◆ Orientation

typedef enum CFxUI::_Orientation CFxUI::Orientation

Description: Values that represent _Orientation.

◆ ToolbarType

typedef enum CFxUI::_ToolbarType CFxUI::ToolbarType

Description: Values that represent _ToolbarType.

Member Enumeration Documentation

◆ _ButtonType

enum CFxUI::_ButtonType

Description: Values that represent _ButtonType.

Enumerator
eClick
eShiftClick
eCtrlClick
eCtrlShiftClick

Definition at line 123 of file FxUI.h.

◆ _MenuType

enum CFxUI::_MenuType

Description: Values that represent _MenuType.

Enumerator
eNormal
eMain
eContextDefault
eContextEditDefault
eContextCommandDefault
eContextObject
eContextCommand

Definition at line 97 of file FxUI.h.

◆ _NavigationToolbarType

enum CFxUI::_NavigationToolbarType

Enumerator
eFull
eMedium
eNarrow

Definition at line 145 of file FxUI.h.

◆ _Orientation

enum CFxUI::_Orientation

Description: Values that represent _Orientation.

Enumerator
eLeft
eRight
eTop
eBottom
eFloating
eAll

Definition at line 135 of file FxUI.h.

◆ _ToolbarType

enum CFxUI::_ToolbarType

Description: Values that represent _ToolbarType.

Enumerator
eAction
eControl
eFlyout

Definition at line 112 of file FxUI.h.

Constructor & Destructor Documentation

◆ ~CFxUI()

virtual CFxUI::~CFxUI ( )

inlinevirtual

Definition at line 152 of file FxUI.h.

Member Function Documentation

◆ AddGroup()

virtual bool CFxUI::AddGroup ( CFxUIGroup * pItem )

pure virtual

Description: Adds a group. Arguments:

Parameters

[in,out] pItem If non-null, the item.

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

◆ AddUIReactor()

virtual void CFxUI::AddUIReactor ( CFxUIReactor * pReactor )

pure virtual

Description: Adds a user interface reactor. Arguments:

Parameters

[in,out] pReactor If non-null, the reactor.

◆ AddUserCommandContextMenu()

virtual void CFxUI::AddUserCommandContextMenu	(	const CFxString &	strCommand,
		CFxUIContext *	pContext
	)

pure virtual

Description: Adds a user command context menu to 'pContext'. Arguments:

Parameters

	strCommand	The string command.
[in,out]	pContext	If non-null, the context.

◆ AddUserDefaultContextMenu()

virtual void CFxUI::AddUserDefaultContextMenu ( CFxUIContext * pContext )

pure virtual

Description: Adds a user default context menu. Arguments:

Parameters

[in,out] pContext If non-null, the context.

◆ AddUserObjectContextMenu()

virtual void CFxUI::AddUserObjectContextMenu	(	const CFxString &	pClass,
		CFxUIContext *	pContext
	)

pure virtual

Description: Adds a user object context menu to 'pContext'. Arguments:

Parameters

	pClass	The class.
[in,out]	pContext	If non-null, the context.

◆ AddWorkspace()

virtual bool CFxUI::AddWorkspace ( CFxUIWorkspace * pItem )

pure virtual

Description: Adds a workspace. Arguments:

Parameters

[in,out] pItem If non-null, the item.

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

◆ CheckEvents()

virtual bool CFxUI::CheckEvents	(	bool	bMouseMove,
		bool	bMouseWheel,
		bool	bMouseButton,
		bool	bAllKeyboard
	)

pure virtual

Description: Check events. Arguments:

Parameters

bMouseMove	true to mouse move.
bMouseWheel	true to mouse wheel.
bMouseButton	true to mouse button.
bAllKeyboard	true to all keyboard.

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

◆ CreateAccelerator()

virtual CFxUIAccelerator * CFxUI::CreateAccelerator	(	CFxUIItemDefinition *	pDefinition,
		const CFxString &	sUID = `CFxString()`
	)		const

pure virtual

Description: Creates an accelerator. Arguments:

Parameters

[in,out] pDefinition If non-null, the definition.

Return Value: null if it fails, else.

◆ CreateDoubleClickAction()

virtual CFxUIDoubleClickAction * CFxUI::CreateDoubleClickAction	(	const CFxString &	className,
		const CFxString &	sUID = `CFxString()`
	)		const

pure virtual

Description: Creates a double click action. Arguments:

Parameters

className Name of the class.

Return Value: null if it fails, else.

◆ CreateGroup()

virtual CFxUIGroup * CFxUI::CreateGroup	(	const CFxString &	groupName,
		const CFxString &	fileName
	)		const

pure virtual

Description: Creates a group. Arguments:

Parameters

groupName	Name of the group.
fileName	Filename of the file.

Return Value: null if it fails, else.

◆ CreateGroupIterator()

virtual CFxUIGroupIterator * CFxUI::CreateGroupIterator ( )

pure virtual

Description: Creates the group iterator.

Return Value: null if it fails, else.

◆ CreateImageItem()

virtual CFxUIImageItem * CFxUI::CreateImageItem	(	const CFxString &	sName,
		const CFxString &	sUID = `CFxString()`
	)		const

pure virtual

Description: Creates a Image Tile menu item. Arguments:

Parameters

sName Image Menu Name.

Return Value: null if it fails, else.

◆ CreateItemDefinition()

virtual CFxUIItemDefinition * CFxUI::CreateItemDefinition	(	const CFxString &	id,
		CFxUIContext *	pContext
	)		const

pure virtual

Description: Creates an item definition. Arguments:

Parameters

	id	The identifier.
[in,out]	pContext	If non-null, the context.

Return Value: null if it fails, else.

◆ CreateMenuItem()

virtual CFxUIMenuItem * CFxUI::CreateMenuItem	(	MenuType	eType,
		const CFxString &	pClass,
		const CFxString &	command,
		const CFxString &	id = `CFxString()`
	)		const

pure virtual

Description: Creates a menu item. Arguments:

Parameters

eType	The type.
pClass	The class.
command	The command.
id	(optional) the identifier.

Return Value: null if it fails, else.

◆ CreateMouseButton()

virtual CFxUIButton * CFxUI::CreateMouseButton	(	CFxUIItemDefinition *	pDefinition,
		int	iButtonNumber,
		const CFxString &	sUID = `CFxString()`
	)		const

pure virtual

Description: Creates a mouse button. Arguments:

Parameters

[in,out]	pDefinition	If non-null, the definition.
	iButtonNumber	Zero-based index of the button number.

Return Value: null if it fails, else.

◆ CreateRibbonHelpMenuItem()

virtual CFxUIRibbonHelpMenuItem * CFxUI::CreateRibbonHelpMenuItem ( const CFxString & sUID = CFxString() ) const

pure virtual

Description: Creates a ribbon help menu item. Arguments:

Return Value: null if it fails, else.

◆ CreateRibbonPanelItem()

virtual CFxUIRibbonPanel * CFxUI::CreateRibbonPanelItem ( const CFxString & sUID = CFxString() ) const

pure virtual

Description: Creates a ribbon panel. Arguments:

Return Value: null if it fails, else.

◆ CreateRibbonQuickAccessBar()

virtual CFxUIRibbonQuickAccessBar * CFxUI::CreateRibbonQuickAccessBar ( const CFxString & sUID = CFxString() ) const

pure virtual

Description: Creates a ribbon quick access bar. Arguments:

Return Value: null if it fails, else.

◆ CreateRibbonQuickAccessBarItem()

virtual CFxUIRibbonQuickAccessBarItem * CFxUI::CreateRibbonQuickAccessBarItem ( const CFxString & sUID = CFxString() ) const

pure virtual

Description: Creates a ribbon quick access bar item. Arguments:

Return Value: null if it fails, else.

◆ CreateRibbonRowElementItem()

virtual CFxUIRibbonRowItem * CFxUI::CreateRibbonRowElementItem	(	CFxUIRibbonItem::RibbonItemType	type,
		const CFxString &	sUID = `CFxString()`
	)		const

pure virtual

Description: Creates a ribbon row. Arguments: type: type of item. Return Value: null if it fails, else.

◆ CreateRibbonRowItem()

virtual CFxUIRibbonRow * CFxUI::CreateRibbonRowItem ( const CFxString & sUID = CFxString() ) const

pure virtual

Description: Creates a ribbon row. Arguments:

Return Value: null if it fails, else.

◆ CreateRibbonSystemMenuItem()

virtual CFxUIRibbonSystemMenuItem * CFxUI::CreateRibbonSystemMenuItem ( const CFxString & sUID = CFxString() ) const

pure virtual

Description: Creates a ribbon system menu item. Arguments:

Return Value: null if it fails, else.

◆ CreateRibbonTabItem()

virtual CFxUIRibbonTab * CFxUI::CreateRibbonTabItem ( const CFxString & sUID = CFxString() ) const

pure virtual

Description: Creates a ribbon tab. Arguments:

Return Value: null if it fails, else.

◆ CreateRuntimeGroup()

virtual CFxUIGroup * CFxUI::CreateRuntimeGroup ( const CFxString & groupName ) const

pure virtual

◆ CreateRuntimeItemDefinition()

virtual CFxUIItemDefinition * CFxUI::CreateRuntimeItemDefinition	(	const CFxString &	id,
		CFxUIContext *	pContext
	)		const

pure virtual

◆ CreateRuntimeMenuItem()

virtual CFxUIMenuItem * CFxUI::CreateRuntimeMenuItem	(	MenuType	eType,
		const CFxString &	pClass,
		const CFxString &	command,
		const CFxString &	id = `CFxString()`
	)		const

pure virtual

◆ CreateRuntimeToolbar() [1/2]

virtual CFxString CFxUI::CreateRuntimeToolbar ( const CFxString & sToolbarName )

pure virtual

Description: Creates a runtime toolbar. Arguments:

Parameters

sToolbarName Name of the toolbar.

Return Value: .

◆ CreateRuntimeToolbar() [2/2]

virtual CFxUIToolbarItem * CFxUI::CreateRuntimeToolbar	(	const CFxString &	sToolbarName,
		const CFxString &	sGroupName
	)

pure virtual

Description: Creates a runtime toolbar. Arguments:

Parameters

sToolbarName	Name of the toolbar.
sGroupName	Name of the group.

Return Value: .

◆ CreateRuntimeToolbarItem()

virtual CFxUIToolbarItem * CFxUI::CreateRuntimeToolbarItem ( CFxUI::ToolbarType type = CFxUI::eAction ) const

pure virtual

◆ CreateTabletMenu()

virtual CFxUITabletMenu * CFxUI::CreateTabletMenu ( ) const

pure virtual

Description: Creates the tablet menu.

Return Value: null if it fails, else.

◆ CreateTempOverrideKey()

virtual CFxUITempOverrideKey * CFxUI::CreateTempOverrideKey ( const CFxString & sUID = CFxString() ) const

pure virtual

Description: Creates the temporary override key.

Return Value: null if it fails, else.

◆ CreateToolbarItem()

virtual CFxUIToolbarItem * CFxUI::CreateToolbarItem	(	CFxUI::ToolbarType	type = `CFxUI::eAction`,
		const CFxString &	sUID = `CFxString()`
	)		const

pure virtual

Description: Creates a toolbar item. Arguments:

Parameters

type	(optional) the type.

Return Value: null if it fails, else.

◆ CreateUniqueID()

virtual CFxString CFxUI::CreateUniqueID ( ) const

pure virtual

Description: Creates the unique identifier.

Return Value: .

◆ CreateWorkspace()

virtual CFxUIWorkspace * CFxUI::CreateWorkspace	(	const CFxString &	wsName,
		const CFxString &	fileName
	)		const

pure virtual

Description: Creates a workspace. Arguments:

Parameters

wsName	Name of the ws.
fileName	Filename of the file.

Return Value: null if it fails, else.

◆ CreateWorkspaceIterator()

virtual CFxUIWorkspaceIterator * CFxUI::CreateWorkspaceIterator ( )

pure virtual

Description: Creates the workspace iterator.

Return Value: null if it fails, else.

◆ DestroyAccelerator()

virtual void CFxUI::DestroyAccelerator ( CFxUIAccelerator * pItem )

pure virtual

Description: Destroys the accelerator described by pItem. Arguments:

Parameters

[in,out] pItem If non-null, the item.

◆ DestroyDoubleClickAction()

virtual void CFxUI::DestroyDoubleClickAction ( CFxUIDoubleClickAction * pItem )

pure virtual

Description: Destroys the double click action described by pItem. Arguments:

Parameters

[in,out] pItem If non-null, the item.

◆ DestroyImageItem()

virtual void CFxUI::DestroyImageItem ( CFxUIImageItem * pItem )

pure virtual

Description: Destroys the Image tile menu item described by pItem. Arguments:

Parameters

[in,out] pItem If non-null, the item.

◆ DestroyItemDefinition()

virtual void CFxUI::DestroyItemDefinition ( CFxUIItemDefinition * pDefinition )

pure virtual

Description: Destroys the item definition described by pDefinition. Arguments:

Parameters

[in,out] pDefinition If non-null, the definition.

◆ DestroyMenuItem()

virtual void CFxUI::DestroyMenuItem ( CFxUIMenuItem * pItem )

pure virtual

Description: Destroys the menu item described by pItem. Arguments:

Parameters

[in,out] pItem If non-null, the item.

◆ DestroyMouseButton()

virtual void CFxUI::DestroyMouseButton ( CFxUIButton * pItem )

pure virtual

◆ DestroyRibbonHelpMenuItem()

virtual void CFxUI::DestroyRibbonHelpMenuItem ( CFxUIRibbonHelpMenuItem * pHelpMenuItem )

pure virtual

Description: Destroys the ribbon help menu item described by pHelpMenuItem. Arguments:

Parameters

[in,out] pHelpMenuItem If non-null, the item.

◆ DestroyRibbonPanelItem()

virtual void CFxUI::DestroyRibbonPanelItem ( CFxUIRibbonPanel * pPanel )

pure virtual

Description: Destroys the ribbon panel described by pPanel. Arguments:

Parameters

[in,out] pItem If non-null, the panel.

◆ DestroyRibbonQuickAccessBar()

virtual void CFxUI::DestroyRibbonQuickAccessBar ( CFxUIRibbonQuickAccessBar * pQuickAccessBar )

pure virtual

Description: Destroys the ribbon quick access bar described by pQuickAccessBar. Arguments:

Parameters

[in,out] pQuickAccessBar If non-null, the item.

◆ DestroyRibbonQuickAccessBarItem()

virtual void CFxUI::DestroyRibbonQuickAccessBarItem ( CFxUIRibbonQuickAccessBarItem * pQuickAccessBarItem )

pure virtual

Description: Destroys the ribbon quick access bar item described by pQuickAccessBarItem. Arguments:

Parameters

[in,out] pQuickAccessBarItem If non-null, the item.

◆ DestroyRibbonRowElementItem()

virtual void CFxUI::DestroyRibbonRowElementItem ( CFxUIRibbonRowItem * pItem )

pure virtual

Description: Destroys the ribbon row item described by pItem. Arguments:

Parameters

[in,out] pItem If non-null, the item.

◆ DestroyRibbonRowItem()

virtual void CFxUI::DestroyRibbonRowItem ( CFxUIRibbonRow * pRow )

pure virtual

Description: Destroys the ribbon row described by pRow. Arguments:

Parameters

[in,out] pItem If non-null, the row.

◆ DestroyRibbonSystemMenuItem()

virtual void CFxUI::DestroyRibbonSystemMenuItem ( CFxUIRibbonSystemMenuItem * pSystemMenuItem )

pure virtual

Description: Destroys the ribbon system menu item described by pSystemMenuItem. Arguments:

Parameters

[in,out] pSystemMenuItem If non-null, the item.

◆ DestroyRibbonTabItem()

virtual void CFxUI::DestroyRibbonTabItem ( CFxUIRibbonTab * pTab )

pure virtual

Description: Destroys the ribbon tab described by pTab. Arguments:

Parameters

[in,out] pItem If non-null, the tab.

◆ DestroyRuntimeItemDefinition()

virtual void CFxUI::DestroyRuntimeItemDefinition ( CFxUIItemDefinition * pDefinition )

pure virtual

◆ DestroyRuntimeMenuItem()

virtual void CFxUI::DestroyRuntimeMenuItem ( CFxUIMenuItem * pItem )

pure virtual

◆ DestroyRuntimeToolbar()

virtual void CFxUI::DestroyRuntimeToolbar ( const CFxString & sObjectName )

pure virtual

Description: Destroys the runtime toolbar described by sObjectName. Arguments:

Parameters

sObjectName Name of the object.

◆ DestroyRuntimeToolbarItem()

virtual void CFxUI::DestroyRuntimeToolbarItem ( CFxUIToolbarItem * pItem )

pure virtual

◆ DestroyTabletMenu()

virtual void CFxUI::DestroyTabletMenu ( CFxUITabletMenu * pItem )

pure virtual

Description: Destroys the tablet menu described by pItem. Arguments:

Parameters

[in,out] pItem If non-null, the item.

◆ DestroyTempOverrideKey()

virtual void CFxUI::DestroyTempOverrideKey ( CFxUITempOverrideKey * pItem )

pure virtual

Description: Destroys the temporary override key described by pItem. Arguments:

Parameters

[in,out] pItem If non-null, the item.

◆ DestroyToolbarItem()

virtual void CFxUI::DestroyToolbarItem ( CFxUIToolbarItem * pItem )

pure virtual

Description: Destroys the toolbar item described by pItem. Arguments:

Parameters

[in,out] pItem If non-null, the item.

◆ DisplayContextMenu()

virtual bool CFxUI::DisplayContextMenu ( )

pure virtual

◆ FindItem()

virtual CFxUIItemDefinition * CFxUI::FindItem	(	const CFxString &	uiGroup,
		const CFxString &	id
	)

pure virtual

Description: Searches for the first item. Arguments:

Parameters

uiGroup	Group the user interface belongs to.
id	The identifier.

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

◆ GetCurrentWorkspace()

virtual CFxUIWorkspace * CFxUI::GetCurrentWorkspace ( )

pure virtual

Description: Gets the current workspace.

Return Value: null if it fails, else the current workspace.

◆ GetGroup()

virtual CFxUIGroup * CFxUI::GetGroup ( const CFxString & name )

pure virtual

Description: Gets a group. Arguments:

Parameters

name The name.

Return Value: null if it fails, else the group.

◆ GetStartUpGroup()

virtual CFxUIGroup * CFxUI::GetStartUpGroup ( )

pure virtual

Description: Returns pointer to StartUp UI group (no document open).

Return Value: null if it fails, else group pointer.

◆ GetStartUpWorkspace()

virtual CFxUIWorkspace * CFxUI::GetStartUpWorkspace ( )

pure virtual

Description: Returns pointer to StartUp workspace (no document open).

Return Value: null if it fails, else workspace pointer.

◆ GetVisibleMenuCollection()

virtual CFxUIMenuItemCollection * CFxUI::GetVisibleMenuCollection ( )

pure virtual

◆ GetVisibleRibbonHelpMenu()

virtual CFxUIRibbonHelpMenuItemCollection * CFxUI::GetVisibleRibbonHelpMenu ( )

pure virtual

◆ GetVisibleRibbonQuickAccessBar()

virtual CFxUIRibbonQuickAccessBar * CFxUI::GetVisibleRibbonQuickAccessBar ( )

pure virtual

◆ GetVisibleRibbonSystemMenu()

virtual CFxUIRibbonSystemMenuItem * CFxUI::GetVisibleRibbonSystemMenu ( )

pure virtual

◆ GetVisibleRibbonTabCollection()

virtual CFxUIRibbonTabCollection * CFxUI::GetVisibleRibbonTabCollection ( )

pure virtual

◆ GetVisibleToolbarCollection()

virtual CFxUIToolbarItemCollection * CFxUI::GetVisibleToolbarCollection ( )

pure virtual

◆ GetWorkspace()

virtual CFxUIWorkspace * CFxUI::GetWorkspace ( const CFxString & name )

pure virtual

Description: Gets a workspace. Arguments:

Parameters

name The name.

Return Value: null if it fails, else the workspace.

◆ LoadInterface()

virtual void CFxUI::LoadInterface ( )

pure virtual

Description: Loads the interface.

◆ LoadResourceFile()

virtual bool CFxUI::LoadResourceFile	(	const CFxString &	name,
		CFxUIGroup **	pLoadedGroup = `0`
	)

pure virtual

Description: Loads a resource file.

Parameters

name	The name.
pLoadedGroup	(optional) [in,out] If non-null, group the loaded belongs to.

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

◆ Menucmd()

virtual int CFxUI::Menucmd	(	const CFxString &	strCmd,
		CFxString &	strResult
	)

pure virtual

Description: Menucmds. Arguments:

Parameters

	strCmd	The string command.
[in,out]	strResult	The string result.

Return Value: .

◆ RemoveGroup()

virtual bool CFxUI::RemoveGroup ( const CFxString & sGroupName )

pure virtual

Description: Removes the group described by sGroupName. Arguments:

Parameters

sGroupName Name of the group.

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

◆ RemoveItemDefinition()

virtual bool CFxUI::RemoveItemDefinition ( CFxUIItemDefinition * pDefinition )

pure virtual

Description: Removes the item definition described by pDefinition. Arguments:

Parameters

[in,out] pDefinition If non-null, the definition.

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

◆ RemoveUIReactor()

virtual void CFxUI::RemoveUIReactor ( CFxUIReactor * pReactor )

pure virtual

Description: Removes the user interface reactor described by pReactor. Arguments:

Parameters

[in,out] pReactor If non-null, the reactor.

◆ RemoveUserCommandContextMenu()

virtual void CFxUI::RemoveUserCommandContextMenu	(	const CFxString &	strCommand,
		CFxUIContext *	pContext
	)

pure virtual

Description: Removes the user command context menu. Arguments:

Parameters

	strCommand	The string command.
[in,out]	pContext	If non-null, the context.

◆ RemoveUserDefaultContextMenu()

virtual void CFxUI::RemoveUserDefaultContextMenu ( CFxUIContext * pContext )

pure virtual

Description: Removes the user default context menu described by pContext. Arguments:

Parameters

[in,out] pContext If non-null, the context.

◆ RemoveUserObjectContextMenu()

virtual void CFxUI::RemoveUserObjectContextMenu	(	const CFxString &	pClass,
		CFxUIContext *	pContext
	)

pure virtual

Description: Removes the user object context menu. Arguments:

Parameters

	pClass	The class.
[in,out]	pContext	If non-null, the context.

◆ RemoveWorkspace()

virtual bool CFxUI::RemoveWorkspace ( CFxUIWorkspace * pItem )

pure virtual

Description: Removes the workspace described by pItem. Arguments:

Parameters

[in,out] pItem If non-null, the item.

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

◆ ResetEvents()

virtual void CFxUI::ResetEvents ( )

pure virtual

Description: Resets the events.

◆ SaveInterface()

virtual void CFxUI::SaveInterface ( )

pure virtual

Description: Saves the interface.

◆ SetCleanScreenState()

virtual void CFxUI::SetCleanScreenState ( bool bValue )

pure virtual

Description: Sets a clean screen state. Arguments:

Parameters

bValue true to value.

◆ SetCurrentWorkspace()

virtual void CFxUI::SetCurrentWorkspace ( CFxUIWorkspace * )

pure virtual

Description: Sets a current workspace. Arguments:

Parameters

[in,out] If non-null, the.

◆ Update()

virtual void CFxUI::Update ( bool bFullUpdate = false )

pure virtual

Description: Updates the given bFullUpdate. Arguments:

Parameters

bFullUpdate (optional) the full update.

◆ UpdateMenu()

virtual void CFxUI::UpdateMenu ( )

pure virtual

Description: Updates the menu.

◆ UpdatePanelPreview()

virtual CFxWidget * CFxUI::UpdatePanelPreview	(	CFxUIRibbonPanel *	pRibbonPanelDef,
		CFxWidget *	parent,
		CFxRibbonPreviewProxy *	pRibbonPreviewProxy,
		const CFxString &	strUID
	)

pure virtual

Description: Creates a Preview od a Ribbon Panel

◆ UpdateRibbon()

virtual void CFxUI::UpdateRibbon ( )

pure virtual

Description: Updates the ribbon.

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

FxUI.h

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ ButtonType

◆ MenuType

◆ NavigationToolbarType

◆ Orientation

◆ ToolbarType

Member Enumeration Documentation

◆ _ButtonType

◆ _MenuType

◆ _NavigationToolbarType

◆ _Orientation

◆ _ToolbarType

Constructor & Destructor Documentation

◆ ~CFxUI()

Member Function Documentation

◆ AddGroup()

◆ AddUIReactor()

◆ AddUserCommandContextMenu()

◆ AddUserDefaultContextMenu()

◆ AddUserObjectContextMenu()

◆ AddWorkspace()

◆ CheckEvents()

◆ CreateAccelerator()

◆ CreateDoubleClickAction()

◆ CreateGroup()

◆ CreateGroupIterator()

◆ CreateImageItem()

◆ CreateItemDefinition()

◆ CreateMenuItem()

◆ CreateMouseButton()

◆ CreateRibbonHelpMenuItem()

◆ CreateRibbonPanelItem()

◆ CreateRibbonQuickAccessBar()

◆ CreateRibbonQuickAccessBarItem()

◆ CreateRibbonRowElementItem()

◆ CreateRibbonRowItem()

◆ CreateRibbonSystemMenuItem()

◆ CreateRibbonTabItem()

◆ CreateRuntimeGroup()

◆ CreateRuntimeItemDefinition()

◆ CreateRuntimeMenuItem()

◆ CreateRuntimeToolbar() [1/2]

◆ CreateRuntimeToolbar() [2/2]

◆ CreateRuntimeToolbarItem()

◆ CreateTabletMenu()

◆ CreateTempOverrideKey()

◆ CreateToolbarItem()

◆ CreateUniqueID()

◆ CreateWorkspace()

◆ CreateWorkspaceIterator()

◆ DestroyAccelerator()

◆ DestroyDoubleClickAction()

◆ DestroyImageItem()

◆ DestroyItemDefinition()

◆ DestroyMenuItem()

◆ DestroyMouseButton()

◆ DestroyRibbonHelpMenuItem()

◆ DestroyRibbonPanelItem()

◆ DestroyRibbonQuickAccessBar()

◆ DestroyRibbonQuickAccessBarItem()

◆ DestroyRibbonRowElementItem()

◆ DestroyRibbonRowItem()

◆ DestroyRibbonSystemMenuItem()

◆ DestroyRibbonTabItem()

◆ DestroyRuntimeItemDefinition()

◆ DestroyRuntimeMenuItem()

◆ DestroyRuntimeToolbar()

◆ DestroyRuntimeToolbarItem()

◆ DestroyTabletMenu()

◆ DestroyTempOverrideKey()

◆ DestroyToolbarItem()

◆ DisplayContextMenu()

◆ FindItem()

◆ GetCurrentWorkspace()

◆ GetGroup()

◆ GetStartUpGroup()

◆ GetStartUpWorkspace()