uiMsg Class Reference

Public Types
enum	Icon {   NoIcon, Information, Warning, Critical,   Question }

Public Member Functions
void	message (const uiString &, const uiString &part2=uiString::emptyString(), const uiString &part3=uiString::emptyString())
bool	message (const uiString &, const uiString &part2, const uiString &part3, bool withdontshowatain)
void	warning (const uiString &, const uiString &part2=uiString::emptyString(), const uiString &part3=uiString::emptyString())
bool	warning (const uiString &, const uiString &part2, const uiString &part3, bool withdontshowatain)
void	error (const uiString &, const uiString &part2=uiString::emptyString(), const uiString &part3=uiString::emptyString())
bool	error (const uiString &, const uiString &part2, const uiString &part3, bool withdontshowatain)
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, const uiString &textno, const uiString &textcncl, const uiString &caption, bool *dontaskagain)
int	question (const uiString &, const uiString &textyes=uiString::emptyString(), const uiString &textno=uiString::emptyString(), const uiString &textcncl=uiString::emptyString(), const uiString &caption=uiString::emptyString())
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)
	withyesno false: 'OK' and 'Cancel', true: 'Yes' and 'No' More...
bool	askGoOn (const uiString &msg, const uiString &textyes, const uiString &textno)
int	askGoOnAfter (const uiString &, const uiString &cnclmsg=uiString::emptyString(), const uiString &textyes=uiString::emptyString(), const uiString &textno=uiString::emptyString())
bool	askGoOn (const uiString &, bool withyesno, bool *dontaskagain)
bool	askGoOn (const uiString &msg, const uiString &textyes, const uiString &textno, bool *dontaskagain)
int	askGoOnAfter (const uiString &, const uiString &cnclmsg, const uiString &textyes, const uiString &textno, bool *dontaskagain)
bool	showMsgNextTime (const uiString &, const uiString &msg=uiString::emptyString())
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())
int	showMessageBox (Icon icon, QWidget *parent, const uiString &txt, const uiString &yestxtinp, const uiString &notxtinp, const uiString &cncltxtinp, const uiString &title, bool *notagain)

Static Public Member Functions
static void	setNextCaption (const uiString &)
static uiString	sDontShowAgain ()

Protected Member Functions
	uiMsg ()
	mQtclass (QWidget *) popParnt()

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

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
	)

withyesno false: 'OK' and 'Cancel', true: 'Yes' and 'No'

bool uiMsg::askGoOn	(	const uiString &	msg,
		const uiString &	textyes,
		const uiString &	textno
	)

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

withyesno false: 'OK' and 'Cancel', true: 'Yes' and 'No' If don't askagain 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
	)

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()
	)

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

1=yes, 0=no, -1=cancel 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::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::endCmdRecEvent ( int  refnr, int  retval, const char *  buttxt0, const char *  buttxt1 = 0, const char *  buttxt2 = 0  )

private

void uiMsg::error	(	const uiString &	,
		const uiString &	part2 = uiString::emptyString(),
		const uiString &	part3 = uiString::emptyString()
	)

bool uiMsg::error	(	const uiString &	,
		const uiString &	part2,
		const uiString &	part3,
		bool	withdontshowatain
	)

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::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::message	(	const uiString &	,
		const uiString &	part2 = uiString::emptyString(),
		const uiString &	part3 = uiString::emptyString()
	)

bool uiMsg::message	(	const uiString &	,
		const uiString &	part2,
		const uiString &	part3,
		bool	withdontshowatain
	)

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,
		const uiString &	textno,
		const uiString &	textcncl,
		const uiString &	caption,
		bool *	dontaskagain
	)

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::question	(	const uiString &	,
		const uiString &	textyes = uiString::emptyString(),
		const uiString &	textno = uiString::emptyString(),
		const uiString &	textcncl = uiString::emptyString(),
		const uiString &	caption = uiString::emptyString()
	)

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()
	)

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

bool uiMsg::showMsgNextTime	(	const uiString &	,
		const uiString &	msg = uiString::emptyString()
	)

The msg must be negative, like "Don't show msg again" Be sure to store the ret val in the user settings

uiStatusBar* uiMsg::statusBar

(

)

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

returns false if there is none

void uiMsg::warning	(	const uiString &	,
		const uiString &	part2 = uiString::emptyString(),
		const uiString &	part3 = uiString::emptyString()
	)

bool uiMsg::warning	(	const uiString &	,
		const uiString &	part2,
		const uiString &	part3,
		bool	withdontshowatain
	)

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.

Friends And Related Function Documentation

uiMsg& uiMSG ( )

friend

Member Data Documentation

uiMsg* uiMsg::theinst_

staticprotected

uiMainWin* uiMsg::uimainwin_

private