uimainwin.h

Go to the documentation of this file.

#pragma once
 
/*+
________________________________________________________________________
 
 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        A.H. Lammertink
 Date:          31/05/2000
________________________________________________________________________
 
-*/
 
#include "uibasemod.h"
#include "uiparent.h"
#include "mousecursor.h"
#include "uistring.h"
 
mFDQtclass(QWidget)
class uiDockWin;
class uiGroup;
class uiMainWinBody;
class uiMenu;
class uiMenuBar;
class uiObject;
class uiStatusBar;
class uiToolBar;
class Timer;
class BufferStringSet;
 
mExpClass(uiBase) uiMainWin : public uiParent
{ mODTextTranslationClass(uiMainWin);
friend class uiMainWinBody;
public:
    mExpClass(uiBase) Setup
    { mODTextTranslationClass(Setup);
    public:
                        Setup( const uiString& capt )
                        : caption_(capt)
                        , icontxt_(capt)
                        , modal_(false)
                        , withmenubar_(true)
                        , deleteonclose_(true)
                        , nrstatusflds_(1)
                        {}
 
        mDefSetupMemb(uiString,caption)
        mDefSetupMemb(uiString,icontxt)
        mDefSetupMemb(bool,modal)
        mDefSetupMemb(bool,withmenubar)
        mDefSetupMemb(bool,deleteonclose)
        mDefSetupMemb(int,nrstatusflds)
    };
 
                        uiMainWin(uiParent*,const uiMainWin::Setup&);
                        uiMainWin(uiParent*,const uiString&
                                  caption=uiString::emptyString(),
                                  int nrstatusflds=1,bool withmenubar=true,
                                  bool modal=false);
    virtual             ~uiMainWin();
 
    enum Dock
    {
        Top,        
        Bottom,     
        Right,      
        Left,       
        Minimized,  
        TornOff,        
        Unmanaged       
    };
 
    uiStatusBar*        statusBar();
    uiMenuBar*          menuBar();
 
    static uiMainWin*   activeWindow();
 
    void                setCaption(const uiString&);
    const uiString&     caption(bool unique=false) const;
    void                setIcon(const uiPixmap&);
    void                setIconText(const uiString&);
 
    bool                showMinMaxButtons(bool yn=true);
    bool                showAlwaysOnTop(bool yn=true);
                        /* Return if changed. Will hide the dialog
                           if finalised and already shown */
    void                showAndActivate();
                        /* Only for windows already shown before */
    void                setActivateOnFirstShow(bool yn=true);
                        /* Activates the window once after its
                           first pops-up */
    void                activate();
 
    virtual void        show();
    void                close();
    void                raise();
    void                forceClose();
 
    void                showMaximized();
    void                showMinimized();
    void                showNormal();
 
    bool                isMaximized() const;
    bool                isMinimized() const;
    bool                isHidden() const;
    bool                isModal() const;
 
    void                setSensitive(bool yn);
 
    void                toStatusBar(const uiString&,int fldidx=0,int msecs=-1);
 
    virtual void        reDraw(bool deep);
    uiGroup*            topGroup();
 
    void                setShrinkAllowed(bool yn);
    bool                shrinkAllowed();
 
    void                setExitAppOnClose(bool yn);
    void                setDeleteOnClose(bool yn);
 
    void                removeDockWindow(uiDockWin*);
    void                addDockWindow(uiDockWin&,Dock);
    void                addToolBar(uiToolBar*);
    uiToolBar*          findToolBar(const char*);
    uiToolBar*          removeToolBar(uiToolBar*);
    void                addToolBarBreak();
 
    uiMenu&             getToolbarsMenu() const;
 
    const ObjectSet<uiToolBar>& toolBars() const;
    const ObjectSet<uiDockWin>& dockWins() const;
 
    Notifier<uiMainWin> windowShown;
    Notifier<uiMainWin> windowHidden;
    Notifier<uiMainWin> windowClosed;
 
    static uiMainWin*   gtUiWinIfIsBdy(mQtclass(QWidget*) mwimpl);
 
    enum PopupArea      { TopLeft, TopRight, BottomLeft, BottomRight,
                          Middle, Auto };
    void                setPopupArea( PopupArea pa )    { popuparea_ = pa; }
    PopupArea           getPopupArea() const            { return popuparea_; }
    void                setCornerPos(int x,int y);
    uiRect              geometry(bool frame=true) const;
 
    bool                poppedUp() const;
    bool                touch(); 
    bool                finalised() const;
    virtual uiMainWin*  mainwin()                       { return this; }
    mQtclass(QWidget*)          qWidget() const;
    uiParent*           parent()                        { return parent_; }
    const uiParent*     parent() const                  { return parent_; }
 
    enum   ActModalTyp  { None=0, Main, Message, File, Colour, Font, Unknown };
    static ActModalTyp  activeModalType();
    static uiMainWin*   activeModalWindow();
    static const char*  activeModalQDlgTitle();
    static const char*  activeModalQDlgButTxt(int butnr);
    static int          activeModalQDlgRetVal(int butnr);
    static void         closeActiveModalQDlg(int retval);
 
    static void         getModalSignatures(BufferStringSet&);
    static void         getTopLevelWindows(ObjectSet<uiMainWin>&,
                                           bool visibleonly=true);
 
    static uiString     uniqueWinTitle(const uiString&,
                                       mQtclass(QWidget*) forwindow=0,
                                       BufferString* addendum = 0);
 
    void                translateText();
 
 
    bool                grab(const char* filenm,int zoom=1,
                             const char* format=0,int quality=-1) const;
    static bool         grabScreen(const char* filenm,const char* format=0,
                                   int quality=-1,int screen=0);
 
    void                activateInGUIThread(const CallBack&,
                                            bool busywait=true);
    void                saveImage(const char* fnm,int w,int h,int res);
    void                saveAsPDF(const char* fnm,int w,int h,int res);
    mDeprecatedObs
    void                saveAsPS(const char* fnm,int w,int h,int res)
                        { saveAsPDF( fnm, w, h, res ); }
    Notifier<uiMainWin> activatedone;
    Notifier<uiMainWin> ctrlCPressed;
    Notifier<uiMainWin> afterPopup;
    void                copyToClipBoard();
 
    Notifier<uiMainWin> runScriptRequest;
    void                runScript(const char* filename);
    const char*         getScriptToRun() const;
 
protected:
 
    virtual bool        closeOK()       {return true;}
 
                        uiMainWin(uiString,uiParent*);
    uiObject*           mainobject();
 
    void                saveSettings();
    void                readSettings();
    void                saveAsPDF_PS(const char* fnm,int w,int h,
                                     int res);
 
    void                copyToClipBoardCB(CallBacker*);
    void                aftPopupCB(CallBacker*);
    void                languageChangeCB(CallBacker*);
    void                setForceFinalise(bool);
 
    uiMainWinBody*      body_;
    uiParent*           parent_;
    Timer*              afterpopuptimer_;
 
    PopupArea           popuparea_;
 
    void                updateCaption();
    uiString            caption_;
    uiString            uniquecaption_;
    int                 languagechangecount_;
 
    BufferString        scripttorun_;
 
private:
 
    bool                doSetWindowFlags(od_uint32 qtwinflag,bool set);
 
public:
                        // Not for casual use
    static void         programActiveWindow(uiMainWin*);
    static uiMainWin*   programmedActiveWindow();
    static void         setActivateBehaviour(OD::WindowActivationBehavior);
    static OD::WindowActivationBehavior getActivateBehaviour();
 
    mDeprecated         ("Use uiString")
    void                setCaption( const char* str )
                        { setCaption(toUiString(str)); }
};
 
 
template <class T>
void closeAndZeroPtr( T*& ptr )
{
    auto* uimw = dCast( uiMainWin*, ptr );
    if ( uimw ) uimw->forceClose();
    ptr = nullptr;
}