uiLabel Class Reference

Inheritance diagram for uiLabel:

Public Member Functions
	uiLabel (uiParent *, const uiString &)
	uiLabel (uiParent *, const uiString &, uiGroup *)
	uiLabel (uiParent *, const uiString &, uiObject *)
	~uiLabel ()
Alignment::HPos	alignment () const
void	makeRequired (bool yn=true)
void	setAlignment (Alignment::HPos)
void	setIcon (const char *iconnm)
void	setPixmap (const uiPixmap &)
virtual void	setText (const uiString &)
	set text on label More...
void	setTextSelectable (bool yn=true)
const uiString &	text () const
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 uiFont *	font () 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
uiMainWin *	mainwin ()
uiParent *	parent ()
const uiParent *	parent () 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 uiString &	toolTip () 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)
uiBody *	body ()
const uiBody *	body () 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 CallBacker *	trueCaller ()
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_type &	name () const override
NamedObject &	operator= (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

Private Member Functions
void	init (const uiString &txt, uiObject *buddy)
uiLabelBody &	mkbody (uiParent *, const uiString &)
void	translateText () override
void	updateWidth ()

Private Attributes
uiLabelBody *	body_
bool	isrequired_
uiString	text_

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
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 inherited from uiObject
Notifier< uiObject >	closed
	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 uiObject
	uiObject (uiParent *, const char *nm)
	uiObject (uiParent *, const char *nm, uiObjectBody &)
virtual bool	closeOK ()
	hook. Accepts/denies closing of window. More...
uiObjectBody *	objBody ()
const uiObjectBody *	objBody () 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 uiObject
uiString	tooltip_
uiObjEventFilter *	uiobjeventfilter_
Protected Attributes inherited from NamedCallBacker
Threads::Atomic< bool >	delalreadytriggered_
Notifier< NamedCallBacker >	delnotif_
Protected Attributes inherited from NamedObject
BufferString	name_

Detailed Description

<>

Constructor & Destructor Documentation

uiLabel() [1/3]

uiLabel::uiLabel	(	uiParent *	,
		const uiString &
	)

uiLabel() [2/3]

uiLabel::uiLabel	(	uiParent *	,
		const uiString &	,
		uiObject *
	)

uiLabel() [3/3]

uiLabel::uiLabel	(	uiParent *	,
		const uiString &	,
		uiGroup *
	)

~uiLabel()

uiLabel::~uiLabel

(

)

Member Function Documentation

alignment()

Alignment::HPos uiLabel::alignment

(

)

const

init()

void uiLabel::init ( const uiString &  txt, uiObject *  buddy  )

private

makeRequired()

void uiLabel::makeRequired

(

bool

yn = true

)

mkbody()

uiLabelBody& uiLabel::mkbody ( uiParent *  , const uiString &    )

private

setAlignment()

void uiLabel::setAlignment

(

Alignment::HPos

)

setting an alignment only makes sense if you reserve space using setPrefWidthInChar();

setIcon()

void uiLabel::setIcon

(

const char *

iconnm

)

setPixmap()

void uiLabel::setPixmap

(

const uiPixmap &

)

setText()

virtual void uiLabel::setText ( const uiString &  )

virtual

set text on label

Note that the layout for the label is not updated when setting a new text. So, if the new text is too long, part of it might be invisible. Therefore, reserve enough space for it with setPrefWidthInChar.

setTextSelectable()

void uiLabel::setTextSelectable

(

bool

yn = true

)

text()

const uiString& uiLabel::text

(

)

const

translateText()

void uiLabel::translateText ( )

overrideprivatevirtual

Triggers translation of object and all members to current language.

Reimplemented from uiBaseObject.

updateWidth()

void uiLabel::updateWidth ( )

private

Member Data Documentation

body_

uiLabelBody* uiLabel::body_

private

isrequired_

bool uiLabel::isrequired_

private

text_

uiString uiLabel::text_

private