OpendTect  6.6
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Private Attributes | List of all members
uiAttrDescEd Class Referenceabstract

Attribute description editor. More...

Inheritance diagram for uiAttrDescEd:
[legend]

Public Types

enum  DimensionType { AnyDim , Only3D , Only2D }
 
enum  DomainType { Both , Time , Depth }
 
- Public Types inherited from ObjectWithName
typedef OD::String name_type
 

Public Member Functions

virtual ~uiAttrDescEd ()
 
virtual const char * attribName () const =0
 
virtual uiString commit (Desc *desc=0)
 
DesccurDesc ()
 
const DesccurDesc () const
 
DimensionType dimensionType () const
 
const char * displayName () const
 
DomainType domainType () const
 
uiString errMsgStr (Desc *desc)
 
virtual void getEvalParams (TypeSet< EvalParam > &) const
 
virtual int getOutputIdx (float val) const
 
virtual float getOutputValue (int idx) const
 
const ZDomain::InfogetZDomainInfo () const
 
HelpKey helpKey () const
 
bool is2D () const
 
virtual void setDataPackInp (const TypeSet< DataPack::FullID > &)
 
void setDesc (Desc *, DescSetMan *)
 
void setDescSet (DescSet *ds)
 
void setDimensionType (DimensionType t)
 
void setDisplayName (const char *nm)
 
void setDomainType (DomainType t)
 
void setNeedInputUpdate ()
 
virtual void setOutputStep (float step)
 
void setVideoKey (const HelpKey &k)
 
void setZDomainInfo (const ZDomain::Info *)
 
HelpKey videoKey () const
 
- 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
 

Static Public Member Functions

static const char * filterszstr ()
 
static const char * frequencystr ()
 
static const char * getInputAttribName (uiAttrSel *, const Desc &)
 
static const char * stepoutstr ()
 
static const char * timegatestr ()
 
- 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 ()
 

Protected Member Functions

 uiAttrDescEd (uiParent *, bool is2d, const HelpKey &)
 
virtual bool areUIParsOK ()
 
uiImagAttrSelcreateImagInpFld (bool is2d)
 
uiAttrSelcreateInpFld (bool is2d, const char *txt=0)
 
uiAttrSelcreateInpFld (const uiAttrSelData &, const char *txt=0)
 
void fillInp (uiAttrSel *, Desc &, int)
 
void fillInp (uiSteerAttrSel *, Desc &, int)
 
void fillInp (uiSteeringSel *, Desc &, int)
 
void fillOutput (Desc &, int selout)
 
uiString gateLabel () const
 
virtual bool getInput (Desc &)
 
DescgetInputDescFromDP (uiAttrSel *) const
 
bool getInputDPID (uiAttrSel *, DataPack::FullID &) const
 
virtual bool getOutput (Desc &)
 
virtual bool getParameters (Desc &)
 
bool needInputUpdate () const
 
void putInp (uiAttrSel *, const Desc &, int inpnr)
 
void putInp (uiSteerAttrSel *, const Desc &, int inpnr)
 
void putInp (uiSteeringSel *, const Desc &, int inpnr)
 
virtual bool setInput (const Desc &)
 
virtual bool setOutput (const Desc &)
 
virtual bool setParameters (const Desc &)
 
uiString shiftLabel () const
 
uiString zDepLabel (const uiString &pre, const uiString &post) const
 
bool zIsTime () const
 
- 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
 

Static Protected Member Functions

static uiString sInputTypeError (int input)
 
static const char * sKeyBasicGrp ()
 
static const char * sKeyDipGrp ()
 
static const char * sKeyFilterGrp ()
 
static const char * sKeyFreqGrp ()
 
static const char * sKeyOtherGrp ()
 
static const char * sKeyPatternGrp ()
 
static const char * sKeyPositionGrp ()
 
static const char * sKeyStatsGrp ()
 

Protected Attributes

DescSetads_
 
BufferString attrnm_
 
ChangeTracker chtr_
 
DimensionType dimtyp_
 
DomainType domtyp_
 
TypeSet< DataPack::FullIDdpfids_
 
uiString errmsg_
 
HelpKey helpkey_
 
bool is2d_
 
bool needinpupd_
 
HelpKey videokey_
 
const ZDomain::Infozdomaininfo_
 
- 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_
 

Private Attributes

DescSetManadsman_
 
Descdesc_
 
BufferString dispname_
 

Detailed Description

Attribute description editor.

Required functions are declared in the macro mDeclReqAttribUIFns. Two of those, attribName() and createInstance() are implemented by the mInitAttribUI macro.

<>

Member Enumeration Documentation

◆ DimensionType

Enumerator
AnyDim 
Only3D 
Only2D 

◆ DomainType

Enumerator
Both 
Time 
Depth 

Constructor & Destructor Documentation

◆ ~uiAttrDescEd()

virtual uiAttrDescEd::~uiAttrDescEd ( )
virtual

◆ uiAttrDescEd()

uiAttrDescEd::uiAttrDescEd ( uiParent ,
bool  is2d,
const HelpKey  
)
protected

Member Function Documentation

◆ areUIParsOK()

virtual bool uiAttrDescEd::areUIParsOK ( )
inlineprotectedvirtual

◆ attribName()

virtual const char* uiAttrDescEd::attribName ( ) const
pure virtual

◆ commit()

virtual uiString uiAttrDescEd::commit ( Desc desc = 0)
virtual

returns null on success, error message otherwise If attribdesc is non-zero, that desc will be filled. If not, the internal desc will be filled.

◆ createImagInpFld()

uiImagAttrSel* uiAttrDescEd::createImagInpFld ( bool  is2d)
protected

◆ createInpFld() [1/2]

uiAttrSel* uiAttrDescEd::createInpFld ( bool  is2d,
const char *  txt = 0 
)
protected

◆ createInpFld() [2/2]

uiAttrSel* uiAttrDescEd::createInpFld ( const uiAttrSelData ,
const char *  txt = 0 
)
protected

◆ curDesc() [1/2]

Desc* uiAttrDescEd::curDesc ( )
inline

◆ curDesc() [2/2]

const Desc* uiAttrDescEd::curDesc ( ) const
inline

◆ dimensionType()

DimensionType uiAttrDescEd::dimensionType ( ) const
inline

◆ displayName()

const char* uiAttrDescEd::displayName ( ) const
inline

◆ domainType()

DomainType uiAttrDescEd::domainType ( ) const
inline

◆ errMsgStr()

uiString uiAttrDescEd::errMsgStr ( Desc desc)

◆ fillInp() [1/3]

void uiAttrDescEd::fillInp ( uiAttrSel ,
Desc ,
int   
)
protected

◆ fillInp() [2/3]

void uiAttrDescEd::fillInp ( uiSteerAttrSel ,
Desc ,
int   
)
protected

◆ fillInp() [3/3]

void uiAttrDescEd::fillInp ( uiSteeringSel ,
Desc ,
int   
)
protected

◆ fillOutput()

void uiAttrDescEd::fillOutput ( Desc ,
int  selout 
)
protected

◆ filterszstr()

static const char* uiAttrDescEd::filterszstr ( )
static

◆ frequencystr()

static const char* uiAttrDescEd::frequencystr ( )
static

◆ gateLabel()

uiString uiAttrDescEd::gateLabel ( ) const
inlineprotected

◆ getEvalParams()

virtual void uiAttrDescEd::getEvalParams ( TypeSet< EvalParam > &  ) const
inlinevirtual

◆ getInput()

virtual bool uiAttrDescEd::getInput ( Desc )
inlineprotectedvirtual

◆ getInputAttribName()

static const char* uiAttrDescEd::getInputAttribName ( uiAttrSel ,
const Desc  
)
static

◆ getInputDescFromDP()

Desc* uiAttrDescEd::getInputDescFromDP ( uiAttrSel ) const
protected

◆ getInputDPID()

bool uiAttrDescEd::getInputDPID ( uiAttrSel ,
DataPack::FullID  
) const
protected

◆ getOutput()

virtual bool uiAttrDescEd::getOutput ( Desc )
protectedvirtual

◆ getOutputIdx()

virtual int uiAttrDescEd::getOutputIdx ( float  val) const
inlinevirtual

Reimplemented in uiSpecDecompAttrib.

◆ getOutputValue()

virtual float uiAttrDescEd::getOutputValue ( int  idx) const
inlinevirtual

Reimplemented in uiSpecDecompAttrib.

◆ getParameters()

virtual bool uiAttrDescEd::getParameters ( Desc )
inlineprotectedvirtual

◆ getZDomainInfo()

const ZDomain::Info* uiAttrDescEd::getZDomainInfo ( ) const

◆ helpKey()

HelpKey uiAttrDescEd::helpKey ( ) const
inline

◆ is2D()

bool uiAttrDescEd::is2D ( ) const
inline

◆ needInputUpdate()

bool uiAttrDescEd::needInputUpdate ( ) const
inlineprotected

◆ putInp() [1/3]

void uiAttrDescEd::putInp ( uiAttrSel ,
const Desc ,
int  inpnr 
)
protected

◆ putInp() [2/3]

void uiAttrDescEd::putInp ( uiSteerAttrSel ,
const Desc ,
int  inpnr 
)
protected

◆ putInp() [3/3]

void uiAttrDescEd::putInp ( uiSteeringSel ,
const Desc ,
int  inpnr 
)
protected

◆ setDataPackInp()

virtual void uiAttrDescEd::setDataPackInp ( const TypeSet< DataPack::FullID > &  )
virtual

Reimplemented in uiPreStackAttrib.

◆ setDesc()

void uiAttrDescEd::setDesc ( Desc ,
DescSetMan  
)

◆ setDescSet()

void uiAttrDescEd::setDescSet ( DescSet ds)
inline

◆ setDimensionType()

void uiAttrDescEd::setDimensionType ( DimensionType  t)
inline

◆ setDisplayName()

void uiAttrDescEd::setDisplayName ( const char *  nm)
inline

◆ setDomainType()

void uiAttrDescEd::setDomainType ( DomainType  t)
inline

◆ setInput()

virtual bool uiAttrDescEd::setInput ( const Desc )
inlineprotectedvirtual

◆ setNeedInputUpdate()

void uiAttrDescEd::setNeedInputUpdate ( )
inline

◆ setOutput()

virtual bool uiAttrDescEd::setOutput ( const Desc )
inlineprotectedvirtual

◆ setOutputStep()

virtual void uiAttrDescEd::setOutputStep ( float  step)
inlinevirtual

◆ setParameters()

virtual bool uiAttrDescEd::setParameters ( const Desc )
inlineprotectedvirtual

◆ setVideoKey()

void uiAttrDescEd::setVideoKey ( const HelpKey k)
inline

◆ setZDomainInfo()

void uiAttrDescEd::setZDomainInfo ( const ZDomain::Info )

◆ shiftLabel()

uiString uiAttrDescEd::shiftLabel ( ) const
inlineprotected

◆ sInputTypeError()

static uiString uiAttrDescEd::sInputTypeError ( int  input)
staticprotected

◆ sKeyBasicGrp()

static const char* uiAttrDescEd::sKeyBasicGrp ( )
staticprotected

◆ sKeyDipGrp()

static const char* uiAttrDescEd::sKeyDipGrp ( )
staticprotected

◆ sKeyFilterGrp()

static const char* uiAttrDescEd::sKeyFilterGrp ( )
staticprotected

◆ sKeyFreqGrp()

static const char* uiAttrDescEd::sKeyFreqGrp ( )
staticprotected

◆ sKeyOtherGrp()

static const char* uiAttrDescEd::sKeyOtherGrp ( )
staticprotected

◆ sKeyPatternGrp()

static const char* uiAttrDescEd::sKeyPatternGrp ( )
staticprotected

◆ sKeyPositionGrp()

static const char* uiAttrDescEd::sKeyPositionGrp ( )
staticprotected

◆ sKeyStatsGrp()

static const char* uiAttrDescEd::sKeyStatsGrp ( )
staticprotected

◆ stepoutstr()

static const char* uiAttrDescEd::stepoutstr ( )
static

◆ timegatestr()

static const char* uiAttrDescEd::timegatestr ( )
static

◆ videoKey()

HelpKey uiAttrDescEd::videoKey ( ) const
inline

◆ zDepLabel()

uiString uiAttrDescEd::zDepLabel ( const uiString pre,
const uiString post 
) const
protected

◆ zIsTime()

bool uiAttrDescEd::zIsTime ( ) const
protected

Member Data Documentation

◆ ads_

DescSet* uiAttrDescEd::ads_
protected

◆ adsman_

DescSetMan* uiAttrDescEd::adsman_
private

◆ attrnm_

BufferString uiAttrDescEd::attrnm_
protected

◆ chtr_

ChangeTracker uiAttrDescEd::chtr_
protected

◆ desc_

Desc* uiAttrDescEd::desc_
private

◆ dimtyp_

DimensionType uiAttrDescEd::dimtyp_
protected

◆ dispname_

BufferString uiAttrDescEd::dispname_
private

◆ domtyp_

DomainType uiAttrDescEd::domtyp_
protected

◆ dpfids_

TypeSet<DataPack::FullID> uiAttrDescEd::dpfids_
protected

◆ errmsg_

uiString uiAttrDescEd::errmsg_
protected

◆ helpkey_

HelpKey uiAttrDescEd::helpkey_
protected

◆ is2d_

bool uiAttrDescEd::is2d_
protected

◆ needinpupd_

bool uiAttrDescEd::needinpupd_
protected

◆ videokey_

HelpKey uiAttrDescEd::videokey_
protected

◆ zdomaininfo_

const ZDomain::Info* uiAttrDescEd::zdomaininfo_
protected

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