rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Gadgets Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Member Functions
IlvIPromptString Class Reference

Dialog class. More...

#include <ilviews/gadgets/iprompt.h>

Inheritance diagram for IlvIPromptString:
IlvDialog IlvGadgetContainer IlvContainer IlvDrawingView IlvView IlvAbstractView IlvSystemPort IlvPort

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. More...
 
const char * get (IlBoolean grab=IlFalse, IlvCursor *cursor=0)
 Displays the dialog as a modal dialog. More...
 
const char * getResult ()
 Returns the current selection. More...
 
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. More...
 
void setResult (const char *string)
 Sets the string of the current selection. More...
 
void setString (const char *string)
 Sets the string displayed in the IlvMessageLabel object named "title". More...
 
- Public Member Functions inherited from IlvDialog
 IlvDialog (IlvDisplay *display, const char *name, const char *title, const IlvRect &rect, IlUInt properties=0, IlvSystemView transientFor=0)
 Constructor. More...
 
 IlvDialog (IlvDisplay *display, const char *name, const char *title, const char *filename, const IlvRect *rect=0)
 Constructor. More...
 
 IlvDialog (IlvDisplay *display, const char *name, const char *title, const char *filename, IlUInt properties, const IlvRect *rect=0, IlvSystemView transientFor=0)
 Constructor. More...
 
virtual void apply ()
 Is called when the callback associated with the apply symbol is triggered. More...
 
virtual void cancel ()
 Is called when the callback associated with the cancel symbol is triggered. More...
 
virtual void wait (IlBoolean grab=IlFalse, IlvCursor *cursor=0)
 Displays a modal dialog. More...
 
IlBoolean wasCanceled () const
 Returns the status of the dialog after closing it. More...
 
- Public Member Functions inherited from IlvGadgetContainer
 IlvGadgetContainer (IlvDisplay *display, const char *name, const char *title, const IlvRect &rect, IlBoolean useacc=IlFalse, IlBoolean visible=IlTrue)
 Constructor. More...
 
 IlvGadgetContainer (IlvDisplay *display, const char *name, const char *title, const IlvRect &rect, IlUInt properties, IlBoolean useacc=IlFalse, IlBoolean visible=IlTrue, IlvSystemView transientFor=0)
 Constructor. More...
 
 IlvGadgetContainer (IlvAbstractView *parent, const IlvRect &rect, IlBoolean useacc=IlFalse, IlBoolean visible=IlTrue)
 Constructor. More...
 
 IlvGadgetContainer (IlvDisplay *display, IlvSystemView parent, const IlvRect &rect, IlBoolean useacc=IlFalse, IlBoolean visible=IlTrue)
 Constructor. More...
 
 IlvGadgetContainer (IlvDisplay *display, IlvSystemView window, IlBoolean useacc=IlFalse)
 Constructor. More...
 
virtual IlBoolean allowFocus (IlBoolean value)
 Specifies whether the container manages the focus. More...
 
virtual void applyResize (IlFloat sx, IlFloat sy, IlBoolean redraw=IlTrue)
 Is called to carry out the resize events applying to the gadget container. More...
 
IlBoolean autoResize (IlBoolean a)
 Sets the auto resize mode of the gadget container. More...
 
IlvButtongetDefaultButton () const
 Returns the default button of the gadget container. More...
 
virtual IlvGraphicgetFirstFocusGraphic () const
 Returns the first object that receives the focus in this container. More...
 
virtual IlvGraphicgetFocus () const
 Returns the object that has the keyboard focus in the gadget container. More...
 
virtual IlvGraphicgetGrab () const
 Returns the object that is currently grabbing events in the container. More...
 
virtual IlvGraphicgetLastFocusGraphic () const
 Returns the last object that receives the focus in this container. More...
 
IlvLookFeelHandlergetLookFeelHandler () const
 Returns the look and feel handler associated with this container. More...
 
virtual IlvGraphicgetNextFocusGraphic (IlvGraphic *object) const
 Returns the next object that will receive the focus after the specified object. More...
 
IlvGraphicgetOverriddenFocus () const
 Returns the object that will receive the focus after calling setFocus. More...
 
virtual IlvGraphicgetPreviousFocusGraphic (IlvGraphic *object) const
 Returns the previous object that received the focus before the specified object. More...
 
IlBoolean isAutoResizing () const
 Indicates whether the gadget container gets resized when loading a file. More...
 
virtual IlBoolean isFocusAllowed () const
 Indicates whether the focus is allowed in the container. More...
 
virtual void moveFocusAfter (IlBoolean redraw=IlTrue)
 Is called to find the next focusable object. More...
 
virtual void moveFocusBefore (IlBoolean redraw=IlTrue)
 Is called to find the previous focusable object. More...
 
void overrideFocus (IlvGraphic *obj)
 Sets the object that will receive the focus after calling setFocus. More...
 
virtual void removeGrab ()
 Cancels the grabbing settings defined with setGrab. More...
 
void setDefaultButton (IlvButton *, IlBoolean redraw=IlTrue)
 Sets the default button of the gadget container. More...
 
virtual void setFocus (IlvGraphic *graphic=0, IlBoolean redraw=IlTrue)
 Sets the focus to the specified object of the gadget container. More...
 
virtual void setGrab (IlvGraphic *object)
 Sets the specified object as the grabbing object. More...
 
void setLookFeelHandler (IlvLookFeelHandler *lfh)
 Sets the look and feel handler of this container. More...
 

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
displayThe connection to the display.
stringThe initial selection.
stringsThe array of strings from which the user can choose.
countThe number of elements in strings. If count is set to 0, the string list is not displayed.
copyA Boolean value specifying whether strings should be copied.
showtextfA Boolean value specifying whether the text field should be shown or hidden.
fileordataSpecifies 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.
transientForThe system view for which the dialog is transient. For details, see the IlvView constructors.
propertiesThe 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
grabA 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
cursorThe 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
stringsThe array of strings from which the user can choose.
countThe number of elements in strings. If count is 0, the dialog does not display the string list.
copyA Boolean value specifying whether strings should be copied.
showtextfA 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
stringThe new selection.
See Also
getResult.
void IlvIPromptString::setString ( const char *  string)

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

Parameters
stringThe new label for the IlvMessageLabel object named "title".

© Copyright 2012, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.