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

Inheritance diagram for uiIOObjSel:

Classes
class	Setup

Public Member Functions
	uiIOObjSel (uiParent *, const IOObjContext &, const Setup &)

	uiIOObjSel (uiParent *, const IOObjContext &, const uiString &seltxt=uiString::empty())

	uiIOObjSel (uiParent *, CtxtIOObj &, const Setup &)

	uiIOObjSel (uiParent *, CtxtIOObj &, const uiString &seltxt=uiString::empty())

	~uiIOObjSel ()

bool	commitInput ()

CtxtIOObj &	ctxtIOObj (bool work=false)

bool	doCommitInput (bool &)

uiObject *	endObj (bool left) override

virtual bool	existingTyped () const

void	fillEntries ()
	only if forread More...

virtual bool	fillPar (IOPar &) const

bool	fillPar (IOPar &, const char *baseky) const

IOObj *	getIOObj (bool noerr=false)
	My IOObj becomes yours. More...

const IOObj *	ioobj (bool noerr=false) const

MultiID	key (bool noerr=false) const

void	processInput () override

void	require (const char key, const char typ, bool allowempty=false)

const ZDomain::Info *	requiredZDomain () const

void	requireType (const char *, bool allowempty=false)

void	requireZDomain (const ZDomain::Info &, bool allowempty=true)

void	setConfirmOverwrite (bool yn)

void	setEmpty () override

void	setHelpKey (const HelpKey &helpkey)

void	setInput (const IOObj &)

void	setInput (const MultiID &)

virtual void	updateInput ()
	a.o. updates from CtxtIOObj More...

virtual void	usePar (const IOPar &)

void	usePar (const IOPar &, const char *baseky)

virtual MultiID	validKey () const
	no side-effects More...

Public Member Functions inherited from uiIOSelect
	uiIOSelect (uiParent *, const Setup &, const CallBack &)

	~uiIOSelect ()

void	addExtSelBut (uiButton *)

void	addToHistory (const BufferStringSet &)

void	addToHistory (const char *)

void	avoidTextValidator ()

void	doSel (CallBacker *)

int	getCurrentItem () const

virtual void	getHistory (const IOPar &)

const char *	getInput () const

const char *	getItem (int) const

const char *	getKey () const

uiComboBox *	inpBox ()

bool	isChecked () const
	only useful when optional_ More...

bool	isEmpty () const

const uiString &	labelText () const

int	nrItems () const

void	setChecked (bool yn)
	does something when optional_ More...

void	setCurrentItem (int)

void	setEntries (const BufferStringSet &keys, const BufferStringSet &names)

void	setHSzPol (uiObject::SzPolicy)

void	setInput (const char *key)
	Will fetch user name using userNameFromKey. More...

void	setInputText (const char *)
	As if user typed it manually. More...

void	setLabelSelectable (bool yn=true)

void	setLabelText (const uiString &)

void	setReadOnly (bool readonly=true)

void	setTextValidator (const BufferString &regex)

virtual void	updateHistory (IOPar &) const

Public Member Functions inherited from uiGroup
	uiGroup (uiParent , const char nm="uiGroup", bool manage=true)

virtual	~uiGroup ()

uiObject *	attachObj ()

const uiObject *	attachObj () const

uiObject *	hAlignObj ()

uiObject *	hCenterObj ()

uiMainWin *	mainwin () override

	operator const uiGroupObj * () const

	operator const uiObject & () const

	operator uiGroupObj * ()

	operator uiObject & ()

uiParent *	parent ()

const uiParent *	parent () const

Notifier< uiBaseObject > &	postFinalise () override

Notifier< uiBaseObject > &	postFinalize () override

Notifier< uiBaseObject > &	preFinalise () override

Notifier< uiBaseObject > &	preFinalize () override

void	setBorder (int l, int t, int r, int b)

void	setBorder (int)

void	setChildrenSensitive (bool)

void	setFrame (bool yn=true)

void	setHAlignObj (uiGroup *o)

void	setHAlignObj (uiObject *)

void	setHCenterObj (uiGroup *o)

void	setHCenterObj (uiObject *)

void	setHSpacing (int)

void	setIsMain (bool)
	internal use only. Tells the layout manager it's a toplevel mngr. More...

void	setNoBackGround ()

virtual void	setSize (const uiSize &)

void	setSpacing (int s=0)

void	setVSpacing (int)

Public Member Functions inherited from uiParent
uiSize	actualsize (bool inclborder=true) const

uiSize	actualSize (bool include_border) const

void	addChild (uiBaseObject &)

void	attach (constraintType t, int margin=-1)

void	attach (constraintType t, uiObject *oth, int margin=-1, bool reciprocal=true)

void	attach (constraintType t, uiParent *oth, int margin=-1, bool reciprocal=true)

void	attachChild (constraintType tp, uiObject child, uiObject other, int margin, bool reciprocal)

OD::Color	backgroundColor () const

const ObjectSet< uiBaseObject > *	childList () const

void	deepRedraw (CallBacker *=0)

virtual void	display (bool yn, bool shrk=false, bool maximize=false)

const uiFont *	font () const

bool	hasFocus () const

bool	isDisplayed () const

uiObject *	mainObject ()

const uiObject *	mainObject () const

void	manageChild (uiBaseObject &, uiObjectBody &)

uiParentBody *	pbody ()

const uiParentBody *	pbody () const

int	prefHNrPics () const

int	prefVNrPics () const

virtual void	reDraw (bool deep)

OD::Color	roBackgroundColor () const

bool	sensitive () const

void	setBackgroundColor (const OD::Color &c)

void	setCaption (const uiString &c)

void	setCursor (const MouseCursor &c)

void	setFocus ()

void	setFont (const uiFont &f)

void	setPrefHeight (int h)

void	setPrefHeightInChar (float h)

void	setPrefHeightInChar (int h)

void	setPrefWidth (int w)

void	setPrefWidthInChar (float w)

void	setPrefWidthInChar (int w)

void	setSensitive (bool yn=true)

void	setStretch (int h, int v)

void	shallowRedraw (CallBacker *=0)

int	stretch (bool h) const

void	translateText () override

Public Member Functions inherited from uiBaseObject
	uiBaseObject (const char nm, uiBody =0)

virtual	~uiBaseObject ()

int	beginCmdRecEvent (const BufferString &msg)

int	beginCmdRecEvent (const char *msg=0)

int	beginCmdRecEvent (od_uint64 id, const char *msg=0)

uiBody *	body ()

const uiBody *	body () const

void	clear ()

void	endCmdRecEvent (int refnr, const char *msg=0)

void	endCmdRecEvent (od_uint64 id, int refnr, const char *msg=0)

void	finalise ()

bool	finalised () const

void	finalize ()

bool	finalized () const

virtual QWidget *	getWidget ()

const QWidget *	getWidget () const

Public Member Functions inherited from NamedCallBacker
	NamedCallBacker (const char *nm=0)

	NamedCallBacker (const NamedCallBacker &)

virtual Notifier< NamedCallBacker > &	objectToBeDeleted () const

bool	operator== (const NamedCallBacker &oth) const

bool	operator== (const NamedObject &oth) const

Public Member Functions inherited from CallBacker
	CallBacker ()

	CallBacker (const CallBacker &)

virtual	~CallBacker ()

bool	attachCB (const NotifierAccess &, const CallBack &, bool onlyifnew=false) const

bool	attachCB (const NotifierAccess *notif, const CallBack &cb, bool onlyifnew=false) const

void	detachAllNotifiers () const
	Call from the destructor of your inherited object. More...

void	detachCB (const NotifierAccess &, const CallBack &) const

void	detachCB (const NotifierAccess *notif, const CallBack &cb) const

virtual bool	isCapsule () const

bool	isNotifierAttached (const NotifierAccess *) const
	Only for debugging purposes, don't use. More...

void	stopReceivingNotifications () const

virtual CallBacker *	trueCaller ()

Public Member Functions inherited from NamedObject
	NamedObject (const char *nm=nullptr)

	NamedObject (const NamedObject &oth)

virtual	~NamedObject ()

virtual BufferString	getName () const

bool	getNameFromPar (const IOPar &)

const name_type &	name () const override

NamedObject &	operator= (const NamedObject &)

bool	operator== (const NamedObject &oth) const

virtual void	setName (const char *nm)

Public Member Functions inherited from ObjectWithName
virtual	~ObjectWithName ()

bool	hasName (const char *nm) const

bool	hasName (const name_type &nm) const

void	putNameInPar (IOPar &) const

Static Public Member Functions
static IOObjContext	getWriteIOObjCtxt (IOObjContext)

Static Public Member Functions inherited from uiGroup
static uiGroup *	gtDynamicCastToGrp (QWidget *)

Static Public Member Functions inherited from uiBaseObject
static void	addCmdRecorder (const CallBack &)

static void	removeCmdRecorder (const CallBack &)

Static Public Member Functions inherited from CallBacker
static void	createReceiverForCurrentThread ()

static void	removeReceiverForCurrentThread ()

Protected Member Functions
virtual void	commitSucceeded ()

virtual IOObj *	createEntry (const char *)

void	doCommit (bool) const

void	doObjSel (CallBacker *)

bool	existingUsrName (const char *) const

virtual void	fillDefault ()

void	initRead ()

virtual uiIOObjRetDlg *	mkDlg ()

virtual void	newSelection (uiIOObjRetDlg *)

void	objInserted (CallBacker *)

void	objSel () override
	notification when user selects from combo More...

void	obtainIOObj ()

void	optCheckCB (CallBacker *)

void	preFinalizeCB (CallBacker *)

void	survChangedCB (CallBacker *)

const char *	userNameFromKey (const char *) const override

Protected Member Functions inherited from uiIOSelect
void	checkState () const

void	doFinalize (CallBacker *)

bool	haveEntry (const char *) const

int	nrSpec () const

void	optCheck (CallBacker *)

void	selDone (CallBacker *)

void	updateFromEntries ()

Protected Member Functions inherited from uiGroup
void	attach_ (constraintType, uiObject *oth, int margin=-1, bool reciprocal=true) override

void	bodyDel (CallBacker *)

uiObject *	mainobject () override

virtual void	reDraw_ (bool deep)

void	reSizeChildren (const uiObject *, float, float)

void	setFrameStyle (int)

void	setShrinkAllowed (bool)

bool	shrinkAllowed ()

void	uiobjDel (CallBacker *)

Protected Member Functions inherited from uiParent
	uiParent (const char nm, uiParentBody )

	~uiParent ()

Protected Member Functions inherited from uiBaseObject
void	setBody (uiBody *b)

Protected Member Functions inherited from NamedCallBacker
void	sendDelNotif () const

Protected Attributes
HelpKey	helpkey_

CtxtIOObj &	inctio_

bool	inctiomine_

ObjectSet< uiIOObjInserter >	inserters_

Setup	setup_

CtxtIOObj &	workctio_

uiIOObjSelWriteTranslator *	wrtrselfld_

Protected Attributes inherited from uiIOSelect
CallBack	doselcb_

BufferStringSet	entries_

ObjectSet< uiButton >	extselbuts_

bool	haveempty_

uiComboBox *	inp_

bool	keepmytxt_

uiLabel *	lbl_

uiCheckBox *	optbox_

uiButton *	selbut_

bool	selok_

Protected Attributes inherited from uiGroup
uiGroupParentBody *	body_

uiGroupObj *	grpobj_

Protected Attributes inherited from NamedCallBacker
Threads::Atomic< bool >	delalreadytriggered_

Notifier< NamedCallBacker >	delnotif_

Protected Attributes inherited from NamedObject
BufferString	name_

Private Member Functions
void	init ()

Additional Inherited Members
Public Types inherited from ObjectWithName
typedef OD::String	name_type

Public Attributes inherited from uiIOSelect
Notifier< uiIOSelect >	optionalChecked

Notifier< uiIOSelect >	selectionDone

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() [1/4]

uiIOObjSel::uiIOObjSel	(	uiParent *	,
		const IOObjContext &	,
		const uiString &	seltxt = `uiString::empty()`
	)

◆ uiIOObjSel() [2/4]

uiIOObjSel::uiIOObjSel	(	uiParent *	,
		const IOObjContext &	,
		const Setup &
	)

◆ ~uiIOObjSel()

uiIOObjSel::~uiIOObjSel ( )

◆ uiIOObjSel() [3/4]

uiIOObjSel::uiIOObjSel	(	uiParent *	,
		CtxtIOObj &	,
		const uiString &	seltxt = `uiString::empty()`
	)

◆ uiIOObjSel() [4/4]

uiIOObjSel::uiIOObjSel	(	uiParent *	,
		CtxtIOObj &	,
		const Setup &
	)

Member Function Documentation

◆ commitInput()

bool uiIOObjSel::commitInput ( )

◆ commitSucceeded()

virtual void uiIOObjSel::commitSucceeded ( )

inlineprotectedvirtual

Reimplemented in uiSeisSel.

◆ createEntry()

virtual IOObj* uiIOObjSel::createEntry ( const char * )

protectedvirtual

◆ ctxtIOObj()

CtxtIOObj& uiIOObjSel::ctxtIOObj ( bool work = false )

inline

◆ doCommit()

void uiIOObjSel::doCommit ( bool ) const

protected

◆ doCommitInput()

bool uiIOObjSel::doCommitInput ( bool & )

◆ doObjSel()

void uiIOObjSel::doObjSel ( CallBacker * )

protected

◆ endObj()

uiObject* uiIOObjSel::endObj ( bool left )

overridevirtual

Reimplemented from uiIOSelect.

◆ existingTyped()

virtual bool uiIOObjSel::existingTyped ( ) const

inlinevirtual

returns false is typed input is not an existing IOObj name

Reimplemented in uiSeisSel.

◆ existingUsrName()

bool uiIOObjSel::existingUsrName ( const char * ) const

protected

◆ fillDefault()

virtual void uiIOObjSel::fillDefault ( )

protectedvirtual

Reimplemented in uiVelSel, and uiSeisSel.

◆ fillEntries()

void uiIOObjSel::fillEntries ( )

only if forread

◆ fillPar() [1/2]

virtual bool uiIOObjSel::fillPar ( IOPar & ) const

virtual

Reimplemented in uiSeisSel.

◆ fillPar() [2/2]

bool uiIOObjSel::fillPar	(	IOPar &	,
		const char *	baseky
	)		const

◆ getIOObj()

IOObj* uiIOObjSel::getIOObj ( bool noerr = false )

My IOObj becomes yours.

◆ getWriteIOObjCtxt()

static IOObjContext uiIOObjSel::getWriteIOObjCtxt ( IOObjContext )

static

◆ init()

void uiIOObjSel::init ( )

private

◆ initRead()

void uiIOObjSel::initRead ( )

protected

◆ ioobj()

const IOObj* uiIOObjSel::ioobj ( bool noerr = false ) const

◆ key()

MultiID uiIOObjSel::key ( bool noerr = false ) const

◆ mkDlg()

virtual uiIOObjRetDlg* uiIOObjSel::mkDlg ( )

protectedvirtual

Reimplemented in uiSeisSel.

◆ newSelection()

virtual void uiIOObjSel::newSelection ( uiIOObjRetDlg * )

inlineprotectedvirtual

Reimplemented in uiSeisSel.

◆ objInserted()

void uiIOObjSel::objInserted ( CallBacker * )

protected

◆ objSel()

void uiIOObjSel::objSel ( )

overrideprotectedvirtual

notification when user selects from combo

Reimplemented from uiIOSelect.

◆ obtainIOObj()

void uiIOObjSel::obtainIOObj ( )

protected

◆ optCheckCB()

void uiIOObjSel::optCheckCB ( CallBacker * )

protected

◆ preFinalizeCB()

void uiIOObjSel::preFinalizeCB ( CallBacker * )

protected

◆ processInput()

void uiIOObjSel::processInput ( )

overridevirtual

Match user typing with existing IOObjs, then set item accordingly

Reimplemented from uiIOSelect.

Reimplemented in uiSeisSel.

◆ require()

void uiIOObjSel::require	(	const char *	key,
		const char *	typ,
		bool	allowempty = `false`
	)

◆ requiredZDomain()

const ZDomain::Info* uiIOObjSel::requiredZDomain ( ) const

◆ requireType()

void uiIOObjSel::requireType	(	const char *	,
		bool	allowempty = `false`
	)

◆ requireZDomain()

void uiIOObjSel::requireZDomain	(	const ZDomain::Info &	,
		bool	allowempty = `true`
	)

◆ setConfirmOverwrite()

void uiIOObjSel::setConfirmOverwrite ( bool yn )

inline

◆ setEmpty()

void uiIOObjSel::setEmpty ( )

overridevirtual

Reimplemented from uiIOSelect.

◆ setHelpKey()

void uiIOObjSel::setHelpKey ( const HelpKey & helpkey )

inline

◆ setInput() [1/2]

void uiIOObjSel::setInput ( const IOObj & )

◆ setInput() [2/2]

void uiIOObjSel::setInput ( const MultiID & )

◆ survChangedCB()

void uiIOObjSel::survChangedCB ( CallBacker * )

protected

◆ updateInput()

virtual void uiIOObjSel::updateInput ( )

virtual

a.o. updates from CtxtIOObj

Reimplemented in uiSeisSel.

◆ usePar() [1/2]

virtual void uiIOObjSel::usePar ( const IOPar & )

virtual

Reimplemented in uiSeisSel.

◆ usePar() [2/2]

void uiIOObjSel::usePar	(	const IOPar &	,
		const char *	baseky
	)

◆ userNameFromKey()

const char* uiIOObjSel::userNameFromKey ( const char * s ) const

overrideprotectedvirtual

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

Reimplemented from uiIOSelect.

Reimplemented in uiSeisSel.

◆ validKey()

virtual MultiID uiIOObjSel::validKey ( ) const

virtual

no side-effects

Member Data Documentation

◆ helpkey_

HelpKey uiIOObjSel::helpkey_

protected

◆ inctio_

CtxtIOObj& uiIOObjSel::inctio_

protected

◆ inctiomine_

bool uiIOObjSel::inctiomine_

protected

◆ inserters_

ObjectSet<uiIOObjInserter> uiIOObjSel::inserters_

protected

◆ setup_

Setup uiIOObjSel::setup_

protected

◆ workctio_

CtxtIOObj& uiIOObjSel::workctio_

protected

◆ wrtrselfld_

uiIOObjSelWriteTranslator* uiIOObjSel::wrtrselfld_

protected

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ uiIOObjSel() [1/4]

◆ uiIOObjSel() [2/4]

◆ ~uiIOObjSel()

◆ uiIOObjSel() [3/4]

◆ uiIOObjSel() [4/4]

Member Function Documentation

◆ commitInput()

◆ commitSucceeded()

◆ createEntry()

◆ ctxtIOObj()

◆ doCommit()

◆ doCommitInput()

◆ doObjSel()

◆ endObj()

◆ existingTyped()

◆ existingUsrName()

◆ fillDefault()

◆ fillEntries()

◆ fillPar() [1/2]

◆ fillPar() [2/2]

◆ getIOObj()

◆ getWriteIOObjCtxt()

◆ init()

◆ initRead()

◆ ioobj()

◆ key()

◆ mkDlg()

◆ newSelection()

◆ objInserted()

◆ objSel()

◆ obtainIOObj()

◆ optCheckCB()

◆ preFinalizeCB()

◆ processInput()

◆ require()

◆ requiredZDomain()

◆ requireType()

◆ requireZDomain()

◆ setConfirmOverwrite()

◆ setEmpty()

◆ setHelpKey()

◆ setInput() [1/2]

◆ setInput() [2/2]

◆ survChangedCB()

◆ updateInput()

◆ usePar() [1/2]

◆ usePar() [2/2]

◆ userNameFromKey()

◆ validKey()

Member Data Documentation

◆ helpkey_

◆ inctio_

◆ inctiomine_

◆ inserters_

◆ setup_

◆ workctio_

◆ wrtrselfld_