NumeRe v1.1.4
NumeRe: Framework für Numerische Rechnungen
documentationbrowser.hpp
Go to the documentation of this file.
1/*****************************************************************************
2 NumeRe: Framework fuer Numerische Rechnungen
3 Copyright (C) 2019 Erik Haenel et al.
4
5 This program is free software: you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation, either version 3 of the License, or
8 (at your option) any later version.
9
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
14
15 You should have received a copy of the GNU General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
17******************************************************************************/
18
19#ifndef DOCUMENTATIONBROWSER_HPP
20#define DOCUMENTATIONBROWSER_HPP
21
22#include <wx/treectrl.h>
23#include <wx/splitter.h>
24#include <wx/notebook.h>
27#include "IconManager.h"
28
29class NumeReWindow;
30
38{
39 private:
40 wxTreeCtrl* m_doctree;
44
45 void prepareToolbar();
46 void fillDocTree(NumeReWindow* mainwindow);
47 bool findAndSelectPage(const wxString& title);
48
49 public:
50 DocumentationBrowser(wxWindow* parent, const wxString& titletemplate, NumeReWindow* mainwindow);
52
53 bool SetStartPage(const wxString& docId);
54 void OnTreeClick(wxTreeEvent& event);
55 void OnToolbarEvent(wxCommandEvent& event);
56
57 bool createNewPage(const wxString& docId);
58 void setCurrentTabText(const wxString& text);
59 void onPageChange(wxAuiNotebookEvent& event);
60 void onPageClose(wxAuiNotebookEvent& event);
61
63};
64
65
66#endif // DOCUMENTATIONBROWSER_HPP
67
68
This represents the main frame of the documentation browser, which contains the tabbed layout,...
void onPageClose(wxAuiNotebookEvent &event)
Event handler called, when the user closes the tab in some way.
void onPageChange(wxAuiNotebookEvent &event)
Event handler function called, when the user switches the tabs.
void OnToolbarEvent(wxCommandEvent &event)
Event handler function for clicks on the toolbar of the current window. Redirects all clicks to the H...
bool createNewPage(const wxString &docId)
Create a new viewer in a new page.
bool findAndSelectPage(const wxString &title)
Finds and selects the page with the passed title or returns false.
void prepareToolbar()
Private member function to prepare the toolbar of the main frame.
~DocumentationBrowser()
Documentation browser destructor. Removes the created IconManager object.
bool SetStartPage(const wxString &docId)
Public interface to set the start page.
void OnTreeClick(wxTreeEvent &event)
Event handler function to load the documentation article describing the clicked item.
void fillDocTree(NumeReWindow *mainwindow)
This private member function prepares the index tree of the documentation browser.
DocumentationBrowser(wxWindow *parent, const wxString &titletemplate, NumeReWindow *mainwindow)
Documentation browser constructor.
void setCurrentTabText(const wxString &text)
Change the text displayed on the current tab.
This class is the actual NumeRe main frame. The application's logic is implemented here.
Definition: NumeReWindow.h:177
This class generalizes a set of basic floating window functionalities like being closable by pressing...
Definition: viewerframe.hpp:31