uiODMain Class Reference

OpendTect application top level object. More...

Inheritance diagram for uiODMain:

Public Member Functions
	uiODMain (uiMain &)
	~uiODMain ()
uiODApplMgr &	applMgr ()
bool	askStore (bool &askedanything, const uiString &actiontype)
bool	askStoreAttribs (bool, bool &askedanything)
void	autoSession ()
	pops up the auto session dlg More...
uiVisColTabEd &	colTabEd ()
uiToolBar *	colTabToolBar ()
void	exit (bool interact=true, bool doconfirm=true)
uiString	getProgramName ()
bool	go ()
bool	hasSessionChanged ()
bool	isRestoringSession ()
uiODMenuMgr &	menuMgr ()
bool	menuMgrAvailable () const
void	restart (bool interact=true, bool doconfirm=true)
void	restoreSession ()
	pops up the restore session dlg More...
void	saveSession ()
	pops up the save session dialog More...
uiODSceneMgr &	sceneMgr ()
bool	sceneMgrAvailable () const
uiServiceClientMgr &	serviceMgr ()
IOPar &	sessionPars ()
void	setProgInfo (const char *)
void	setProgramName (const char *)
void	updateCaption ()
uiODViewer2DMgr &	viewer2DMgr ()
bool	viewer2DMgrAvailable () const
Public Member Functions inherited from uiMainWin
	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 ()
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. More...
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 ()
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 More...
void	setGeometry (const uiRect &)
void	setIcon (const uiPixmap &)
	Default icon is set in uiMain. More...
void	setIconText (const uiString &)
void	setPopupArea (PopupArea pa)
void	setSensitive (bool yn)
void	setShrinkAllowed (bool yn)
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 ()
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 More...
Public Member Functions inherited from uiParent
uiSize	actualsize (bool inclborder=true) const
uiSize	actualSize (bool include_border) const
void	addChild (uiBaseObject &)
void	attach (constraintType t, int margin=-1)
void	attach (constraintType t, uiObject *oth, int margin=-1, bool reciprocal=true)
void	attach (constraintType t, 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 *=0)
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 &c)
void	setCaption (const uiString &c)
void	setCursor (const MouseCursor &c)
void	setFocus ()
void	setFont (const uiFont &f)
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 *=0)
int	stretch (bool h) const
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
virtual QWidget *	getWidget ()
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
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 uiString	sODDesc ()
Static Public Member Functions inherited from uiMainWin
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	getActivateBehaviour ()
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 More...
static void	programActiveWindow (uiMainWin *)
static uiMainWin *	programmedActiveWindow ()
static void	setActivateBehaviour (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< uiODMain >	beforeExit
Notifier< uiODMain >	justBeforeGo
	Scenes inited, auto-plugins loaded. More...
Notifier< uiODMain >	sessionRestore
	Get data from pars. More...
Notifier< uiODMain >	sessionRestoreEarly
	Get data from pars, before vis. More...
Notifier< uiODMain >	sessionSave
	Put data in pars. More...
Public Attributes inherited from uiMainWin
Notifier< uiMainWin >	activatedone
Notifier< uiMainWin >	afterPopup
Notifier< uiMainWin >	ctrlCPressed
Notifier< uiMainWin >	runScriptRequest
Notifier< uiMainWin >	windowClosed
	triggered when window exits More...
Notifier< uiMainWin >	windowHidden
Notifier< uiMainWin >	windowShown

Protected Member Functions
void	afterStartupCB (CallBacker *)
void	afterSurveyChgCB (CallBacker *)
bool	closeOK () override
	confirm window close More...
bool	closeOK (bool interact, bool doconfirm)
void	handleStartupSession ()
bool	prepareRestart (bool interact, bool doconfirm)
void	restoreSession (const IOObj *)
Protected Member Functions inherited from uiMainWin
	uiMainWin (uiString, uiParent *)
void	aftPopupCB (CallBacker *)
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	setForceFinalise (bool yn)
void	setForceFinalize (bool)
void	updateCaption ()
Protected Member Functions inherited from uiParent
	uiParent (const char *nm, uiParentBody *)
	~uiParent ()
virtual void	attach_ (constraintType t, uiObject *oth, int margin=-1, bool reciprocal=true)
Protected Member Functions inherited from uiBaseObject
void	setBody (uiBody *b)
Protected Member Functions inherited from NamedCallBacker
void	sendDelNotif () const

Protected Attributes
uiODApplMgr *	applmgr_
uiVisColTabEd *	ctabed_
uiToolBar *	ctabtb_
MultiID	cursessid_
ODSession *	cursession_ = nullptr
bool	failed_ = true
ODSession &	lastsession_
uiODMenuMgr *	menumgr_
BufferString	programinfo_
BufferString	programname_
bool	restarting_ = false
bool	restoringsess_ = false
uiODSceneMgr *	scenemgr_
uiMain &	uiapp_
uiODViewer2DMgr *	viewer2dmgr_
Protected Attributes inherited from uiMainWin
Timer *	afterpopuptimer_
uiMainWinBody *	body_
uiString	caption_
int	languagechangecount_
uiParent *	parent_
PopupArea	popuparea_
BufferString	scripttorun_
uiString	uniquecaption_
Protected Attributes inherited from NamedCallBacker
Threads::Atomic< bool >	delalreadytriggered_
Notifier< NamedCallBacker >	delnotif_
Protected Attributes inherited from NamedObject
BufferString	name_

Private Member Functions
bool	buildUI ()
void	checkUpdateAvailable ()
void	doRestoreSession ()
mDeprecatedObs bool	ensureGoodDataDir ()
mDeprecatedObs bool	ensureGoodSurveySetup ()
uiString	getProgramString () const
CtxtIOObj *	getUserSessionIOData (bool)
void	initScene ()
void	memTimerCB (CallBacker *)
void	newSurvInitTimerCB (CallBacker *)
void	sessTimerCB (CallBacker *)
void	translateText () override
void	updateCaptionCB (CallBacker *)
bool	updateSession ()
void	updateStatusCB (CallBacker *)

Private Attributes
Timer &	memtimer_
bool	neednewsurvinit_ = false
Timer &	newsurvinittimer_
Timer &	sesstimer_

Friends
int	ODMain (uiMain &)

Additional Inherited Members
Public Types inherited from uiMainWin
enum	ActModalTyp {   None =0 , Main , Message , File ,   Colour , Font , Unknown }
enum	Dock {   Top , Bottom , Right , Left ,   Minimized , TornOff , Unmanaged }
	Dock Selector. More...
enum	PopupArea {   TopLeft , TopRight , BottomLeft , BottomRight ,   Middle , Auto }
Public Types inherited from ObjectWithName
typedef OD::String	name_type

Detailed Description

OpendTect application top level object.

<>

Constructor & Destructor Documentation

uiODMain()

uiODMain::uiODMain

(

uiMain &

)

~uiODMain()

uiODMain::~uiODMain

(

)

Member Function Documentation

afterStartupCB()

void uiODMain::afterStartupCB ( CallBacker *  )

protected

afterSurveyChgCB()

void uiODMain::afterSurveyChgCB ( CallBacker *  )

protected

applMgr()

uiODApplMgr& uiODMain::applMgr ( )

inline

askStore()

bool uiODMain::askStore	(	bool &	askedanything,
		const uiString &	actiontype
	)

Asks user if session, picksets or attributesets need to be stored.

askStoreAttribs()

bool uiODMain::askStoreAttribs	(	bool	,
		bool &	askedanything
	)

Asks user if attributesets (2D or 3D ) need to be stored.

autoSession()

void uiODMain::autoSession

(

)

pops up the auto session dlg

buildUI()

bool uiODMain::buildUI ( )

private

checkUpdateAvailable()

void uiODMain::checkUpdateAvailable ( )

private

closeOK() [1/2]

bool uiODMain::closeOK ( )

inlineoverrideprotectedvirtual

confirm window close

Reimplemented from uiMainWin.

closeOK() [2/2]

bool uiODMain::closeOK ( bool  interact, bool  doconfirm  )

protected

colTabEd()

uiVisColTabEd& uiODMain::colTabEd ( )

inline

colTabToolBar()

uiToolBar* uiODMain::colTabToolBar ( )

inline

doRestoreSession()

void uiODMain::doRestoreSession ( )

private

ensureGoodDataDir()

mDeprecatedObs bool uiODMain::ensureGoodDataDir ( )

private

ensureGoodSurveySetup()

mDeprecatedObs bool uiODMain::ensureGoodSurveySetup ( )

private

exit()

void uiODMain::exit	(	bool	interact = true,
		bool	doconfirm = true
	)

getProgramName()

uiString uiODMain::getProgramName

(

)

getProgramString()

uiString uiODMain::getProgramString ( ) const

private

getUserSessionIOData()

CtxtIOObj* uiODMain::getUserSessionIOData ( bool  )

private

go()

bool uiODMain::go

(

)

handleStartupSession()

void uiODMain::handleStartupSession ( )

protected

hasSessionChanged()

bool uiODMain::hasSessionChanged

(

)

Compares current session with last saved.

initScene()

void uiODMain::initScene ( )

private

isRestoringSession()

bool uiODMain::isRestoringSession ( )

inline

memTimerCB()

void uiODMain::memTimerCB ( CallBacker *  )

private

menuMgr()

uiODMenuMgr& uiODMain::menuMgr ( )

inline

• toolbar

menuMgrAvailable()

bool uiODMain::menuMgrAvailable ( ) const

inline

newSurvInitTimerCB()

void uiODMain::newSurvInitTimerCB ( CallBacker *  )

private

prepareRestart()

bool uiODMain::prepareRestart ( bool  interact, bool  doconfirm  )

protected

restart()

void uiODMain::restart	(	bool	interact = true,
		bool	doconfirm = true
	)

restoreSession() [1/2]

void uiODMain::restoreSession

(

)

pops up the restore session dlg

restoreSession() [2/2]

void uiODMain::restoreSession ( const IOObj *  )

protected

saveSession()

void uiODMain::saveSession

(

)

pops up the save session dialog

sceneMgr()

uiODSceneMgr& uiODMain::sceneMgr ( )

inline

sceneMgrAvailable()

bool uiODMain::sceneMgrAvailable ( ) const

inline

serviceMgr()

uiServiceClientMgr& uiODMain::serviceMgr

(

)

sessionPars()

IOPar& uiODMain::sessionPars

(

)

On session save or restore notification, to get/put data

sessTimerCB()

void uiODMain::sessTimerCB ( CallBacker *  )

private

setProgInfo()

void uiODMain::setProgInfo

(

const char *

)

setProgramName()

void uiODMain::setProgramName

(

const char *

)

sODDesc()

static uiString uiODMain::sODDesc ( )

inlinestatic

translateText()

void uiODMain::translateText ( )

overrideprivatevirtual

Triggers translation of object and all members to current language.

Reimplemented from uiMainWin.

updateCaption()

void uiODMain::updateCaption

(

)

updateCaptionCB()

void uiODMain::updateCaptionCB ( CallBacker *  )

private

updateSession()

bool uiODMain::updateSession ( )

private

updateStatusCB()

void uiODMain::updateStatusCB ( CallBacker *  )

private

viewer2DMgr()

uiODViewer2DMgr& uiODMain::viewer2DMgr ( )

inline

viewer2DMgrAvailable()

bool uiODMain::viewer2DMgrAvailable ( ) const

inline

Friends And Related Function Documentation

ODMain

int ODMain ( uiMain &  )

friend

Member Data Documentation

applmgr_

uiODApplMgr* uiODMain::applmgr_

protected

beforeExit

Notifier<uiODMain> uiODMain::beforeExit

ctabed_

uiVisColTabEd* uiODMain::ctabed_

protected

ctabtb_

uiToolBar* uiODMain::ctabtb_

protected

cursessid_

MultiID uiODMain::cursessid_

protected

cursession_

ODSession* uiODMain::cursession_ = nullptr

protected

failed_

bool uiODMain::failed_ = true

protected

justBeforeGo

Notifier<uiODMain> uiODMain::justBeforeGo

Scenes inited, auto-plugins loaded.

lastsession_

ODSession& uiODMain::lastsession_

protected

memtimer_

Timer& uiODMain::memtimer_

private

menumgr_

uiODMenuMgr* uiODMain::menumgr_

protected

neednewsurvinit_

bool uiODMain::neednewsurvinit_ = false

private

newsurvinittimer_

Timer& uiODMain::newsurvinittimer_

private

programinfo_

BufferString uiODMain::programinfo_

protected

programname_

BufferString uiODMain::programname_

protected

restarting_

bool uiODMain::restarting_ = false

protected

restoringsess_

bool uiODMain::restoringsess_ = false

protected

scenemgr_

uiODSceneMgr* uiODMain::scenemgr_

protected

sessionRestore

Notifier<uiODMain> uiODMain::sessionRestore

Get data from pars.

sessionRestoreEarly

Notifier<uiODMain> uiODMain::sessionRestoreEarly

Get data from pars, before vis.

sessionSave

Notifier<uiODMain> uiODMain::sessionSave

Put data in pars.

sesstimer_

Timer& uiODMain::sesstimer_

private

uiapp_

uiMain& uiODMain::uiapp_

protected

viewer2dmgr_

uiODViewer2DMgr* uiODMain::viewer2dmgr_

protected