uiioobjsel.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:          April 2001
 RCS:           $Id$
________________________________________________________________________
 
-*/
 
#include "uiiomod.h"
#include "uiiosel.h"
#include "helpview.h"
 
class IOObj;
class CtxtIOObj;
class IOObjContext;
class uiIOObjRetDlg;
class uiIOObjInserter;
class uiIOObjSelWriteTranslator;
 
 
mExpClass(uiIo) uiIOObjSel : public uiIOSelect
{ mODTextTranslationClass(uiIOObjSel);
public:
 
    mExpClass(uiIo) Setup : public uiIOSelect::Setup
    {
    public:
                        Setup(const uiString& seltxt=uiString::empty())
                            : uiIOSelect::Setup(seltxt)
                            , confirmoverwr_(true)
                            , withinserters_(true)
                            , withwriteopts_(true)
                            , filldef_(true)            {}
 
        mDefSetupMemb(bool,confirmoverwr)
        mDefSetupMemb(bool,withinserters) 
        mDefSetupMemb(bool,withwriteopts) 
        mDefSetupMemb(bool,filldef)     
 
        mDeprecated     ("Use uiString" )
                        Setup( const char * txt )
                          : Setup(toUiString(txt))              {}
    };
 
                        uiIOObjSel(uiParent*,const IOObjContext&,
                               const uiString& seltxt=uiString::empty());
                        uiIOObjSel(uiParent*,const IOObjContext&,const Setup&);
                        uiIOObjSel(uiParent*,
                                const BufferStringSet& trnotallowed,
                                const IOObjContext&,
                               const uiString& seltxt=uiString::empty());
                        uiIOObjSel(uiParent*,const IOObjContext&,
                            const BufferStringSet& trnotallowed,const Setup&);
                        ~uiIOObjSel();
 
    void                setTrNotAllowed(const BufferStringSet&);
    const BufferStringSet&      getTrNotAllowed() const;
 
    void                setInput(const IOObj&);
    void                setInput(const MultiID&);
    virtual void        setEmpty();
 
    MultiID             key(bool noerr=false) const;
    const IOObj*        ioobj(bool noerr=false) const;
    IOObj*              getIOObj(bool noerr=false); 
 
    virtual bool        fillPar(IOPar&) const;
    bool                fillPar(IOPar&,const char* baseky) const;
    virtual void        usePar(const IOPar&);
    void                usePar(const IOPar&,const char* baseky);
 
    void                fillEntries(); 
    void                setConfirmOverwrite( bool yn )
                                        { setup_.confirmoverwr_ = yn; }
    void                setHelpKey(const HelpKey& helpkey) { helpkey_=helpkey; }
 
    virtual void        updateInput();  
    virtual void        processInput(); 
    virtual bool        existingTyped() const
                                        { return existingUsrName(getInput()); }
 
    virtual MultiID     validKey() const; 
    virtual uiObject*   endObj(bool left);
 
    static IOObjContext getWriteIOObjCtxt(IOObjContext);
 
protected:
 
    uiIOObjSelWriteTranslator* wrtrselfld_;
 
    CtxtIOObj&          inctio_;
    CtxtIOObj&          workctio_;
    Setup               setup_;
    HelpKey             helpkey_;
    bool                inctiomine_;
    ObjectSet<uiIOObjInserter> inserters_;
 
    void                preFinaliseCB(CallBacker*);
    void                doObjSel(CallBacker*);
    void                objInserted(CallBacker*);
    void                survChangedCB(CallBacker*);
    void                optCheckCB(CallBacker*);
    void                initRead();
 
    virtual const char* userNameFromKey(const char*) const;
    virtual void        objSel();
    virtual void        commitSucceeded()                       {}
 
    virtual void        fillDefault();
    virtual void        newSelection(uiIOObjRetDlg*)            {}
    virtual uiIOObjRetDlg* mkDlg();
    virtual IOObj*      createEntry(const char*);
    void                obtainIOObj();
    bool                existingUsrName(const char*) const;
    void                doCommit(bool) const;
 
private:
 
    void                init();
 
public: // old style
 
    /* Comments for old style only:
On creation, the object makes a copy of your CtxtIOObj. When needed, you can do
commitInput() to get the selection in your input CtxtIOObj;
 
You *have* to do commitInput() to get any selection! Other functions like
processInput() are special stuff for special situations.
 
You have to check commitInput() and issue and error message if necessary. In
the new style, this is done if the setup.optional_ flag is false (this is the
default).
*/
 
                        uiIOObjSel(uiParent*,CtxtIOObj&,
                                const uiString& seltxt=uiString::empty());
                        uiIOObjSel(uiParent*,CtxtIOObj&,const Setup&);
                        uiIOObjSel(uiParent*,
                        const BufferStringSet& trnotallowed,
                        CtxtIOObj&,const uiString& seltxt=uiString::empty());
                        uiIOObjSel(uiParent*,CtxtIOObj&,
                        const BufferStringSet& trnotallowed,const Setup&);
    bool                commitInput();
    bool                doCommitInput(bool&);
    CtxtIOObj&          ctxtIOObj( bool work=false )
                                        { return work ? workctio_ : inctio_; }
 
                        mDeprecated("Use uiString")
                        uiIOObjSel( uiParent* p, CtxtIOObj& ctxt,
                                    const char* seltxt )
                            : uiIOObjSel(p,ctxt,toUiString(seltxt))
                        {}
 
};
 
 
#define mWriteIOObjContext(clss) \
    uiIOObjSel::getWriteIOObjCtxt(mIOObjContext(clss))
#define mRWIOObjContext(clss,forread) \
    (forread ? mIOObjContext(clss) : mWriteIOObjContext(clss))