uimsg.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. Bril
 Date:          26/04/2000
________________________________________________________________________

-*/

#include "uibasemod.h"
#include "gendefs.h"
#include "uistring.h"
#include "uiparent.h"
#include "typeset.h"
class uiMainWin;
class uiStatusBar;
mFDQtclass(QWidget)
class BufferStringSet;
class FileMultiString;
class uiString;


mExpClass(uiBase) uiMsg : public CallBacker
{ mODTextTranslationClass(uiMsg)

friend class uiMain;
mGlobal(uiBase) friend uiMsg& uiMSG();

public:

    // Messages
    bool        message(const uiString&,
                        const uiString& part2=uiString::emptyString(),
                        const uiString& part3=uiString::emptyString(),
                        bool withdontshowagain=false);
    bool        warning(const uiString&,
                        const uiString& part2=uiString::emptyString(),
                        const uiString& part3=uiString::emptyString(),
                        bool withdontshowagain=false);
    void        warning(const uiRetVal&);
    void        handleWarnings(const uiRetVal&); 
    bool        error(const uiString&,
                      const uiString& part2=uiString::emptyString(),
                      const uiString& part3=uiString::emptyString(),
                      bool withdontshowagain=false);
    void        error(const uiRetVal&);
    void        handleErrors(const uiRetVal&); 
    void        errorWithDetails(const FileMultiString&);
    void        errorWithDetails(const uiStringSet&,
                                 const uiString& firstmsg);
    void        errorWithDetails(const uiStringSet&);
    void        errorWithDetails(const BufferStringSet&);

    // Interaction
    int         question(const uiString&,
                         const uiString& textyes=uiString::emptyString(),
                         const uiString& textno=uiString::emptyString(),
                         const uiString& textcncl=uiString::emptyString(),
                         const uiString& caption=uiString::emptyString(),
                         bool* dontaskagain=0);
    int         askSave(const uiString&,bool cancelbut=true);
    int         askRemove(const uiString&,bool cancelbut=false);
    int         askContinue(const uiString&);
    int         askOverwrite(const uiString&);
    int         ask2D3D(const uiString&,bool cancelbut=false);

    bool        askGoOn(const uiString&,bool withyesno=true,
                        bool* dontaskagain=0);
    bool        askGoOn(const uiString& msg,const uiString& textyes,
                        const uiString& textno,
                        bool* dontaskagain=0);
    int         askGoOnAfter(const uiString&,
                             const uiString& cnclmsg=uiString::emptyString(),
                             const uiString& textyes=uiString::emptyString(),
                             const uiString& textno=uiString::emptyString(),
                             bool* dontaskagain=0);

    static void setNextCaption(const uiString&);

    uiMainWin*  setMainWin(uiMainWin*); 

    bool        toStatusbar(uiString,int fld=0,int msec=-1);
    uiStatusBar* statusBar();

    void        about(const uiString&);
    void        aboutOpendTect(const uiString&);

    enum Icon   { NoIcon, Information, Warning, Critical, Question };
    int         showMessageBox(Icon icon,QWidget* parent,
                           const uiString& txt,const uiString& yestxtinp,
                           const uiString& notxtinp,const uiString& cncltxtinp,
                           const uiString& title=uiString::emptyString(),
                           bool* notagain=0);
    static uiString     sDontShowAgain();
    enum msgType        { WarningMsg, ErrorWithDetails, ErrorMsg, Info };
                            mDeclareEnumUtils(msgType);
    void                showMsg(uiMainWin*, msgType, const uiStringSet&);
    void                dispErrMsgCB(CallBacker*);
    void                dispWarnMsgCB(CallBacker*);
    void                errorWithDetailProc(uiStringSet&);
protected:

                        uiMsg();

    mQtclass(QWidget*)  popParnt();

    static uiMsg*       theinst_;
    Threads::Lock       lock_;
    Threads::Lock       msgdisplock_;

private:

    int                 beginCmdRecEvent( const char* wintitle );
    void                endCmdRecEvent(int refnr,int retval,const char* buttxt0,
                                const char* buttxt1=0,const char* buttxt2=0);

    uiMainWin*          uimainwin_;
};

mGlobal(uiBase) uiMsg& uiMSG();


mExpClass(uiBase) uiMsgMainWinSetter
{
public:
                        uiMsgMainWinSetter( uiMainWin* np )
                            : isset_( np )
                            , oldparent_( 0 )
                        {
                            if ( np ) oldparent_ = ::uiMSG().setMainWin( np );
                        }

                        ~uiMsgMainWinSetter()
                        { if ( isset_ ) ::uiMSG().setMainWin( oldparent_ ); }
protected:
    uiMainWin*          oldparent_;
    bool                isset_;
};