IlvIPromptString Class Reference

Dialog class. More...

#include <ilviews/gadgets/iprompt.h>

Inheritance diagram for IlvIPromptString:

List of all members.

Public Member Functions
	IlvIPromptString (IlvDisplay *display, const char *string=0, const char *const *strings=0, IlUShort count=0, IlBoolean copy=IlTrue, IlBoolean showtextf=IlTrue, const char *fileordata=0, IlvSystemView transientFor=0, IlUInt properties=0)
	Constructor.
const char *	get (IlBoolean grab=IlFalse, IlvCursor *cursor=0)
	Displays the dialog as a modal dialog.
const char *	getResult ()
	Returns the current selection.
void	setLabels (const char *const *strings, IlUShort count, IlBoolean copy=IlTrue, IlBoolean showtextf=IlTrue)
	Reloads the default components of the dialog and initializes it with the specified parameters.
void	setResult (const char *string)
	Sets the string of the current selection.
void	setString (const char *string)
	Sets the string displayed in the IlvMessageLabel object named "title".

---

Detailed Description

Dialog class.

Library: ilvadvgdt

The IlvIPromptString class defines a dialog that lets the user choose among a list of strings. The names of the graphic objects are displayed to let you change the default look of the dialog.

A prompt string dialog

See also:

IlvPromptDialog.

---

Constructor & Destructor Documentation

IlvIPromptString::IlvIPromptString	(	IlvDisplay *	display,
		const char *	string = 0,
		const char *const *	strings = 0,
		IlUShort	count = 0,
		IlBoolean	copy = IlTrue,
		IlBoolean	showtextf = IlTrue,
		const char *	fileordata = 0,
		IlvSystemView	transientFor = 0,
		IlUInt	properties = 0
	)

Constructor.

Initializes a new instance of the IlvIPromptString class.

Parameters:

	display	The connection to the display.
	string	The initial selection.
	strings	The array of strings from which the user can choose.
	count	The number of elements in strings. If count is set to 0, the string list is not displayed.
	copy	A Boolean value specifying whether strings should be copied.
	showtextf	A Boolean value specifying whether the text field should be shown or hidden.
	fileordata	Specifies an alternative source of Rogue Wave Views data defining the user interface of this dialog. This data can be stored in a file, in which case fileordata represents the name of the file, or in a C++ string, in which case fileordata stands for the string itself. If fileordata is not specified, the default dialog is used.
	transientFor	The system view for which the dialog is transient. For details, see the IlvView constructors.
	properties	The properties of the dialog. For details, see the IlvView constructors.

---

Member Function Documentation

const char* IlvIPromptString::get	(	IlBoolean	grab = IlFalse,
		IlvCursor *	cursor = 0
	)

Displays the dialog as a modal dialog.

Parameters:

grab

A Boolean value specifying whether the dialog should be system modal. The system modal dialog grabs input events occurring on the entire system so that other applications are not able to catch any keyboard or mouse event until the member function returns. In this case, you can specify the cursor to be used with the cursor parameter. If grab is set to IlFalse (the default), the dialog is application modal, which means that the application does not receive input events in other windows.

Warning:

[note]Some operating systems, such as Windows NT and Windows 95, do not allow system modal dialogs. On these operating system dialogs are always application modal.

Parameters:

cursor

The cursor used to make the selection.

Returns:

The selected string.

See also:

getResult.

const char* IlvIPromptString::getResult

(

)

Returns the current selection.

Returns:

The current selection.

See also:

setResult.

void IlvIPromptString::setLabels	(	const char *const *	strings,
		IlUShort	count,
		IlBoolean	copy = IlTrue,
		IlBoolean	showtextf = IlTrue
	)

Reloads the default components of the dialog and initializes it with the specified parameters.

If you have customized the dialog, your modifications will be lost.

Parameters:

	strings	The array of strings from which the user can choose.
	count	The number of elements in strings. If count is 0, the dialog does not display the string list.
	copy	A Boolean value specifying whether strings should be copied.
	showtextf	A Boolean value specifying whether the text field should be shown or hidden.

void IlvIPromptString::setResult

(

const char *

string

)

Sets the string of the current selection.

Parameters:

string

The new selection.

See also:

getResult.

void IlvIPromptString::setString

(

const char *

string

)

Sets the string displayed in the IlvMessageLabel object named "title".

Parameters:

string

The new label for the IlvMessageLabel object named "title".