GCC Code Coverage Report
Directory: src/ Exec Total Coverage
File: src/gui/windows/helpwindow.h Lines: 1 1 100.0 %
Date: 2017-11-29 Branches: 0 0 0.0 %

Line Branch Exec Source
1
/*
2
 *  The ManaPlus Client
3
 *  Copyright (C) 2004-2009  The Mana World Development Team
4
 *  Copyright (C) 2009-2010  The Mana Developers
5
 *  Copyright (C) 2011-2017  The ManaPlus Developers
6
 *
7
 *  This file is part of The ManaPlus Client.
8
 *
9
 *  This program is free software; you can redistribute it and/or modify
10
 *  it under the terms of the GNU General Public License as published by
11
 *  the Free Software Foundation; either version 2 of the License, or
12
 *  any later version.
13
 *
14
 *  This program is distributed in the hope that it will be useful,
15
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
16
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17
 *  GNU General Public License for more details.
18
 *
19
 *  You should have received a copy of the GNU General Public License
20
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
21
 */
22
23
#ifndef GUI_WINDOWS_HELPWINDOW_H
24
#define GUI_WINDOWS_HELPWINDOW_H
25
26
#include "gui/widgets/linkhandler.h"
27
#include "gui/widgets/window.h"
28
29
#include "listeners/actionlistener.h"
30
31
#include "localconsts.h"
32
33
class Button;
34
class ScrollArea;
35
class StaticBrowserBox;
36
37
typedef std::set<std::string> HelpNames;
38
typedef HelpNames::const_iterator HelpNamesCIter;
39
typedef std::map<std::string, HelpNames> HelpTagsMap;
40
41
/**
42
 * The help window.
43
 */
44
20
class HelpWindow final : public Window,
45
                         public LinkHandler,
46
                         public ActionListener
47
{
48
    public:
49
        /**
50
         * Constructor.
51
         */
52
        HelpWindow();
53
54
        A_DELETE_COPY(HelpWindow)
55
56
        /**
57
         * Called when receiving actions from the widgets.
58
         */
59
        void action(const ActionEvent &event) override final;
60
61
        /**
62
         * Handles link action.
63
         */
64
        void handleLink(const std::string &link,
65
                        MouseEvent *const event A_UNUSED) override final;
66
67
        /**
68
         * Loads help in the dialog.
69
         */
70
        void loadHelp(const std::string &helpFile);
71
72
        void loadHelpSimple(const std::string &helpFile);
73
74
        /**
75
         * Seach for given text in tags.
76
         */
77
        void search(const std::string &text);
78
79
    private:
80
        void loadTags();
81
82
        void loadFile(std::string file);
83
84
        Button *mDYKButton A_NONNULLPOINTER;
85
        StaticBrowserBox *mBrowserBox A_NONNULLPOINTER;
86
        ScrollArea *mScrollArea A_NONNULLPOINTER;
87
        HelpTagsMap mTagFileMap;
88
};
89
90
extern HelpWindow *helpWindow;
91
92
#endif  // GUI_WINDOWS_HELPWINDOW_H