CFx SDK Documentation  2023 SP0
Public Member Functions | Protected Member Functions | List of all members
CFxUIWorkspace Class Referenceabstract

#include <FxUI.h>

Public Member Functions

virtual const CFxStringGetName () const =0
 
virtual void SetName (const CFxString &strName)=0
 
virtual const CFxStringGetLocalizedName () const =0
 
virtual void SetLocalizedName (const CFxString &strName)=0
 
virtual const CFxStringGetFileName () const =0
 
virtual void SetFileName (const CFxString &strFileName)=0
 
virtual const CFxStringGetDescription () const =0
 
virtual void SetDescription (const CFxString &strDesc)=0
 
virtual CFxUIMenuItemCollectionGetMenus ()=0
 
virtual CFxUIToolbarItemCollectionGetToolbars ()=0
 
virtual CFxUIToolbarItemCollectionGetNavigationToolbars ()=0
 
virtual CFxUIRibbonTabCollectionGetRibbonTabs ()=0
 
virtual CFxUIDockableWindowCollectionGetDockableWindows ()=0
 
virtual bool GetStatusBarVisible () const =0
 
virtual void SetStatusBarVisible (bool bVisible)=0
 
virtual CFxUIRibbonQuickAccessBarGetRibbonQuickAccessBar ()=0
 
virtual CFxUIRibbonSystemMenuItemGetRibbonSystemMenu ()=0
 
virtual void SetRibbonQuickAccessBar (CFxUIRibbonQuickAccessBar *pQuickAccessBar, CFxString sGroupName)=0
 

Protected Member Functions

virtual ~CFxUIWorkspace ()
 

Detailed Description

Description: Represents the user interface workspace. Library: DDKERNEL

Definition at line 875 of file FxUI.h.

Constructor & Destructor Documentation

◆ ~CFxUIWorkspace()

virtual CFxUIWorkspace::~CFxUIWorkspace ( )
inlineprotectedvirtual

Definition at line 878 of file FxUI.h.

Member Function Documentation

◆ GetDescription()

virtual const CFxString& CFxUIWorkspace::GetDescription ( ) const
pure virtual

Description: Gets the description.

Return Value: The description.

◆ GetDockableWindows()

virtual CFxUIDockableWindowCollection* CFxUIWorkspace::GetDockableWindows ( )
pure virtual

Description: Gets the dockable windows.

Return Value: null if it fails, else the dockable windows.

◆ GetFileName()

virtual const CFxString& CFxUIWorkspace::GetFileName ( ) const
pure virtual

Description: Gets the file name.

Return Value: The file name.

◆ GetLocalizedName()

virtual const CFxString& CFxUIWorkspace::GetLocalizedName ( ) const
pure virtual

Description: Gets the localized name.

Return Value: The name.

◆ GetMenus()

virtual CFxUIMenuItemCollection* CFxUIWorkspace::GetMenus ( )
pure virtual

Description: Gets the menus.

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

◆ GetName()

virtual const CFxString& CFxUIWorkspace::GetName ( ) const
pure virtual

Description: Gets the name.

Return Value: The name.

◆ GetNavigationToolbars()

virtual CFxUIToolbarItemCollection* CFxUIWorkspace::GetNavigationToolbars ( )
pure virtual

Description: Gets the navigation toolbars.

Return Value: null if it fails, else the navigation toolbars.

◆ GetRibbonQuickAccessBar()

virtual CFxUIRibbonQuickAccessBar* CFxUIWorkspace::GetRibbonQuickAccessBar ( )
pure virtual

Description: Gets the ribbon quick access bar.

Return Value: null if it fails, else the quick access bar.

◆ GetRibbonSystemMenu()

virtual CFxUIRibbonSystemMenuItem* CFxUIWorkspace::GetRibbonSystemMenu ( )
pure virtual

Description: Gets the ribbon system menu.

Return Value: null if it fails, else the system menu

◆ GetRibbonTabs()

virtual CFxUIRibbonTabCollection* CFxUIWorkspace::GetRibbonTabs ( )
pure virtual

Description: Gets the ribbon tabs.

Return Value: null if it fails, else the ribbon tabs.

◆ GetStatusBarVisible()

virtual bool CFxUIWorkspace::GetStatusBarVisible ( ) const
pure virtual

Description: Gets the status bar visible.

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

◆ GetToolbars()

virtual CFxUIToolbarItemCollection* CFxUIWorkspace::GetToolbars ( )
pure virtual

Description: Gets the toolbars.

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

◆ SetDescription()

virtual void CFxUIWorkspace::SetDescription ( const CFxString strDesc)
pure virtual

Description: Sets a description. Arguments:

Parameters
strDescInformation describing the string.

◆ SetFileName()

virtual void CFxUIWorkspace::SetFileName ( const CFxString strFileName)
pure virtual

Description: Sets a file name. Arguments:

Parameters
strFileNameFile name of the string.

◆ SetLocalizedName()

virtual void CFxUIWorkspace::SetLocalizedName ( const CFxString strName)
pure virtual

Description: Sets the localized name. Arguments:

Parameters
strNameName of the string.

◆ SetName()

virtual void CFxUIWorkspace::SetName ( const CFxString strName)
pure virtual

Description: Sets a name. Arguments:

Parameters
strNameName of the string.

◆ SetRibbonQuickAccessBar()

virtual void CFxUIWorkspace::SetRibbonQuickAccessBar ( CFxUIRibbonQuickAccessBar pQuickAccessBar,
CFxString  sGroupName 
)
pure virtual

Description: Sets the ribbon quick access bar.

◆ SetStatusBarVisible()

virtual void CFxUIWorkspace::SetStatusBarVisible ( bool  bVisible)
pure virtual

Description: Sets the status bar visible. Arguments:

Parameters
bVisibletrue to show, false to hide.

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