Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members

FXInputDialog Class Reference

#include <FXInputDialog.h>

Inheritance diagram for FXInputDialog:

FXDialogBox FXTopWindow FXShell FXComposite FXWindow FXDrawable FXId FXObject List of all members.

Public Methods

 FXInputDialog (FXWindow *owner, const FXString &caption, const FXString &label, FXIcon *ic=NULL, FXuint opts=INPUTDIALOG_STRING, FXint x=0, FXint y=0, FXint w=0, FXint h=0)
 Construct input dialog box with given caption, icon, and prompt text.

void setText (const FXString &text)
 Set input string.

void setNumColumns (FXint num)
 Change number of visible columns of text.

FXint getNumColumns () const
 Return number of visible columns of text.

void setLimits (FXdouble lo, FXdouble hi)
 Change limits.

void getLimits (FXdouble &lo, FXdouble &hi)
 Return limits.

virtual FXuint execute (FXuint placement=PLACEMENT_CURSOR)
 Run modal invocation of the dialog.


Static Public Methods

FXbool getString (FXString &result, FXWindow *owner, const FXString &caption, const FXString &label, FXIcon *ic=NULL)
FXbool getInteger (FXint &result, FXWindow *owner, const FXString &caption, const FXString &label, FXIcon *ic=NULL, FXint lo=1, FXint hi=0)
FXbool getReal (FXdouble &result, FXWindow *owner, const FXString &caption, const FXString &label, FXIcon *ic=NULL, FXdouble lo=1.0, FXdouble hi=0.0)

Public Attributes

FXString getText () const
 Get input string.


Detailed Description

An Input Dialog is a simple dialog which is used to obtain a text string, integer, or real number from the user. A password mode allows the key-in to remain hidden.


Member Function Documentation

FXbool FXInputDialog::getString FXString   result,
FXWindow   owner,
const FXString   caption,
const FXString   label,
FXIcon   ic = NULL
[static]
 

Prompt for a string, start with the initial value. Return TRUE if the new value is accepted, and false otherwise.

FXbool FXInputDialog::getInteger FXint &    result,
FXWindow   owner,
const FXString   caption,
const FXString   label,
FXIcon   ic = NULL,
FXint    lo = 1,
FXint    hi = 0
[static]
 

Prompt for an integer number, start with the given initial value. Return TRUE if the new value is accepted, and false otherwise. The input is constrained between lo and hi, unless lo>hi, in which case the input can be any number.

FXbool FXInputDialog::getReal FXdouble &    result,
FXWindow   owner,
const FXString   caption,
const FXString   label,
FXIcon   ic = NULL,
FXdouble    lo = 1.0,
FXdouble    hi = 0.0
[static]
 

Prompt for an real number, start with the given initial value. Return TRUE if the new value is accepted, and false otherwise. The input is constrained between lo and hi, unless lo>hi, in which case the input can be any number.