ManaPlus
Public Member Functions | Private Member Functions | Private Attributes
HelpWindow Class Reference

#include <helpwindow.h>

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

Public Member Functions

 HelpWindow ()
 
void action (const ActionEvent &event)
 
void handleLink (const std::string &link, MouseEvent *const event)
 
void loadHelp (const std::string &helpFile)
 
void loadHelpSimple (const std::string &helpFile)
 
void search (const std::string &text)
 
- 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 LinkHandler
 LinkHandler ()
 
virtual ~LinkHandler ()
 
- Public Member Functions inherited from ActionListener
virtual ~ActionListener ()
 

Private Member Functions

void loadTags ()
 
void loadFile (std::string file)
 

Private Attributes

ButtonmDYKButton
 
StaticBrowserBoxmBrowserBox
 
ScrollAreamScrollArea
 
HelpTagsMap mTagFileMap
 

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
 
SkinmSkin
 
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
 
FocusHandlermFocusHandler
 
FocusHandlermInternalFocusHandler
 
WidgetmParent
 
FontmCurrentFont
 
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
 
WidgetmWindow
 
Color mForegroundColor2
 
- Static Protected Attributes inherited from Widget
static FontmGlobalFont = 0
 

Detailed Description

The help window.

Definition at line 44 of file helpwindow.h.

Constructor & Destructor Documentation

◆ HelpWindow()

HelpWindow::HelpWindow ( )

Constructor.

Definition at line 55 of file helpwindow.cpp.

References ImagePosition::CENTER, Window::enableVisibleSound(), Gui::getHelpFont(), Window::getLayout(), gui, loadTags(), Window::loadWindowState(), mBrowserBox, mDYKButton, 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, Window::setWindowName(), and Window::widgetResized().

55  :
56  // TRANSLATORS: help window name
57  Window(_("Help"), Modal_false, nullptr, "help.xml"),
58  LinkHandler(),
60  // TRANSLATORS: help window. button.
61  mDYKButton(new Button(this, _("Did you know..."), "DYK",
62  BUTTON_SKIN, this)),
64  "browserbox.xml")),
66  Opaque_true, "help_background.xml")),
67  mTagFileMap()
68 {
69  setMinWidth(300);
70  setMinHeight(220);
71  setContentSize(455, 350);
72  setWindowName("Help");
73  setCloseButton(true);
74  setResizable(true);
75  setStickyButtonLock(true);
76 
77  if (setupWindow != nullptr)
79 
80  setDefaultSize(500, 400, ImagePosition::CENTER, 0, 0);
81 
83 
85  if (gui != nullptr)
91 
92  place(4, 3, mDYKButton, 1, 1);
93  place(0, 0, mScrollArea, 5, 3).setPadding(3);
94 
95  Layout &layout = getLayout();
96  layout.setRowHeight(0, LayoutType::SET);
97 
99  loadTags();
100  enableVisibleSound(true);
101  widgetResized(Event(nullptr));
102 }
void setDefaultSize()
Definition: window.cpp:1193
LayoutCell & place(const int x, const int y, Widget *const wg, const int w, const int h)
Definition: window.cpp:1379
#define _(s)
Definition: gettext.h:34
Button * mDYKButton
Definition: helpwindow.h:84
Font * getHelpFont() const
Definition: gui.h:165
StaticBrowserBox * mBrowserBox
Definition: helpwindow.h:85
Gui * gui
Definition: gui.cpp:110
void loadWindowState()
Definition: window.cpp:1082
void setProcessVars(const bool n)
void setMinWidth(const int width)
Definition: window.cpp:586
void setEnableKeys(const bool n)
Definition: button.h:96
void setEnableImages(const bool n)
void registerWindowForReset(Window *const window)
void setContentSize(int width, int height)
Definition: window.cpp:491
void setLinkHandler(LinkHandler *linkHandler)
void widgetResized(const Event &event)
Definition: window.cpp:650
const std::string BUTTON_SKIN
Definition: button.h:88
const bool Opaque_false
Definition: opaque.h:29
void loadTags()
Definition: helpwindow.cpp:164
void setCloseButton(const bool flag)
Definition: window.cpp:744
void enableVisibleSound(bool b)
Definition: window.h:480
void setMinHeight(const int height)
Definition: window.cpp:599
LayoutCell & setPadding(int p)
Definition: layoutcell.h:59
Layout & getLayout()
Definition: window.cpp:1360
void setOpaque(Opaque opaque)
void setFont(Font *const font)
Definition: widget.cpp:348
const bool Opaque_true
Definition: opaque.h:29
Definition: event.h:77
ScrollArea * mScrollArea
Definition: helpwindow.h:86
void setEnableTabs(const bool n)
void setResizable(const bool resize)
Definition: window.cpp:622
void setStickyButtonLock(const bool sticky)
Definition: window.cpp:767
SetupWindow * setupWindow
Definition: setupwindow.cpp:63
Definition: layout.h:43
HelpTagsMap mTagFileMap
Definition: helpwindow.h:87
void setRowHeight(const int n, const int h)
Definition: layoutcell.cpp:127
Window(const std::string &caption, const Modal modal, Window *const parent, std::string skin)
Definition: window.cpp:108
void setWindowName(const std::string &name)
Definition: window.h:354

Member Function Documentation

◆ action()

void HelpWindow::action ( const ActionEvent event)
virtual

Called when receiving actions from the widgets.

Implements ActionListener.

Definition at line 104 of file helpwindow.cpp.

References InputManager::executeAction(), ActionEvent::getId(), inputManager, and InputAction::WINDOW_DIDYOUKNOW.

105 {
106  if (event.getId() == "DYK")
108 }
const std::string & getId() const
Definition: actionevent.h:121
InputManager inputManager
void executeAction(const InputActionT keyNum)

◆ handleLink()

void HelpWindow::handleLink ( const std::string &  link,
MouseEvent *const  event 
)
virtual

Handles link action.

Implements LinkHandler.

Definition at line 110 of file helpwindow.cpp.

References loadHelp(), openBrowser(), and strStartWith().

112 {
113  if (!strStartWith(link, "http://") && !strStartWith(link, "https://"))
114  {
115  // need use separate variable
116  const std::string helpFile = link; // NOLINT
117  loadHelp(helpFile);
118  }
119  else
120  {
121  openBrowser(link);
122  }
123 }
bool strStartWith(const std::string &str1, const std::string &str2)
void loadHelp(const std::string &helpFile)
Definition: helpwindow.cpp:125
bool openBrowser(std::string url)
Definition: process.cpp:309

◆ loadFile()

void HelpWindow::loadFile ( std::string  file)
private

Definition at line 149 of file helpwindow.cpp.

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

Referenced by loadHelp(), loadHelpSimple(), and search().

150 {
151  trim(file);
152  std::string helpPath = branding.getStringValue("helpPath");
153  if (helpPath.empty())
154  helpPath = paths.getStringValue("help");
155 
156  StringVect lines;
157  TranslationManager::translateFile(pathJoin(helpPath, file).append(".txt"),
158  translator, lines);
159 
160  for (size_t i = 0, sz = lines.size(); i < sz; ++i)
161  mBrowserBox->addRow(lines[i], false);
162 }
Configuration branding
std::string getStringValue(const std::string &key) const
StaticBrowserBox * mBrowserBox
Definition: helpwindow.h:85
std::string pathJoin(std::string str1, const std::string &str2)
std::vector< std::string > StringVect
Definition: stringvector.h:28
static bool translateFile(const std::string &fileName, PoDict *const dict, StringVect &lines)
std::string trim(std::string const &str)
Configuration paths
PoDict * translator
Definition: podict.cpp:27
void addRow(const std::string &row, const bool atTop)

◆ loadHelp()

void HelpWindow::loadHelp ( const std::string &  helpFile)

Loads help in the dialog.

Definition at line 125 of file helpwindow.cpp.

References checkPath(), StaticBrowserBox::clearRows(), loadFile(), mBrowserBox, mScrollArea, ScrollArea::setVerticalScrollAmount(), Window::setVisible(), StaticBrowserBox::updateHeight(), and Visible_true.

Referenced by ItemLinkHandler::handleHelpLink(), handleLink(), search(), and Actions::showHelpPage().

126 {
127  if (!checkPath(helpFile))
128  return;
130  loadFile("header");
131  loadFile(helpFile);
132  loadFile("footer");
136 }
StaticBrowserBox * mBrowserBox
Definition: helpwindow.h:85
const bool Visible_true
Definition: visible.h:29
bool checkPath(const std::string &path)
Definition: paths.cpp:106
void setVerticalScrollAmount(const int vScroll)
virtual void setVisible(Visible visible)
Definition: window.cpp:773
ScrollArea * mScrollArea
Definition: helpwindow.h:86
void loadFile(std::string file)
Definition: helpwindow.cpp:149

◆ loadHelpSimple()

void HelpWindow::loadHelpSimple ( const std::string &  helpFile)

Definition at line 138 of file helpwindow.cpp.

References checkPath(), StaticBrowserBox::clearRows(), loadFile(), mBrowserBox, mScrollArea, ScrollArea::setVerticalScrollAmount(), Window::setVisible(), StaticBrowserBox::updateHeight(), and Visible_true.

Referenced by ItemLinkHandler::handleLink().

139 {
140  if (!checkPath(helpFile))
141  return;
143  loadFile(helpFile);
147 }
StaticBrowserBox * mBrowserBox
Definition: helpwindow.h:85
const bool Visible_true
Definition: visible.h:29
bool checkPath(const std::string &path)
Definition: paths.cpp:106
void setVerticalScrollAmount(const int vScroll)
virtual void setVisible(Visible visible)
Definition: window.cpp:773
ScrollArea * mScrollArea
Definition: helpwindow.h:86
void loadFile(std::string file)
Definition: helpwindow.cpp:149

◆ loadTags()

void HelpWindow::loadTags ( )
private

Definition at line 164 of file helpwindow.cpp.

References branding, FOR_EACH, VirtFs::getFilesInDir(), Configuration::getStringValue(), VirtFs::loadTextFile(), mTagFileMap, paths, and ServerCommandType::str.

Referenced by HelpWindow().

165 {
166  std::string helpPath = branding.getStringValue("tagsPath");
167  if (helpPath.empty())
168  helpPath = paths.getStringValue("tags");
169 
170  StringVect filesVect;
171  VirtFs::getFilesInDir(helpPath, filesVect, ".idx");
172  FOR_EACH (StringVectCIter, itVect, filesVect)
173  {
174  StringVect lines;
175  VirtFs::loadTextFile(*itVect, lines);
176  FOR_EACH (StringVectCIter, it, lines)
177  {
178  const std::string &str = *it;
179  const size_t idx = str.find('|');
180  if (idx != std::string::npos)
181  mTagFileMap[str.substr(idx + 1)].insert(str.substr(0, idx));
182  }
183  }
184 }
Configuration branding
#define FOR_EACH(type, iter, array)
Definition: foreach.h:24
std::string getStringValue(const std::string &key) const
StringVect::const_iterator StringVectCIter
Definition: stringvector.h:30
std::vector< std::string > StringVect
Definition: stringvector.h:28
void getFilesInDir(const std::string &dir, StringVect &list, const std::string &ext)
Definition: tools.cpp:80
Configuration paths
bool loadTextFile(const std::string &fileName, StringVect &lines)
Definition: tools.cpp:136
HelpTagsMap mTagFileMap
Definition: helpwindow.h:87

◆ search()

void HelpWindow::search ( const std::string &  text)

Seach for given text in tags.

Definition at line 186 of file helpwindow.cpp.

References StaticBrowserBox::addRow(), StaticBrowserBox::clearRows(), FOR_EACH, PoDict::getChar(), loadFile(), loadHelp(), mBrowserBox, mScrollArea, mTagFileMap, ScrollArea::setVerticalScrollAmount(), Window::setVisible(), ServerCommandType::str, strprintf(), Catch::toLower(), translator, Catch::trim(), StaticBrowserBox::updateHeight(), and Visible_true.

Referenced by ChatTab::handleHelp(), and ItemLinkHandler::handleSearchLink().

187 {
188  std::string text = text0;
189  trim(text);
190  toLower(text);
191  if (mTagFileMap.find(text) == mTagFileMap.end())
192  {
193  loadHelp("searchnotfound");
194  }
195  else
196  {
197  const HelpNames &names = mTagFileMap[text];
198  if (names.size() == 1)
199  {
200  loadHelp(*names.begin());
201  }
202  else
203  {
204  if (translator == nullptr)
205  return;
207  loadFile("header");
208  loadFile("searchmany");
209  FOR_EACH (HelpNamesCIter, it, names)
210  {
211  const char *const str = (*it).c_str();
212  mBrowserBox->addRow(strprintf(" -> @@%s|%[email protected]@", str,
213  translator->getChar(str)),
214  false);
215  }
216  loadFile("footer");
220  }
221  }
222 }
#define FOR_EACH(type, iter, array)
Definition: foreach.h:24
StaticBrowserBox * mBrowserBox
Definition: helpwindow.h:85
const bool Visible_true
Definition: visible.h:29
const char * getChar(const char *const str)
Definition: podict.cpp:51
void setVerticalScrollAmount(const int vScroll)
void loadHelp(const std::string &helpFile)
Definition: helpwindow.cpp:125
std::string strprintf(const char *const format,...)
Definition: stringutils.cpp:99
std::string trim(std::string const &str)
std::string toLower(std::string const &s)
std::set< std::string > HelpNames
Definition: helpwindow.h:35
virtual void setVisible(Visible visible)
Definition: window.cpp:773
ScrollArea * mScrollArea
Definition: helpwindow.h:86
void loadFile(std::string file)
Definition: helpwindow.cpp:149
HelpTagsMap mTagFileMap
Definition: helpwindow.h:87
PoDict * translator
Definition: podict.cpp:27
HelpNames::const_iterator HelpNamesCIter
Definition: helpwindow.h:38
void addRow(const std::string &row, const bool atTop)

Field Documentation

◆ mBrowserBox

StaticBrowserBox* HelpWindow::mBrowserBox
private

Definition at line 85 of file helpwindow.h.

Referenced by HelpWindow(), loadFile(), loadHelp(), loadHelpSimple(), and search().

◆ mDYKButton

Button* HelpWindow::mDYKButton
private

Definition at line 84 of file helpwindow.h.

Referenced by HelpWindow().

◆ mScrollArea

ScrollArea* HelpWindow::mScrollArea
private

Definition at line 86 of file helpwindow.h.

Referenced by HelpWindow(), loadHelp(), loadHelpSimple(), and search().

◆ mTagFileMap

HelpTagsMap HelpWindow::mTagFileMap
private

Definition at line 87 of file helpwindow.h.

Referenced by loadTags(), and search().


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