An 'Ok' button dialog. More...
#include <okdialog.h>
Inheritance diagram for OkDialog:
Public Member Functions | |
| OkDialog (const std::string &title, const std::string &msg, bool modal=true, Window *parent=nullptr) | |
| void | action (const gcn::ActionEvent &event) override |
| Called when receiving actions from the widgets. | |
 Public Member Functions inherited from Window | |
| Window (const std::string &caption="Window", bool modal=false, Window *parent=nullptr) | |
| Constructor. | |
| Window (SkinType skinType, const std::string &caption="Window", bool modal=false, Window *parent=nullptr) | |
| Constructor that allows customizing the SkinType used by the window. | |
| ~Window () override | |
| Destructor. | |
| void | draw (gcn::Graphics *graphics) override |
| Draws the window contents. | |
| void | drawFrame (gcn::Graphics *graphics) override |
| Draws the window frame. | |
| void | setContentSize (int width, int height) |
| Sets the size of this window. | |
| void | setMinimumContentSize (int width, int height) |
| Sets the minimum size of the window content. | |
| void | setLocationRelativeTo (gcn::Widget *widget) |
| Sets the location relative to the given widget. | |
| void | setResizable (bool resize) |
| Sets whether or not the window can be resized. | |
| void | redraw () |
| void | widgetResized (const gcn::Event &event) override |
| Called whenever the widget changes size. | |
| void | widgetHidden (const gcn::Event &event) override |
| Called whenever the widget is hidden. | |
| void | setCloseButton (bool flag) |
| Sets whether or not the window has a close button. | |
| bool | isResizable () const |
| Returns whether the window can be resized. | |
| void | setMinWidth (int width) |
| Sets the minimum width of the window. | |
| int | getMinWidth () const |
| void | setMinHeight (int height) |
| Sets the minimum height of the window. | |
| int | getMinHeight () const |
| void | setMaxWidth (int width) |
| Sets the maximum width of the window. | |
| int | getMaxWidth () const |
| void | setMaxHeight (int height) |
| Sets the minimum height of the window. | |
| int | getMaxHeight () const |
| void | setShowTitle (bool flag) |
| Sets flag to show a title or not. | |
| void | setStickyButton (bool flag) |
| Sets whether or not the window has a sticky button. | |
| void | setSticky (bool sticky) |
| Sets whether the window is sticky. | |
| bool | isSticky () const |
| Returns whether the window is sticky. | |
| virtual void | setVisible (bool visible) |
| Overloads window setVisible by Guichan to allow sticky window handling. | |
| void | setVisible (bool visible, bool forceSticky) |
| Overloads window setVisible by Guichan to allow sticky window handling, or not, if you force the sticky state. | |
| bool | isDefaultVisible () const |
| Returns whether the window is visible by default. | |
| void | setDefaultVisible (bool save) |
| Sets whether the window is visible by default. | |
| bool | willSaveVisible () const |
| Returns whether the window will save it's visibility. | |
| void | setSaveVisible (bool save) |
| Sets whether the window will save it's visibility. | |
| Window * | getParentWindow () const |
| Returns the parent window. | |
| void | scheduleDelete () |
| Schedule this window for deletion. | |
| void | mousePressed (gcn::MouseEvent &event) override |
| Starts window resizing when appropriate. | |
| void | mouseDragged (gcn::MouseEvent &event) override |
| Implements window resizing and makes sure the window is not dragged/resized outside of the screen. | |
| void | mouseMoved (gcn::MouseEvent &event) override |
| Implements custom cursor image changing context, based on mouse relative position. | |
| void | mouseReleased (gcn::MouseEvent &event) override |
| When the mouse button has been let go, this ensures that the mouse custom cursor is restored back to it's standard image. | |
| void | mouseExited (gcn::MouseEvent &event) override |
| When the mouse leaves the window this ensures that the custom cursor is restored back to it's standard image. | |
| void | setWindowName (const std::string &name) |
| Sets the name of the window. | |
| const std::string & | getWindowName () const |
| Returns the name of the window. | |
| void | loadWindowState () |
| Reads the position (and the size for resizable windows) in the configuration based on the given string. | |
| void | saveWindowState () const |
| Saves the window state so that when the window is reloaded, it'll maintain its previous state and location. | |
| void | setDefaultSize (int defaultX, int defaultY, int defaultWidth, int defaultHeight) |
| Set the default win pos and size. | |
| void | setDefaultSize () |
| Set the default win pos and size to the current ones. | |
| void | setDefaultSize (int defaultWidth, int defaultHeight, WindowAlignment alignment, int offsetx=0, int offsetY=0) |
| Set the default win pos and size. | |
| virtual void | resetToDefaultSize () |
| Reset the win pos and size to default. | |
| void | adjustPositionAfterResize (int oldScreenWidth, int oldScreenHeight) |
| Adjusts the window position after the application window has been resized. | |
| Layout & | getLayout () |
| Gets the layout handler for this window. | |
| void | clearLayout () |
| Clears the window's layout (useful for redesigning the window). | |
| void | reflowLayout (int w=0, int h=0) |
| Computes the position of the widgets according to the current layout. | |
| LayoutCell & | place (int x, int y, gcn::Widget *, int w=1, int h=1) |
| Adds a widget to the window and sets it at given cell. | |
| ContainerPlacer | getPlacer (int x, int y) |
| Returns a proxy for adding widgets in an inner table of the layout. | |
| void | center () |
| Positions the window in the center of it's parent. | |
| virtual void | close () |
| Overrideable functionality for when the window is to close. | |
| const Skin & | getSkin () const |
| Returns the Skin used by this window. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from Window | |
| static void | setWindowContainer (WindowContainer *windowContainer) |
| Sets the window container to be used by new windows. | |
| static int | getGuiAlpha () |
| Gets the alpha value used by the window, in a Guichan usable format. | |
| Static Protected Attributes inherited from Window | |
| static int | mouseResize = 0 |
| Active resize handles. | |
Detailed Description
An 'Ok' button dialog.
Definition at line 33 of file okdialog.h.
Constructor & Destructor Documentation
◆ OkDialog()
| OkDialog::OkDialog | ( | const std::string & | title, |
| const std::string & | msg, | ||
| bool | modal = true, |
||
| Window * | parent = nullptr |
||
| ) |
Definition at line 32 of file okdialog.cpp.
Member Function Documentation
◆ action()
|
override |
Called when receiving actions from the widgets.
Definition at line 52 of file okdialog.cpp.
The documentation for this class was generated from the following files:
- src/gui/okdialog.h
- src/gui/okdialog.cpp
