OpendTect  7.0
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
uiBuildListFromList Class Referenceabstract

Base class for element allowing the building of lists of items from available 'ingredients'. More...

Inheritance diagram for uiBuildListFromList:
[legend]

Classes

class  Setup
 

Public Member Functions

 ~uiBuildListFromList ()
 
bool haveUserChange () const
 
- Public Member Functions inherited from uiGroup
 uiGroup (uiParent *, const char *nm="uiGroup", bool manage=true)
 
virtual ~uiGroup ()
 
uiObjectattachObj ()
 
const uiObjectattachObj () const
 
uiObjecthAlignObj ()
 
uiObjecthCenterObj ()
 
uiMainWinmainwin () override
 
 operator const uiGroupObj * () const
 
 operator const uiObject & () const
 
 operator uiGroupObj * ()
 
 operator uiObject & ()
 
uiParentparent ()
 
const uiParentparent () 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 uiFontfont () const
 
bool hasFocus () const
 
bool isDisplayed () const
 
uiObjectmainObject ()
 
const uiObjectmainObject () const
 
void manageChild (uiBaseObject &, uiObjectBody &)
 
uiParentBodypbody ()
 
const uiParentBodypbody () 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)
 
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
 
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 CallBackertrueCaller ()
 
- 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_typename () const override
 
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

 uiBuildListFromList (uiParent *, const Setup &, const char *grpnm=0)
 
void addCB (CallBacker *)
 
void addItem (const char *)
 
virtual const char * avFromDef (const char *) const =0
 
const char * curAvSel () const
 null = no selection More...
 
const char * curDefSel () const
 null = no selection More...
 
void defSelCB (CallBacker *)
 
virtual void defSelChg ()
 
void edCB (CallBacker *)
 
virtual void editReq (bool isadd)=0
 
void handleSuccessfullEdit (bool isadd, const char *itmnm)
 
virtual bool ioReq (bool forsave)
 
virtual void itemSwitch (const char *, const char *)
 
uiToolButtonlowestStdBut ()
 
void moveCB (CallBacker *)
 
void openCB (CallBacker *)
 
void removeAll ()
 
void removeItem ()
 
virtual void removeReq ()=0
 
void rmCB (CallBacker *)
 
void rmItm (int, bool)
 
void saveCB (CallBacker *)
 
void setAvailable (const BufferStringSet &)
 at start More...
 
void setCurDefSel (const char *)
 null = first More...
 
void setItemName (const char *)
 
- Protected Member Functions inherited from uiGroup
void attach_ (constraintType, uiObject *oth, int margin=-1, bool reciprocal=true) override
 
void bodyDel (CallBacker *)
 
uiObjectmainobject () 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

uiListBoxavfld_
 
uiListBoxdeffld_
 
uiToolButtonedbut_
 
uiToolButtonmovedownbut_
 
uiToolButtonmoveupbut_
 
uiToolButtonrmbut_
 
uiToolButtonsavebut_
 
Setup setup_
 
bool usrchg_
 
- Protected Attributes inherited from uiGroup
uiGroupParentBodybody_
 
uiGroupObjgrpobj_
 
- 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 ()
 

Detailed Description

Base class for element allowing the building of lists of items from available 'ingredients'.

Let's say you want to make a list of persons. These can be male or female, and dep on the gender you want to be able to define different properties.

uiBuildListFromList::Setup( true, "person" ) .withtitles(true).avtitle("gender");

The list of 'available' items is simply "male" and "female". Once you create e.g. a female, the option 'female' itself should stay in the available list. Thus singleuse must remain false. The order of the defined items is not important so we choose 'movable' = true. The constructor will now generate default tooltips and titles, like "Add person".

Required: Both sets of names cannot have double entries. You only get requests for edit and remove. You have to manage underlying objects yourself. Moreover, you have to use functions like 'removeItem' and 'handleSuccessfullEdit' to keep the display in sync with the actual set that is being built. You must define the avFromDef() function. It should return the 'available' item that belongs to a 'defined' item name.

<>

Constructor & Destructor Documentation

◆ ~uiBuildListFromList()

uiBuildListFromList::~uiBuildListFromList ( )

◆ uiBuildListFromList()

uiBuildListFromList::uiBuildListFromList ( uiParent ,
const Setup ,
const char *  grpnm = 0 
)
protected

Member Function Documentation

◆ addCB()

void uiBuildListFromList::addCB ( CallBacker )
inlineprotected

◆ addItem()

void uiBuildListFromList::addItem ( const char *  )
protected

◆ avFromDef()

virtual const char* uiBuildListFromList::avFromDef ( const char *  ) const
protectedpure virtual

◆ curAvSel()

const char* uiBuildListFromList::curAvSel ( ) const
protected

null = no selection

◆ curDefSel()

const char* uiBuildListFromList::curDefSel ( ) const
protected

null = no selection

◆ defSelCB()

void uiBuildListFromList::defSelCB ( CallBacker )
inlineprotected

◆ defSelChg()

virtual void uiBuildListFromList::defSelChg ( )
protectedvirtual

Reimplemented in uiAttribDescSetBuild.

◆ edCB()

void uiBuildListFromList::edCB ( CallBacker )
inlineprotected

◆ editReq()

virtual void uiBuildListFromList::editReq ( bool  isadd)
protectedpure virtual

◆ handleSuccessfullEdit()

void uiBuildListFromList::handleSuccessfullEdit ( bool  isadd,
const char *  itmnm 
)
inlineprotected

◆ haveUserChange()

bool uiBuildListFromList::haveUserChange ( ) const
inline

◆ ioReq()

virtual bool uiBuildListFromList::ioReq ( bool  forsave)
inlineprotectedvirtual

◆ itemSwitch()

virtual void uiBuildListFromList::itemSwitch ( const char *  ,
const char *   
)
inlineprotectedvirtual

◆ lowestStdBut()

uiToolButton* uiBuildListFromList::lowestStdBut ( )
protected

◆ moveCB()

void uiBuildListFromList::moveCB ( CallBacker )
protected

◆ openCB()

void uiBuildListFromList::openCB ( CallBacker )
protected

◆ removeAll()

void uiBuildListFromList::removeAll ( )
protected

◆ removeItem()

void uiBuildListFromList::removeItem ( )
protected

◆ removeReq()

virtual void uiBuildListFromList::removeReq ( )
protectedpure virtual

◆ rmCB()

void uiBuildListFromList::rmCB ( CallBacker )
inlineprotected

◆ rmItm()

void uiBuildListFromList::rmItm ( int  ,
bool   
)
protected

◆ saveCB()

void uiBuildListFromList::saveCB ( CallBacker )
protected

◆ setAvailable()

void uiBuildListFromList::setAvailable ( const BufferStringSet )
protected

at start

◆ setCurDefSel()

void uiBuildListFromList::setCurDefSel ( const char *  )
protected

null = first

◆ setItemName()

void uiBuildListFromList::setItemName ( const char *  )
protected

Member Data Documentation

◆ avfld_

uiListBox* uiBuildListFromList::avfld_
protected

◆ deffld_

uiListBox* uiBuildListFromList::deffld_
protected

◆ edbut_

uiToolButton* uiBuildListFromList::edbut_
protected

◆ movedownbut_

uiToolButton* uiBuildListFromList::movedownbut_
protected

◆ moveupbut_

uiToolButton* uiBuildListFromList::moveupbut_
protected

◆ rmbut_

uiToolButton* uiBuildListFromList::rmbut_
protected

◆ savebut_

uiToolButton* uiBuildListFromList::savebut_
protected

◆ setup_

Setup uiBuildListFromList::setup_
protected

◆ usrchg_

bool uiBuildListFromList::usrchg_
protected

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