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

#include <FxMainFrame.h>

Classes

struct  CFxCommandWindowInfo
 
class  CFxToolBars
 

Public Types

enum  _DockWidgetArea { LeftDockWidgetArea = 0x1 , RightDockWidgetArea = 0x2 , TopDockWidgetArea = 0x4 , BottomDockWidgetArea = 0x8 }
 
typedef enum CFxMainFrame::_DockWidgetArea DockableWidgetArea
 

Public Member Functions

 CFxMainFrame ()
 
virtual ~CFxMainFrame ()
 
virtual CFxStatusBar * GetStatusBar ()=0
 
virtual CFxMenuBar * GetMenuBar ()=0
 
virtual FxWId GetWindowHandle () const =0
 
virtual CFxContainerWidget * GetFxWidget ()=0
 
virtual QMdiArea * GetWorkspace ()=0
 
virtual CFxWidget * GetCommandLine ()=0
 
virtual FxWId GetCommandLineWindowHandle ()=0
 
virtual FxWId GetCommandHistoryWindowHandle ()=0
 
virtual QScrollBar * GetHorizontalScroller ()=0
 
virtual QScrollBar * GetVerticalScroller ()=0
 
virtual CFxString GetInput () const =0
 
virtual void SetInput (const CFxString &str)=0
 
virtual void ShowPropertiesWindow (bool bShow)=0
 
virtual void ShowCommandWindow (bool bShow)=0
 
virtual void ShowMatrixToolbarWindow (bool bShow)=0
 
virtual bool IsTextWindowVisible () const =0
 
virtual void ClearCommandWindow ()=0
 
virtual void ShowTextWindow (bool bShow)=0
 
virtual CFxUIDockWidget * AddDockableWidget (CFxUIBaseView *pWid, int iInitialArea, int allowedAreas, const CFxString &dockFrameTitle=CFxString(), const CFxString &objectName=CFxString(), int iMinWidth=-1, int iMinHeight=-1, int iMaxWidth=-1, int iMaxHeight=-1, int iInitialWidth=-1, int iInitialHeight=-1, bool bVisibleOnStartup=false, bool bForceVisibleRestart=false, bool bVisibleOnNoDocument=false, const CFxString &customIconResPath=CFxString())=0
 
virtual CFxWidget * AddDockableWidget (CFxWidget *pWid, int iInitialArea, int allowedAreas, const CFxString &dockFrameTitle=CFxString(), const CFxString &objectName=CFxString(), int iMinWidth=-1, int iMinHeight=-1, int iMaxWidth=-1, int iMaxHeight=-1, int iInitialWidth=-1, int iInitialHeight=-1, bool bVisibleOnStartup=false, bool bForceVisibleRestart=false, bool bVisibleOnNoDocument=false, const CFxString &customIconResPath=CFxString())=0
 
virtual bool RemoveDockableWidget (CFxUIDockWidget *pDockingFrame)=0
 
virtual bool RemoveDockableWidget (CFxWidget *pDockingFrame)=0
 
virtual int GetCommandWindowInfo (CFxCommandWindowInfo &info) const =0
 
virtual void hideApplicationWindows (bool hide)=0
 
virtual void SetTitleSuffix (const CFxString &suffix)=0
 
virtual CFxToolBars * GetToolBars ()=0
 

Detailed Description

Description: Manages the main frame window. Library: DDKERNEL

Definition at line 38 of file FxMainFrame.h.

Member Typedef Documentation

◆ DockableWidgetArea

typedef enum CFxMainFrame::_DockWidgetArea CFxMainFrame::DockableWidgetArea

Represents possible values for dockable widget areas

Member Enumeration Documentation

◆ _DockWidgetArea

enum CFxMainFrame::_DockWidgetArea

Represents possible values for dockable widget areas

Enumerator
LeftDockWidgetArea 
RightDockWidgetArea 
TopDockWidgetArea 
BottomDockWidgetArea 

Definition at line 42 of file FxMainFrame.h.

Constructor & Destructor Documentation

◆ CFxMainFrame()

CFxMainFrame::CFxMainFrame ( )

◆ ~CFxMainFrame()

virtual CFxMainFrame::~CFxMainFrame ( )
virtual

Member Function Documentation

◆ AddDockableWidget() [1/2]

virtual CFxUIDockWidget* CFxMainFrame::AddDockableWidget ( CFxUIBaseView *  pWid,
int  iInitialArea,
int  allowedAreas,
const CFxString &  dockFrameTitle = CFxString(),
const CFxString &  objectName = CFxString(),
int  iMinWidth = -1,
int  iMinHeight = -1,
int  iMaxWidth = -1,
int  iMaxHeight = -1,
int  iInitialWidth = -1,
int  iInitialHeight = -1,
bool  bVisibleOnStartup = false,
bool  bForceVisibleRestart = false,
bool  bVisibleOnNoDocument = false,
const CFxString &  customIconResPath = CFxString() 
)
pure virtual

Description: Provides a dockable place for a given CommonUI widget. Use values from CFxMainFrame::DockableWidgetArea enum to specify iInitialArea and OR-combination of this enum for allowedAreas.

◆ AddDockableWidget() [2/2]

virtual CFxWidget* CFxMainFrame::AddDockableWidget ( CFxWidget *  pWid,
int  iInitialArea,
int  allowedAreas,
const CFxString &  dockFrameTitle = CFxString(),
const CFxString &  objectName = CFxString(),
int  iMinWidth = -1,
int  iMinHeight = -1,
int  iMaxWidth = -1,
int  iMaxHeight = -1,
int  iInitialWidth = -1,
int  iInitialHeight = -1,
bool  bVisibleOnStartup = false,
bool  bForceVisibleRestart = false,
bool  bVisibleOnNoDocument = false,
const CFxString &  customIconResPath = CFxString() 
)
pure virtual

Description: Provides a dockable place for a given QWidget. Use values from CFxMainFrame::DockableWidgetArea enum to specify iInitialArea and OR-combination of this enum for allowedAreas.

◆ ClearCommandWindow()

virtual void CFxMainFrame::ClearCommandWindow ( )
pure virtual

Description: Clears the command window.

◆ GetCommandHistoryWindowHandle()

virtual FxWId CFxMainFrame::GetCommandHistoryWindowHandle ( )
pure virtual

Description: Returns the Command history window handle.

◆ GetCommandLine()

virtual CFxWidget* CFxMainFrame::GetCommandLine ( )
pure virtual

Description: Returns the Command line using winbase function.

◆ GetCommandLineWindowHandle()

virtual FxWId CFxMainFrame::GetCommandLineWindowHandle ( )
pure virtual

Description: Returns the Command line window handle.

◆ GetCommandWindowInfo()

virtual int CFxMainFrame::GetCommandWindowInfo ( CFxCommandWindowInfo &  info) const
pure virtual

Description: Returns the window info of the main and second command window.

◆ GetFxWidget()

virtual CFxContainerWidget* CFxMainFrame::GetFxWidget ( )
pure virtual

Description: Returns the QWidget associated to the interface object.

◆ GetHorizontalScroller()

virtual QScrollBar* CFxMainFrame::GetHorizontalScroller ( )
pure virtual

Description: Returns the Horizontal scroller from an active document.

◆ GetInput()

virtual CFxString CFxMainFrame::GetInput ( ) const
pure virtual

Description: Returns the user input.

◆ GetMenuBar()

virtual CFxMenuBar* CFxMainFrame::GetMenuBar ( )
pure virtual

Description: Returns the current menu bar.

◆ GetStatusBar()

virtual CFxStatusBar* CFxMainFrame::GetStatusBar ( )
pure virtual

Description: Returns the bar status.

◆ GetToolBars()

virtual CFxToolBars* CFxMainFrame::GetToolBars ( )
pure virtual

◆ GetVerticalScroller()

virtual QScrollBar* CFxMainFrame::GetVerticalScroller ( )
pure virtual

Description: Returns the Vertical scroller from an active document.

◆ GetWindowHandle()

virtual FxWId CFxMainFrame::GetWindowHandle ( ) const
pure virtual

Description: Returns the window handle.

◆ GetWorkspace()

virtual QMdiArea* CFxMainFrame::GetWorkspace ( )
pure virtual

Description: Returns the QMdiArea associated to the interface object.

◆ hideApplicationWindows()

virtual void CFxMainFrame::hideApplicationWindows ( bool  hide)
pure virtual

Description: Hides the application windows for the Mac print dialog

◆ IsTextWindowVisible()

virtual bool CFxMainFrame::IsTextWindowVisible ( ) const
pure virtual

Description: Returns true if the text window has the keyboard input focus.

◆ RemoveDockableWidget() [1/2]

virtual bool CFxMainFrame::RemoveDockableWidget ( CFxUIDockWidget *  pDockingFrame)
pure virtual

Description: Removes CommonUI dockable widget from main frame. All dock widget properties will be lost and wont be saved to profile.

◆ RemoveDockableWidget() [2/2]

virtual bool CFxMainFrame::RemoveDockableWidget ( CFxWidget *  pDockingFrame)
pure virtual

Description: Removes dockable widget from main frame. All dock widget properties will be lost and wont be saved to profile.

◆ SetInput()

virtual void CFxMainFrame::SetInput ( const CFxString &  str)
pure virtual

Description: Sets the user input as a compose sequence.

◆ SetTitleSuffix()

virtual void CFxMainFrame::SetTitleSuffix ( const CFxString &  suffix)
pure virtual

Description: Sets main window title suffix.

◆ ShowCommandWindow()

virtual void CFxMainFrame::ShowCommandWindow ( bool  bShow)
pure virtual

Description: Shows/hides command window

◆ ShowMatrixToolbarWindow()

virtual void CFxMainFrame::ShowMatrixToolbarWindow ( bool  bShow)
pure virtual

Description: Shows/hides Matrix Toolbar

◆ ShowPropertiesWindow()

virtual void CFxMainFrame::ShowPropertiesWindow ( bool  bShow)
pure virtual

Description: Shows/hides properties window

◆ ShowTextWindow()

virtual void CFxMainFrame::ShowTextWindow ( bool  bShow)
pure virtual

Description: Shows/hides second input window

The documentation for this class was generated from the following file:
Generated on Fri Jan 22 2021 18:02:00