#include <helpwindow.h>

Inheritance diagram for HelpWindow:

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 ()

Window *	getParentWindow () 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)

Layout &	getLayout ()

void	clearLayout ()

void	reflowLayout (int w, int h)

LayoutCell &	place (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)

Widget *	getWidgetAt (int x, int y)

void	death (const Event &event)

Widget *	findFirstWidget (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

Widget *	getParent () 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 Rect &	getDimension () 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 Color &	getBaseColor () const

void	setForegroundColor (const Color &color)

const Color &	getForegroundColor () const

void	setBackgroundColor (const Color &color)

const Color &	getBackgroundColor () const

virtual void	requestFocus ()

virtual void	requestMoveToTop ()

virtual void	requestMoveToBottom ()

FocusHandler *	getFocusHandler ()

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)

Font *	getFont () 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 FocusHandler *	getInternalFocusHandler ()

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 Color &	getThemeColor (const ThemeColorIdT type, const unsigned int alpha) const A_INLINE

const Color &	getThemeCharColor (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)

Widget *	getWindow () 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
Button *	mDYKButton

StaticBrowserBox *	mBrowserBox

ScrollArea *	mScrollArea

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 Font *	getGloablFont ()

static void	cleanGlobalFont ()

static bool	widgetExists (const Widget *const widget)

static void	distributeWindowResizeEvent ()

static Widget *	callPostInit (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

Skin *	mSkin

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

FocusHandler *	mFocusHandler

FocusHandler *	mInternalFocusHandler

Widget *	mParent

Font *	mCurrentFont

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

Widget *	mWindow

Color	mForegroundColor2

Static Protected Attributes inherited from Widget
static Font *	mGlobalFont = 0

Detailed Description

The help window.

Definition at line 45 of file helpwindow.h.

Constructor & Destructor Documentation

◆ HelpWindow()

HelpWindow::HelpWindow ( )

Constructor.

Definition at line 56 of file helpwindow.cpp.

                        :
     // TRANSLATORS: help window name
     Window(_("Help"), Modal_false, nullptr, "help.xml"),
     LinkHandler(),
     ActionListener(),
     // TRANSLATORS: help window. button.
     mDYKButton(new Button(this, _("Did you know..."), "DYK",
         BUTTON_SKIN, this)),
     mBrowserBox(new StaticBrowserBox(this, Opaque_true,
         "browserbox.xml")),
     mScrollArea(new ScrollArea(this, mBrowserBox,
         Opaque_true, "help_background.xml")),
     mTagFileMap()
 {
     setMinWidth(300);
     setMinHeight(220);
     setContentSize(455, 350);
     setWindowName("Help");
     setCloseButton(true);
     setResizable(true);
     setStickyButtonLock(true);
  
     if (setupWindow != nullptr)
         setupWindow->registerWindowForReset(this);
  
     setDefaultSize(500, 400, ImagePosition::CENTER, 0, 0);
  
     mBrowserBox->setOpaque(Opaque_false);
  
     mBrowserBox->setLinkHandler(this);
     if (gui != nullptr)
         mBrowserBox->setFont(gui->getHelpFont());
     mBrowserBox->setProcessVars(true);
     mBrowserBox->setEnableImages(true);
     mBrowserBox->setEnableKeys(true);
     mBrowserBox->setEnableTabs(true);
  
     place(4, 3, mDYKButton, 1, 1);
     place(0, 0, mScrollArea, 5, 3).setPadding(3);
  
     Layout &layout = getLayout();
     layout.setRowHeight(0, LayoutType::SET);
  
     loadWindowState();
     loadTags();
     enableVisibleSound(true);
     widgetResized(Event(nullptr));
 }

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().

Member Function Documentation

◆ action()

void HelpWindow::action ( const ActionEvent & event )

virtual

Called when receiving actions from the widgets.

Implements ActionListener.

Definition at line 105 of file helpwindow.cpp.

 {
     if (event.getId() == "DYK")
         inputManager.executeAction(InputAction::WINDOW_DIDYOUKNOW);
 }

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

◆ handleLink()

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

virtual

Handles link action.

Implements LinkHandler.

Definition at line 111 of file helpwindow.cpp.

 {
     if (!strStartWith(link, "http://") && !strStartWith(link, "https://"))
     {
         // need use separate variable
         const std::string helpFile = link;  // NOLINT
         loadHelp(helpFile);
     }
     else
     {
         openBrowser(link);
     }
 }

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

◆ loadFile()

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

private

Definition at line 150 of file helpwindow.cpp.

 {
     trim(file);
     std::string helpPath = branding.getStringValue("helpPath");
     if (helpPath.empty())
         helpPath = paths.getStringValue("help");
  
     StringVect lines;
     TranslationManager::translateFile(pathJoin(helpPath, file).append(".txt"),
         translator, lines);
  
     for (size_t i = 0, sz = lines.size(); i < sz; ++i)
         mBrowserBox->addRow(lines[i], false);
 }

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

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

◆ loadHelp()

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

Loads help in the dialog.

Definition at line 126 of file helpwindow.cpp.

 {
     if (!checkPath(helpFile))
         return;
     mBrowserBox->clearRows();
     loadFile("header");
     loadFile(helpFile);
     loadFile("footer");
     mScrollArea->setVerticalScrollAmount(0);
     mBrowserBox->updateHeight();
     setVisible(Visible_true);
 }

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().

◆ loadHelpSimple()

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

Definition at line 139 of file helpwindow.cpp.

 {
     if (!checkPath(helpFile))
         return;
     mBrowserBox->clearRows();
     loadFile(helpFile);
     mScrollArea->setVerticalScrollAmount(0);
     mBrowserBox->updateHeight();
     setVisible(Visible_true);
 }

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

Referenced by ItemLinkHandler::handleLink().

◆ loadTags()

void HelpWindow::loadTags ( )

private

Definition at line 165 of file helpwindow.cpp.

 {
     std::string helpPath = branding.getStringValue("tagsPath");
     if (helpPath.empty())
         helpPath = paths.getStringValue("tags");
  
     StringVect filesVect;
     VirtFs::getFilesInDir(helpPath, filesVect, ".idx");
     FOR_EACH (StringVectCIter, itVect, filesVect)
     {
         StringVect lines;
         VirtFs::loadTextFile(*itVect, lines);
         FOR_EACH (StringVectCIter, it, lines)
         {
             const std::string &str = *it;
             const size_t idx = str.find('|');
             if (idx != std::string::npos)
                 mTagFileMap[str.substr(idx + 1)].insert(str.substr(0, idx));
         }
     }
 }

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

Referenced by HelpWindow().

◆ search()

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

Seach for given text in tags.

Definition at line 187 of file helpwindow.cpp.

 {
     std::string text = text0;
     trim(text);
     toLower(text);
     if (mTagFileMap.find(text) == mTagFileMap.end())
     {
         loadHelp("searchnotfound");
     }
     else
     {
         const HelpNames &names = mTagFileMap[text];
         if (names.size() == 1)
         {
             loadHelp(*names.begin());
         }
         else
         {
             if (translator == nullptr)
                 return;
             mBrowserBox->clearRows();
             loadFile("header");
             loadFile("searchmany");
             FOR_EACH (HelpNamesCIter, it, names)
             {
                 const char *const str = (*it).c_str();
                 mBrowserBox->addRow(strprintf(" -> @@%s|%s@@", str,
                     translator->getChar(str)),
                     false);
             }
             loadFile("footer");
             mScrollArea->setVerticalScrollAmount(0);
             mBrowserBox->updateHeight();
             setVisible(Visible_true);
         }
     }
 }

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

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

Field Documentation

◆ mBrowserBox

StaticBrowserBox* HelpWindow::mBrowserBox

private

Definition at line 86 of file helpwindow.h.

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

◆ mDYKButton

Button* HelpWindow::mDYKButton

private

Definition at line 85 of file helpwindow.h.

Referenced by HelpWindow().

◆ mScrollArea

ScrollArea* HelpWindow::mScrollArea

private

Definition at line 87 of file helpwindow.h.

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

◆ mTagFileMap

HelpTagsMap HelpWindow::mTagFileMap

private

Definition at line 88 of file helpwindow.h.

Referenced by loadTags(), and search().

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

src/gui/windows/helpwindow.h (986a3bf)
src/gui/windows/helpwindow.cpp (986a3bf)

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HelpWindow()

Member Function Documentation

◆ action()

◆ handleLink()

◆ loadFile()

◆ loadHelp()

◆ loadHelpSimple()

◆ loadTags()

◆ search()

Field Documentation

◆ mBrowserBox

◆ mDYKButton

◆ mScrollArea

◆ mTagFileMap