uiMainWin Class Reference

User interface main window. More...

Inheritance diagram for uiMainWin:

Classes
class	Setup

Public Types
enum	Dock {   Top, Bottom, Right, Left,   Minimized, TornOff, Unmanaged }
	Dock Selector. More...
enum	PopupArea {   TopLeft, TopRight, BottomLeft, BottomRight,   Middle, Auto }
enum	ActModalTyp {   None =0, Main, Message, File,   Colour, Font, Unknown }

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 ()
uiStatusBar *	statusBar ()
uiMenuBar *	menuBar ()
void	setCaption (const uiString &)
const uiString &	caption (bool unique=false) const
void	setIcon (const uiPixmap &)
	Default icon is set in uiMain. More...
void	setIconText (const uiString &)
virtual void	show ()
void	close ()
void	raise ()
void	showMaximized ()
void	showMinimized ()
void	showNormal ()
bool	isMaximized () const
bool	isMinimized () const
bool	isHidden () const
bool	isModal () const
void	setSensitive (bool yn)
void	toStatusBar (const uiString &, int fldidx=0, int msecs=-1)
virtual void	reDraw (bool deep)
uiGroup *	topGroup ()
void	setShrinkAllowed (bool yn)
bool	shrinkAllowed ()
void	setExitAppOnClose (bool yn)
	automatically set by uiMain::setTopLevel More...
void	setDeleteOnClose (bool yn)
void	removeDockWindow (uiDockWin *)
void	addDockWindow (uiDockWin &, Dock)
void	addToolBar (uiToolBar *)
uiToolBar *	findToolBar (const char *)
uiToolBar *	removeToolBar (uiToolBar *)
void	addToolBarBreak ()
uiMenu &	getToolbarsMenu () const
const ObjectSet< uiToolBar > &	toolBars () const
const ObjectSet< uiDockWin > &	dockWins () const
void	setPopupArea (PopupArea pa)
PopupArea	getPopupArea () const
void	setCornerPos (int x, int y)
uiRect	geometry (bool frame=true) const
	Position of top-left corner in screen pixel coords. More...
bool	poppedUp () const
bool	resetPopupTimerIfNotPoppedUp ()
bool	finalised () const
virtual uiMainWin *	mainwin ()
int	getNrWidgets () const
	mQtclass (QWidget *) getWidget(int)
uiParent *	parent ()
const uiParent *	parent () const
void	translateText ()
bool	grab (const char *filenm, int zoom=1, const char *format=0, int quality=-1) const
void	activateInGUIThread (const CallBack &, bool busywait=true)
void	saveImage (const char *fnm, int w, int h, int res)
void	saveAsPDF (const char *fnm, int w, int h, int res)
void	saveAsPS (const char *fnm, int w, int h, int res)
void	copyToClipBoard ()
void	runScript (const char *filename)
const char *	getScriptToRun () const
Public Member Functions inherited from uiParent
	uiParent (const char *nm, uiParentBody *)
void	addChild (uiBaseObject &)
void	manageChld (uiBaseObject &, uiObjectBody &)
void	attachChild (constraintType tp, uiObject *child, uiObject *other, int margin, bool reciprocal)
const ObjectSet< uiBaseObject > *	childList () const
uiObject *	mainObject ()
const uiObject *	mainObject () const
uiParentBody *	pbody ()
const uiParentBody *	pbody () const
void	attach (constraintType t, int margin=-1)
void	attach (constraintType t, uiParent *oth, int margin=-1, bool reciprocal=true)
void	attach (constraintType t, uiObject *oth, int margin=-1, bool reciprocal=true)
virtual void	display (bool yn, bool shrk=false, bool maximize=false)
bool	isDisplayed () const
void	setFocus ()
bool	hasFocus () const
void	setSensitive (bool yn=true)
bool	sensitive () const
const uiFont *	font () const
void	setFont (const uiFont &f)
void	setCaption (const uiString &c)
void	setCursor (const MouseCursor &c)
uiSize	actualsize (bool include_border) const
int	prefHNrPics () const
int	prefVNrPics () const
void	setPrefHeight (int h)
void	setPrefWidth (int w)
void	setPrefHeightInChar (int h)
void	setPrefHeightInChar (float h)
void	setPrefWidthInChar (float w)
void	setPrefWidthInChar (int w)
void	shallowRedraw (CallBacker *=0)
void	deepRedraw (CallBacker *=0)
void	setStretch (int h, int v)
Color	backgroundColor () const
Color	roBackgroundColor () const
void	setBackgroundColor (const Color &c)
void	translateText ()

Static Public Member Functions
static uiMainWin *	activeWindow ()
static uiMainWin *	gtUiWinIfIsBdy (mQtclass(QWidget *) mwimpl)
	get uiMainWin for mwimpl if it is a uiMainWinBody More...
static ActModalTyp	activeModalType ()
static uiMainWin *	activeModalWindow ()
static const char *	activeModalQDlgTitle ()
static const char *	activeModalQDlgButTxt (int butnr)
static int	activeModalQDlgRetVal (int butnr)
static void	closeActiveModalQDlg (int retval)
static void	getModalSignatures (BufferStringSet &)
static void	getTopLevelWindows (ObjectSet< uiMainWin > &, bool visibleonly=true)
static uiString	uniqueWinTitle (const uiString &, mQtclass(QWidget *) forwindow=0, BufferString *addendum=0)
static bool	grabScreen (const char *filenm, const char *format=0, int quality=-1, int screen=0)
static void	programActiveWindow (uiMainWin *)
static uiMainWin *	programmedActiveWindow ()

Public Attributes
Notifier< uiMainWin >	windowClosed
	triggered when window exits More...
Notifier< uiMainWin >	activatedone
Notifier< uiMainWin >	ctrlCPressed
Notifier< uiMainWin >	afterPopup
Notifier< uiMainWin >	runScriptRequest

Protected Member Functions
virtual bool	closeOK ()
	confirm window close More...
	uiMainWin (uiString, uiParent *)
uiObject *	mainobject ()
void	saveSettings ()
void	readSettings ()
void	saveAsPDF_PS (const char *fnm, bool aspdf, int w, int h, int res)
void	copyToClipBoardCB (CallBacker *)
void	aftPopupCB (CallBacker *)
void	languageChangeCB (CallBacker *)
void	updateCaption ()
Protected Member Functions inherited from uiParent
virtual void	attach_ (constraintType t, uiObject *oth, int margin=-1, bool reciprocal=true)

Protected Attributes
uiMainWinBody *	body_
uiParent *	parent_
Timer *	afterpopuptimer_
PopupArea	popuparea_
uiString	caption_
uiString	uniquecaption_
int	languagechangecount_
BufferString	scripttorun_

Private Member Functions
	mODTextTranslationClass (uiMainWin)

Friends
class	uiMainWinBody

Detailed Description

User interface main window.

Member Enumeration Documentation

enum uiMainWin::ActModalTyp

Enumerator
None
Main
Message
File
Colour
Font
Unknown

enum uiMainWin::Dock

Dock Selector.

Enumerator
Top	above the central uiGroup, below the menubar.
Bottom	below the central uiGroup, above the status bar.
Right	to the right of the central uiGroup.
Left	to the left of the central uiGroup.
Minimized	the toolbar is not shown - all handles of minimized toolbars are drawn in one row below the menu bar.
TornOff	the dock window floats as its own top level window which always stays on top of the main window.
Unmanaged	not managed by a uiMainWin

enum uiMainWin::PopupArea

Enumerator
TopLeft
TopRight
BottomLeft
BottomRight
Middle
Auto

Constructor & Destructor Documentation

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

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

virtual uiMainWin::~uiMainWin ( )

virtual

uiMainWin::uiMainWin ( uiString  , uiParent *    )

protected

Member Function Documentation

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

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

static

static int uiMainWin::activeModalQDlgRetVal ( int  butnr )

static

static const char* uiMainWin::activeModalQDlgTitle ( )

static

static ActModalTyp uiMainWin::activeModalType ( )

static

static uiMainWin* uiMainWin::activeModalWindow ( )

static

static uiMainWin* uiMainWin::activeWindow ( )

static

void uiMainWin::addDockWindow	(	uiDockWin &	,
		Dock
	)

void uiMainWin::addToolBar

(

uiToolBar *

)

void uiMainWin::addToolBarBreak

(

)

void uiMainWin::aftPopupCB ( CallBacker *  )

protected

const uiString& uiMainWin::caption

(

bool

unique = false

)

const

void uiMainWin::close

(

)

static void uiMainWin::closeActiveModalQDlg ( int  retval )

static

virtual bool uiMainWin::closeOK ( )

inlineprotectedvirtual

confirm window close

Reimplemented in uiStratLayerModel, uiODMain, and uiStratTreeWin.

void uiMainWin::copyToClipBoard

(

)

void uiMainWin::copyToClipBoardCB ( CallBacker *  )

protected

const ObjectSet<uiDockWin>& uiMainWin::dockWins

(

)

const

bool uiMainWin::finalised

(

)

const

uiToolBar* uiMainWin::findToolBar

(

const char *

)

uiRect uiMainWin::geometry

(

bool

frame = true

)

const

Position of top-left corner in screen pixel coords.

static void uiMainWin::getModalSignatures ( BufferStringSet &  )

static

int uiMainWin::getNrWidgets ( ) const

inline

PopupArea uiMainWin::getPopupArea ( ) const

inline

const char* uiMainWin::getScriptToRun

(

)

const

uiMenu& uiMainWin::getToolbarsMenu

(

)

const

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

static

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

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

static

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

static

get uiMainWin for mwimpl if it is a uiMainWinBody

bool uiMainWin::isHidden

(

)

const

bool uiMainWin::isMaximized

(

)

const

bool uiMainWin::isMinimized

(

)

const

bool uiMainWin::isModal

(

)

const

void uiMainWin::languageChangeCB ( CallBacker *  )

protected

uiObject* uiMainWin::mainobject ( )

protectedvirtual

Reimplemented from uiParent.

virtual uiMainWin* uiMainWin::mainwin ( )

inlinevirtual

Reimplemented from uiParent.

uiMenuBar* uiMainWin::menuBar

(

)

uiMainWin::mODTextTranslationClass ( uiMainWin  )

private

uiMainWin::mQtclass

(

QWidget *

)

uiParent* uiMainWin::parent ( )

inline

const uiParent* uiMainWin::parent ( ) const

inline

bool uiMainWin::poppedUp

(

)

const

static void uiMainWin::programActiveWindow ( uiMainWin *  )

static

static uiMainWin* uiMainWin::programmedActiveWindow ( )

static

void uiMainWin::raise

(

)

void uiMainWin::readSettings ( )

protected

virtual void uiMainWin::reDraw ( bool  deep )

virtual

Reimplemented from uiParent.

void uiMainWin::removeDockWindow

(

uiDockWin *

)

uiToolBar* uiMainWin::removeToolBar

(

uiToolBar *

)

bool uiMainWin::resetPopupTimerIfNotPoppedUp

(

)

void uiMainWin::runScript

(

const char *

filename

)

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

inline

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

protected

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

inline

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

void uiMainWin::saveSettings ( )

protected

void uiMainWin::setCaption

(

const uiString &

)

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

void uiMainWin::setDeleteOnClose

(

bool

yn

)

void uiMainWin::setExitAppOnClose

(

bool

yn

)

automatically set by uiMain::setTopLevel

void uiMainWin::setIcon

(

const uiPixmap &

)

Default icon is set in uiMain.

void uiMainWin::setIconText

(

const uiString &

)

void uiMainWin::setPopupArea ( PopupArea  pa )

inline

void uiMainWin::setSensitive

(

bool

yn

)

void uiMainWin::setShrinkAllowed

(

bool

yn

)

virtual void uiMainWin::show ( )

virtual

Reimplemented in uiDirLightDlg.

void uiMainWin::showMaximized

(

)

void uiMainWin::showMinimized

(

)

void uiMainWin::showNormal

(

)

bool uiMainWin::shrinkAllowed

(

)

uiStatusBar* uiMainWin::statusBar

(

)

const ObjectSet<uiToolBar>& uiMainWin::toolBars

(

)

const

uiGroup* uiMainWin::topGroup

(

)

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

void uiMainWin::translateText

(

)

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

static

void uiMainWin::updateCaption ( )

protected

Friends And Related Function Documentation

friend class uiMainWinBody

friend

Member Data Documentation

Notifier<uiMainWin> uiMainWin::activatedone

Notifier<uiMainWin> uiMainWin::afterPopup

Timer* uiMainWin::afterpopuptimer_

protected

uiMainWinBody* uiMainWin::body_

protected

uiString uiMainWin::caption_

protected

Notifier<uiMainWin> uiMainWin::ctrlCPressed

int uiMainWin::languagechangecount_

protected

uiParent* uiMainWin::parent_

protected

PopupArea uiMainWin::popuparea_

protected

Notifier<uiMainWin> uiMainWin::runScriptRequest

BufferString uiMainWin::scripttorun_

protected

uiString uiMainWin::uniquecaption_

protected

Notifier<uiMainWin> uiMainWin::windowClosed

triggered when window exits