Classes
class	i_uiLayoutItem
	Wrapper around QLayoutItem class. Stores some dGB specific layout info. More...

class	ODQtObjectSet< OD, QT >

class	uiActionSeparString

class	uiActionContainer

class	CmdRecStopper

class	uiBodyImpl< C, T >
	Simple delegating implementation of uiBody. More...

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

class	uiRadioButton

class	uiCheckBox

class	uiButtonMessenger
	Button Abstract Base class. More...

class	uiButtonGroup

class	uiClipboard

class	uiColorInput
	small element for color selection. Has no text label. More...

class	uiComboBox
	Combo box. More...

class	uiLabeledComboBox

class	uiCalendar

class	uiDateSel

class	uiDesktopServices

class	uiDial

class	uiDialExtra

class	uiDialExtra::Setup

class	uiDialog

class	uiDialog::Setup
	description of properties of dialog. More...

class	uiEventFilter
	is a class that is able to recieve events from Qt and trigger an OD-style notification/callback. More...

class	uiFileDialog
	Dialog to get a file or directory name from user. More...

class	uiFont

class	uiFontList

class	uiSize

class	uiRect

class	uiBorder

class	uiGraphicsItemSet

class	uiGraphicsItemGroup

class	uiObjectItem

class	uiEllipseItem

class	uiCircleItem

class	uiLineItem

class	uiDynamicImageItem

class	uiPixmapItem

class	uiPolygonItem

class	uiPolyLineItem

class	uiMultiColorPolyLineItem

class	uiRectItem

class	uiTextItem

class	uiAdvancedTextItem

class	uiMarkerItem

class	uiPointItem

class	uiArrowItem

class	uiCurvedItem

class	uiCurvedItem::SplineSpec

class	uiCurvedItem::ArcSpec

class	uiManipHandleItem
	lines looking like a user can pick it up and drag it. More...

class	uiManipHandleItem::Setup

class	uiGraphicsScene

class	uiGraphicsObjectScene

class	uiGraphicsSceneChanger

class	uiGraphicsViewBase

class	uiGroup

class	SimpleHelpProvider
	A simple HelpProvider that can be extended to create a HelpProvider for third party plug-ins. You need a urlbase string which can refer to a web URL (starting with "http://") or a local file path (starting with "file:///"). For linking the individual HelpKeys, you can either add links for specific keys using the function: More...

class	FlareHelpProvider

class	DevDocHelp

class	WebsiteHelp

class	uiLabel

class	uiConstraint

class	uiIntValidator

class	uiFloatValidator

class	uiLineEdit

class	uiListBox
	List Box. More...

class	uiListBox::Setup

class	uiMain

class	uiMainWin
	User interface main window. More...

class	uiMainWin::Setup

class	uiMdiArea

class	uiMenu

class	uiMouseEventBlockerByGestures

class	uiMsg

class	uiMsgMainWinSetter
	Sets the uiMSG's main window temporary during the scope of the object. More...

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

class	uiObjBodyImpl< C, T >
	Default (Template) implementation of uiObjectBody. More...

class	uiObjectStack

class	uiParent

class	uiParentBody

class	uiPixmap
	Off-screen pixel-based paint device. More...

class	uiProgressBar

class	uiRGBImageLoader

class	uiSeparator

class	uiKeyDesc

class	uiShortcutsList

class	uiShortcutsMgr

class	uiExtraIntKeyDesc

class	uiSliderObj

class	uiSlider

class	uiSlider::Setup

class	uiSpinBox

class	uiLabeledSpinBox

class	uiSplitter
	Provides a splitter object. More...

class	uiStatusBar

class	uiSystemTrayIcon

class	uiTabBar
	TabBar widget only. Normally you'd want to use the uiTabStack class. More...

class	uiTab

class	uiTable

class	uiTable::SelectionRange

class	uiTable::Setup

class	uiTabStack

class	uiTextEditBase

class	uiTextEdit

class	uiTextBrowser

class	uiToolBar

class	uiToolButton

class	uiToolButtonSetup

class	uiTreeView

class	uiTreeViewItem

class	uiTreeViewItem::Setup

class	uiVirtualKeyboard

Macros
#define	mBlockCmdRec CmdRecStopper cmdrecstopper(this);

Functions
	mFDQtclass (QWidget) class uiBody

mODTextTranslationClass(uiColorInput) public	uiColorInput::uiColorInput (uiParent , const Setup &, const char nm=0)

	mFDQtclass (QIcon) class uiIcon
	Manager for icons of different sizes. More...

	mFDQtclass (QMouseEvent) mFDQtclass(QRubberBand) mFDQtclass(QWidget) class uiRubberBand

	mFDQtclass (QSplashScreen) class uiSplashScreen

Detailed Description

Introduction

This module is a set of cooperating classes that enable creating User Interfaces. This layer on top of the already wonderful Qt package was created because of the following problems:

Qt provides an enormous set of tools, of which we need only a fraction
On the other hand, Qt does not offer things like:
- Selection of widget on basis of data characteristics
- Automated 'black-box' layouting (enabling full grouping into new classes)
- Integration with our data types
- Generalised Callback/Notifier support (instead of Qt's Signal/Slot)
If we use Qt directly, no isolation is present.

Therefore, as with most external libraries, we chose to make a new layer to combine the power of Qt with the flexibility of more generalised design principles.

Usage

The basic principles are:

Objects are linked to each other in the window by attaching. This determines the layout of the window.
Events are notified by specifically asking a Notifier in the class.
All objects can be grouped; every group must be prepared to be attached to other UI elements; this is done by assigning one of the objects as being the 'align object'.
'Simple' data input should preferably be done through the uiGenInput class (see uiTools module).

The Qt window painting facilities are only used for quick sketching, the code generation capacity is not used. Example:

IntInpSpec spec( lastnrclasses ); spec.setLimits( Interval<int>( 0, 100 ) ); nrclassfld = new uiGenInput( this, "Number of classes", spec ); FloatInpSpec inpspec( lastratiotst*100 ); inpspec.setLimits( Interval<float>( 0, 100 ) ); perctstfld = new uiGenInput( this, "Percentage used for test set", inpspec ); perctstfld->attach( alignedBelow, nrclassfld ); defbut = new uiPushButton( this, "Default" ); defbut->activated.notify( mCB(this,ThisClass,setPercToDefault) ); defbut->attach( rightOf, perctstfld );

Note that all objects could have been made:

Conditional (only if a condition is met)
Iterative (any number that may be necessary)
As part of a group (e.g. to later treat as one uiObject)
From a Factory (for example an object transforming a string into a uiObject).

Design

In the uiBase directory, you'll find classes that directly communicate with Qt to implement (parts of) this strategy. To keep the header files uncoupled from the Qt header files, there is a mechanism where the 'ui' class has a 'ui'-Body class that is a subclass of a Qt class.

Almost every 'visible' object is a uiObject. Besides the different subclasses, there is also the uiGroup which is just another uiObject. The windows holding these are (like uiObjects) uiBaseObject's. The uiMainWin is a subclass, and the ubiquitous uiDialog.

Macro Definition Documentation

#define mBlockCmdRec CmdRecStopper cmdrecstopper(this);

The main class for all UI-objects in OpendTect. Normally, there is one widget per class, but there can be multiple. If so, each widget has a relative position related to the others, as returned from getWidgetOrigin and getWidgetSpan.

<Triggers translation of object and all members to current language.

Function Documentation

mFDQtclass ( QWidget )

can return 0

mFDQtclass ( QMouseEvent )

mFDQtclass ( QIcon )

Manager for icons of different sizes.

Icons can be created from the identifier, see odiconfile.h. It is, basically, the file name without extension.

mFDQtclass ( QSplashScreen )

mODTextTranslationClass (uiColorInput) public uiColorInput::uiColorInput	(	uiParent *	,
		const Setup &	,
		const char *	nm = `0`
	)

private

Classes