OpendTect  6.6
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Attributes | Private Member Functions | Private Attributes | Friends | List of all members
uiMsg Class Reference
uiBase

Public Types

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

Public Member Functions

void about (const uiString &)
 
void aboutOpendTect (const uiString &)
 
int ask2D3D (const uiString &, bool cancelbut=false)
 
int askContinue (const char *msg)
 
int askContinue (const uiString &)
 
bool askGoOn (const char *msg, bool withyesno=true)
 
bool askGoOn (const char *msg, const char *textyes, const char *textno)
 
bool askGoOn (const uiString &, bool withyesno, bool *dontaskagain)
 
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)
 
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)
 
int askGoOnAfter (const uiString &, const uiString &cnclmsg=uiString::emptyString(), const uiString &textyes=uiString::emptyString(), const uiString &textno=uiString::emptyString())
 
int askOverwrite (const char *msg)
 
int askOverwrite (const uiString &)
 
int askRemove (const char *msg, bool cancelbut=false)
 
int askRemove (const uiString &, bool cancelbut=false)
 
int askSave (const char *msg, bool cancelbut=true)
 
int askSave (const uiString &, bool cancelbut=true)
 
void error (const char *txt, const char *part2=nullptr, const char *part3=nullptr)
 
bool error (const uiString &, const uiString &part2, const uiString &part3, bool withdontshowatain)
 
void error (const uiString &, const uiString &part2=uiString::emptyString(), const uiString &part3=uiString::emptyString())
 
void errorWithDetails (const BufferStringSet &)
 
void errorWithDetails (const FileMultiString &)
 
void errorWithDetails (const uiStringSet &)
 
void errorWithDetails (const uiStringSet &, const uiString &firstmsg)
 
void message (const char *txt, const char *part2=nullptr, const char *part3=nullptr)
 
bool message (const uiString &, const uiString &part2, const uiString &part3, bool withdontshowatain)
 
void message (const uiString &, const uiString &part2=uiString::emptyString(), const uiString &part3=uiString::emptyString())
 
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())
 
uiMainWin * setMainWin (uiMainWin *)
 return old More...
 
int showMessageBox (Icon icon, QWidget *parent, const uiString &txt, const uiString &yestxtinp, const uiString &notxtinp, const uiString &cncltxtinp, const uiString &title, bool *notagain)
 
int showMessageBox (Icon icon, QWidget *parent, const uiString &txt, const uiString &yestxtinp, const uiString &notxtinp, const uiString &cncltxtinp, const uiString &title=uiString::emptyString())
 
bool showMsgNextTime (const uiString &, const uiString &msg=uiString::emptyString())
 
uiStatusBar * statusBar ()
 
bool toStatusbar (uiString, int fld=0, int msec=-1)
 returns false if there is none More...
 
void warning (const char *txt, const char *part2=nullptr, const char *part3=nullptr)
 
bool warning (const uiString &, const uiString &part2, const uiString &part3, bool withdontshowatain)
 
void warning (const uiString &, const uiString &part2=uiString::emptyString(), const uiString &part3=uiString::emptyString())
 

Static Public Member Functions

static uiString sDontShowAgain ()
 
static void setNextCaption (const uiString &)
 

Protected Member Functions

 uiMsg ()
 
QWidget * popParnt ()
 

Static Protected Attributes

static uiMsg * theinst_
 

Private Member Functions

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

class uiMain
 
uiMsg & uiMSG ()
 

Detailed Description

<>

Member Enumeration Documentation

◆ Icon

enum uiMsg::Icon
Enumerator
NoIcon 
Information 
Warning 
Critical 
Question 

Constructor & Destructor Documentation

◆ uiMsg()

uiMsg::uiMsg ( )
protected

Member Function Documentation

◆ about()

void uiMsg::about ( const uiString &  )

◆ aboutOpendTect()

void uiMsg::aboutOpendTect ( const uiString &  )

◆ ask2D3D()

int uiMsg::ask2D3D ( const uiString &  ,
bool  cancelbut = false 
)
Return values
0=3D1=2D -1=Cancel

◆ askContinue() [1/2]

int uiMsg::askContinue ( const char *  msg)
inline

◆ askContinue() [2/2]

int uiMsg::askContinue ( const uiString &  )
Return values
0=Abort1=Continue

◆ askGoOn() [1/6]

bool uiMsg::askGoOn ( const char *  msg,
bool  withyesno = true 
)
inline

◆ askGoOn() [2/6]

bool uiMsg::askGoOn ( const char *  msg,
const char *  textyes,
const char *  textno 
)
inline

◆ askGoOn() [3/6]

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.

◆ askGoOn() [4/6]

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

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

◆ askGoOn() [5/6]

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

◆ askGoOn() [6/6]

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.

◆ askGoOnAfter() [1/2]

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.

◆ askGoOnAfter() [2/2]

int uiMsg::askGoOnAfter ( const uiString &  ,
const uiString &  cnclmsg = uiString::emptyString(),
const uiString &  textyes = uiString::emptyString(),
const uiString &  textno = uiString::emptyString() 
)

◆ askOverwrite() [1/2]

int uiMsg::askOverwrite ( const char *  msg)
inline

◆ askOverwrite() [2/2]

int uiMsg::askOverwrite ( const uiString &  )
Return values
0=Abort1=Overwrite

◆ askRemove() [1/2]

int uiMsg::askRemove ( const char *  msg,
bool  cancelbut = false 
)
inline

◆ askRemove() [2/2]

int uiMsg::askRemove ( const uiString &  ,
bool  cancelbut = false 
)
Return values
0=Don'tremove 1=Remove -1=Cancel

◆ askSave() [1/2]

int uiMsg::askSave ( const char *  msg,
bool  cancelbut = true 
)
inline

◆ askSave() [2/2]

int uiMsg::askSave ( const uiString &  ,
bool  cancelbut = true 
)
Return values
0=Don'tsave 1=Save -1=Cancel

◆ beginCmdRecEvent()

int uiMsg::beginCmdRecEvent ( const char *  wintitle)
private

◆ endCmdRecEvent()

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

◆ error() [1/3]

void uiMsg::error ( const char *  txt,
const char *  part2 = nullptr,
const char *  part3 = nullptr 
)
inline

◆ error() [2/3]

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.

◆ error() [3/3]

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

◆ errorWithDetails() [1/4]

void uiMsg::errorWithDetails ( const BufferStringSet &  )

◆ errorWithDetails() [2/4]

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.

◆ errorWithDetails() [3/4]

void uiMsg::errorWithDetails ( const uiStringSet &  )

◆ errorWithDetails() [4/4]

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

◆ message() [1/3]

void uiMsg::message ( const char *  txt,
const char *  part2 = nullptr,
const char *  part3 = nullptr 
)
inline

◆ message() [2/3]

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.

◆ message() [3/3]

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

◆ popParnt()

QWidget* uiMsg::popParnt ( )
protected

◆ question() [1/2]

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.

◆ question() [2/2]

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

◆ sDontShowAgain()

static uiString uiMsg::sDontShowAgain ( )
static

◆ setMainWin()

uiMainWin* uiMsg::setMainWin ( uiMainWin *  )

return old

◆ setNextCaption()

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

◆ showMessageBox() [1/2]

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

◆ showMessageBox() [2/2]

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

◆ showMsgNextTime()

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

◆ statusBar()

uiStatusBar* uiMsg::statusBar ( )

◆ toStatusbar()

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

returns false if there is none

◆ warning() [1/3]

void uiMsg::warning ( const char *  txt,
const char *  part2 = nullptr,
const char *  part3 = nullptr 
)
inline

◆ warning() [2/3]

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.

◆ warning() [3/3]

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

Friends And Related Function Documentation

◆ uiMain

friend class uiMain
friend

◆ uiMSG

uiMsg& uiMSG ( )
friend

Member Data Documentation

◆ theinst_

uiMsg* uiMsg::theinst_
staticprotected

◆ uimainwin_

uiMainWin* uiMsg::uimainwin_
private

Generated at for the OpendTect seismic interpretation project. Copyright (C): dGB Beheer B.V. 1995-2022