Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Member Functions | Private Attributes | Friends

uiObject Class Reference

Inheritance diagram for uiObject:
uiBaseObject NamedObject CallBacker uiButton uiComboBox uiDial uiDrawableObj uiGraphicsViewBase uiGroupObj uiLabel uiLineEdit uiListBox uiListView uiMdiArea uiObjectStack uiProgressBar uiSeparator uiSlider uiSpinBox uiSplitter uiTabBar uiTable uiTextEditBase

List of all members.

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.
virtual int height () const
 Actual size in pixels.
virtual void setName (const char *)
void setToolTip (const char *)
const char * toolTip () const
virtual void translate ()
void display (bool yn, bool shrink=false, bool maximised=false)
void setFocus ()
bool hasFocus () const
void disabFocus ()
void setCursor (const MouseCursor &)
bool isCursorInside () const
virtual Color backgroundColor () const
virtual void setBackgroundColor (const Color &)
virtual void setBackgroundPixmap (const ioPixmap &)
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 (float)
void setMinimumWidth (int)
int prefVNrPics () const
virtual void setPrefHeight (int)
void setPrefHeightInChar (float)
void setStretch (int hor, int ver)
 Sets stretch factors for object If stretch factor is > 1, then object will already grow at pop-up.
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.
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 uiFontfont () const
void setCaption (const char *)
void shallowRedraw (CallBacker *=0)
void deepRedraw (CallBacker *=0)
void reDraw (bool deep)
uiSize actualsize (bool include_border=true) const
uiParentparent ()
const uiParentparent () const
void reParent (uiParent *)
uiMainWinmainwin ()
QWidget * qwidget ()
const QWidget * qwidget () const
virtual bool handleLongTabletPress ()
virtual const ObjectSet
< uiBaseObject > * 
childList () const
void close ()

Static Public Member Functions

static void useNameToolTip (bool)
static void setTabOrder (uiObject *first, uiObject *second)
static int baseFldSize ()
static int iconSize ()

Public Attributes

Notifier< uiObjectclosed
 Triggered when object closes.
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.

Protected Member Functions

virtual bool closeOK ()
 hook. Accepts/denies closing of window.
void triggerSetGeometry (const i_LayoutItem *, uiRect &)
 setGeometry should be triggered by this's layoutItem
void doSetToolTip ()

Protected Attributes

BufferString normaltooltiptxt_
uiObjEventFilter * uiobjeventfilter_

Static Protected Attributes

static bool nametooltipactive_
static Color normaltooltipcolor_

Private Member Functions

void trlReady (CallBacker *)

Private Attributes

uiParentparent_
int translateid_

Friends

class uiObjectBody
class i_LayoutItem

Detailed Description

\ The base class for most UI elements.


Member Enumeration Documentation

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  ,
uiParent ,
int  margin = -1,
bool  reciprocal = true 
)
void uiObject::attach ( constraintType  ,
uiObject ,
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 [inline, virtual]

Reimplemented in uiGroupObj.

void uiObject::close (  ) 
virtual bool uiObject::closeOK (  )  [inline, protected, virtual]

hook. Accepts/denies closing of window.

void uiObject::deepRedraw ( CallBacker = 0  )  [inline]
void uiObject::disabFocus (  ) 
void uiObject::display ( bool  yn,
bool  shrink = false,
bool  maximised = false 
)
void uiObject::doSetToolTip (  )  [protected]
const uiFont* uiObject::font (  )  const
virtual bool uiObject::handleLongTabletPress (  )  [virtual]

Reimplemented in uiLineEdit, uiListBox, uiListView, uiSpinBox, and uiTable.

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 (  ) 
const uiParent* uiObject::parent (  )  const [inline]
uiParent* uiObject::parent (  )  [inline]

Reimplemented in uiListView.

int uiObject::prefHNrPics (  )  const
int uiObject::prefVNrPics (  )  const
const QWidget* uiObject::qwidget (  )  const [inline]
QWidget* uiObject::qwidget (  ) 
void uiObject::reDraw ( bool  deep  ) 
void uiObject::reParent ( uiParent  ) 
bool uiObject::sensitive (  )  const
virtual void uiObject::setBackgroundColor ( const Color  )  [virtual]

Reimplemented in uiGraphicsViewBase.

virtual void uiObject::setBackgroundPixmap ( const ioPixmap  )  [virtual]
void uiObject::setCaption ( const char *   ) 
void uiObject::setCursor ( const MouseCursor  ) 
void uiObject::setFocus (  ) 
void uiObject::setFont ( const uiFont  ) 
void uiObject::setHSzPol ( SzPolicy   ) 
void uiObject::setMinimumWidth ( int   ) 
virtual void uiObject::setName ( const char *   )  [virtual]

Reimplemented from NamedObject.

virtual void uiObject::setPrefHeight ( int   )  [virtual]
void uiObject::setPrefHeightInChar ( float   ) 
virtual void uiObject::setPrefWidth ( int   )  [virtual]
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.

static void uiObject::setTabOrder ( uiObject first,
uiObject second 
) [static]
virtual void uiObject::setTextColor ( const Color  )  [virtual]
void uiObject::setToolTip ( const char *   ) 

Reimplemented in uiLineEdit.

void uiObject::setVSzPol ( SzPolicy   ) 
void uiObject::shallowRedraw ( CallBacker = 0  )  [inline]
SzPolicy uiObject::szPol ( bool  hor = true  )  const
const char* uiObject::toolTip (  )  const
virtual void uiObject::translate (  )  [virtual]

Reimplemented in uiListView.

void uiObject::triggerSetGeometry ( const i_LayoutItem ,
uiRect  
) [protected]

setGeometry should be triggered by this's layoutItem

void uiObject::trlReady ( CallBacker  )  [private]
static void uiObject::useNameToolTip ( bool   )  [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

Triggered when object closes.

bool uiObject::nametooltipactive_ [static, protected]
Color uiObject::normaltooltipcolor_ [static, protected]

Reimplemented in uiListView.

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.

int uiObject::translateid_ [private]
uiObjEventFilter* uiObject::uiobjeventfilter_ [protected]