OpendTect-6_4  6.4
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
uiIOObjSel Class Reference

User Interface (UI) element for selection of IOObjs. More...

Inheritance diagram for uiIOObjSel:
[legend]

Classes

class  Setup
 

Public Member Functions

 uiIOObjSel (uiParent *, const IOObjContext &, const uiString &seltxt=uiString::emptyString())
 
 uiIOObjSel (uiParent *, const IOObjContext &, const Setup &)
 
 ~uiIOObjSel ()
 
void setInput (const IOObj &)
 
void setInput (const MultiID &)
 
virtual void setEmpty ()
 
MultiID key (bool noerr=false) const
 
const IOObjioobj (bool noerr=false) const
 
IOObjgetIOObj (bool noerr=false)
 My IOObj becomes yours. More...
 
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 ()
 only if forread More...
 
void setConfirmOverwrite (bool yn)
 
void setHelpKey (const HelpKey &helpkey)
 
virtual void updateInput ()
 a.o. updates from CtxtIOObj More...
 
virtual void processInput ()
 
virtual bool existingTyped () const
 
virtual MultiID validKey () const
 no side-effects More...
 
virtual uiObjectendObj (bool left)
 
 uiIOObjSel (uiParent *, CtxtIOObj &, const uiString &seltxt=uiString::emptyString())
 
 uiIOObjSel (uiParent *, CtxtIOObj &, const Setup &)
 
bool commitInput ()
 
bool doCommitInput (bool &)
 
CtxtIOObjctxtIOObj (bool work=false)
 
- Public Member Functions inherited from uiIOSelect
 uiIOSelect (uiParent *, const Setup &, const CallBack &)
 
 ~uiIOSelect ()
 
void addExtSelBut (uiButton *)
 
bool isEmpty () const
 
const char * getInput () const
 
const char * getKey () const
 
void setInput (const char *key)
 Will fetch user name using userNameFromKey. More...
 
void setInputText (const char *)
 As if user typed it manually. More...
 
void setEntries (const BufferStringSet &keys, const BufferStringSet &names)
 
int nrItems () const
 
int getCurrentItem () const
 
void setCurrentItem (int)
 
const char * getItem (int) const
 
bool isChecked () const
 only useful when optional_ More...
 
void setChecked (bool yn)
 does something when optional_ More...
 
virtual void updateHistory (IOPar &) const
 
virtual void getHistory (const IOPar &)
 
void addToHistory (const char *)
 
void addToHistory (const BufferStringSet &)
 
void setReadOnly (bool readonly=true)
 
void doSel (CallBacker *)
 
const uiStringlabelText () const
 
void setLabelText (const uiString &)
 
void setLabelSelectable (bool yn=true)
 
void setHSzPol (uiObject::SzPolicy)
 
uiComboBoxinpBox ()
 
- Public Member Functions inherited from uiGroup
 uiGroup (uiParent *, const char *nm="uiGroup", bool manage=true)
 
virtual ~uiGroup ()
 
 operator const uiGroupObj * () const
 
 operator uiGroupObj * ()
 
 operator const uiObject & () const
 
 operator uiObject & ()
 
uiObjectattachObj ()
 
const uiObjectattachObj () const
 
uiParentparent ()
 
const uiParentparent () const
 
void setHSpacing (int)
 
void setVSpacing (int)
 
void setSpacing (int s=0)
 
void setBorder (int)
 
void setFrame (bool yn=true)
 
void setNoBackGround ()
 
uiObjecthAlignObj ()
 
void setHAlignObj (uiObject *o)
 
void setHAlignObj (uiGroup *o)
 
uiObjecthCenterObj ()
 
void setHCenterObj (uiObject *o)
 
void setHCenterObj (uiGroup *o)
 
void setIsMain (bool)
 internal use only. Tells the layout manager it's a toplevel mngr. More...
 
virtual uiMainWinmainwin ()
 
void setChildrenSensitive (bool)
 
virtual Notifier< uiBaseObject > & preFinalise ()
 
virtual Notifier< uiBaseObject > & postFinalise ()
 
virtual void setSize (const uiSize &)
 
- Public Member Functions inherited from uiParent
 uiParent (const char *nm, uiParentBody *)
 
void addChild (uiBaseObject &)
 
void manageChld (uiBaseObject &, uiObjectBody &)
 
void attachChild (constraintType tp, uiObject *child, uiObject *other, int margin, bool reciprocal)
 
const ObjectSet< uiBaseObject > * childList () const
 
uiObjectmainObject ()
 
const uiObjectmainObject () const
 
uiParentBodypbody ()
 
const uiParentBodypbody () const
 
void attach (constraintType t, int margin=-1)
 
void attach (constraintType t, uiParent *oth, int margin=-1, bool reciprocal=true)
 
void attach (constraintType t, uiObject *oth, int margin=-1, bool reciprocal=true)
 
virtual void display (bool yn, bool shrk=false, bool maximize=false)
 
bool isDisplayed () const
 
void setFocus ()
 
bool hasFocus () const
 
void setSensitive (bool yn=true)
 
bool sensitive () const
 
const uiFontfont () const
 
void setFont (const uiFont &f)
 
void setCaption (const uiString &c)
 
void setCursor (const MouseCursor &c)
 
uiSize actualsize (bool include_border) const
 
int prefHNrPics () const
 
int prefVNrPics () const
 
void setPrefHeight (int h)
 
void setPrefWidth (int w)
 
void setPrefHeightInChar (int h)
 
void setPrefHeightInChar (float h)
 
void setPrefWidthInChar (float w)
 
void setPrefWidthInChar (int w)
 
virtual void reDraw (bool deep)
 
void shallowRedraw (CallBacker *=0)
 
void deepRedraw (CallBacker *=0)
 
void setStretch (int h, int v)
 
Color backgroundColor () const
 
Color roBackgroundColor () const
 
void setBackgroundColor (const Color &c)
 
void translateText ()
 

Static Public Member Functions

static IOObjContext getWriteIOObjCtxt (IOObjContext)
 
- Static Public Member Functions inherited from uiGroup
static uiGroupgtDynamicCastToGrp (mQtclass(QWidget *))
 

Protected Member Functions

void preFinaliseCB (CallBacker *)
 
void doObjSel (CallBacker *)
 
void objInserted (CallBacker *)
 
void survChangedCB (CallBacker *)
 
void initRead ()
 
virtual const char * userNameFromKey (const char *) const
 
virtual void objSel ()
 notification when user selects from combo More...
 
virtual void commitSucceeded ()
 
virtual void fillDefault ()
 
virtual void newSelection (uiIOObjRetDlg *)
 
virtual uiIOObjRetDlgmkDlg ()
 
virtual IOObjcreateEntry (const char *)
 
void obtainIOObj ()
 
bool existingUsrName (const char *) const
 
void doCommit (bool) const
 
- Protected Member Functions inherited from uiIOSelect
void optCheck (CallBacker *)
 
void selDone (CallBacker *)
 
int nrSpec () const
 
void checkState () const
 
void updateFromEntries ()
 
bool haveEntry (const char *) const
 
void doFinalise (CallBacker *)
 
- Protected Member Functions inherited from uiGroup
virtual uiObjectmainobject ()
 
virtual void attach_ (constraintType, uiObject *oth, int margin=-1, bool reciprocal=true)
 
virtual void reDraw_ (bool deep)
 
void setShrinkAllowed (bool)
 
bool shrinkAllowed ()
 
void bodyDel (CallBacker *)
 
void uiobjDel (CallBacker *)
 
void setFrameStyle (int)
 
void reSizeChildren (const uiObject *, float, float)
 

Protected Attributes

uiIOObjSelWriteTranslatorwrtrselfld_
 
CtxtIOObjinctio_
 
CtxtIOObjworkctio_
 
Setup setup_
 
HelpKey helpkey_
 
bool inctiomine_
 
ObjectSet< uiIOObjInserterinserters_
 
- Protected Attributes inherited from uiIOSelect
BufferStringSet entries_
 
bool haveempty_
 
bool selok_
 
bool keepmytxt_
 
CallBack doselcb_
 
uiComboBoxinp_
 
uiButton * selbut_
 
ObjectSet< uiButton > extselbuts_
 
uiLabellbl_
 
uiCheckBoxoptbox_
 
- Protected Attributes inherited from uiGroup
uiGroupObjgrpobj_
 
uiGroupParentBodybody_
 

Private Member Functions

 mODTextTranslationClass (uiIOObjSel)
 
void init ()
 

Additional Inherited Members

- Public Attributes inherited from uiIOSelect
Notifier< uiIOSelectselectionDone
 
Notifier< uiIOSelectoptionalChecked
 

Detailed Description

User Interface (UI) element for selection of IOObjs.

User gets the possibility to select an object of a certain type.

If nothing is selected, an error will be generated if setup.mandatory_ is true. This is the default. Thus, you can simply do, in acceptOK(): const IOObj* theobj = theselfld_->ioobj(); if ( !theobj ) return false;

Constructor & Destructor Documentation

uiIOObjSel::uiIOObjSel ( uiParent ,
const IOObjContext ,
const uiString seltxt = uiString::emptyString() 
)
uiIOObjSel::uiIOObjSel ( uiParent ,
const IOObjContext ,
const Setup  
)
uiIOObjSel::~uiIOObjSel ( )
uiIOObjSel::uiIOObjSel ( uiParent ,
CtxtIOObj ,
const uiString seltxt = uiString::emptyString() 
)
uiIOObjSel::uiIOObjSel ( uiParent ,
CtxtIOObj ,
const Setup  
)

Member Function Documentation

bool uiIOObjSel::commitInput ( )
virtual void uiIOObjSel::commitSucceeded ( )
inlineprotectedvirtual

Reimplemented in uiSeisSel.

virtual IOObj* uiIOObjSel::createEntry ( const char *  )
protectedvirtual
CtxtIOObj& uiIOObjSel::ctxtIOObj ( bool  work = false)
inline
void uiIOObjSel::doCommit ( bool  ) const
protected
bool uiIOObjSel::doCommitInput ( bool &  )
void uiIOObjSel::doObjSel ( CallBacker )
protected
virtual uiObject* uiIOObjSel::endObj ( bool  left)
virtual

Reimplemented from uiIOSelect.

virtual bool uiIOObjSel::existingTyped ( ) const
inlinevirtual

returns false is typed input is not an existing IOObj name

Reimplemented in uiSeisSel.

bool uiIOObjSel::existingUsrName ( const char *  ) const
protected
virtual void uiIOObjSel::fillDefault ( )
protectedvirtual

Reimplemented in uiVelSel, and uiSeisSel.

void uiIOObjSel::fillEntries ( )

only if forread

virtual bool uiIOObjSel::fillPar ( IOPar ) const
virtual

Reimplemented in uiSeisSel.

bool uiIOObjSel::fillPar ( IOPar ,
const char *  baseky 
) const
IOObj* uiIOObjSel::getIOObj ( bool  noerr = false)

My IOObj becomes yours.

static IOObjContext uiIOObjSel::getWriteIOObjCtxt ( IOObjContext  )
static
void uiIOObjSel::init ( )
private
void uiIOObjSel::initRead ( )
protected
const IOObj* uiIOObjSel::ioobj ( bool  noerr = false) const
MultiID uiIOObjSel::key ( bool  noerr = false) const
virtual uiIOObjRetDlg* uiIOObjSel::mkDlg ( )
protectedvirtual

Reimplemented in uiSeisSel.

uiIOObjSel::mODTextTranslationClass ( uiIOObjSel  )
private
virtual void uiIOObjSel::newSelection ( uiIOObjRetDlg )
inlineprotectedvirtual

Reimplemented in uiSeisSel.

void uiIOObjSel::objInserted ( CallBacker )
protected
virtual void uiIOObjSel::objSel ( )
protectedvirtual

notification when user selects from combo

Reimplemented from uiIOSelect.

void uiIOObjSel::obtainIOObj ( )
protected
void uiIOObjSel::preFinaliseCB ( CallBacker )
protected
virtual void uiIOObjSel::processInput ( )
virtual

Match user typing with existing IOObjs, then set item accordingly

Reimplemented from uiIOSelect.

Reimplemented in uiSeisSel.

void uiIOObjSel::setConfirmOverwrite ( bool  yn)
inline
virtual void uiIOObjSel::setEmpty ( )
virtual

Reimplemented from uiIOSelect.

void uiIOObjSel::setHelpKey ( const HelpKey helpkey)
inline
void uiIOObjSel::setInput ( const IOObj )
void uiIOObjSel::setInput ( const MultiID )
void uiIOObjSel::survChangedCB ( CallBacker )
protected
virtual void uiIOObjSel::updateInput ( )
virtual

a.o. updates from CtxtIOObj

Reimplemented in uiSeisSel.

virtual void uiIOObjSel::usePar ( const IOPar )
virtual

Reimplemented in uiSeisSel.

void uiIOObjSel::usePar ( const IOPar ,
const char *  baseky 
)
virtual const char* uiIOObjSel::userNameFromKey ( const char *  s) const
protectedvirtual

If 0 returned, then if possible, that entry is not entered in the entries_.

Reimplemented from uiIOSelect.

Reimplemented in uiSeisSel.

virtual MultiID uiIOObjSel::validKey ( ) const
virtual

no side-effects

Member Data Documentation

HelpKey uiIOObjSel::helpkey_
protected
CtxtIOObj& uiIOObjSel::inctio_
protected
bool uiIOObjSel::inctiomine_
protected
ObjectSet<uiIOObjInserter> uiIOObjSel::inserters_
protected
Setup uiIOObjSel::setup_
protected
CtxtIOObj& uiIOObjSel::workctio_
protected
uiIOObjSelWriteTranslator* uiIOObjSel::wrtrselfld_
protected

Generated at for the OpendTect seismic interpretation project. Copyright (C): dGB Beheer B. V. 2019