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
 RCS:           $Id$
________________________________________________________________________
 
-*/
 
#include "uibasemod.h"
#include "gendefs.h"
#include "uistring.h"
class MouseCursorChanger;
class uiMainWin;
class uiStatusBar;
mFDQtclass(QWidget)
class BufferStringSet;
class FileMultiString;
class uiParent;
 
 
mExpClass(uiBase) uiMsg
{ mODTextTranslationClass(uiMsg)
 
friend class uiMain;
mGlobal(uiBase) friend uiMsg& uiMSG();
 
public:
 
    // Messages
    void        message(const uiString&,
                        const uiString& part2=uiString::emptyString(),
                        const uiString& part3=uiString::emptyString());
    bool        message(const uiString&,
                        const uiString& part2,
                        const uiString& part3,
                        bool withdontshowatain );
    void        warning(const uiString&,
                        const uiString& part2=uiString::emptyString(),
                        const uiString& part3=uiString::emptyString());
    bool        warning(const uiString&,
                        const uiString& part2,
                        const uiString& part3,
                        bool withdontshowatain );
    void        error(const uiString&,
                      const uiString& part2=uiString::emptyString(),
                      const uiString& part3=uiString::emptyString());
    bool        error(const uiString&,
                      const uiString& part2,
                      const uiString& part3,
                      bool withdontshowatain );
    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,
                         const uiString& textno,
                         const uiString& textcncl,
                         const uiString& caption,
                         bool* dontaskagain);
    int         question(const uiString&,
                         const uiString& textyes=uiString::emptyString(),
                         const uiString& textno=uiString::emptyString(),
                         const uiString& textcncl=uiString::emptyString(),
                         const uiString& caption=uiString::emptyString());
    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        askGoOn(const uiString& msg,const uiString& textyes,
                        const uiString& textno);
    int         askGoOnAfter(const uiString&,
                             const uiString& cnclmsg=uiString::emptyString(),
                             const uiString& textyes=uiString::emptyString(),
                             const uiString& textno=uiString::emptyString());
    bool        askGoOn(const uiString&,bool withyesno,
                        bool* dontaskagain);
    bool        askGoOn(const uiString& msg,const uiString& textyes,
                        const uiString& textno,
                        bool* dontaskagain);
    int         askGoOnAfter(const uiString&,
                             const uiString& cnclmsg,
                             const uiString& textyes,
                             const uiString& textno,
                             bool* dontaskagain);
    bool        showMsgNextTime(const uiString&,
                                const uiString& msg=uiString::emptyString());
 
    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());
    int         showMessageBox(Icon icon,QWidget* parent,
                           const uiString& txt,const uiString& yestxtinp,
                           const uiString& notxtinp,const uiString& cncltxtinp,
                           const uiString& title,
                           bool* notagain);
 
    static uiString     sDontShowAgain();
 
protected:
 
                        uiMsg();
 
    mQtclass(QWidget*)  popParnt();
 
    static uiMsg*       theinst_;
 
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_;
 
public:
    mDeprecated         ("Use uiString")
    void                message( const char* txt,const char* part2=nullptr,
                                 const char* part3=nullptr )
                        { message(toUiString(txt),toUiString(part2),
                                  toUiString(part3)); }
    mDeprecated         ("Use uiString")
    void                warning( const char* txt,const char* part2=nullptr,
                                 const char* part3=nullptr )
                        { warning(toUiString(txt),toUiString(part2),
                                  toUiString(part3)); }
    mDeprecated         ("Use uiString")
    void                error( const char* txt,const char* part2=nullptr,
                               const char* part3=nullptr )
                        { error(toUiString(txt),toUiString(part2),
                                toUiString(part3)); }
 
    mDeprecated         ("Use uiString")
    int                 askSave( const char* msg, bool cancelbut=true )
                        { return askSave(toUiString(msg),cancelbut); }
    mDeprecated         ("Use uiString")
    int                 askRemove( const char* msg, bool cancelbut=false )
                        { return askRemove(toUiString(msg),cancelbut); }
    mDeprecated         ("Use uiString")
    int                 askContinue( const char* msg )
                        { return askContinue(toUiString(msg)); }
    mDeprecated         ("Use uiString")
    int                 askOverwrite( const char* msg )
                        { return askOverwrite(toUiString(msg)); }
    mDeprecated         ("Use uiString")
    bool                askGoOn( const char* msg, bool withyesno=true )
                        { return askGoOn(toUiString(msg),withyesno); }
    mDeprecated         ("Use uiString")
    bool                askGoOn( const char* msg, const char* textyes,
                                 const char* textno )
                        { return askGoOn(toUiString(msg),toUiString(textyes),
                                         toUiString(textno)); }
};
 
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_;
};
 
 
 
mExpClass(uiBase) uiUserShowWait
{
public:
 
                        uiUserShowWait(uiParent*,const uiString&,int sbfld=0);
                        ~uiUserShowWait();
 
    void                setMessage(const uiString&);
    void                readyNow();
 
    uiStatusBar*        statusBar()     { return sb_; }
 
protected:
 
    uiStatusBar*        sb_;
    MouseCursorChanger* mcc_;
    const int           fldidx_;
    uiStringSet         prevmessages_;
 
};