A file-name input. More...

Inheritance diagram for uiFileInput:

Classes
class	Setup

Public Member Functions
	uiFileInput (uiParent , const uiString &seltxt, const char fnm=0)

	uiFileInput (uiParent *, const uiString &seltxt, const Setup &)

	~uiFileInput ()

const char *	baseName () const

const char *	defaultSelectionDir () const

void	enableExamine (bool)
	only if examinebut present More...

File::ViewStyle	examStyle () const

const char *	fileName () const

void	getFileNames (BufferStringSet &) const

const char *	pathOnly () const

const char *	selectedFilter () const

void	selectFile (CallBacker *cb)

uiFileDialog::Mode	selectMode () const

void	setDefaultExtension (const char *ext)

void	setDefaultSelectionDir (const char *)

void	setExamine (const CallBack &cb)
	Overrules the simple stand-alone file browser. More...

void	setExamStyle (File::ViewStyle vs)

void	setFileName (const char *)

void	setFilter (const char *fltr)

void	setObjType (const uiString &s)

void	setSelectedFilter (const char *f)

void	setSelectMode (uiFileDialog::Mode m)

void	setSensitive (bool yn)

Public Member Functions inherited from uiGenInput
	uiGenInput (uiParent *p, const uiString &, const DataInpSpec &, const DataInpSpec &)

	uiGenInput (uiParent *p, const uiString &, const DataInpSpec &, const DataInpSpec &, const DataInpSpec &)

	uiGenInput (uiParent p, const uiString &disptxt, const char inputStr=nullptr)

	uiGenInput (uiParent *p, const uiString &disptxt, const DataInpSpec &)

virtual	~uiGenInput ()

void	addInput (const DataInpSpec &)

const DataInpSpec *	dataInpSpec (int nr=0) const
	gives access to the actual spec of an input field. More...

void	displayField (bool yn=true, int elemnr=-1, int fldnr=-1)

UserInputObj *	element (int idx)
	returns 0 if not finalized. More...

uiObject::SzPolicy	elemSzPol () const

BinID	getBinID (int nr=0, int undefval=mUdf(int)) const

bool	getBoolValue (int nr=0, bool undefval=mUdf(bool)) const

Coord	getCoord (int nr=0, double undefval=mUdf(double)) const

Interval< double >	getDInterval (double undefval) const

Interval< double >	getDInterval (int nr=0, double undefval=mUdf(double)) const

StepInterval< double >	getDStepInterval (double undefval) const

StepInterval< double >	getDStepInterval (int nr=0, double undefval=mUdf(double)) const

double	getDValue (double undefval) const

double	getDValue (int nr=0, double undefval=mUdf(double)) const

Interval< float >	getFInterval (float undefval) const

Interval< float >	getFInterval (int nr=0, float undefval=mUdf(float)) const

StepInterval< float >	getFStepInterval (float undefval) const

StepInterval< float >	getFStepInterval (int nr=0, float undefval=mUdf(float)) const

float	getFValue (float undefval) const

float	getFValue (int nr=0, float undefval=mUdf(float)) const

Interval< int >	getIInterval (int nr=0, int undefval=mUdf(int)) const

od_int64	getInt64Value (int nr=0, od_int64 undefval=mUdf(od_int64)) const

int	getIntValue (int nr=0, int undefval=mUdf(int)) const

StepInterval< int >	getIStepInterval (int nr=0, int undefval=mUdf(int)) const

float	getOffset (int nr=0, float undefval=mUdf(float)) const

int	getTrcNr (int nr=0, int undefval=mUdf(int)) const

bool	isCheckable () const

bool	isChecked () const

virtual bool	isSingleLine () const

bool	isUndef (int nr=0) const

bool	newSpec (const DataInpSpec &nw, int nr)
	makes it possible to change the actual spec for an input field. More...

int	nrElements () const

uiObject *	rightObj ()
	for attaching More...

void	setChecked (bool yn)

void	setDefaultTextValidator ()

void	setElemSzPol (uiObject::SzPolicy p)

void	setEmpty (int nr=-1)

void	setFilename (const char *)

void	setNrDecimals (int nrdec, int fldnr=0)

void	setPrefix (const uiString &r, int fldnr=0)

void	setReadOnly (bool yn=true, int elemnr=-1, int fldnr=-1)

void	setRequired (bool yn=true)

void	setSensitive (bool yn=true, int elemnr=-1, int fldnr=-1)

void	setText (const char *, int nr=0)

void	setTexts (const char v1, const char v2)

void	setTextValidator (const uiTextValidator &)

virtual void	setTitleText (const uiString &)

void	setToolTip (const uiString &, int ielem=0)

void	setValue (bool, int nr=0)

void	setValue (const BinID &b)

void	setValue (const BinIDValue &)

void	setValue (const Coord &c)

void	setValue (const Interval< double > &)
	and StepIntv More...

void	setValue (const Interval< float > &)
	and StepIntv More...

void	setValue (const Interval< int > &)
	and StepIntv More...

void	setValue (double, int nr=0)

void	setValue (float, int nr=0)

void	setValue (int, int nr=0)

void	setValue (od_int64, int nr=0)

void	setValues (bool v1, bool v2)

void	setValues (double v1, double v2)

void	setValues (float v1, float v2)

void	setValues (int v1, int v2)

void	setWithCheck (bool yn=true)

void	setWithSelect (bool yn=true)

const char *	text (const char *undefval) const

const char *	text (int nr=0, const char undefval=mUdf(const char )) const

virtual const uiString &	titleText ()

void	updateSpecs ()
	update dataInpSpec() from current values on screen. More...

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

Protected Member Functions
void	doSelect (CallBacker *) override
	Select is pressed. Called by doSelect_. More...

void	ensureAbsolutePath (BufferString &) const

void	examineFile (CallBacker *)

void	fnmEntered (CallBacker *)

void	inputChg (CallBacker *)

void	isFinalized (CallBacker *)

Protected Member Functions inherited from uiGenInput
void	checkBoxSel (CallBacker *)

uiGenInputInputFld &	createInpFld (const DataInpSpec &)
	DataInpField factory. More...

void	doClear (CallBacker *)

void	doFinalize (CallBacker *)

void	doSelect_ (CallBacker *)
	Select is pressed. Calls virtual doSelect. More...

DataInpSpec *	spec (int nr)

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
bool	addallexts_

bool	confirmoverwrite_

BufferString	defaultext_

BufferString	defseldir_

bool	displaylocalpath_

bool	exameditable_

uiButton *	examinebut_

File::ViewStyle	examstyle_

CallBack	excb_

uiFileDialog::Type	filedlgtype_

BufferString	filter_

bool	forread_

uiString	objtype_

BufferString	selfltr_

uiFileDialog::Mode	selmode_

bool	selmodset_

Protected Attributes inherited from uiGenInput
uiCheckBox *	cbox_ = nullptr

bool	finalized_ = false

ObjectSet< uiGenInputInputFld >	flds_

TypeSet< uiGenInputFieldIdx > &	idxes_

bool	isrequired_ = false

uiLabel *	labl_ = nullptr

uiButton *	selbut_ = nullptr

uiString	selText_

uiTextValidator *	textvl_ = nullptr

uiString	titletext_

bool	withchk_ = false

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_

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

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 ()

Public Attributes inherited from uiGenInput
Notifier< uiGenInput >	checked

Notifier< uiGenInput >	updateRequested

Notifier< uiGenInput >	valueChanged

Notifier< uiGenInput >	valuechanged

Notifier< uiGenInput >	valueChanging

Notifier< uiGenInput >	valuechanging

Detailed Description

A file-name input.

Displays a uiLineEdit field showing the current selected file. The user can edit the filename by hand, or pop up a file selector trough the included "Select..." push button. Optional is an Examine button for browsing the file.

The filter you specify will automatically get an 'All files' added unless you specify otherwise in the setup.

<>

Constructor & Destructor Documentation

◆ uiFileInput() [1/2]

uiFileInput::uiFileInput	(	uiParent *	,
		const uiString &	seltxt,
		const char *	fnm = `0`
	)

◆ uiFileInput() [2/2]

uiFileInput::uiFileInput	(	uiParent *	,
		const uiString &	seltxt,
		const Setup &
	)

◆ ~uiFileInput()

uiFileInput::~uiFileInput ( )

Member Function Documentation

◆ baseName()

const char* uiFileInput::baseName ( ) const

◆ defaultSelectionDir()

const char* uiFileInput::defaultSelectionDir ( ) const

inline

◆ doSelect()

void uiFileInput::doSelect ( CallBacker * )

overrideprotectedvirtual

Select is pressed. Called by doSelect_.

Reimplemented from uiGenInput.

◆ enableExamine()

void uiFileInput::enableExamine ( bool )

only if examinebut present

◆ ensureAbsolutePath()

void uiFileInput::ensureAbsolutePath ( BufferString & ) const

protected

◆ examineFile()

void uiFileInput::examineFile ( CallBacker * )

protected

◆ examStyle()

File::ViewStyle uiFileInput::examStyle ( ) const

inline

◆ fileName()

const char* uiFileInput::fileName ( ) const

◆ fnmEntered()

void uiFileInput::fnmEntered ( CallBacker * )

protected

◆ getFileNames()

void uiFileInput::getFileNames ( BufferStringSet & ) const

◆ inputChg()

void uiFileInput::inputChg ( CallBacker * )

protected

◆ isFinalized()

void uiFileInput::isFinalized ( CallBacker * )

protected

◆ pathOnly()

const char* uiFileInput::pathOnly ( ) const

◆ selectedFilter()

const char* uiFileInput::selectedFilter ( ) const

inline

◆ selectFile()

void uiFileInput::selectFile ( CallBacker * cb )

inline

◆ selectMode()

uiFileDialog::Mode uiFileInput::selectMode ( ) const

inline

◆ setDefaultExtension()

void uiFileInput::setDefaultExtension ( const char * ext )

◆ setDefaultSelectionDir()

void uiFileInput::setDefaultSelectionDir ( const char * )

◆ setExamine()

void uiFileInput::setExamine ( const CallBack & cb )

inline

Overrules the simple stand-alone file browser.

◆ setExamStyle()

void uiFileInput::setExamStyle ( File::ViewStyle vs )

inline

◆ setFileName()

void uiFileInput::setFileName ( const char * )

◆ setFilter()

void uiFileInput::setFilter ( const char * fltr )

inline

◆ setObjType()

void uiFileInput::setObjType ( const uiString & s )

inline

◆ setSelectedFilter()

void uiFileInput::setSelectedFilter ( const char * f )

inline

◆ setSelectMode()

void uiFileInput::setSelectMode ( uiFileDialog::Mode m )

inline

◆ setSensitive()

void uiFileInput::setSensitive ( bool yn )

inline

Member Data Documentation

◆ addallexts_

bool uiFileInput::addallexts_

protected

◆ confirmoverwrite_

bool uiFileInput::confirmoverwrite_

protected

◆ defaultext_

BufferString uiFileInput::defaultext_

protected

◆ defseldir_

BufferString uiFileInput::defseldir_

protected

◆ displaylocalpath_

bool uiFileInput::displaylocalpath_

protected

◆ exameditable_

bool uiFileInput::exameditable_

protected

◆ examinebut_

uiButton* uiFileInput::examinebut_

protected

◆ examstyle_

File::ViewStyle uiFileInput::examstyle_

protected

◆ excb_

CallBack uiFileInput::excb_

protected

◆ filedlgtype_

uiFileDialog::Type uiFileInput::filedlgtype_

protected

◆ filter_

BufferString uiFileInput::filter_

protected

◆ forread_

bool uiFileInput::forread_

protected

◆ objtype_

uiString uiFileInput::objtype_

protected

◆ selfltr_

BufferString uiFileInput::selfltr_

protected

◆ selmode_

uiFileDialog::Mode uiFileInput::selmode_

protected

◆ selmodset_

bool uiFileInput::selmodset_

protected

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ uiFileInput() [1/2]

◆ uiFileInput() [2/2]

◆ ~uiFileInput()

Member Function Documentation

◆ baseName()

◆ defaultSelectionDir()

◆ doSelect()

◆ enableExamine()

◆ ensureAbsolutePath()

◆ examineFile()

◆ examStyle()

◆ fileName()

◆ fnmEntered()

◆ getFileNames()

◆ inputChg()

◆ isFinalized()

◆ pathOnly()

◆ selectedFilter()

◆ selectFile()

◆ selectMode()

◆ setDefaultExtension()

◆ setDefaultSelectionDir()

◆ setExamine()

◆ setExamStyle()

◆ setFileName()

◆ setFilter()

◆ setObjType()

◆ setSelectedFilter()

◆ setSelectMode()

◆ setSensitive()

Member Data Documentation

◆ addallexts_

◆ confirmoverwrite_

◆ defaultext_

◆ defseldir_

◆ displaylocalpath_

◆ exameditable_

◆ examinebut_

◆ examstyle_

◆ excb_

◆ filedlgtype_

◆ filter_

◆ forread_

◆ objtype_

◆ selfltr_

◆ selmode_

◆ selmodset_