OpendTect  6.6
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
uiButton Class Referenceabstract

is the base class for all buttons. More...

Inheritance diagram for uiButton:
[legend]

Public Member Functions

virtual ~uiButton ()
 
virtual void click ()=0
 
QAbstractButton * qButton ()
 Not for casual use. More...
 
const QAbstractButton * qButton () const
 
void setIcon (const char *icon_identifier)
 
void setIconScale (float val)
 
void setPixmap (const uiPixmap &pm)
 
void setText (const char *txt)
 
virtual void setText (const uiString &)
 
const uiStringtext () const
 
virtual void updateIconSize ()
 
- Public Member Functions inherited from uiObject
 ~uiObject ()
 
uiSize actualsize (bool inclborder=true) const
 
uiSize actualSize (bool include_border=true) const
 
void attach (constraintType, int margin=-1)
 attaches object to another In case the stretched... options are used, margin=-1 (default) stretches the object not to cross the border. margin=-2 stretches the object to fill the parent's border. This looks nice with separators. More...
 
void attach (constraintType, uiObject *, int margin=-1, bool reciprocal=true)
 
void attach (constraintType, uiParent *, int margin=-1, bool reciprocal=true)
 
virtual Color backgroundColor () const
 
virtual const ObjectSet< uiBaseObject > * childList () const
 
void close ()
 
void deepRedraw (CallBacker *=0)
 
void disabFocus ()
 
void display (bool yn, bool shrink=false, bool maximized=false)
 
const uiFontfont () const
 
QWidget * getWidget ()
 
virtual bool handleLongTabletPress ()
 
bool hasFocus () const
 
virtual int height () const
 Actual size in pixels. More...
 
bool isCursorInside () const
 
bool isDisplayed () const
 
virtual bool isEmpty () const
 
bool isSensitive () const
 
uiMainWinmainwin ()
 
uiParentparent ()
 
const uiParentparent () const
 
int prefHNrPics () const
 
int prefVNrPics () const
 
QWidget * qwidget ()
 
const QWidget * qwidget () const
 
void reDraw (bool deep)
 
void reParent (uiParent *)
 
Color roBackgroundColor () const
 
bool sensitive () const
 
virtual void setBackgroundColor (const Color &)
 
virtual void setBackgroundPixmap (const uiPixmap &)
 
void setCaption (const uiString &)
 
virtual void setCursor (const MouseCursor &)
 
void setFocus ()
 
void setFont (const uiFont &)
 
void setHSzPol (SzPolicy)
 
void setMaximumHeight (int)
 
void setMaximumHeightInChar (int)
 
void setMaximumWidth (int)
 
void setMaximumWidthInChar (int)
 
void setMinimumHeight (int)
 
void setMinimumHeightInChar (int)
 
void setMinimumWidth (int)
 
void setMinimumWidthInChar (int)
 
virtual void setName (const char *)
 
virtual void setPrefHeight (int)
 
void setPrefHeightInChar (float)
 
void setPrefHeightInChar (int)
 
virtual void setPrefWidth (int)
 
void setPrefWidthInChar (float)
 
void setPrefWidthInChar (int)
 
void setSensitive (bool yn=true)
 
void setStretch (int hor, int ver)
 Sets stretch factors for object If stretch factor is > 1, then object will already grow at pop-up. More...
 
virtual void setStyleSheet (const char *)
 
virtual void setTextColor (const Color &)
 
void setToolTip (const char *txt)
 
void setToolTip (const uiString &)
 
void setVSzPol (SzPolicy)
 
void shallowRedraw (CallBacker *=0)
 
int stretch (bool hor) const
 
SzPolicy szPol (bool hor=true) const
 
const uiStringtoolTip () const
 
void translateText ()
 
bool visible () const
 
virtual int width () const
 Actual size in pixels. More...
 
- 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
 
const QWidget * getWidget () const
 
virtual Notifier< uiBaseObject > & postFinalise ()
 
virtual Notifier< uiBaseObject > & preFinalise ()
 
- 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
 
- 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 uiButtongetStd (uiParent *, OD::StdActionType, const CallBack &, bool immediate)
 
static uiButtongetStd (uiParent *, OD::StdActionType, const CallBack &, bool immediate, const uiString &nonstd_text)
 will deliver toolbutton is txt is empty More...
 
static bool haveCommonPBIcons ()
 
static void setHaveCommonPBIcons (bool yn=true)
 
- Static Public Member Functions inherited from uiObject
static int baseFldSize ()
 
static int iconSize ()
 
static void setTabOrder (uiObject *first, uiObject *second)
 
static void updateToolTips ()
 
- 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

Notifier< uiButtonactivated
 
- Public Attributes inherited from uiObject
Notifier< uiObjectclosed
 Triggered when object closes. More...
 
CNotifier< uiObject, uiRect & > setGeometry
 triggered when getting a new geometry A reference to the new geometry is passed which can be manipulated, before the geometry is actually set to the QWidget. More...
 

Protected Member Functions

 uiButton (uiParent *, const uiString &, const CallBack *, uiObjectBody &)
 
virtual void setPM (const uiPixmap &)
 
virtual void translateText ()
 
- Protected Member Functions inherited from uiObject
 uiObject (uiParent *, const char *nm)
 
 uiObject (uiParent *, const char *nm, uiObjectBody &)
 
virtual bool closeOK ()
 hook. Accepts/denies closing of window. More...
 
void triggerSetGeometry (const i_LayoutItem *, uiRect &)
 setGeometry should be triggered by this's layoutItem More...
 
void updateToolTip (CallBacker *=0)
 
- Protected Member Functions inherited from uiBaseObject
void setBody (uiBody *b)
 
- Protected Member Functions inherited from NamedCallBacker
void sendDelNotif () const
 

Protected Attributes

float iconscale_
 
uiString text_
 
- Protected Attributes inherited from uiObject
uiString tooltip_
 
uiObjEventFilter * uiobjeventfilter_
 
- 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_
 

Static Protected Attributes

static bool havecommonpbics_
 

Additional Inherited Members

- Public Types inherited from uiObject
enum  SzPolicy {
  Undef , Small , Medium , Wide ,
  SmallVar , MedVar , WideVar , SmallMax ,
  MedMax , WideMax
}
 How should the object's size behave? Undef : use default. Small : 1 base sz. Medium : 2* base sz + 1. Wide : 4* base sz + 3. The xxVar options specify that the element may have a bigger internal preferred size. In that case, the maximum is taken. The xxMax options specify that the element should take all available space ( stretch = 2 ) More...
 
- Public Types inherited from ObjectWithName
typedef OD::String name_type
 

Detailed Description

is the base class for all buttons.

<>

Constructor & Destructor Documentation

◆ ~uiButton()

virtual uiButton::~uiButton ( )
inlinevirtual

◆ uiButton()

uiButton::uiButton ( uiParent ,
const uiString ,
const CallBack ,
uiObjectBody  
)
protected

Member Function Documentation

◆ click()

virtual void uiButton::click ( )
pure virtual

◆ getStd() [1/2]

static uiButton* uiButton::getStd ( uiParent ,
OD::StdActionType  ,
const CallBack ,
bool  immediate 
)
static

◆ getStd() [2/2]

static uiButton* uiButton::getStd ( uiParent ,
OD::StdActionType  ,
const CallBack ,
bool  immediate,
const uiString nonstd_text 
)
static

will deliver toolbutton is txt is empty

◆ haveCommonPBIcons()

static bool uiButton::haveCommonPBIcons ( )
inlinestatic

◆ qButton() [1/2]

QAbstractButton* uiButton::qButton ( )

Not for casual use.

◆ qButton() [2/2]

const QAbstractButton* uiButton::qButton ( ) const

◆ setHaveCommonPBIcons()

static void uiButton::setHaveCommonPBIcons ( bool  yn = true)
inlinestatic

◆ setIcon()

void uiButton::setIcon ( const char *  icon_identifier)

◆ setIconScale()

void uiButton::setIconScale ( float  val)

val between [0-1]

◆ setPixmap()

void uiButton::setPixmap ( const uiPixmap pm)
inline

◆ setPM()

virtual void uiButton::setPM ( const uiPixmap )
protectedvirtual

◆ setText() [1/2]

void uiButton::setText ( const char *  txt)
inline

◆ setText() [2/2]

virtual void uiButton::setText ( const uiString )
virtual

◆ text()

const uiString& uiButton::text ( ) const
inline

◆ translateText()

virtual void uiButton::translateText ( )
protectedvirtual

Triggers translation of object and all members to current language.

Reimplemented from uiBaseObject.

Reimplemented in uiPushButton.

◆ updateIconSize()

virtual void uiButton::updateIconSize ( )
inlinevirtual

Reimplemented in uiPushButton.

Member Data Documentation

◆ activated

Notifier<uiButton> uiButton::activated

◆ havecommonpbics_

bool uiButton::havecommonpbics_
staticprotected

◆ iconscale_

float uiButton::iconscale_
protected

◆ text_

uiString uiButton::text_
protected

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