FxMainFrame.h

Go to the documentation of this file.

//
// (C) Copyright 2005-2025 by Graebert GmbH.
//
// Permission to use, copy, modify, and distribute this software in
// object code form for any purpose and without fee is hereby granted, 
// provided that the above copyright notice appears in all copies and 
// that both that copyright notice and the limited warranty and
// restricted rights notice below appear in all supporting 
// documentation.
//
// GRAEBERT PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS. 
// GRAEBERT SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE.  GRAEBERT GMBH 
// DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
// UNINTERRUPTED OR ERROR FREE.
 
#pragma once
 
#include "FxPlatformSettings.h"
#include "FxString.h"
 
#include "FxPragmaPush.h"
 
class CFxStatusBar;
 
class QMdiArea;
class QScrollBar;
 
class CFxUIBaseView;
class CFxUIDockWidget;
class CFxUIToolbarItemCollection;
class CFxUIToolbarItem;
class DDKERNEL_API CFxMainFrame
{
public:
    typedef enum _DockWidgetArea
    {
        LeftDockWidgetArea = 0x1,
        RightDockWidgetArea = 0x2,
        TopDockWidgetArea = 0x4,
        BottomDockWidgetArea = 0x8
    } DockableWidgetArea;
 
    CFxMainFrame();
    virtual ~CFxMainFrame();
 
    static CFxWidget* GetMainFrameWidget();

    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(),
                                                const CFxString& description = 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(),
        const CFxString& description = CFxString() ) = 0;

 
    virtual bool RemoveDockableWidget( CFxUIDockWidget* pDockingFrame ) = 0;
    virtual bool RemoveDockableWidget( CFxWidget* pDockingFrame ) = 0;

 
    struct CFxCommandWindowInfo
    {
        bool visibleMain;
        bool visibleSecond;
 
        int linesCountMain;
        int linesCountSecond;
    };

    virtual int GetCommandWindowInfo( CFxCommandWindowInfo& info ) const = 0;

    virtual void hideApplicationWindows(bool hide) = 0;

    virtual void SetTitleSuffix( const CFxString& suffix ) = 0;
 
    class CFxToolBars
    {
    public:
        virtual bool IsVisible( CFxUIToolbarItem* pToolbarDef ) = 0;
        virtual void SetVisible( CFxUIToolbarItem* pToolbarDef, bool bVisible ) = 0;
        virtual void SetVisible( CFxUIToolbarItemCollection* pToolbars, bool show ) = 0;
        virtual void SaveState( CFxUIToolbarItem* pToolbarDef ) = 0;
    };
 
    virtual CFxToolBars* GetToolBars() = 0;
};
 
DDKERNEL_API CFxMainFrame::CFxToolBars* fxToolBars();
 
#include "FxPragmaPop.h"