OpendTect  7.0
Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
uiToolButton Class Reference
Inheritance diagram for uiToolButton:
[legend]

Public Types

enum  ArrowType {
  NoArrow , UpArrow , DownArrow , LeftArrow ,
  RightArrow
}
 
enum  PopupMode { DelayedPopup , MenuButtonPopup , InstantPopup }
 
- 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
 

Public Member Functions

 uiToolButton (uiParent *, ArrowType, const uiString &tooltip, const CallBack &)
 
 uiToolButton (uiParent *, const char *filenm, const uiString &tooltip, const CallBack &)
 
 uiToolButton (uiParent *, const uiToolButtonSetup &)
 
 ~uiToolButton ()
 
void click () override
 
int id () const
 
bool isOn () const
 
bool isToggleButton () const
 
const uiMenumenu () const
 
void setArrowType (ArrowType)
 
void setID (int i)
 
void setMenu (uiMenu *, PopupMode=MenuButtonPopup)
 Menu becomes mine. More...
 
void setOn (bool yn=true)
 
void setShortcut (const char *)
 
void setToggleButton (bool yn=true)
 
- Public Member Functions inherited from uiButton
virtual ~uiButton ()
 
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)
 
virtual void setText (const uiString &)
 
const uiStringtext () const
 
virtual void updateIconSize ()
 
- Public Member Functions inherited from uiObject
 ~uiObject ()
 
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 OD::Color backgroundColor () const
 
virtual const ObjectSet< uiBaseObject > * childList () const
 
void close ()
 
void deepRedraw ()
 
void disabFocus ()
 
void display (bool yn, bool shrink=false, bool maximized=false)
 
const uiFontfont () const
 
QWidget * getWidget () override
 
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 *)
 
OD::Color roBackgroundColor () const
 
bool sensitive () const
 
virtual void setBackgroundColor (const OD::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 *) override
 
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 OD::Color &)
 
void setToolTip (const uiString &)
 
void setVSzPol (SzPolicy)
 
void shallowRedraw ()
 
int stretch (bool hor) const
 
SzPolicy szPol (bool hor=true) const
 
const uiStringtoolTip () const
 
void translateText () override
 
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 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
 
const QWidget * getWidget () const
 
virtual Notifier< uiBaseObject > & postFinalise ()
 
virtual Notifier< uiBaseObject > & postFinalize ()
 
virtual Notifier< uiBaseObject > & preFinalise ()
 
virtual Notifier< uiBaseObject > & preFinalize ()
 
- 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
 
- 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 uiToolButtongetStd (uiParent *, OD::StdActionType, const CallBack &, const uiString &ttip)
 
- Static Public Member Functions inherited from uiButton
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 ()
 

Private Member Functions

uiToolButtonBody & mkbody (uiParent *, const char *icon_identifier, const uiString &)
 

Private Attributes

int id_
 
uiToolButtonBody * tbbody_
 
uiMenuuimenu_
 

Additional Inherited Members

- Public Attributes inherited from uiButton
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 inherited from uiButton
 uiButton (uiParent *, const uiString &, const CallBack *, uiObjectBody &)
 
virtual void setPM (const uiPixmap &)
 
void translateText () override
 
- 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...
 
uiObjectBodyobjBody ()
 
const uiObjectBodyobjBody () const
 
void triggerSetGeometry (const i_LayoutItem *, uiRect &)
 setGeometry should be triggered by this's layoutItem More...
 
void updateToolTip (CallBacker *=nullptr)
 
- Protected Member Functions inherited from uiBaseObject
void setBody (uiBody *b)
 
- Protected Member Functions inherited from NamedCallBacker
void sendDelNotif () const
 
- Protected Attributes inherited from uiButton
float iconscale_
 
uiString text_
 
- Protected Attributes inherited from uiObject
uiString tooltip_
 
uiObjEventFilter * uiobjeventfilter_
 
- Protected Attributes inherited from NamedCallBacker
Threads::Atomic< bool > delalreadytriggered_
 
Notifier< NamedCallBackerdelnotif_
 
- Protected Attributes inherited from NamedObject
BufferString name_
 
- Static Protected Attributes inherited from uiButton
static bool havecommonpbics_
 

Detailed Description

<>

Member Enumeration Documentation

◆ ArrowType

Enumerator
NoArrow 
UpArrow 
DownArrow 
LeftArrow 
RightArrow 

◆ PopupMode

Enumerator
DelayedPopup 
MenuButtonPopup 
InstantPopup 

Constructor & Destructor Documentation

◆ uiToolButton() [1/3]

uiToolButton::uiToolButton ( uiParent ,
const uiToolButtonSetup  
)

◆ uiToolButton() [2/3]

uiToolButton::uiToolButton ( uiParent ,
const char *  filenm,
const uiString tooltip,
const CallBack  
)

◆ uiToolButton() [3/3]

uiToolButton::uiToolButton ( uiParent ,
ArrowType  ,
const uiString tooltip,
const CallBack  
)

◆ ~uiToolButton()

uiToolButton::~uiToolButton ( )

Member Function Documentation

◆ click()

void uiToolButton::click ( )
overridevirtual

Implements uiButton.

◆ getStd()

static uiToolButton* uiToolButton::getStd ( uiParent ,
OD::StdActionType  ,
const CallBack ,
const uiString ttip 
)
static

◆ id()

int uiToolButton::id ( ) const
inline

◆ isOn()

bool uiToolButton::isOn ( ) const

◆ isToggleButton()

bool uiToolButton::isToggleButton ( ) const

◆ menu()

const uiMenu* uiToolButton::menu ( ) const
inline

◆ mkbody()

uiToolButtonBody& uiToolButton::mkbody ( uiParent ,
const char *  icon_identifier,
const uiString  
)
private

◆ setArrowType()

void uiToolButton::setArrowType ( ArrowType  )

◆ setID()

void uiToolButton::setID ( int  i)
inline

◆ setMenu()

void uiToolButton::setMenu ( uiMenu ,
PopupMode  = MenuButtonPopup 
)

Menu becomes mine.

◆ setOn()

void uiToolButton::setOn ( bool  yn = true)

◆ setShortcut()

void uiToolButton::setShortcut ( const char *  )

◆ setToggleButton()

void uiToolButton::setToggleButton ( bool  yn = true)

Member Data Documentation

◆ id_

int uiToolButton::id_
private

◆ tbbody_

uiToolButtonBody* uiToolButton::tbbody_
private

◆ uimenu_

uiMenu* uiToolButton::uimenu_
private

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