WidgetDialog Class
This class creates a dialog window.
When pressing ESC, the Close button will be pressed instead of the Cancel button if it is active.
WidgetDialog Class
Members
WidgetDialog (Gui gui, string str = 0, int x = 0, int y = 0)
Constructor. Creates a dialog window with given parameters.Arguments
- Gui gui - GUI, to which the dialog will belong.
- string str - Window title. This is an optional parameter.
- int x - Horizontal space between widgets in the window and between them and the window border. This is an optional parameter.
- int y - Vertical space between widgets in the window and between them and the window border. This is an optional parameter.
WidgetDialog create (Widget widget)
WidgetDialog constructor.Arguments
- Widget widget - Widget smart pointer.
Return value
string getCancelText ()
Returns the caption of the cancel button. The default is Cancel.Return value
Cancel button caption.void setCancelText (string text)
Sets a caption of the cancel button.Arguments
- string text - Cancel button caption.
WidgetButton getCloseButton ()
Returns the button that closes an action.Return value
Close button.string getCloseText ()
Returns a caption of the close button. By default, it is empty.Return value
Close button caption.int isDone ()
Returns a value indicating if the dialog window is closed.Return value
1 if the dialog window is closed; otherwise, 0.WidgetDialog getWidgetDialog ()
Returns a dialog pointer.Return value
WidgetDialog pointer.int isOkClicked ()
Returns a value indicating if the Ok button is clicked.Return value
1 if the Ok button is clicked; otherwise, 0.int isCloseClicked ()
Returns a value indicating if the close button is clicked.Return value
1 if the close button is clicked; otherwise, 0.int type ()
WidgetDialog type.Return value
WidgetDialog type identifier.void setOkText (string text)
Sets a caption of the Ok button.Arguments
- string text - Ok button caption.
string getOkText ()
Returns the caption of the Ok button. The default is Ok.Return value
Ok button caption.WidgetButton getCancelButton ()
Returns the button that cancels an action.Return value
Cancel button.int getResult ()
Returns a value indicating which button has been clicked.Return value
1 if the Ok button is clicked; -1 if the cancel button is clicked; 0 if the close button is clicked.WidgetButton getOkButton ()
Returns the button that approves an action.Return value
Ok button.void setCloseText (string text)
Sets a caption of the close button.Arguments
- string text - Close button caption to set.
int isCancelClicked ()
Returns a value indicating if the cancel button is clicked.Return value
1 if the cancel button is clicked; otherwise, 0.Last update: 2017-07-03
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)