OpendTect  6.6
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
uiFileInput Class Reference

A file-name input. More...

Inheritance diagram for uiFileInput:
[legend]

Classes

class  Setup
 

Public Member Functions

 uiFileInput (uiParent *, const char *seltxt, const Setup &)
 
 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 char *disptxt, const char *inputStr=nullptr)
 
 uiGenInput (uiParent *p, const char *disptxt, const DataInpSpec &)
 
 uiGenInput (uiParent *p, const char *disptxt, const DataInpSpec &, const DataInpSpec &)
 
 uiGenInput (uiParent *p, const char *disptxt, const DataInpSpec &, const DataInpSpec &, const DataInpSpec &)
 
 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 DataInpSpecdataInpSpec (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)
 
UserInputObjelement (int idx)
 returns 0 if not finalised. 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 (float undefval) const
 
double getDValue (int nr=0, double undefval=mUdf(double)) const
 
double getdValue (int nr=0, double uv=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 (float undefval) const
 
float getfValue (int nr=0, float udfval=mUdf(float)) 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
 
uiObjectrightObj ()
 for attaching More...
 
void setChecked (bool yn)
 
void setElemSzPol (uiObject::SzPolicy p)
 
void setEmpty (int nr=-1)
 
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 uiStringtitleText ()
 
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 ()
 
uiObjectattachObj ()
 
const uiObjectattachObj () const
 
uiObjecthAlignObj ()
 
uiObjecthCenterObj ()
 
virtual uiMainWinmainwin ()
 
 operator const uiGroupObj * () const
 
 operator const uiObject & () const
 
 operator uiGroupObj * ()
 
 operator uiObject & ()
 
uiParentparent ()
 
const uiParentparent () const
 
virtual Notifier< uiBaseObject > & postFinalise ()
 
virtual Notifier< uiBaseObject > & preFinalise ()
 
void setBorder (int)
 
void setChildrenSensitive (bool)
 
void setFrame (bool yn=true)
 
void setHAlignObj (uiGroup *o)
 
void setHAlignObj (uiObject *o)
 
void setHCenterObj (uiGroup *o)
 
void setHCenterObj (uiObject *o)
 
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)
 
Color backgroundColor () const
 
const ObjectSet< uiBaseObject > * childList () const
 
void deepRedraw (CallBacker *=0)
 
virtual void display (bool yn, bool shrk=false, bool maximize=false)
 
const uiFontfont () const
 
bool hasFocus () const
 
bool isDisplayed () const
 
uiObjectmainObject ()
 
const uiObjectmainObject () const
 
void manageChld (uiBaseObject &, uiObjectBody &)
 
uiParentBodypbody ()
 
const uiParentBodypbody () const
 
int prefHNrPics () const
 
int prefVNrPics () const
 
virtual void reDraw (bool deep)
 
Color roBackgroundColor () const
 
bool sensitive () const
 
void setBackgroundColor (const 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 ()
 
- Public Member Functions inherited from uiBaseObject
 uiBaseObject (const char *nm, uiBody *=0)
 
virtual ~uiBaseObject ()
 
int beginCmdRecEvent (const char *msg=0)
 
int beginCmdRecEvent (od_uint64 id, const char *msg=0)
 
uiBodybody ()
 
const uiBodybody () 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
 
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
 
- 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 &)
 
virtual const name_typename () const
 
NamedObjectoperator= (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

virtual void doSelect (CallBacker *)
 Select is pressed. Called by doSelect_. More...
 
void examineFile (CallBacker *)
 
void fnmEntered (CallBacker *)
 
void inputChg (CallBacker *)
 
void isFinalised (CallBacker *)
 
- Protected Member Functions inherited from uiGenInput
void checkBoxSel (CallBacker *)
 
uiGenInputInputFldcreateInpFld (const DataInpSpec &)
 DataInpField factory. More...
 
void doClear (CallBacker *)
 
void doFinalise (CallBacker *)
 
void doSelect_ (CallBacker *)
 Select is pressed. Calls virtual doSelect. More...
 
DataInpSpecspec (int nr)
 
- Protected Member Functions inherited from uiGroup
virtual void attach_ (constraintType, uiObject *oth, int margin=-1, bool reciprocal=true)
 
void bodyDel (CallBacker *)
 
virtual uiObjectmainobject ()
 
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 *)
 
- 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_
 
uiButtonexaminebut_
 
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
uiCheckBoxcbox_
 
bool finalised_
 
ObjectSet< uiGenInputInputFldflds_
 
TypeSet< uiGenInputFieldIdx > & idxes_
 
bool isrequired_
 
uiLabellabl_
 
uiButtonselbut_
 
uiString selText_
 
uiTextValidatortextvl_ = nullptr
 
uiString titletext_
 
bool withchk_
 
- Protected Attributes inherited from uiGroup
uiGroupParentBodybody_
 
uiGroupObjgrpobj_
 
- Protected Attributes inherited from uiBaseObject
Notifier< uiBaseObjectfinaliseDone
 triggered when finalising finished More...
 
Notifier< uiBaseObjectfinaliseStart
 triggered when about to start finalising More...
 
- Protected Attributes inherited from NamedCallBacker
Threads::Atomic< bool > delalreadytriggered_
 
Notifier< NamedCallBackerdelnotif_
 
- 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 uiGroupgtDynamicCastToGrp (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< uiGenInputchecked
 
Notifier< uiGenInputupdateRequested
 
Notifier< uiGenInputvaluechanged
 
Notifier< uiGenInputvaluechanging
 

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/3]

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

◆ uiFileInput() [2/3]

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

◆ ~uiFileInput()

uiFileInput::~uiFileInput ( )

◆ uiFileInput() [3/3]

uiFileInput::uiFileInput ( uiParent ,
const char *  seltxt,
const Setup  
)

Member Function Documentation

◆ baseName()

const char* uiFileInput::baseName ( ) const

◆ defaultSelectionDir()

const char* uiFileInput::defaultSelectionDir ( ) const
inline

◆ doSelect()

virtual void uiFileInput::doSelect ( CallBacker )
protectedvirtual

Select is pressed. Called by doSelect_.

Reimplemented from uiGenInput.

◆ enableExamine()

void uiFileInput::enableExamine ( bool  )

only if examinebut present

◆ 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

◆ isFinalised()

void uiFileInput::isFinalised ( 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

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