uiObject Class Reference

The base class for most UI elements. More...

Inheritance diagram for uiObject:

Public Types
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 Member Functions
	uiObject (uiParent *, const char *nm)
	uiObject (uiParent *, const char *nm, uiObjectBody &)
	~uiObject ()
void	setHSzPol (SzPolicy)
void	setVSzPol (SzPolicy)
SzPolicy	szPol (bool hor=true) const
virtual int	width () const
	Actual size in pixels. More...
virtual int	height () const
	Actual size in pixels. More...
virtual void	setName (const char *)
void	setToolTip (const uiString &)
const uiString &	toolTip () const
void	translateText ()
void	display (bool yn, bool shrink=false, bool maximized=false)
void	setFocus ()
bool	hasFocus () const
void	disabFocus ()
virtual void	setCursor (const MouseCursor &)
bool	isCursorInside () const
virtual void	setStyleSheet (const char *)
virtual Color	backgroundColor () const
Color	roBackgroundColor () const
virtual void	setBackgroundColor (const Color &)
virtual void	setBackgroundPixmap (const uiPixmap &)
virtual void	setTextColor (const Color &)
void	setSensitive (bool yn=true)
bool	sensitive () const
bool	visible () const
bool	isDisplayed () const
int	prefHNrPics () const
virtual void	setPrefWidth (int)
void	setPrefWidthInChar (int)
void	setPrefWidthInChar (float)
void	setMinimumWidth (int)
void	setMaximumWidth (int)
int	prefVNrPics () const
virtual void	setPrefHeight (int)
void	setPrefHeightInChar (int)
void	setPrefHeightInChar (float)
void	setMinimumHeight (int)
void	setMaximumHeight (int)
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...
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)
void	setFont (const uiFont &)
const uiFont *	font () const
void	setCaption (const uiString &)
void	shallowRedraw (CallBacker *=0)
void	deepRedraw (CallBacker *=0)
void	reDraw (bool deep)
uiSize	actualsize (bool include_border=true) const
uiParent *	parent ()
const uiParent *	parent () const
void	reParent (uiParent *)
uiMainWin *	mainwin ()
	mQtclass (QWidget *) getWidget()
	mQtclass (QWidget *) qwidget()
const	mQtclass (QWidget *) qwidget() const
virtual bool	handleLongTabletPress ()
virtual const ObjectSet< uiBaseObject > *	childList () const
void	close ()

Static Public Member Functions
static void	updateToolTips ()
static void	setTabOrder (uiObject *first, uiObject *second)
static int	baseFldSize ()
static int	iconSize ()

Public Attributes
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
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 Attributes
uiString	tooltip_
uiObjEventFilter *	uiobjeventfilter_

Private Attributes
uiParent *	parent_

Friends
class	uiObjectBody
class	i_LayoutItem

Detailed Description

The base class for most UI elements.

Member Enumeration Documentation

enum uiObject::SzPolicy

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 )

Enumerator
Undef
Small
Medium
Wide
SmallVar
MedVar
WideVar
SmallMax
MedMax
WideMax

Constructor & Destructor Documentation

uiObject::uiObject	(	uiParent *	,
		const char *	nm
	)

uiObject::uiObject	(	uiParent *	,
		const char *	nm,
		uiObjectBody &
	)

uiObject::~uiObject

(

)

Member Function Documentation

uiSize uiObject::actualsize

(

bool

include_border = true

)

const

void uiObject::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.

void uiObject::attach	(	constraintType	,
		uiObject *	,
		int	margin = -1,
		bool	reciprocal = true
	)

void uiObject::attach	(	constraintType	,
		uiParent *	,
		int	margin = -1,
		bool	reciprocal = true
	)

virtual Color uiObject::backgroundColor ( ) const

virtual

Reimplemented in uiGraphicsViewBase.

static int uiObject::baseFldSize ( )

static

virtual const ObjectSet<uiBaseObject>* uiObject::childList ( ) const

inlinevirtual

void uiObject::close

(

)

virtual bool uiObject::closeOK ( )

inlineprotectedvirtual

hook. Accepts/denies closing of window.

void uiObject::deepRedraw ( CallBacker *  = 0 )

inline

void uiObject::disabFocus

(

)

void uiObject::display	(	bool	yn,
		bool	shrink = false,
		bool	maximized = false
	)

const uiFont* uiObject::font

(

)

const

virtual bool uiObject::handleLongTabletPress ( )

virtual

Reimplemented in uiTable, uiComboBox, uiTreeView, uiSpinBox, uiLineEdit, and uiColorTableCanvas.

bool uiObject::hasFocus

(

)

const

virtual int uiObject::height ( ) const

virtual

Actual size in pixels.

Reimplemented in uiGraphicsViewBase.

static int uiObject::iconSize ( )

static

bool uiObject::isCursorInside

(

)

const

bool uiObject::isDisplayed

(

)

const

uiMainWin* uiObject::mainwin

(

)

uiObject::mQtclass ( QWidget *  )

inline

uiObject::mQtclass

(

QWidget *

)

const uiObject::mQtclass ( QWidget *  ) const

inline

uiParent* uiObject::parent ( )

inline

const uiParent* uiObject::parent ( ) const

inline

int uiObject::prefHNrPics

(

)

const

int uiObject::prefVNrPics

(

)

const

void uiObject::reDraw

(

bool

deep

)

void uiObject::reParent

(

uiParent *

)

Color uiObject::roBackgroundColor

(

)

const

bool uiObject::sensitive

(

)

const

virtual void uiObject::setBackgroundColor ( const Color &  )

virtual

Reimplemented in ui3DViewer, and uiGraphicsViewBase.

virtual void uiObject::setBackgroundPixmap ( const uiPixmap &  )

virtual

void uiObject::setCaption

(

const uiString &

)

virtual void uiObject::setCursor ( const MouseCursor &  )

virtual

Reimplemented in uiObjectItemView.

void uiObject::setFocus

(

)

void uiObject::setFont

(

const uiFont &

)

void uiObject::setHSzPol

(

SzPolicy

)

void uiObject::setMaximumHeight

(

int

)

void uiObject::setMaximumWidth

(

int

)

void uiObject::setMinimumHeight

(

int

)

void uiObject::setMinimumWidth

(

int

)

virtual void uiObject::setName ( const char *  )

virtual

virtual void uiObject::setPrefHeight ( int  )

virtual

void uiObject::setPrefHeightInChar

(

int

)

void uiObject::setPrefHeightInChar

(

float

)

virtual void uiObject::setPrefWidth ( int  )

virtual

void uiObject::setPrefWidthInChar

(

int

)

void uiObject::setPrefWidthInChar

(

float

)

void uiObject::setSensitive

(

bool

yn = true

)

void uiObject::setStretch	(	int	hor,
		int	ver
	)

Sets stretch factors for object If stretch factor is > 1, then object will already grow at pop-up.

virtual void uiObject::setStyleSheet ( const char *  )

virtual

static void uiObject::setTabOrder ( uiObject *  first, uiObject *  second  )

static

virtual void uiObject::setTextColor ( const Color &  )

virtual

void uiObject::setToolTip

(

const uiString &

)

void uiObject::setVSzPol

(

SzPolicy

)

void uiObject::shallowRedraw ( CallBacker *  = 0 )

inline

SzPolicy uiObject::szPol

(

bool

hor = true

)

const

const uiString& uiObject::toolTip

(

)

const

void uiObject::translateText

(

)

void uiObject::triggerSetGeometry ( const i_LayoutItem *  , uiRect &    )

protected

setGeometry should be triggered by this's layoutItem

void uiObject::updateToolTip ( CallBacker *  = 0 )

protected

static void uiObject::updateToolTips ( )

static

bool uiObject::visible

(

)

const

virtual int uiObject::width ( ) const

virtual

Actual size in pixels.

Reimplemented in uiGraphicsViewBase.

Friends And Related Function Documentation

friend class i_LayoutItem

friend

friend class uiObjectBody

friend

Member Data Documentation

Notifier<uiObject> uiObject::closed

Triggered when object closes.

uiParent* uiObject::parent_

private

CNotifier<uiObject,uiRect&> uiObject::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.

uiString uiObject::tooltip_

protected

uiObjEventFilter* uiObject::uiobjeventfilter_

protected