Rogue Wave Views
Gadgets Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions
IlvIMessageDialog Class Reference

Dialog class. More...

#include <ilviews/gadgets/stdialog.h>

Inheritance diagram for IlvIMessageDialog:
IlvDialog IlvGadgetContainer IlvContainer IlvStylist IlvDrawingView IlvDrawingView IlvView IlvView IlvAbstractView IlvAbstractView IlvSystemPort IlvStylable IlvSystemPort IlvStylable IlvPort IlvPort IlvValueInterface IlvValueInterface IlvIErrorDialog IlvIInformationDialog IlvIQuestionDialog IlvIWarner

Public Member Functions

 IlvIMessageDialog (IlvDisplay *display, const char *string, const char *fileordata=0, IlvIDialogType type=IlvDialogOkCancel, IlvSystemView transientFor=0)
 Constructor. More...
 
 IlvIMessageDialog (IlvDisplay *display, const char *const *strings, IlUShort count, IlBoolean copy=IlTrue, const char *fileordata=0, IlvIDialogType type=IlvDialogOkCancel, IlvSystemView transientFor=0)
 Constructor. More...
 
IlBoolean get (IlBoolean grab=IlFalse, IlvCursor *cursor=0)
 Displays the dialog as a modal dialog. More...
 
IlBoolean getResult ()
 Returns a Boolean value indicating whether the user clicked on Apply or Cancel in the dialog. More...
 
void setString (const char *string)
 Sets a message with a single line to the dialog. More...
 
void setString (const char *const *strings, IlUShort count, IlBoolean copy=IlTrue)
 Sets a message with multiple lines to the dialog. 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 *button, 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: ilvgadgt

The IlvIMessageDialog class asks the user a question and expects a yes or no answer. IlvIMessageDialog has predefined subclasses for questions (IlvIQuestionDialog), warnings (IlvIWarner), errors (IlvIErrorDialog), and information (IlvIInformationDialog). The names of the graphic object are displayed to let you modify the default look of the dialog box.


- A Message Dialog -

See also
IlvIQuestionDialog, IlvIInformationDialog, IlvIErrorDialog, IlvIWarner.

Constructor & Destructor Documentation

IlvIMessageDialog::IlvIMessageDialog ( IlvDisplay display,
const char *  string,
const char *  fileordata = 0,
IlvIDialogType  type = IlvDialogOkCancel,
IlvSystemView  transientFor = 0 
)

Constructor.

Initializes a new instance of the IlvIMessageDialog class that initially displays a message with a single line.

Parameters
displayThe connection to the display.
stringThe message to be displayed.
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.
typeThe type of the dialog. For details, see IlvIDialogType.
transientForA system view for which the dialog is transient. For details, see the IlvView constructors.
IlvIMessageDialog::IlvIMessageDialog ( IlvDisplay display,
const char *const *  strings,
IlUShort  count,
IlBoolean  copy = IlTrue,
const char *  fileordata = 0,
IlvIDialogType  type = IlvDialogOkCancel,
IlvSystemView  transientFor = 0 
)

Constructor.

Initializes a new instance of the IlvIMessageDialog class that initially displays a message with multiple lines.

Parameters
displayThe connection to the display.
stringsAn array of strings representing the message to be displayed.
countThe number of elements in the strings array.
copyNot used.
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.
typeThe type of the dialog. For details, see IlvIDialogType.
transientForThe system view for which the dialog is transient. For details, see the IlvView constructors.

Member Function Documentation

IlBoolean IlvIMessageDialog::get ( IlBoolean  grab = IlFalse,
IlvCursor cursor = 0 
)

Displays the dialog as a modal dialog.

Parameters
grabSpecifies whether the dialog should be system modal. A 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.
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 result.
See also
getResult().
IlBoolean IlvIMessageDialog::getResult ( )

Returns a Boolean value indicating whether the user clicked on Apply or Cancel in the dialog.

Returns
IlTrue if the dialog was closed by calling the IlvDialog::apply() method, or IlFalse if the dialog was closed by calling the IlvDialog::cancel() method.
See also
IlvDialog::wasCanceled(), get().
void IlvIMessageDialog::setString ( const char *  string)

Sets a message with a single line to the dialog.

The dialog is resized to fit the size of the new message.

Parameters
stringThe new message displayed by the dialog.
See also
setString(const char* const*, IlUShort, IlBoolean).
void IlvIMessageDialog::setString ( const char *const *  strings,
IlUShort  count,
IlBoolean  copy = IlTrue 
)

Sets a message with multiple lines to the dialog.

The dialog is resized to fit the size of the new message.

Parameters
stringsAn array of strings representing the message to be displayed.
countThe number of elements in the strings array.
copyNot used.
See also
setString(const char*).

© Copyright 2016, 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.