CrystalSpace

Public API Reference

Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

Standard dialogs
[Crystal Space Windowing System]


Classes

struct  iMessageBoxData
 The application will receive a cscmdStopModal event when csMessageBox is done. More...

Message box style flags (used in csMessageBox (...) as last parameter)

These style flags can be combined using logical OR (|) operation; some styles are mutually exclusive (for example, a message box cannot be CSMBS_INFORMATION and CSMBS_WARNING at same time)

#define CSMBS_NOTYPE   0x00000000
 Message box style: Message has no type.
#define CSMBS_INFORMATION   0x00000001
 Message box style: Informational message.
#define CSMBS_INFO   CSMBS_INFORMATION
 Message box style: Same for lazy ones (like me :-).
#define CSMBS_WARNING   0x00000002
 Message box style: Warning message.
#define CSMBS_WARN   CSMBS_WARNING
 Message box style: Same but shorter.
#define CSMBS_QUESTION   0x00000003
 Message box style: Question message.
#define CSMBS_ERROR   0x00000004
 Message box style: Fatal error.
#define CSMBS_STOP   0x00000005
 Message box style: Invalid operation.
#define CSMBS_CUSTOMICON   0x0000000f
 Message box style: Custom bitmap (texture name/x/y/w/h follows last parameter).
#define CSMBS_TYPEMASK   0x0000000f
 Message box style: This is the mask used to separate message box style from other flags.
#define CSMBS_OK   0x00000010
 Message box style: Message box contains a "OK" button.
#define CSMBS_CANCEL   0x00000020
 Message box style: Message box contains a "Cancel" button.
#define CSMBS_ABORT   0x00000040
 Message box style: Message box contains a "Abort" button.
#define CSMBS_RETRY   0x00000080
 Message box style: Message box contains a "Retry" button.
#define CSMBS_IGNORE   0x00000100
 Message box style: Message box contains a "Ignore" button.
#define CSMBS_OKCANCEL   (CSMBS_OK | CSMBS_CANCEL)
 Message box style: Message box contains a "OK" button and a "Cancel" button.
#define CSMBS_ABORTRETRYIGNORE   (CSMBS_ABORT | CSMBS_RETRY | CSMBS_IGNORE)
 Message box style: Message box contains a "Abort" button, a "Retry" button and a "Ignore" button.
#define CSMBS_NONMODAL   0x80000000
 Message box style: Message is not program-modal.
#define CSMBS_USEHEIGHT   0x40000000
 Message box style: Align text vertically so that it occupies given height (given as '...').
#define CSMBS_CENTER   0x20000000
 Message box style: Center all text lines.

Defines

#define CSWID_FILENAME   0xC509
 File name entry field in file dialogs.
#define CSWID_PATHNAME   0xC50A
 Path name entry field in file dialogs.
#define CSWID_DIRLIST   0xC50B
 Directory list box in file dialogs.
#define CSWID_FILELIST   0xC50C
 File list box in file dialogs.
#define CSWID_COLORWHEEL   0xC50D
 Color wheel in color choose dialogs.
#define CSWID_COLORHR   0xC50E
 Color hue/red scrollbar in color choose dialogs.
#define CSWID_COLORLG   0xC50F
 Color light/green scrollbar in color choose dialogs.
#define CSWID_COLORSB   0xC510
 Color saturation/blue scrollbar in color choose dialogs.
#define CSWID_COLORSAMPLE   0xC511
 Color sample (static rectangle) in color choose dialogs.
#define CSWID_COLORHLS   0xC512
 "HLS" radio button identifier
#define CSWID_COLORRGB   0xC513
 "RGB" radio button identifier

Functions

void csMessageBox (csComponent *iParent, const char *iTitle, const char *iMessage, iBase *userdata, int iFlags=CSMBS_INFO|CSMBS_OK,...)
 Display a message box and return immediatelly.
csWindowcsFileDialog (csComponent *iParent, const char *iTitle, const char *iFileName="./", const char *iOpenButtonText="~Load", bool vfspaths=false)
 Create and return a new file open dialog.
void csQueryFileDialog (csWindow *iFileDialog, char *iFileName, size_t iFileNameSize)
 Query full name, filename and pathname from a file dialog.
csWindowcsColorDialog (csComponent *iParent, const char *iTitle, int iColor=0)
 Create and return a new color choose dialog.
csWindowcsColorDialog (csComponent *iParent, const char *iTitle, float iR, float iG, float iB)
 Same but accepts R/G/B separately.
void csQueryColorDialog (csWindow *iColorDialog, int &oColor)
 Query color dialog contents as a single color value.
void csQueryColorDialog (csWindow *iColorDialog, float &oR, float &oG, float &oB)
 Query color dialog contents as R,G,B floating-point numbers.

Define Documentation

#define CSMBS_ABORT   0x00000040
 

Message box style: Message box contains a "Abort" button.

Definition at line 69 of file csstddlg.h.

#define CSMBS_ABORTRETRYIGNORE   (CSMBS_ABORT | CSMBS_RETRY | CSMBS_IGNORE)
 

Message box style: Message box contains a "Abort" button, a "Retry" button and a "Ignore" button.

Definition at line 77 of file csstddlg.h.

#define CSMBS_CANCEL   0x00000020
 

Message box style: Message box contains a "Cancel" button.

Definition at line 67 of file csstddlg.h.

#define CSMBS_CENTER   0x20000000
 

Message box style: Center all text lines.

Definition at line 84 of file csstddlg.h.

#define CSMBS_CUSTOMICON   0x0000000f
 

Message box style: Custom bitmap (texture name/x/y/w/h follows last parameter).

Definition at line 60 of file csstddlg.h.

#define CSMBS_ERROR   0x00000004
 

Message box style: Fatal error.

Definition at line 56 of file csstddlg.h.

#define CSMBS_IGNORE   0x00000100
 

Message box style: Message box contains a "Ignore" button.

Definition at line 73 of file csstddlg.h.

#define CSMBS_INFO   CSMBS_INFORMATION
 

Message box style: Same for lazy ones (like me :-).

Definition at line 48 of file csstddlg.h.

#define CSMBS_INFORMATION   0x00000001
 

Message box style: Informational message.

Definition at line 46 of file csstddlg.h.

#define CSMBS_NONMODAL   0x80000000
 

Message box style: Message is not program-modal.

Definition at line 80 of file csstddlg.h.

#define CSMBS_NOTYPE   0x00000000
 

Message box style: Message has no type.

Definition at line 44 of file csstddlg.h.

#define CSMBS_OK   0x00000010
 

Message box style: Message box contains a "OK" button.

Definition at line 65 of file csstddlg.h.

#define CSMBS_OKCANCEL   (CSMBS_OK | CSMBS_CANCEL)
 

Message box style: Message box contains a "OK" button and a "Cancel" button.

Definition at line 75 of file csstddlg.h.

#define CSMBS_QUESTION   0x00000003
 

Message box style: Question message.

Definition at line 54 of file csstddlg.h.

#define CSMBS_RETRY   0x00000080
 

Message box style: Message box contains a "Retry" button.

Definition at line 71 of file csstddlg.h.

#define CSMBS_STOP   0x00000005
 

Message box style: Invalid operation.

Definition at line 58 of file csstddlg.h.

#define CSMBS_TYPEMASK   0x0000000f
 

Message box style: This is the mask used to separate message box style from other flags.

Definition at line 62 of file csstddlg.h.

#define CSMBS_USEHEIGHT   0x40000000
 

Message box style: Align text vertically so that it occupies given height (given as '...').

Definition at line 82 of file csstddlg.h.

#define CSMBS_WARN   CSMBS_WARNING
 

Message box style: Same but shorter.

Definition at line 52 of file csstddlg.h.

#define CSMBS_WARNING   0x00000002
 

Message box style: Warning message.

Definition at line 50 of file csstddlg.h.

#define CSWID_COLORHLS   0xC512
 

"HLS" radio button identifier

Definition at line 140 of file csstddlg.h.

#define CSWID_COLORHR   0xC50E
 

Color hue/red scrollbar in color choose dialogs.

Definition at line 132 of file csstddlg.h.

#define CSWID_COLORLG   0xC50F
 

Color light/green scrollbar in color choose dialogs.

Definition at line 134 of file csstddlg.h.

#define CSWID_COLORRGB   0xC513
 

"RGB" radio button identifier

Definition at line 142 of file csstddlg.h.

#define CSWID_COLORSAMPLE   0xC511
 

Color sample (static rectangle) in color choose dialogs.

Definition at line 138 of file csstddlg.h.

#define CSWID_COLORSB   0xC510
 

Color saturation/blue scrollbar in color choose dialogs.

Definition at line 136 of file csstddlg.h.

#define CSWID_COLORWHEEL   0xC50D
 

Color wheel in color choose dialogs.

Definition at line 130 of file csstddlg.h.

#define CSWID_DIRLIST   0xC50B
 

Directory list box in file dialogs.

Definition at line 116 of file csstddlg.h.

#define CSWID_FILELIST   0xC50C
 

File list box in file dialogs.

Definition at line 118 of file csstddlg.h.

#define CSWID_FILENAME   0xC509
 

File name entry field in file dialogs.

Definition at line 112 of file csstddlg.h.

#define CSWID_PATHNAME   0xC50A
 

Path name entry field in file dialogs.

Definition at line 114 of file csstddlg.h.


Function Documentation

csWindow* csColorDialog csComponent iParent,
const char *  iTitle,
float  iR,
float  iG,
float  iB
 

Same but accepts R/G/B separately.

csWindow* csColorDialog csComponent iParent,
const char *  iTitle,
int  iColor = 0
 

Create and return a new color choose dialog.

csWindow* csFileDialog csComponent iParent,
const char *  iTitle,
const char *  iFileName = "./",
const char *  iOpenButtonText = "~Load",
bool  vfspaths = false
 

Create and return a new file open dialog.

void csMessageBox csComponent iParent,
const char *  iTitle,
const char *  iMessage,
iBase userdata,
int  iFlags = CSMBS_INFO|CSMBS_OK,
  ...
 

Display a message box and return immediatelly.

When message box finishes it will send a cscmdStopModal message to the csApp::HandleEvent() with iMessageBoxData as userdata. The pressed button will be given as the 'Info' field in Event.Command.Info (cscmdCancel, cscmdOk, ...).

void csQueryColorDialog csWindow iColorDialog,
float &  oR,
float &  oG,
float &  oB
 

Query color dialog contents as R,G,B floating-point numbers.

void csQueryColorDialog csWindow iColorDialog,
int &  oColor
 

Query color dialog contents as a single color value.

void csQueryFileDialog csWindow iFileDialog,
char *  iFileName,
size_t  iFileNameSize
 

Query full name, filename and pathname from a file dialog.


Generated for Crystal Space by doxygen 1.3.9.1