Public Member Functions | Private Attributes
OkDialog Class Reference

#include <okdialog.h>

Inheritance diagram for OkDialog:
Window ActionListener BasicContainer2 MouseListener WidgetListener BasicContainer Widget WidgetDeathListener Widget2

Public Member Functions

 OkDialog (const std::string &title, const std::string &msg, const std::string &button, const DialogTypeT soundEvent, const Modal modal, const ShowCenter showCenter, Window *const parent, const int minWidth)
void action (const ActionEvent &event)
- Public Member Functions inherited from Window
 Window (const std::string &caption, const Modal modal, Window *const parent, std::string skin)
 ~Window ()
void draw (Graphics *const graphics)
void safeDraw (Graphics *const graphics)
void setContentSize (int width, int height)
void setLocationRelativeTo (const Widget *const widget)
void setLocationHorisontallyRelativeTo (const Widget *const widget)
void setLocationRelativeTo (const ImagePosition::Type &position, int offsetX, int offsetY)
void setResizable (const bool resize)
void redraw ()
void widgetResized (const Event &event)
void widgetMoved (const Event &event)
void widgetHidden (const Event &event)
void setCloseButton (const bool flag)
bool getCloseButton () const
void setAllowClose (const bool b)
bool getAlowClose () const
bool isResizable () const
void setMinWidth (const int width)
int getMinWidth () const
void setMinHeight (const int height)
int getMinHeight () const
void setMaxWidth (const int width)
int getMaxWidth () const
void setMaxHeight (const int height)
int getMaxHeight () const
void setShowTitle (bool flag)
void setStickyButton (const bool flag)
void setSticky (const bool sticky)
bool isSticky () const
void setStickyButtonLock (const bool sticky)
bool isStickyButtonLock () const
virtual void setVisible (Visible visible)
void setVisible (const Visible visible, const bool forceSticky)
bool isDefaultVisible () const
void setDefaultVisible (const bool save)
bool willSaveVisible () const
void setSaveVisible (const bool save)
void postInit ()
WindowgetParentWindow () const
virtual void scheduleDelete ()
void mousePressed (MouseEvent &event)
void mouseDragged (MouseEvent &event)
void mouseMoved (MouseEvent &event)
void mouseReleased (MouseEvent &event)
void mouseExited (MouseEvent &event)
void mouseEntered (MouseEvent &event)
void updateResizeHandler (MouseEvent &event)
void setWindowName (const std::string &name)
const std::string & getWindowName () const
void loadWindowState ()
void saveWindowState ()
void setDefaultSize (const int defaultX, const int defaultY, int defaultWidth, int defaultHeight)
void setDefaultSize ()
void setDefaultSize (const int defaultWidth, const int defaultHeight, const ImagePosition::Type &position, const int offsetx, const int offsetY)
virtual void resetToDefaultSize ()
void adjustPositionAfterResize (const int oldScreenWidth, const int oldScreenHeight)
LayoutgetLayout ()
void clearLayout ()
void reflowLayout (int w, int h)
LayoutCellplace (const int x, const int y, Widget *const wg, const int w, const int h)
ContainerPlacer getPlacer (const int x, const int y)
void center ()
void centerHorisontally ()
virtual void close ()
void setModal (const Modal modal)
Rect getWindowArea () const
bool isResizeAllowed (const MouseEvent &event) const
void setCaptionFont (Font *font)
void enableVisibleSound (bool b)
bool isWindowVisible () const
void setPadding (int padding)
int getPadding () const
void setTitleBarHeight (unsigned int height)
unsigned int getTitleBarHeight () const
void setCaption (const std::string &caption)
const std::string & getCaption () const
void setAlignment (Graphics::Alignment alignment)
Graphics::Alignment getAlignment () const
void setMovable (Move movable)
bool isMovable () const
Rect getChildrenArea ()
virtual void resizeToContent ()
- Public Member Functions inherited from BasicContainer2
 BasicContainer2 (const Widget2 *const widget)
 ~BasicContainer2 ()
void setOpaque (Opaque opaque)
bool isOpaque () const
virtual void add (Widget *const widget)
void addXY (Widget *const widget, const int x, const int y)
- Public Member Functions inherited from BasicContainer
 BasicContainer (const Widget2 *const widget)
 ~BasicContainer ()
void showWidgetPart (Widget *const widget, const Rect &area)
void moveToTop (Widget *const widget)
void moveToBottom (Widget *const widget)
void focusNext ()
void focusPrevious ()
void logic ()
void setFocusHandler (FocusHandler *const focusHandler)
void setInternalFocusHandler (FocusHandler *const focusHandler)
WidgetgetWidgetAt (int x, int y)
void death (const Event &event)
WidgetfindFirstWidget (const std::set< Widget *> &list)
void add (Widget *const widget)
virtual void remove (Widget *const widget)
virtual void clear ()
- Public Member Functions inherited from Widget
 Widget (const Widget2 *const widget)
 ~Widget ()
virtual void drawFrame (Graphics *graphics)
virtual void safeDrawFrame (Graphics *graphics)
void setFrameSize (const unsigned int frameSize)
unsigned int getFrameSize () const
WidgetgetParent () const
void setWidth (const int width)
int getWidth () const
void setHeight (const int height)
int getHeight () const
void setSize (const int width, const int height)
void setX (const int x)
int getX () const
void setY (const int y)
int getY () const
void setPosition (const int x, const int y)
void setDimension (const Rect &dimension)
const RectgetDimension () const
void setFocusable (const bool focusable)
bool isFocusable () const
virtual bool isFocused () const
void setEnabled (const bool enabled)
bool isEnabled () const
void setVisible (Visible visible)
bool isVisible () const
void setBaseColor (const Color &color)
const ColorgetBaseColor () const
void setForegroundColor (const Color &color)
const ColorgetForegroundColor () const
void setBackgroundColor (const Color &color)
const ColorgetBackgroundColor () const
virtual void requestFocus ()
virtual void requestMoveToTop ()
virtual void requestMoveToBottom ()
FocusHandlergetFocusHandler ()
void addActionListener (ActionListener *const actionListener)
void removeActionListener (ActionListener *const actionListener)
void addDeathListener (WidgetDeathListener *const deathListener)
void removeDeathListener (WidgetDeathListener *const deathListener)
void addMouseListener (MouseListener *const mouseListener)
void removeMouseListener (MouseListener *const mouseListener)
void addKeyListener (KeyListener *const keyListener)
void removeKeyListener (KeyListener *const keyListener)
void addFocusListener (FocusListener *const focusListener)
void removeFocusListener (FocusListener *const focusListener)
void addWidgetListener (WidgetListener *const widgetListener)
void removeWidgetListener (WidgetListener *const widgetListener)
void setActionEventId (const std::string &actionEventId)
const std::string & getActionEventId () const
virtual void getAbsolutePosition (int &x, int &y) const
virtual void setParent (Widget *parent)
FontgetFont () const
void setFont (Font *const font)
virtual void fontChanged ()
bool isTabInEnabled () const
void setTabInEnabled (const bool enabled)
bool isTabOutEnabled () const
void setTabOutEnabled (const bool enabled)
void requestModalFocus ()
virtual void requestModalMouseInputFocus ()
virtual void releaseModalFocus ()
virtual void releaseModalMouseInputFocus ()
virtual bool isModalFocused () const
virtual bool isModalMouseInputFocused () const
const std::list< MouseListener * > & getMouseListeners () const A_CONST
const std::list< KeyListener * > & getKeyListeners () const A_CONST
const std::list< FocusListener * > & getFocusListeners () const A_CONST
virtual FocusHandlergetInternalFocusHandler ()
void setInternalFocusHandler (FocusHandler *const internalFocusHandler)
void setId (const std::string &id)
const std::string & getId () const
virtual void showPart (const Rect &rectangle)
bool isAllowLogic () const
void setMouseConsume (const bool b)
bool isMouseConsume () const
void setRedraw (const bool b)
virtual bool isSelectable () const
void setSelectable (const bool selectable)
void windowResized ()
- Public Member Functions inherited from Widget2
virtual ~Widget2 ()
const ColorgetThemeColor (const ThemeColorIdT type, const unsigned int alpha) const A_INLINE
const ColorgetThemeCharColor (const signed char c, bool &valid) const A_INLINE
virtual void setWidget2 (const Widget2 *const widget)
void setPalette (int palette)
void checkPalette ()
void setForegroundColor2 (const Color &color)
WidgetgetWindow () const
virtual void setWindow (Widget *const window)
- Public Member Functions inherited from WidgetDeathListener
virtual ~WidgetDeathListener ()
- Public Member Functions inherited from MouseListener
virtual ~MouseListener ()
virtual void mouseClicked (MouseEvent &event)
virtual void mouseWheelMovedUp (MouseEvent &event)
virtual void mouseWheelMovedDown (MouseEvent &event)
- Public Member Functions inherited from WidgetListener
virtual ~WidgetListener ()
virtual void widgetShown (const Event &event)
- Public Member Functions inherited from ActionListener
virtual ~ActionListener ()

Private Attributes


Additional Inherited Members

- Static Public Member Functions inherited from Window
static void setWindowContainer (WindowContainer *const windowContainer)
- Static Public Member Functions inherited from Widget
static void setGlobalFont (Font *const font)
static FontgetGloablFont ()
static void cleanGlobalFont ()
static bool widgetExists (const Widget *const widget)
static void distributeWindowResizeEvent ()
static WidgetcallPostInit (Widget *const widget)
- Data Fields inherited from Widget
Visible mVisible
- Protected Types inherited from BasicContainer
typedef std::vector< Widget * > WidgetList
typedef WidgetList::iterator WidgetListIterator
typedef WidgetList::const_iterator WidgetListConstIterator
typedef WidgetList::reverse_iterator WidgetListReverseIterator
typedef WidgetList::const_reverse_iterator WidgetListCReverseIterator
- Protected Types inherited from Widget
typedef std::list< MouseListener * > MouseListenerList
typedef MouseListenerList::iterator MouseListenerIterator
typedef std::list< KeyListener * > KeyListenerList
typedef KeyListenerList::iterator KeyListenerIterator
typedef std::list< ActionListener * > ActionListenerList
typedef ActionListenerList::iterator ActionListenerIterator
typedef std::list< WidgetDeathListener * > WidgetDeathListenerList
typedef WidgetDeathListenerList::iterator WidgetDeathListenerIterator
typedef std::list< FocusListener * > FocusListenerList
typedef FocusListenerList::iterator FocusListenerIterator
typedef std::list< WidgetListener * > WidgetListenerList
typedef WidgetListenerList::iterator WidgetListenerIterator
- Protected Member Functions inherited from Window
bool canMove () const
int getOption (const std::string &name, const int def) const
bool getOptionBool (const std::string &name, const bool def) const
void setTitlePadding (const int p)
int getTitlePadding () const
- Protected Member Functions inherited from BasicContainer
virtual void drawChildren (Graphics *const graphics)
virtual void safeDrawChildren (Graphics *const graphics)
virtual void logicChildren ()
- Protected Member Functions inherited from Widget
void distributeActionEvent ()
void distributeResizedEvent ()
void distributeMovedEvent ()
void distributeHiddenEvent ()
void distributeShownEvent ()
- Protected Member Functions inherited from Widget2
 Widget2 (const Widget2 *const widget)
- Protected Member Functions inherited from WidgetDeathListener
 WidgetDeathListener ()
- Protected Member Functions inherited from MouseListener
 MouseListener ()
- Protected Member Functions inherited from WidgetListener
 WidgetListener ()
- Protected Member Functions inherited from ActionListener
 ActionListener ()
- Protected Attributes inherited from Window
std::string mCaption
Graphics::Alignment mAlignment
int mPadding
unsigned int mTitleBarHeight
Move mMovable
int mDragOffsetX
int mDragOffsetY
bool mMoved
int mDefaultX
int mDefaultY
int mDefaultWidth
int mDefaultHeight
int mCaptionOffsetX
int mCaptionOffsetY
bool mShowTitle
bool mLastRedraw
- Protected Attributes inherited from BasicContainer2
Opaque mOpaque
- Protected Attributes inherited from BasicContainer
WidgetList mWidgets
WidgetList mLogicWidgets
- Protected Attributes inherited from Widget
MouseListenerList mMouseListeners
KeyListenerList mKeyListeners
ActionListenerList mActionListeners
WidgetDeathListenerList mDeathListeners
FocusListenerList mFocusListeners
WidgetListenerList mWidgetListeners
Color mForegroundColor
Color mBackgroundColor
Color mBaseColor
Rect mDimension
std::string mActionEventId
std::string mId
unsigned int mFrameSize
bool mFocusable
bool mTabIn
bool mTabOut
bool mEnabled
bool mAllowLogic
bool mMouseConsume
bool mRedraw
bool mSelectable
- Protected Attributes inherited from Widget2
int mPaletteOffset
Color mForegroundColor2
- Static Protected Attributes inherited from Widget
static FontmGlobalFont = 0

Detailed Description

An 'Ok' button dialog.

Definition at line 43 of file okdialog.h.

Constructor & Destructor Documentation

◆ OkDialog()

OkDialog::OkDialog ( const std::string &  title,
const std::string &  msg,
const std::string &  button,
const DialogTypeT  soundEvent,
const Modal  modal,
const ShowCenter  showCenter,
Window *const  parent,
const int  minWidth 


See also

Definition at line 36 of file okdialog.cpp.

References BasicContainer2::add(), BUTTON_SKIN, Window::center(), Window::centerHorisontally(), DialogType::ERROR, Widget::getFont(), Widget::getHeight(), TextBox::getMinWidth(), Window::getMinWidth(), Window::getOption(), Font::getWidth(), Widget::getWidth(), mTextBox, DialogType::OK, Opaque_false, SoundManager::playGuiSound(), Widget::requestFocus(), Window::setContentSize(), TextBox::setEditable(), TextBox::setOpaque(), Widget::setPosition(), TextBox::setTextWrapped(), Window::setVisible(), ShowCenter_true, SOUND_ERROR, SOUND_INFO, soundManager, and Visible_true.

43  :
44  Window(title, modal, parent, "ok.xml"),
46  mTextBox(new TextBox(this))
47 {
48  mTextBox->setEditable(false);
50  mTextBox->setTextWrapped(msg, minWidth);
52  // TRANSLATORS: ok dialog button
53  Button *const okButton = new Button(this,
54  button,
55  "ok",
57  this);
59  int width = getFont()->getWidth(title);
60  if (width < mTextBox->getMinWidth())
61  width = mTextBox->getMinWidth();
62  if (width < okButton->getWidth())
63  width = okButton->getWidth();
65  if (mTextBox->getWidth() > width)
66  width = mTextBox->getWidth();
67  if (okButton->getWidth() > width)
68  width = okButton->getWidth();
69  setContentSize(width, mTextBox->getHeight() + okButton->getHeight()
70  + getOption("buttonPadding", 8));
71  mTextBox->setPosition((width - mTextBox->getWidth()) / 2, 0);
72  okButton->setPosition((width - okButton->getWidth()) / 2,
73  mTextBox->getHeight() + getOption("buttonPadding", 8));
75  // +++ virtual method call
76  add(mTextBox);
77  add(okButton);
79  if (showCenter == ShowCenter_true)
80  center();
81  else
83  // +++ virtual method call
85  okButton->requestFocus();
87  if (soundEvent == DialogType::OK)
89  else if (soundEvent == DialogType::ERROR)
91 }
Font * getFont() const
Definition: widget.cpp:330
int getWidth() const
Definition: widget.h:220
void setTextWrapped(const std::string &text, const int minDimension)
Definition: textbox.cpp:108
const bool Visible_true
Definition: visible.h:29
TextBox * mTextBox
Definition: okdialog.h:69
Definition: button.h:96
SoundManager soundManager
void centerHorisontally()
Definition: window.cpp:1417
int getOption(const std::string &name, const int def) const
Definition: window.cpp:1449
bool msg(InputEvent &event)
Definition: chat.cpp:38
void setContentSize(int width, int height)
Definition: window.cpp:491
void setEditable(const bool editable)
Definition: textbox.h:244
virtual void requestFocus()
Definition: widget.cpp:203
const std::string BUTTON_SKIN
Definition: button.h:88
virtual void add(Widget *const widget)
int getMinWidth() const
Definition: textbox.h:107
const bool ShowCenter_true
Definition: showcenter.h:29
const bool Opaque_false
Definition: opaque.h:29
void setPosition(const int x, const int y)
Definition: widget.cpp:160
void setOpaque(const Opaque opaque)
Definition: textbox.h:273
static const std::string SOUND_ERROR
Definition: sound.h:27
virtual void setVisible(Visible visible)
Definition: window.cpp:773
void center()
Definition: window.cpp:1412
int getWidth(const std::string &text) const
Definition: font.cpp:333
int getHeight() const
Definition: widget.h:239
static const std::string SOUND_INFO
Definition: sound.h:26
Window(const std::string &caption, const Modal modal, Window *const parent, std::string skin)
Definition: window.cpp:108
int getMinWidth() const
Definition: window.h:204
void playGuiSound(const std::string &name)

Member Function Documentation

◆ action()

void OkDialog::action ( const ActionEvent event)

Called when receiving actions from the widgets.

Implements ActionListener.

Definition at line 93 of file okdialog.cpp.

References Widget::distributeActionEvent(), ActionEvent::getId(), Window::scheduleDelete(), and Widget::setActionEventId().

94 {
95  setActionEventId(event.getId());
98 }
void setActionEventId(const std::string &actionEventId)
Definition: widget.h:595
void distributeActionEvent()
Definition: widget.cpp:492
const std::string & getId() const
Definition: actionevent.h:121
virtual void scheduleDelete()
Definition: window.cpp:826

Field Documentation

◆ mTextBox

TextBox* OkDialog::mTextBox

Definition at line 69 of file okdialog.h.

Referenced by OkDialog().

The documentation for this class was generated from the following files: