Public Member Functions | Private Member Functions | Private Attributes
DidYouKnowWindow Class Reference

#include <didyouknowwindow.h>

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

Public Member Functions

 DidYouKnowWindow ()
 ~DidYouKnowWindow ()
void postInit ()
void action (const ActionEvent &event)
void loadData (int num)
void setVisible (Visible visible)
- 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
void setVisible (const Visible visible, const bool forceSticky)
bool isDefaultVisible () const
void setDefaultVisible (const bool save)
bool willSaveVisible () const
void setSaveVisible (const bool save)
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 Member Functions

void loadFile (const int num)

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

The help dialog.

Definition at line 40 of file didyouknowwindow.h.

Constructor & Destructor Documentation

◆ DidYouKnowWindow()

DidYouKnowWindow::DidYouKnowWindow ( )


Definition at line 54 of file didyouknowwindow.cpp.

54  :
55  // TRANSLATORS: did you know window name
56  Window(_("Did You Know?"), Modal_false, nullptr, "didyouknow.xml"),
60  "browserbox.xml")),
62  Opaque_true, "didyouknow_background.xml")),
63  // TRANSLATORS: did you know window button
64  mButtonPrev(new Button(this, _("< Previous"), "prev", BUTTON_SKIN, this)),
65  // TRANSLATORS: did you know window button
66  mButtonNext(new Button(this, _("Next >"), "next", BUTTON_SKIN, this)),
67  // TRANSLATORS: did you know window checkbox
68  mOpenAgainCheckBox(new CheckBox(this, _("Auto open this window"),
69  config.getBoolValue("showDidYouKnow"), this, "openagain"))
70 {
71  setMinWidth(300);
72  setMinHeight(220);
73  setContentSize(455, 350);
74  setWindowName("DidYouKnow");
75  setCloseButton(true);
76  setResizable(true);
77  setStickyButtonLock(true);
79  if (setupWindow != nullptr)
81  setDefaultSize(500, 400, ImagePosition::CENTER, 0, 0);
84  Button *const okButton = new Button(this,
85  // TRANSLATORS: did you know window button
86  _("Close"),
87  "close",
89  this);
92  if (gui != nullptr)
99  place(0, 0, mScrollArea, 5, 3).setPadding(3);
100  place(0, 3, mOpenAgainCheckBox, 5, 1);
101  place(1, 4, mButtonPrev, 1, 1);
102  place(2, 4, mButtonNext, 1, 1);
103  place(4, 4, okButton, 1, 1);
105  Layout &layout = getLayout();
106  layout.setRowHeight(0, LayoutType::SET);
108  loadWindowState();
109  enableVisibleSound(true);
110 }
const std::string BUTTON_SKIN
Definition: button.h:89
Definition: button.h:102
bool getBoolValue(const std::string &key) const
ScrollArea * mScrollArea
StaticBrowserBox * mBrowserBox
ItemLinkHandler * mItemLinkHandler
CheckBox * mOpenAgainCheckBox
Font * getHelpFont() const
Definition: gui.h:166
LayoutCell & setPadding(int p)
Definition: layoutcell.h:60
void setRowHeight(const int n, const int h)
Definition: layoutcell.cpp:128
Definition: layout.h:45
void registerWindowForReset(Window *const window)
void setOpaque(Opaque opaque)
void setEnableKeys(const bool n)
void setEnableImages(const bool n)
void setEnableTabs(const bool n)
void setProcessVars(const bool n)
void setLinkHandler(LinkHandler *linkHandler)
void setFont(Font *const font)
Definition: widget.cpp:349
void setResizable(const bool resize)
Definition: window.cpp:627
void setContentSize(int width, int height)
Definition: window.cpp:492
Layout & getLayout()
Definition: window.cpp:1365
void setWindowName(const std::string &name)
Definition: window.h:355
Window(const std::string &caption, const Modal modal, Window *const parent, std::string skin)
Definition: window.cpp:109
void setMinHeight(const int height)
Definition: window.cpp:604
void setMinWidth(const int width)
Definition: window.cpp:591
void enableVisibleSound(bool b)
Definition: window.h:481
void setCloseButton(const bool flag)
Definition: window.cpp:749
void setStickyButtonLock(const bool sticky)
Definition: window.cpp:772
LayoutCell & place(const int x, const int y, Widget *const wg, const int w, const int h)
Definition: window.cpp:1384
void setDefaultSize()
Definition: window.cpp:1198
void loadWindowState()
Definition: window.cpp:1087
Configuration config
#define _(s)
Definition: gettext.h:35
Gui * gui
Definition: gui.cpp:111
const bool Modal_false
Definition: modal.h:30
const bool Opaque_false
Definition: opaque.h:30
const bool Opaque_true
Definition: opaque.h:30
SetupWindow * setupWindow
Definition: setupwindow.cpp:64

References _, BUTTON_SKIN, ImagePosition::CENTER, Window::enableVisibleSound(), Gui::getHelpFont(), Window::getLayout(), gui, Window::loadWindowState(), mBrowserBox, mButtonNext, mButtonPrev, mItemLinkHandler, mOpenAgainCheckBox, mScrollArea, Opaque_false, Window::place(), SetupWindow::registerWindowForReset(), LayoutType::SET, Window::setCloseButton(), Window::setContentSize(), Window::setDefaultSize(), StaticBrowserBox::setEnableImages(), StaticBrowserBox::setEnableKeys(), StaticBrowserBox::setEnableTabs(), Widget::setFont(), StaticBrowserBox::setLinkHandler(), Window::setMinHeight(), Window::setMinWidth(), StaticBrowserBox::setOpaque(), LayoutCell::setPadding(), StaticBrowserBox::setProcessVars(), Window::setResizable(), LayoutCell::setRowHeight(), Window::setStickyButtonLock(), setupWindow, and Window::setWindowName().

◆ ~DidYouKnowWindow()

DidYouKnowWindow::~DidYouKnowWindow ( )

Definition at line 118 of file didyouknowwindow.cpp.

119 {
121 }
#define delete2(var)
Definition: delete2.h:25

References delete2, and mItemLinkHandler.

Member Function Documentation

◆ action()

void DidYouKnowWindow::action ( const ActionEvent event)

Called when receiving actions from the widgets.

Implements ActionListener.

Definition at line 123 of file didyouknowwindow.cpp.

124 {
125  const std::string &eventId = event.getId();
126  if (eventId == "close")
127  {
129  }
130  else
131  {
132  const unsigned num = config.getIntValue("currentTip");
133  if (eventId == "prev")
134  {
135  loadData(num - 1);
136  }
137  else if (eventId == "next")
138  {
139  loadData(num + 1);
140  }
141  else if (eventId == "openagain")
142  {
143  config.setValue("showDidYouKnow",
145  }
146  }
147 }
bool isSelected() const
Definition: checkbox.h:147
void setValue(const std::string &key, const std::string &value)
int getIntValue(const std::string &key) const
void loadData(int num)
void setVisible(Visible visible)
const bool Visible_false
Definition: visible.h:30

References config, Configuration::getIntValue(), CheckBox::isSelected(), loadData(), mOpenAgainCheckBox, Configuration::setValue(), setVisible(), and Visible_false.

◆ loadData()

void DidYouKnowWindow::loadData ( int  num)

Definition at line 149 of file didyouknowwindow.cpp.

150 {
152  if (num == 0)
153  {
154  const int curTip = config.getIntValue("currentTip");
155  if (curTip == 1)
156  num = maxTip;
157  else
158  num = curTip + 1;
159  }
161  if (num < minTip || num > maxTip)
162  num = minTip;
164  config.setValue("currentTip", num);
166  loadFile(num);
170 }
void loadFile(const int num)
void setVerticalScrollAmount(const int vScroll)
static const int minTip
static const int maxTip

References StaticBrowserBox::clearRows(), config, Configuration::getIntValue(), loadFile(), maxTip, mBrowserBox, minTip, mScrollArea, Configuration::setValue(), ScrollArea::setVerticalScrollAmount(), and StaticBrowserBox::updateHeight().

Referenced by action(), createGuiWindows(), and setVisible().

◆ loadFile()

void DidYouKnowWindow::loadFile ( const int  num)

Definition at line 172 of file didyouknowwindow.cpp.

173 {
174  const std::string file = strprintf("tips/%d", num);
175  std::string helpPath = branding.getStringValue("helpPath");
176  if (helpPath.empty())
177  helpPath = paths.getStringValue("help");
179  StringVect lines;
180  TranslationManager::translateFile(pathJoin(helpPath, file).append(".txt"),
181  translator, lines);
183  for (size_t i = 0, sz = lines.size(); i < sz; ++i)
184  mBrowserBox->addRow(lines[i], false);
185 }
std::string getStringValue(const std::string &key) const
void addRow(const std::string &row, const bool atTop)
static bool translateFile(const std::string &fileName, PoDict *const dict, StringVect &lines)
Configuration paths
Configuration branding
PoDict * translator
Definition: podict.cpp:28
std::string strprintf(const char *const format,...)
std::string pathJoin(std::string str1, const std::string &str2)
std::vector< std::string > StringVect
Definition: stringvector.h:29

References StaticBrowserBox::addRow(), branding, Configuration::getStringValue(), mBrowserBox, pathJoin(), paths, strprintf(), TranslationManager::translateFile(), and translator.

Referenced by loadData().

◆ postInit()

void DidYouKnowWindow::postInit ( )

Reimplemented from Window.

Definition at line 112 of file didyouknowwindow.cpp.

113 {
115  widgetResized(Event(nullptr));
116 }
Definition: event.h:79
void postInit()
Definition: window.cpp:249
void widgetResized(const Event &event)
Definition: window.cpp:655

References Window::postInit(), and Window::widgetResized().

◆ setVisible()

void DidYouKnowWindow::setVisible ( Visible  visible)

Overloads window setVisible by Guichan to allow sticky window handling.

Reimplemented from Window.

Definition at line 187 of file didyouknowwindow.cpp.

188 {
189  Window::setVisible(visible);
191  if (visible == Visible_true || isWindowVisible())
192  loadData(0);
193 }
virtual void setVisible(Visible visible)
Definition: window.cpp:778
bool isWindowVisible() const
Definition: window.h:484
const bool Visible_true
Definition: visible.h:30

References Window::isWindowVisible(), loadData(), Window::setVisible(), and Visible_true.

Referenced by action(), and createGuiWindows().

Field Documentation

◆ mBrowserBox

StaticBrowserBox* DidYouKnowWindow::mBrowserBox

Definition at line 68 of file didyouknowwindow.h.

Referenced by DidYouKnowWindow(), loadData(), and loadFile().

◆ mButtonNext

Button* DidYouKnowWindow::mButtonNext

Definition at line 71 of file didyouknowwindow.h.

Referenced by DidYouKnowWindow().

◆ mButtonPrev

Button* DidYouKnowWindow::mButtonPrev

Definition at line 70 of file didyouknowwindow.h.

Referenced by DidYouKnowWindow().

◆ mItemLinkHandler

ItemLinkHandler* DidYouKnowWindow::mItemLinkHandler

Definition at line 67 of file didyouknowwindow.h.

Referenced by DidYouKnowWindow(), and ~DidYouKnowWindow().

◆ mOpenAgainCheckBox

CheckBox* DidYouKnowWindow::mOpenAgainCheckBox

Definition at line 72 of file didyouknowwindow.h.

Referenced by action(), and DidYouKnowWindow().

◆ mScrollArea

ScrollArea* DidYouKnowWindow::mScrollArea

Definition at line 69 of file didyouknowwindow.h.

Referenced by DidYouKnowWindow(), and loadData().

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