uiMainWin Class Reference

User interface main window. More...

#include <uimainwin.h>

Inheritance diagram for uiMainWin:

Classes
class	Setup

Public Types
enum	ActModalTyp {   None =0 , Main , Message , File ,   Color , Font , Unknown }
enum	PopupArea {   TopLeft , TopRight , BottomLeft , BottomRight ,   Middle , Auto }
Public Types inherited from ObjectWithName
typedef OD::String	name_type

Public Member Functions
	uiMainWin (uiParent *, const uiMainWin::Setup &)
	uiMainWin (uiParent *, const uiString &caption=uiString::emptyString(), int nrstatusflds=1, bool withmenubar=true, bool modal=false)
virtual	~uiMainWin ()
void	activate ()
void	activateInGUIThread (const CallBack &, bool busywait=true)
void	addDockWindow (uiDockWin &, Dock)
void	addToolBar (uiToolBar *)
void	addToolBarBreak ()
void	adjustSize ()
const uiString &	caption (bool unique=false) const
void	close ()
void	copyToClipBoard ()
const ObjectSet< uiDockWin > &	dockWins () const
bool	finalised () const
bool	finalized () const
uiToolBar *	findToolBar (const char *)
void	forceClose ()
uiRect	geometry (bool frame=true) const
	Position of top-left corner in screen pixel coords.
PopupArea	getPopupArea () const
const char *	getScriptToRun () const
uiMenu &	getToolbarsMenu () const
bool	grab (const char *filenm, int zoom=1, const char *format=0, int quality=-1) const
bool	isDeleteOnClose () const
bool	isHidden () const
bool	isMaximized () const
bool	isMinimized () const
bool	isModal () const
uiMainWin *	mainwin () override
uiMenuBar *	menuBar ()
	mOD_DisableCopy (uiMainWin) enum Dock
	Dock Selector.
uiParent *	parent ()
const uiParent *	parent () const
bool	poppedUp () const
QScreen *	qScreen () const
QWidget *	qWidget () const
void	raise ()
void	reDraw (bool deep) override
void	removeDockWindow (uiDockWin *)
uiToolBar *	removeToolBar (uiToolBar *)
void	restoreDefaultState ()
void	runScript (const char *filename)
void	saveAsPDF (const char *fnm, int w, int h, int res)
mDeprecatedObs void	saveAsPS (const char *fnm, int w, int h, int res)
void	saveImage (const char *fnm, const char *fmt=nullptr, int quality=-1)
void	saveImage (const char *fnm, int w, int h, int res)
void	setActivateOnFirstShow (bool yn=true)
void	setCaption (const uiString &)
void	setCornerPos (int x, int y)
void	setDeleteOnClose (bool yn)
void	setExitAppOnClose (bool yn)
	automatically set by uiMain::setTopLevel
void	setGeometry (const uiRect &)
void	setIcon (const uiPixmap &)
	Default icon is set in uiMain.
void	setIconText (const uiString &)
void	setPopupArea (PopupArea pa)
void	setSensitive (bool yn)
void	setShrinkAllowed (bool yn)
void	setSizeRelativeToScreen (float width, float height)
	width=.75 means 75% of screenwidth
virtual void	show ()
bool	showAlwaysOnTop (bool yn=true)
void	showAndActivate ()
void	showMaximized ()
void	showMinimized ()
bool	showMinMaxButtons (bool yn=true)
void	showNormal ()
bool	shrinkAllowed ()
uiStatusBar *	statusBar ()
void	tabifyDockWindow (uiDockWin &first, uiDockWin &second)
const ObjectSet< uiToolBar > &	toolBars () const
uiGroup *	topGroup ()
void	toStatusBar (const uiString &, int fldidx=0, int msecs=-1)
bool	touch ()
	resets pop-up timer if !poppedUp yet
void	translateText () override
Public Member Functions inherited from uiParent
uiSize	actualsize (bool inclborder=true) const
uiSize	actualSize (bool include_border) const
void	addChild (uiBaseObject &)
void	attach (ConstraintType, int margin=-1)
void	attach (ConstraintType, uiObject *oth, int margin=-1, bool reciprocal=true)
void	attach (ConstraintType, uiParent *oth, int margin=-1, bool reciprocal=true)
void	attachChild (ConstraintType tp, uiObject *child, uiObject *other, int margin, bool reciprocal)
OD::Color	backgroundColor () const
const ObjectSet< uiBaseObject > *	childList () const
void	deepRedraw (CallBacker *)
virtual void	display (bool yn, bool shrk=false, bool maximize=false)
const uiFont *	font () const
bool	hasFocus () const
bool	isDisplayed () const
uiObject *	mainObject ()
const uiObject *	mainObject () const
void	manageChild (uiBaseObject &, uiObjectBody &)
uiParentBody *	pbody ()
const uiParentBody *	pbody () const
int	prefHNrPics () const
int	prefVNrPics () const
OD::Color	roBackgroundColor () const
bool	sensitive () const
void	setBackgroundColor (const OD::Color &)
void	setCaption (const uiString &)
void	setCursor (const MouseCursor &)
void	setFocus ()
void	setFont (const uiFont &)
void	setPrefHeight (int h)
void	setPrefHeightInChar (float h)
void	setPrefHeightInChar (int h)
void	setPrefWidth (int w)
void	setPrefWidthInChar (float w)
void	setPrefWidthInChar (int w)
void	setSensitive (bool yn=true)
void	setStretch (int h, int v)
void	shallowRedraw (CallBacker *)
int	stretch (bool h) const
void	translateText () override
Public Member Functions inherited from uiBaseObject
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
bool	finalized () const
virtual QWidget *	getWidget ()
const QWidget *	getWidget () const
	mOD_DisableCopy (uiBaseObject) void final ize()
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=nullptr)
	NamedCallBacker (const NamedCallBacker &)=delete
	~NamedCallBacker ()
virtual Notifier< NamedCallBacker > &	objectToBeDeleted () const
NamedCallBacker &	operator= (const NamedCallBacker &)=delete
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.
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.
CallBacker &	operator= (const CallBacker &)=delete
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
virtual void	setName (const char *nm)
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 const char *	activeModalQDlgButTxt (int butnr)
static int	activeModalQDlgRetVal (int butnr)
static const char *	activeModalQDlgTitle ()
static ActModalTyp	activeModalType ()
static uiMainWin *	activeModalWindow ()
static uiMainWin *	activeWindow ()
static void	closeActiveModalQDlg (int retval)
static OD::WindowActivationBehavior	getActivateBehavior ()
static void	getModalSignatures (BufferStringSet &)
static void	getTopLevelWindows (ObjectSet< uiMainWin > &, bool visibleonly=true)
static bool	grabScreen (const char *filenm, const char *format=0, int quality=-1, int screen=0)
static bool	grabScreen (const char *filenm, const char *format=0, int quality=-1, QScreen *qscreen=nullptr)
static uiMainWin *	gtUiWinIfIsBdy (QWidget *mwimpl)
	get uiMainWin for mwimpl if it is a uiMainWinBody
static bool	hasPrintSupport ()
static Notifier< uiMainWin > &	iconSetChanged ()
static void	programActiveWindow (uiMainWin *)
static uiMainWin *	programmedActiveWindow ()
static bool	saveAsPDF (QWidget &, const char *fnm, int width, int height, int res)
static void	setActivateBehavior (OD::WindowActivationBehavior)
static uiString	uniqueWinTitle (const uiString &, QWidget *forwindow=0, BufferString *addendum=0)
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
Notifier< uiMainWin >	activatedone
Notifier< uiMainWin >	afterPopup
Notifier< uiMainWin >	ctrlCPressed
Notifier< uiMainWin >	runScriptRequest
Notifier< uiMainWin >	windowClosed
	triggered when window exits
Notifier< uiMainWin >	windowHidden
Notifier< uiMainWin >	windowShown

Protected Member Functions
	uiMainWin (const uiString &, uiParent *)
void	aftPopupCB (CallBacker *)
virtual bool	closeOK ()
	confirm window close
void	copyToClipBoardCB (CallBacker *)
void	languageChangeCB (CallBacker *)
uiObject *	mainobject () override
void	readSettings ()
void	saveAsPDF_PS (const char *fnm, int w, int h, int res)
void	saveSettings ()
void	setContentsMargins (int l, int t, int r, int b)
void	setForceFinalise (bool yn)
void	setForceFinalize (bool)
void	updateCaption ()
Protected Member Functions inherited from uiParent
	uiParent (const char *nm, uiParentBody *)
	~uiParent ()
	mOD_DisableCopy (uiParent) virtual void attach_(ConstraintType
Protected Member Functions inherited from uiBaseObject
	uiBaseObject (const char *nm, uiBody *=nullptr)
void	setBody (uiBody *b)
Protected Member Functions inherited from NamedCallBacker
void	sendDelNotif () const

Protected Attributes
Timer *	afterpopuptimer_ = nullptr
uiMainWinBody *	body_ = nullptr
uiString	caption_
int	languagechangecount_
uiParent *	parent_
PopupArea	popuparea_
BufferString	scripttorun_
uiString	uniquecaption_
Protected Attributes inherited from uiParent
uiObject int	margin =-1
uiObject *	oth
uiObject int bool	reciprocal =true)
Protected Attributes inherited from NamedCallBacker
Threads::Atomic< bool >	delalreadytriggered_
Notifier< NamedCallBacker >	delnotif_
Protected Attributes inherited from NamedObject
BufferString	name_

Private Member Functions
bool	doSetWindowFlags (od_uint32 qtwinflag, bool set)

Friends
class	uiMainWinBody

Detailed Description

User interface main window.

<>

Member Enumeration Documentation

ActModalTyp

enum uiMainWin::ActModalTyp

Enumerator
None
Main
Message
File
Color
Font
Unknown

PopupArea

enum uiMainWin::PopupArea

Enumerator
TopLeft
TopRight
BottomLeft
BottomRight
Middle
Auto

Constructor & Destructor Documentation

uiMainWin() [1/3]

uiMainWin::uiMainWin	(	uiParent *	,
		const uiMainWin::Setup &	)

uiMainWin() [2/3]

uiMainWin::uiMainWin	(	uiParent *	,
		const uiString &	caption = uiString::emptyString(),
		int	nrstatusflds = 1,
		bool	withmenubar = true,
		bool	modal = false )

~uiMainWin()

virtual uiMainWin::~uiMainWin ( )

virtual

uiMainWin() [3/3]

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

protected

Member Function Documentation

activate()

void uiMainWin::activate

(

)

activateInGUIThread()

void uiMainWin::activateInGUIThread	(	const CallBack &	,
		bool	busywait = true )

activeModalQDlgButTxt()

static const char * uiMainWin::activeModalQDlgButTxt ( int butnr )

static

activeModalQDlgRetVal()

static int uiMainWin::activeModalQDlgRetVal ( int butnr )

static

activeModalQDlgTitle()

static const char * uiMainWin::activeModalQDlgTitle ( )

static

activeModalType()

static ActModalTyp uiMainWin::activeModalType ( )

static

activeModalWindow()

static uiMainWin * uiMainWin::activeModalWindow ( )

static

activeWindow()

static uiMainWin * uiMainWin::activeWindow ( )

static

addDockWindow()

void uiMainWin::addDockWindow	(	uiDockWin &	,
		Dock	)

addToolBar()

void uiMainWin::addToolBar

(

uiToolBar *

)

addToolBarBreak()

void uiMainWin::addToolBarBreak

(

)

adjustSize()

void uiMainWin::adjustSize

(

)

aftPopupCB()

void uiMainWin::aftPopupCB ( CallBacker * )

protected

caption()

const uiString & uiMainWin::caption

(

bool

unique = false

)

const

close()

void uiMainWin::close

(

)

closeActiveModalQDlg()

static void uiMainWin::closeActiveModalQDlg ( int retval )

static

closeOK()

virtual bool uiMainWin::closeOK ( )

inlineprotectedvirtual

confirm window close

Reimplemented in uiODMain, uiStratTreeWin, uiColorBarDialog, uiWellLogToolWin, and uiStratLayerModel.

copyToClipBoard()

void uiMainWin::copyToClipBoard

(

)

copyToClipBoardCB()

void uiMainWin::copyToClipBoardCB ( CallBacker * )

protected

dockWins()

const ObjectSet< uiDockWin > & uiMainWin::dockWins

(

)

const

doSetWindowFlags()

bool uiMainWin::doSetWindowFlags ( od_uint32 qtwinflag, bool set )

private

finalised()

bool uiMainWin::finalised ( ) const

inline

finalized()

bool uiMainWin::finalized

(

)

const

findToolBar()

uiToolBar * uiMainWin::findToolBar

(

const char *

)

forceClose()

void uiMainWin::forceClose

(

)

geometry()

uiRect uiMainWin::geometry

(

bool

frame = true

)

const

Position of top-left corner in screen pixel coords.

getActivateBehavior()

static OD::WindowActivationBehavior uiMainWin::getActivateBehavior ( )

static

getModalSignatures()

static void uiMainWin::getModalSignatures ( BufferStringSet & )

static

getPopupArea()

PopupArea uiMainWin::getPopupArea ( ) const

inline

getScriptToRun()

const char * uiMainWin::getScriptToRun

(

)

const

getToolbarsMenu()

uiMenu & uiMainWin::getToolbarsMenu

(

)

const

getTopLevelWindows()

static void uiMainWin::getTopLevelWindows ( ObjectSet< uiMainWin > & , bool visibleonly = true )

static

grab()

bool uiMainWin::grab	(	const char *	filenm,
		int	zoom = 1,
		const char *	format = 0,
		int	quality = -1 ) const

zoom=0: grab desktop, zoom=1: grab this window, zoom=2: grab active modal window/qdialog, format = .bpm|.jpg|.jpeg|.png|.ppm|.xbm|.xpm format=0: use filenm suffix quality = 0...100: small compressed to large uncompressed file, quality=-1: use default

grabScreen() [1/2]

static bool uiMainWin::grabScreen ( const char * filenm, const char * format = 0, int quality = -1, int screen = 0 )

static

grabScreen() [2/2]

static bool uiMainWin::grabScreen ( const char * filenm, const char * format = 0, int quality = -1, QScreen * qscreen = nullptr )

static

gtUiWinIfIsBdy()

static uiMainWin * uiMainWin::gtUiWinIfIsBdy ( QWidget * mwimpl )

static

get uiMainWin for mwimpl if it is a uiMainWinBody

hasPrintSupport()

static bool uiMainWin::hasPrintSupport ( )

static

iconSetChanged()

static Notifier< uiMainWin > & uiMainWin::iconSetChanged ( )

static

isDeleteOnClose()

bool uiMainWin::isDeleteOnClose

(

)

const

isHidden()

bool uiMainWin::isHidden

(

)

const

isMaximized()

bool uiMainWin::isMaximized

(

)

const

isMinimized()

bool uiMainWin::isMinimized

(

)

const

isModal()

bool uiMainWin::isModal

(

)

const

languageChangeCB()

void uiMainWin::languageChangeCB ( CallBacker * )

protected

mainobject()

uiObject * uiMainWin::mainobject ( )

overrideprotectedvirtual

Reimplemented from uiParent.

mainwin()

uiMainWin * uiMainWin::mainwin ( )

inlineoverridevirtual

Reimplemented from uiParent.

menuBar()

uiMenuBar * uiMainWin::menuBar

(

)

mOD_DisableCopy()

uiMainWin::mOD_DisableCopy ( uiMainWin )

inline

Dock Selector.

< above the central uiGroup, below the menubar.

< below the central uiGroup, above the status bar.

< to the right of the central uiGroup.

< to the left of the central uiGroup.

< the toolbar is not shown - all handles of minimized toolbars are drawn in one row below the menu bar.

< the dock window floats as its own top level window which always stays on top of the main window.

< not managed by a uiMainWin

parent() [1/2]

uiParent * uiMainWin::parent ( )

inline

parent() [2/2]

const uiParent * uiMainWin::parent ( ) const

inline

poppedUp()

bool uiMainWin::poppedUp

(

)

const

programActiveWindow()

static void uiMainWin::programActiveWindow ( uiMainWin * )

static

programmedActiveWindow()

static uiMainWin * uiMainWin::programmedActiveWindow ( )

static

qScreen()

QScreen * uiMainWin::qScreen

(

)

const

qWidget()

QWidget * uiMainWin::qWidget

(

)

const

raise()

void uiMainWin::raise

(

)

readSettings()

void uiMainWin::readSettings ( )

protected

reDraw()

void uiMainWin::reDraw ( bool deep )

overridevirtual

Reimplemented from uiParent.

removeDockWindow()

void uiMainWin::removeDockWindow

(

uiDockWin *

)

removeToolBar()

uiToolBar * uiMainWin::removeToolBar

(

uiToolBar *

)

restoreDefaultState()

void uiMainWin::restoreDefaultState

(

)

runScript()

void uiMainWin::runScript

(

const char *

filename

)

saveAsPDF() [1/2]

void uiMainWin::saveAsPDF	(	const char *	fnm,
		int	w,
		int	h,
		int	res )

saveAsPDF() [2/2]

static bool uiMainWin::saveAsPDF ( QWidget & , const char * fnm, int width, int height, int res )

static

saveAsPDF_PS()

void uiMainWin::saveAsPDF_PS ( const char * fnm, int w, int h, int res )

protected

saveAsPS()

mDeprecatedObs void uiMainWin::saveAsPS ( const char * fnm, int w, int h, int res )

inline

saveImage() [1/2]

void uiMainWin::saveImage	(	const char *	fnm,
		const char *	fmt = nullptr,
		int	quality = -1 )

saveImage() [2/2]

void uiMainWin::saveImage	(	const char *	fnm,
		int	w,
		int	h,
		int	res )

saveSettings()

void uiMainWin::saveSettings ( )

protected

setActivateBehavior()

static void uiMainWin::setActivateBehavior ( OD::WindowActivationBehavior )

static

setActivateOnFirstShow()

void uiMainWin::setActivateOnFirstShow

(

bool

yn = true

)

setCaption()

void uiMainWin::setCaption

(

const uiString &

)

setContentsMargins()

void uiMainWin::setContentsMargins ( int l, int t, int r, int b )

protected

setCornerPos()

void uiMainWin::setCornerPos	(	int	x,
		int	y )

setDeleteOnClose()

void uiMainWin::setDeleteOnClose

(

bool

yn

)

setExitAppOnClose()

void uiMainWin::setExitAppOnClose

(

bool

yn

)

automatically set by uiMain::setTopLevel

setForceFinalise()

void uiMainWin::setForceFinalise ( bool yn )

inlineprotected

setForceFinalize()

void uiMainWin::setForceFinalize ( bool )

protected

setGeometry()

void uiMainWin::setGeometry

(

const uiRect &

)

setIcon()

void uiMainWin::setIcon

(

const uiPixmap &

)

Default icon is set in uiMain.

setIconText()

void uiMainWin::setIconText

(

const uiString &

)

setPopupArea()

void uiMainWin::setPopupArea ( PopupArea pa )

inline

setSensitive()

void uiMainWin::setSensitive

(

bool

yn

)

setShrinkAllowed()

void uiMainWin::setShrinkAllowed

(

bool

yn

)

setSizeRelativeToScreen()

void uiMainWin::setSizeRelativeToScreen	(	float	width,
		float	height )

width=.75 means 75% of screenwidth

show()

virtual void uiMainWin::show ( )

virtual

Reimplemented in uiSeisExpCubePositionsDlg, and uiDirLightDlg.

showAlwaysOnTop()

bool uiMainWin::showAlwaysOnTop

(

bool

yn = true

)

showAndActivate()

void uiMainWin::showAndActivate

(

)

showMaximized()

void uiMainWin::showMaximized

(

)

showMinimized()

void uiMainWin::showMinimized

(

)

showMinMaxButtons()

bool uiMainWin::showMinMaxButtons

(

bool

yn = true

)

showNormal()

void uiMainWin::showNormal

(

)

shrinkAllowed()

bool uiMainWin::shrinkAllowed

(

)

statusBar()

uiStatusBar * uiMainWin::statusBar

(

)

tabifyDockWindow()

void uiMainWin::tabifyDockWindow	(	uiDockWin &	first,
		uiDockWin &	second )

toolBars()

const ObjectSet< uiToolBar > & uiMainWin::toolBars

(

)

const

topGroup()

uiGroup * uiMainWin::topGroup

(

)

toStatusBar()

void uiMainWin::toStatusBar	(	const uiString &	,
		int	fldidx = 0,
		int	msecs = -1 )

touch()

bool uiMainWin::touch

(

)

resets pop-up timer if !poppedUp yet

translateText()

void uiMainWin::translateText ( )

overridevirtual

Triggers translation of object and all members to current language.

Reimplemented from uiBaseObject.

Reimplemented in uiODMain.

uniqueWinTitle()

static uiString uiMainWin::uniqueWinTitle ( const uiString & , QWidget * forwindow = 0, BufferString * addendum = 0 )

static

updateCaption()

void uiMainWin::updateCaption ( )

protected

Friends And Related Symbol Documentation

uiMainWinBody

friend class uiMainWinBody

friend

Member Data Documentation

activatedone

Notifier<uiMainWin> uiMainWin::activatedone

afterPopup

Notifier<uiMainWin> uiMainWin::afterPopup

afterpopuptimer_

Timer* uiMainWin::afterpopuptimer_ = nullptr

protected

body_

uiMainWinBody* uiMainWin::body_ = nullptr

protected

caption_

uiString uiMainWin::caption_

protected

ctrlCPressed

Notifier<uiMainWin> uiMainWin::ctrlCPressed

languagechangecount_

int uiMainWin::languagechangecount_

protected

parent_

uiParent* uiMainWin::parent_

protected

popuparea_

PopupArea uiMainWin::popuparea_

protected

runScriptRequest

Notifier<uiMainWin> uiMainWin::runScriptRequest

scripttorun_

BufferString uiMainWin::scripttorun_

protected

uniquecaption_

uiString uiMainWin::uniquecaption_

protected

windowClosed

Notifier<uiMainWin> uiMainWin::windowClosed

triggered when window exits

windowHidden

Notifier<uiMainWin> uiMainWin::windowHidden

windowShown

Notifier<uiMainWin> uiMainWin::windowShown