FX::FXInputDialog Class Reference

An Input Dialog is a simple dialog which is used to obtain a text string, integer, or real number from the user. More...

#include <FXInputDialog.h>

Inheritance diagram for FX::FXInputDialog:

List of all members.

Public Member Functions
	FXInputDialog (FXWindow *owner, const FXString &caption, const FXString &label, FXIcon *icon=NULL, FXuint opts=INPUTDIALOG_STRING, FXint x=0, FXint y=0, FXint w=0, FXint h=0)
	FXInputDialog (FXApp *app, const FXString &caption, const FXString &label, FXIcon *icon=NULL, FXuint opts=INPUTDIALOG_STRING, FXint x=0, FXint y=0, FXint w=0, FXint h=0)
FXString	getText () const
void	setText (const FXString &text)
void	setNumColumns (FXint num)
FXint	getNumColumns () const
void	setLimits (FXdouble lo, FXdouble hi)
void	getLimits (FXdouble &lo, FXdouble &hi)
virtual FXuint	execute (FXuint placement=PLACEMENT_CURSOR)
Static Public Member Functions
static FXbool	getString (FXString &result, FXWindow *owner, const FXString &caption, const FXString &label, FXIcon *icon=NULL)
static FXbool	getString (FXString &result, FXApp *app, const FXString &caption, const FXString &label, FXIcon *icon=NULL)
static FXbool	getInteger (FXint &result, FXWindow *owner, const FXString &caption, const FXString &label, FXIcon *icon=NULL, FXint lo=-2147483647, FXint hi=2147483647)
static FXbool	getInteger (FXint &result, FXApp *app, const FXString &caption, const FXString &label, FXIcon *icon=NULL, FXint lo=-2147483647, FXint hi=2147483647)
static FXbool	getReal (FXdouble &result, FXWindow *owner, const FXString &caption, const FXString &label, FXIcon *icon=NULL, FXdouble lo=-1.797693134862315e+308, FXdouble hi=1.797693134862315e+308)
static FXbool	getReal (FXdouble &result, FXApp *app, const FXString &caption, const FXString &label, FXIcon *icon=NULL, FXdouble lo=-1.797693134862315e+308, FXdouble hi=1.797693134862315e+308)

---

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.

See also:

• Input dialog options.

---

Constructor & Destructor Documentation

FX::FXInputDialog::FXInputDialog	(	FXWindow *	owner,
		const FXString &	caption,
		const FXString &	label,
		FXIcon *	icon = 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.

FX::FXInputDialog::FXInputDialog	(	FXApp *	app,
		const FXString &	caption,
		const FXString &	label,
		FXIcon *	icon = NULL,
		FXuint	opts = INPUTDIALOG_STRING,
		FXint	x = 0,
		FXint	y = 0,
		FXint	w = 0,
		FXint	h = 0
	)

Construct free floating input dialog box with given caption, icon, and prompt text.

---

Member Function Documentation

FXString FX::FXInputDialog::getText

(

)

const

Get input string.

void FX::FXInputDialog::setText

(

const FXString &

text

)

Set input string.

void FX::FXInputDialog::setNumColumns

(

FXint

num

)

Change number of visible columns of text.

FXint FX::FXInputDialog::getNumColumns

(

)

const

Return number of visible columns of text.

void FX::FXInputDialog::setLimits	(	FXdouble	lo,
		FXdouble	hi
	)			[inline]

Change limits.

void FX::FXInputDialog::getLimits	(	FXdouble &	lo,
		FXdouble &	hi
	)			[inline]

Return limits.

virtual FXuint FX::FXInputDialog::execute

(

FXuint

placement = PLACEMENT_CURSOR

)

[virtual]

Run modal invocation of the dialog.

Reimplemented from FX::FXDialogBox.

static FXbool FX::FXInputDialog::getString	(	FXString &	result,
		FXWindow *	owner,
		const FXString &	caption,
		const FXString &	label,
		FXIcon *	icon = NULL
	)			[static]

Prompt for a string, start with the initial value.

Return TRUE if the new value is accepted, and false otherwise.

static FXbool FX::FXInputDialog::getString	(	FXString &	result,
		FXApp *	app,
		const FXString &	caption,
		const FXString &	label,
		FXIcon *	icon = NULL
	)			[static]

Prompt for a string, in free floating window.

static FXbool FX::FXInputDialog::getInteger	(	FXint &	result,
		FXWindow *	owner,
		const FXString &	caption,
		const FXString &	label,
		FXIcon *	icon = NULL,
		FXint	lo = -2147483647,
		FXint	hi = 2147483647
	)			[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.

static FXbool FX::FXInputDialog::getInteger	(	FXint &	result,
		FXApp *	app,
		const FXString &	caption,
		const FXString &	label,
		FXIcon *	icon = NULL,
		FXint	lo = -2147483647,
		FXint	hi = 2147483647
	)			[static]

Prompt for a integer number, in free floating window.

static FXbool FX::FXInputDialog::getReal	(	FXdouble &	result,
		FXWindow *	owner,
		const FXString &	caption,
		const FXString &	label,
		FXIcon *	icon = NULL,
		FXdouble	lo = -1.797693134862315e+308,
		FXdouble	hi = 1.797693134862315e+308
	)			[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.

static FXbool FX::FXInputDialog::getReal	(	FXdouble &	result,
		FXApp *	app,
		const FXString &	caption,
		const FXString &	label,
		FXIcon *	icon = NULL,
		FXdouble	lo = -1.797693134862315e+308,
		FXdouble	hi = 1.797693134862315e+308
	)			[static]

Prompt for a real number, in free floating window.