CFx SDK Documentation  2020SP3
FxMainFrame.h
Go to the documentation of this file.
1 //
2 // (C) Copyright 2005-2020 by Graebert GmbH.
3 //
4 // Permission to use, copy, modify, and distribute this software in
5 // object code form for any purpose and without fee is hereby granted,
6 // provided that the above copyright notice appears in all copies and
7 // that both that copyright notice and the limited warranty and
8 // restricted rights notice below appear in all supporting
9 // documentation.
10 //
11 // GRAEBERT PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS.
12 // GRAEBERT SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
13 // MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE. GRAEBERT GMBH
14 // DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
15 // UNINTERRUPTED OR ERROR FREE.
16 
17 #pragma once
18 
19 #include "FxPlatformSettings.h"
20 #include "FxString.h"
21 
22 #include "FxPragmaPush.h"
23 
24 class CFxStatusBar;
25 
26 class QMdiArea;
27 class QScrollBar;
28 
29 class CFxUIBaseView;
30 class CFxUIDockWidget;
32 class CFxUIToolbarItem;
39 {
40 public:
42  typedef enum _DockWidgetArea
43  {
44  LeftDockWidgetArea = 0x1,
45  RightDockWidgetArea = 0x2,
46  TopDockWidgetArea = 0x4,
47  BottomDockWidgetArea = 0x8
48  } DockableWidgetArea;
49 
51  virtual ~CFxMainFrame();
52 
56  virtual CFxStatusBar* GetStatusBar() = 0;
57 
61  virtual CFxMenuBar* GetMenuBar() = 0;
62 
66  virtual FxWId GetWindowHandle() const = 0;
67 
72 
76  virtual QMdiArea* GetWorkspace() = 0;
77 
81  virtual CFxWidget* GetCommandLine() = 0;
82 
87 
92 
96  virtual QScrollBar* GetHorizontalScroller() = 0;
97 
101  virtual QScrollBar* GetVerticalScroller() = 0;
102 
106  virtual CFxString GetInput() const = 0;
107 
111  virtual void SetInput( const CFxString& str ) = 0;
112 
116  virtual void ShowPropertiesWindow(bool bShow) = 0;
117 
121  virtual void ShowCommandWindow( bool bShow ) = 0;
122 
126  virtual void ShowMatrixToolbarWindow(bool bShow) = 0;
127 
131  virtual bool IsTextWindowVisible() const = 0;
132 
136  virtual void ClearCommandWindow() = 0;
137 
141  virtual void ShowTextWindow(bool bShow) = 0;
142 
148  virtual CFxUIDockWidget* AddDockableWidget( CFxUIBaseView* pWid, int iInitialArea, int allowedAreas,
149  const CFxString& dockFrameTitle = CFxString(),
150  const CFxString& objectName = CFxString(),
151  int iMinWidth = -1, int iMinHeight = -1,
152  int iMaxWidth = -1, int iMaxHeight = -1,
153  int iInitialWidth = -1, int iInitialHeight = -1,
154  bool bVisibleOnStartup = false, bool bForceVisibleRestart = false,
155  bool bVisibleOnNoDocument = false,
156  const CFxString& customIconResPath = CFxString()
157  ) = 0;
158 
164  virtual CFxWidget* AddDockableWidget( CFxWidget* pWid, int iInitialArea, int allowedAreas,
165  const CFxString& dockFrameTitle = CFxString(),
166  const CFxString& objectName = CFxString(),
167  int iMinWidth = -1, int iMinHeight = -1,
168  int iMaxWidth = -1, int iMaxHeight = -1,
169  int iInitialWidth = -1, int iInitialHeight = -1,
170  bool bVisibleOnStartup = false,
171  bool bForceVisibleRestart = false,
172  bool bVisibleOnNoDocument = false,
173  const CFxString& customIconResPath = CFxString()) = 0;
174 
180  virtual bool RemoveDockableWidget( CFxUIDockWidget* pDockingFrame ) = 0;
185  virtual bool RemoveDockableWidget( CFxWidget* pDockingFrame ) = 0;
186 
192  {
195 
198  };
202  virtual int GetCommandWindowInfo( CFxCommandWindowInfo& info ) const = 0;
203 
207  virtual void hideApplicationWindows(bool hide) = 0;
208 
212  virtual void SetTitleSuffix( const CFxString& suffix ) = 0;
213 
215  {
216  public:
217  virtual bool IsVisible( CFxUIToolbarItem* pToolbarDef ) = 0;
218  virtual void SetVisible( CFxUIToolbarItem* pToolbarDef, bool bVisible ) = 0;
219  virtual void SetVisible( CFxUIToolbarItemCollection* pToolbars, bool show ) = 0;
220  virtual void SaveState( CFxUIToolbarItem* pToolbarDef ) = 0;
221  };
222 
223  virtual CFxToolBars* GetToolBars() = 0;
224 };
225 
227 
228 #include "FxPragmaPop.h"
CFxUIToolbarItem
Definition: FxUI.h:2100
FxPragmaPop.h
CFxMainFrame::ShowPropertiesWindow
virtual void ShowPropertiesWindow(bool bShow)=0
CFxMainFrame::GetMenuBar
virtual CFxMenuBar * GetMenuBar()=0
CFxMainFrame::GetCommandWindowInfo
virtual int GetCommandWindowInfo(CFxCommandWindowInfo &info) const =0
CFxMainFrame::IsTextWindowVisible
virtual bool IsTextWindowVisible() const =0
CFxMainFrame::ClearCommandWindow
virtual void ClearCommandWindow()=0
CFxMainFrame::AddDockableWidget
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
CFxMainFrame::GetCommandLineWindowHandle
virtual FxWId GetCommandLineWindowHandle()=0
CFxMainFrame::hideApplicationWindows
virtual void hideApplicationWindows(bool hide)=0
FxPlatformSettings.h
CFxMainFrame::GetVerticalScroller
virtual QScrollBar * GetVerticalScroller()=0
CFxMainFrame::GetStatusBar
virtual CFxStatusBar * GetStatusBar()=0
CFxUIBaseView
Definition: FxUIBaseView.h:30
CFxMainFrame::CFxCommandWindowInfo::linesCountSecond
int linesCountSecond
Definition: FxMainFrame.h:197
CFxMainFrame::ShowCommandWindow
virtual void ShowCommandWindow(bool bShow)=0
CFxMainFrame::CFxCommandWindowInfo::linesCountMain
int linesCountMain
Definition: FxMainFrame.h:196
CFxMainFrame::GetHorizontalScroller
virtual QScrollBar * GetHorizontalScroller()=0
CFxMainFrame::SetInput
virtual void SetInput(const CFxString &str)=0
FxString.h
CFxMainFrame::CFxToolBars::SaveState
virtual void SaveState(CFxUIToolbarItem *pToolbarDef)=0
CFxMainFrame::GetToolBars
virtual CFxToolBars * GetToolBars()=0
CFxMainFrame::~CFxMainFrame
virtual ~CFxMainFrame()
fxToolBars
DDKERNEL_API CFxMainFrame::CFxToolBars * fxToolBars()
CFxMainFrame::_DockWidgetArea
_DockWidgetArea
Definition: FxMainFrame.h:43
CFxMainFrame::ShowMatrixToolbarWindow
virtual void ShowMatrixToolbarWindow(bool bShow)=0
CFxMainFrame::ShowTextWindow
virtual void ShowTextWindow(bool bShow)=0
CFxMainFrame::CFxCommandWindowInfo::visibleMain
bool visibleMain
Definition: FxMainFrame.h:193
CFxMainFrame::CFxCommandWindowInfo::visibleSecond
bool visibleSecond
Definition: FxMainFrame.h:194
CFxString
Definition: FxString.h:48
CFxMainFrame::GetWindowHandle
virtual FxWId GetWindowHandle() const =0
CFxMainFrame::SetTitleSuffix
virtual void SetTitleSuffix(const CFxString &suffix)=0
FxWId
int FxWId
Definition: FxPlatformSettings.h:42
CFxContainerWidget
#define CFxContainerWidget
Definition: FxPlatformSettings.h:110
DDKERNEL_API
#define DDKERNEL_API
Definition: DDKERNEL.h:32
CFxMainFrame::GetCommandHistoryWindowHandle
virtual FxWId GetCommandHistoryWindowHandle()=0
CFxUIToolbarItemCollection
Definition: FxUI.h:1380
CFxMainFrame::GetCommandLine
virtual CFxWidget * GetCommandLine()=0
CFxMainFrame
Definition: FxMainFrame.h:39
CFxUIDockWidget
Definition: FxUIDockWidget.h:28
CFxMenuBar
#define CFxMenuBar
Definition: FxPlatformSettings.h:102
CFxMainFrame::GetFxWidget
virtual CFxContainerWidget * GetFxWidget()=0
CFxMainFrame::CFxToolBars::IsVisible
virtual bool IsVisible(CFxUIToolbarItem *pToolbarDef)=0
CFxMainFrame::CFxToolBars::SetVisible
virtual void SetVisible(CFxUIToolbarItemCollection *pToolbars, bool show)=0
CFxStatusBar
Definition: FxStatusBar.h:32
CFxMainFrame::CFxMainFrame
CFxMainFrame()
CFxMainFrame::RemoveDockableWidget
virtual bool RemoveDockableWidget(CFxUIDockWidget *pDockingFrame)=0
CFxMainFrame::CFxToolBars
Definition: FxMainFrame.h:215
CFxMainFrame::CFxToolBars::SetVisible
virtual void SetVisible(CFxUIToolbarItem *pToolbarDef, bool bVisible)=0
CFxMainFrame::CFxCommandWindowInfo
Definition: FxMainFrame.h:192
FxPragmaPush.h
CFxMainFrame::GetInput
virtual CFxString GetInput() const =0
CFxWidget
#define CFxWidget
Definition: FxPlatformSettings.h:91
CFxMainFrame::AddDockableWidget
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
CFxMainFrame::RemoveDockableWidget
virtual bool RemoveDockableWidget(CFxWidget *pDockingFrame)=0
CFxMainFrame::GetWorkspace
virtual QMdiArea * GetWorkspace()=0