uiMsg Class Reference

Inheritance diagram for uiMsg:

Public Types
enum	Icon {   NoIcon, Information, Warning, Critical,   Question }
enum	msgType { WarningMsg, ErrorWithDetails, ErrorMsg, Info }

Public Member Functions
bool	message (const uiString &, const uiString &part2=uiString::emptyString(), const uiString &part3=uiString::emptyString(), bool withdontshowagain=false)
bool	warning (const uiString &, const uiString &part2=uiString::emptyString(), const uiString &part3=uiString::emptyString(), bool withdontshowagain=false)
void	warning (const uiRetVal &)
void	handleWarnings (const uiRetVal &)
	does nothing if isOK() More...
bool	error (const uiString &, const uiString &part2=uiString::emptyString(), const uiString &part3=uiString::emptyString(), bool withdontshowagain=false)
void	error (const uiRetVal &)
void	handleErrors (const uiRetVal &)
	does nothing if isOK() More...
void	errorWithDetails (const FileMultiString &)
void	errorWithDetails (const uiStringSet &, const uiString &firstmsg)
void	errorWithDetails (const uiStringSet &)
void	errorWithDetails (const BufferStringSet &)
int	question (const uiString &, const uiString &textyes=uiString::emptyString(), const uiString &textno=uiString::emptyString(), const uiString &textcncl=uiString::emptyString(), const uiString &caption=uiString::emptyString(), bool *dontaskagain=0)
int	askSave (const uiString &, bool cancelbut=true)
int	askRemove (const uiString &, bool cancelbut=false)
int	askContinue (const uiString &)
int	askOverwrite (const uiString &)
int	ask2D3D (const uiString &, bool cancelbut=false)
bool	askGoOn (const uiString &, bool withyesno=true, bool *dontaskagain=0)
bool	askGoOn (const uiString &msg, const uiString &textyes, const uiString &textno, bool *dontaskagain=0)
int	askGoOnAfter (const uiString &, const uiString &cnclmsg=uiString::emptyString(), const uiString &textyes=uiString::emptyString(), const uiString &textno=uiString::emptyString(), bool *dontaskagain=0)
uiMainWin *	setMainWin (uiMainWin *)
	return old More...
bool	toStatusbar (uiString, int fld=0, int msec=-1)
	returns false if there is none More...
uiStatusBar *	statusBar ()
void	about (const uiString &)
void	aboutOpendTect (const uiString &)
int	showMessageBox (Icon icon, QWidget *parent, const uiString &txt, const uiString &yestxtinp, const uiString &notxtinp, const uiString &cncltxtinp, const uiString &title=uiString::emptyString(), bool *notagain=0)
	mDeclareEnumUtils (msgType)
void	showMsg (uiMainWin *, msgType, const uiStringSet &)
void	dispErrMsgCB (CallBacker *)
void	dispWarnMsgCB (CallBacker *)
void	errorWithDetailProc (uiStringSet &)
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	detachCB (const NotifierAccess &, const CallBack &) const
void	detachCB (const NotifierAccess *notif, const CallBack &cb) const
bool	isNotifierAttached (const NotifierAccess *) const
	Only for debugging purposes, don't use. More...
virtual bool	isCapsule () const
void	stopReceivingNotifications () const

Static Public Member Functions
static void	setNextCaption (const uiString &)
static uiString	sDontShowAgain ()
Static Public Member Functions inherited from CallBacker
static void	createReceiverForCurrentThread ()
static void	removeReceiverForCurrentThread ()

Protected Member Functions
	uiMsg ()
	mQtclass (QWidget *) popParnt()
Protected Member Functions inherited from CallBacker
void	detachAllNotifiers () const
	Call from the destructor of your inherited object. More...

Protected Attributes
Threads::Lock	lock_
Threads::Lock	msgdisplock_

Static Protected Attributes
static uiMsg *	theinst_

Private Member Functions
	mODTextTranslationClass (uiMsg) friend class uiMain
int	beginCmdRecEvent (const char *wintitle)
void	endCmdRecEvent (int refnr, int retval, const char *buttxt0, const char *buttxt1=0, const char *buttxt2=0)

Private Attributes
uiMainWin *	uimainwin_

Friends
uiMsg &	uiMSG ()

Detailed Description

Member Enumeration Documentation

enum uiMsg::Icon

Enumerator
NoIcon
Information
Warning
Critical
Question

enum uiMsg::msgType

Enumerator
WarningMsg
ErrorWithDetails
ErrorMsg
Info

Constructor & Destructor Documentation

uiMsg::uiMsg ( )

protected

Member Function Documentation

void uiMsg::about

(

const uiString &

)

void uiMsg::aboutOpendTect

(

const uiString &

)

int uiMsg::ask2D3D	(	const uiString &	,
		bool	cancelbut = false
	)

Return values

0=3D	1=2D -1=Cancel

int uiMsg::askContinue

(

const uiString &

)

Return values

0=Abort

1=Continue

bool uiMsg::askGoOn	(	const uiString &	,
		bool	withyesno = true,
		bool *	dontaskagain = 0
	)

withyesno false: 'OK' and 'Cancel', true: 'Yes' and 'No' If dontaskagain is given, the user will have the option to not see this again, and the boolean will be filled in.

bool uiMsg::askGoOn	(	const uiString &	msg,
		const uiString &	textyes,
		const uiString &	textno,
		bool *	dontaskagain = 0
	)

If don't askagain is given, the user will have the option to not see this again, and the boolean will be filled in.

int uiMsg::askGoOnAfter	(	const uiString &	,
		const uiString &	cnclmsg = uiString::emptyString(),
		const uiString &	textyes = uiString::emptyString(),
		const uiString &	textno = uiString::emptyString(),
		bool *	dontaskagain = 0
	)

int uiMsg::askOverwrite

(

const uiString &

)

Return values

0=Abort

1=Overwrite

int uiMsg::askRemove	(	const uiString &	,
		bool	cancelbut = false
	)

Return values

0=Don't

remove 1=Remove -1=Cancel

int uiMsg::askSave	(	const uiString &	,
		bool	cancelbut = true
	)

Return values

0=Don't

save 1=Save -1=Cancel

int uiMsg::beginCmdRecEvent ( const char *  wintitle )

private

void uiMsg::dispErrMsgCB

(

CallBacker *

)

void uiMsg::dispWarnMsgCB

(

CallBacker *

)

void uiMsg::endCmdRecEvent ( int  refnr, int  retval, const char *  buttxt0, const char *  buttxt1 = 0, const char *  buttxt2 = 0  )

private

bool uiMsg::error	(	const uiString &	,
		const uiString &	part2 = uiString::emptyString(),
		const uiString &	part3 = uiString::emptyString(),
		bool	withdontshowagain = false
	)

If withdontshowagain is true, the user will be prompted to not see this again. Return true if the user does not want to see it again.

void uiMsg::error

(

const uiRetVal &

)

void uiMsg::errorWithDetailProc

(

uiStringSet &

)

void uiMsg::errorWithDetails

(

const FileMultiString &

)

If input has multiple parts, the first will be displayed directly, while the complete message is available under a 'Details ...' button, separated by new lines.

void uiMsg::errorWithDetails	(	const uiStringSet &	,
		const uiString &	firstmsg
	)

void uiMsg::errorWithDetails

(

const uiStringSet &

)

void uiMsg::errorWithDetails

(

const BufferStringSet &

)

void uiMsg::handleErrors

(

const uiRetVal &

)

does nothing if isOK()

void uiMsg::handleWarnings

(

const uiRetVal &

)

does nothing if isOK()

uiMsg::mDeclareEnumUtils

(

msgType

)

bool uiMsg::message	(	const uiString &	,
		const uiString &	part2 = uiString::emptyString(),
		const uiString &	part3 = uiString::emptyString(),
		bool	withdontshowagain = false
	)

If withdontshowgain is true, the user will be prompted to not see this again. Return true if the user does not want to see it again.

uiMsg::mODTextTranslationClass ( uiMsg  )

private

uiMsg::mQtclass ( QWidget *  )

protected

int uiMsg::question	(	const uiString &	,
		const uiString &	textyes = uiString::emptyString(),
		const uiString &	textno = uiString::emptyString(),
		const uiString &	textcncl = uiString::emptyString(),
		const uiString &	caption = uiString::emptyString(),
		bool *	dontaskagain = 0
	)

If dontaskagain is given, the user will have the option to not see this again, and the boolean will be filled in.

static uiString uiMsg::sDontShowAgain ( )

static

uiMainWin* uiMsg::setMainWin

(

uiMainWin *

)

return old

static void uiMsg::setNextCaption ( const uiString &  )

static

Sets the caption for the next call to any of the msg fns After that, caption will be reset to default

int uiMsg::showMessageBox	(	Icon	icon,
		QWidget *	parent,
		const uiString &	txt,
		const uiString &	yestxtinp,
		const uiString &	notxtinp,
		const uiString &	cncltxtinp,
		const uiString &	title = uiString::emptyString(),
		bool *	notagain = 0
	)

If don't askagain is given, the user will have the option to not see this again, and the boolean will be filled in.

void uiMsg::showMsg	(	uiMainWin *	,
		msgType	,
		const uiStringSet &
	)

uiStatusBar* uiMsg::statusBar

(

)

bool uiMsg::toStatusbar	(	uiString	,
		int	fld = 0,
		int	msec = -1
	)

returns false if there is none

bool uiMsg::warning	(	const uiString &	,
		const uiString &	part2 = uiString::emptyString(),
		const uiString &	part3 = uiString::emptyString(),
		bool	withdontshowagain = false
	)

If withdontshowgain is true, the user will be prompted to not see this again. Return true if the user does not want to see it again.

void uiMsg::warning

(

const uiRetVal &

)

Friends And Related Function Documentation

uiMsg& uiMSG ( )

friend

Member Data Documentation

Threads::Lock uiMsg::lock_

protected

Threads::Lock uiMsg::msgdisplock_

protected

uiMsg* uiMsg::theinst_

staticprotected

uiMainWin* uiMsg::uimainwin_

private