uidialog.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:          08/08/2000
 RCS:           $Id$
________________________________________________________________________
 
-*/
 
#include "uibasemod.h"
 
#include "uimainwin.h"
#include "uistrings.h"
 
#include "bufstring.h"
#include "helpview.h"
#include "od_helpids.h"
 
class uiButton;
 
#define mNoDlgTitle     uiString::empty()
#define mTODOHelpKey    HelpKey( nullptr, ::toString(-1) )
#define mNoHelpKey      HelpKey::emptyHelpKey()
 
 
mExpClass(uiBase) uiDialog : public uiMainWin
{
    friend class        uiDialogBody;
 
public:
 
    mExpClass(uiBase) Setup
    {
    public:
                        Setup( const uiString& window_title,
                               const uiString& dialog_title,
                               const HelpKey& help_key )
                        : wintitle_(window_title)
                        , dlgtitle_(dialog_title)
                        , helpkey_(help_key)
                        , videokey_(HelpKey::emptyHelpKey())
                        , savetext_(uiStrings::sSaveAsDefault())
                        , oktext_( uiStrings::sOk() )
                        , canceltext_( uiStrings::sCancel() )
                        , modal_(true) // if no parent given, always non-modal
                        , applybutton_(false)
                        , applytext_(uiStrings::sApply())
                        , savebutton_(false), savebutispush_(false)
                        , separator_(true), menubar_(false), nrstatusflds_(0)
                        , mainwidgcentered_(false), savechecked_(false)
                        , fixedsize_(false), okcancelrev_(false)
                        {}
 
        mDefSetupMemb(uiString,wintitle)
        mDefSetupMemb(uiString,dlgtitle)
        mDefSetupMemb(HelpKey,helpkey)
        mDefSetupMemb(HelpKey,videokey)
        mDefSetupMemb(uiString,savetext)
        mDefSetupMemb(uiString,oktext)
        mDefSetupMemb(uiString,canceltext)
        mDefSetupMemb(uiString,applytext)
        mDefSetupMemb(bool,modal)
        mDefSetupMemb(bool,applybutton)
        mDefSetupMemb(bool,savebutton)
        mDefSetupMemb(bool,savebutispush)
        mDefSetupMemb(bool,separator)
        mDefSetupMemb(bool,savechecked)
        mDefSetupMemb(bool,menubar)
        mDefSetupMemb(bool,mainwidgcentered)
        mDefSetupMemb(bool,fixedsize)
        mDefSetupMemb(bool,okcancelrev) 
        mDefSetupMemb(int,nrstatusflds)
 
        private:
                        Setup( const char* window_title,
                               const char* dialog_title,
                               int help_id )
                            : helpkey_(mNoHelpKey)
                        {}
 
        public:
        mDeprecated     ("Use uiString and HelpKey object")
                        Setup(const char* window_title,const char* dialog_title,
                              const char* help_key_str);
        mDeprecated     ("Use uiString")
                        Setup( const char* window_title,
                               const char* dialog_title,
                               const HelpKey& help_key )
                          : Setup(toUiString(window_title),
                                  toUiString(dialog_title),help_key)    {}
        mDeprecated     ("Use uiString")
                        Setup( const char* window_title,
                               const uiString& dialog_title,
                               const HelpKey& help_key )
                          : Setup(toUiString(window_title),dialog_title,
                                  help_key)                             {}
        mDeprecated     ("Use uiString")
                        Setup( const uiString& window_title,
                               const char* dialog_title,
                               const HelpKey& help_key )
                          : Setup(window_title,toUiString(dialog_title),
                                  help_key)                             {}
 
    };
 
    enum                Button { OK, CANCEL, APPLY, HELP, CREDITS, SAVE };
 
                        uiDialog(uiParent*,const Setup&);
    const Setup&        setup() const;
 
    int                 go();
    int                 goMinimized();
 
    void                reject(CallBacker* cb=0);
    void                accept(CallBacker* cb=0);
    enum DoneResult     { Rejected=0, Accepted=1 };
    void                done(DoneResult);
 
    void                setHSpacing(int);
    void                setVSpacing(int);
    void                setBorder(int);
 
    void                setModal(bool yn);
    bool                isModal() const;
 
    uiButton*           button( Button but );
    void                setButtonText( Button but, const uiString& txt );
 
    enum CtrlStyle      { OkAndCancel, RunAndClose, CloseOnly };
    void                setCtrlStyle(CtrlStyle);
    CtrlStyle           getCtrlStyle() const            { return ctrlstyle_; }
    void                setOkCancelText(const uiString& ok,const uiString& cnl);
    void                setOkText(const uiString&);
    void                setCancelText(const uiString&);
    void                enableSaveButton(
                            const uiString& txt=uiStrings::sSaveAsDefault());
    int                 uiResult() const;
 
    void                setButtonSensitive(Button,bool);
    void                setSaveButtonChecked(bool);
    void                setTitleText(const uiString& txt);
    bool                hasSaveButton() const;
    bool                saveButtonChecked() const;
 
    void                setSeparator(bool yn);
    bool                separator() const;
    void                setHelpKey(const HelpKey&);
    virtual HelpKey     helpKey() const;
    void                setVideoKey(const HelpKey&);
    void                setVideoKey(const HelpKey&,int idx);
    HelpKey             videoKey(int idx=0) const;
    int                 nrVideos() const;
    void                removeVideo(int);
 
    enum TitlePos       { LeftSide, CenterWin, RightSide };
    static TitlePos     titlePos();
    static void         setTitlePos(TitlePos);
 
    Notifier<uiDialog>  applyPushed;
 
protected:
 
    virtual bool        rejectOK(CallBacker*){ return true;}
    virtual bool        acceptOK(CallBacker*){ return true;}
    virtual bool        doneOK(int)          { return true; } 
 
    bool                cancelpushed_;
    CtrlStyle           ctrlstyle_;
    static TitlePos     titlepos_;
 
public:
    mDeprecated         ("Use uiString")
    void                setTitleText( const char* txt )
                        { setTitleText(toUiString(txt)); }
    mDeprecated         ("Use uiString")
    void                setOkCancelText( const char* ok,const char* cnl )
                        { setOkCancelText(toUiString(ok),toUiString(cnl)); }
    mDeprecated         ("Use uiString")
    void                setOkText( const char* txt )
                        { setOkText(toUiString(txt)); }
    mDeprecated         ("Use uiString")
    void                setCancelText( const char* txt )
                        { setCancelText(toUiString(txt)); }
    mDeprecated         ("Use with argument")
    void                done()                  { done( Rejected ); }
    mDeprecated         ("Use with enum")
    void                done( int i )           { done( DoneResult(i) ); }
    mDeprecated         ("Use with enum")
    static void         setTitlePos( int i )
                        { setTitlePos( TitlePos(i+1) ); }
 
};