Classes | Public Member Functions | Protected Member Functions | Protected Attributes

uiIOObjSel Class Reference

UI element for selection of IOObjs. More...

Inheritance diagram for uiIOObjSel:
uiIOSelect uiGroup uiParent uiBaseObject NamedObject CallBacker

List of all members.

Classes

class  Setup

Public Member Functions

 uiIOObjSel (uiParent *, const IOObjContext &, const char *seltxt=0)
 uiIOObjSel (uiParent *, const IOObjContext &, const Setup &)
 ~uiIOObjSel ()
void setInput (const IOObj &)
void setInput (const MultiID &)
MultiID key (bool noerr=false) const
const IOObjioobj (bool noerr=false) const
IOObjgetIOObj (bool noerr=false)
 My IOObj becomes yours.
virtual bool fillPar (IOPar &, const char *compky=0) const
virtual void usePar (const IOPar &, const char *compky=0)
void setForRead (bool)
void setConfirmOverwrite (bool yn)
void setHelpID (const char *id)
virtual void updateInput ()
 updates from CtxtIOObj
virtual void processInput ()
virtual bool existingTyped () const
virtual MultiID validKey () const
 no side-effects
 uiIOObjSel (uiParent *, CtxtIOObj &, const char *seltxt=0)
 uiIOObjSel (uiParent *, CtxtIOObj &, const Setup &)
bool commitInput ()
bool doCommitInput (bool &)
CtxtIOObjctxtIOObj (bool work=false)

Protected Member Functions

void doObjSel (CallBacker *)
virtual const char * userNameFromKey (const char *) const
virtual void objSel ()
virtual void commitSucceeded ()
void fillDefault ()
virtual void newSelection (uiIOObjRetDlg *)
virtual uiIOObjRetDlgmkDlg ()
virtual IOObjcreateEntry (const char *)
void obtainIOObj ()
bool existingUsrName (const char *) const

Protected Attributes

CtxtIOObjinctio_
CtxtIOObjworkctio_
Setup setup_
BufferString helpid_
bool inctiomine_

Detailed Description

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 char *  seltxt = 0 
)
uiIOObjSel::uiIOObjSel ( uiParent ,
const IOObjContext ,
const Setup  
)
uiIOObjSel::~uiIOObjSel (  ) 
uiIOObjSel::uiIOObjSel ( uiParent ,
CtxtIOObj ,
const char *  seltxt = 0 
)
uiIOObjSel::uiIOObjSel ( uiParent ,
CtxtIOObj ,
const Setup  
)

Member Function Documentation

bool uiIOObjSel::commitInput (  ) 
virtual void uiIOObjSel::commitSucceeded (  )  [inline, protected, virtual]
virtual IOObj* uiIOObjSel::createEntry ( const char *   )  [protected, virtual]
CtxtIOObj& uiIOObjSel::ctxtIOObj ( bool  work = false  )  [inline]
bool uiIOObjSel::doCommitInput ( bool &   ) 
void uiIOObjSel::doObjSel ( CallBacker  )  [protected]
virtual bool uiIOObjSel::existingTyped (  )  const [inline, virtual]

returns false is typed input is not an existing IOObj name

bool uiIOObjSel::existingUsrName ( const char *   )  const [protected]
void uiIOObjSel::fillDefault (  )  [protected]
virtual bool uiIOObjSel::fillPar ( IOPar ,
const char *  compky = 0 
) const [virtual]
IOObj* uiIOObjSel::getIOObj ( bool  noerr = false  ) 

My IOObj becomes yours.

const IOObj* uiIOObjSel::ioobj ( bool  noerr = false  )  const
MultiID uiIOObjSel::key ( bool  noerr = false  )  const
virtual uiIOObjRetDlg* uiIOObjSel::mkDlg (  )  [protected, virtual]
virtual void uiIOObjSel::newSelection ( uiIOObjRetDlg  )  [inline, protected, virtual]
virtual void uiIOObjSel::objSel (  )  [protected, virtual]

Reimplemented from uiIOSelect.

void uiIOObjSel::obtainIOObj (  )  [protected]
virtual void uiIOObjSel::processInput (  )  [virtual]

Match user typing with existing IOObjs, then set item accordingly

Reimplemented from uiIOSelect.

void uiIOObjSel::setConfirmOverwrite ( bool  yn  )  [inline]
void uiIOObjSel::setForRead ( bool   ) 
void uiIOObjSel::setHelpID ( const char *  id  )  [inline]
void uiIOObjSel::setInput ( const IOObj  ) 
void uiIOObjSel::setInput ( const MultiID  ) 
virtual void uiIOObjSel::updateInput (  )  [virtual]

updates from CtxtIOObj

virtual void uiIOObjSel::usePar ( const IOPar ,
const char *  compky = 0 
) [virtual]
virtual const char* uiIOObjSel::userNameFromKey ( const char *   )  const [protected, virtual]

Reimplemented from uiIOSelect.

virtual MultiID uiIOObjSel::validKey (  )  const [virtual]

no side-effects


Member Data Documentation

bool uiIOObjSel::inctiomine_ [protected]