HelpBrowser.h

Go to the documentation of this file.

// -*- mode: c++; c-file-style: "linux"; c-basic-offset: 2; indent-tabs-mode: nil -*-
//
//  Copyright (C) 2009-2015 Andrej Vodopivec <andrej.vodopivec@gmail.com>
//  Copyright (C) 2015 Gunter Königsmann     <wxMaxima@physikbuch.de>
//
//  This program is free software; you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation; either version 2 of the License, or
//  (at your option) any later version.
//
//  This program is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//
//  You should have received a copy of the GNU General Public License
//  along with this program; if not, write to the Free Software
//  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
//
//  SPDX-License-Identifier: GPL-2.0+
 
#ifndef HELPBROWSER_H
#define HELPBROWSER_H
 
#include "BuildConfig.h"
#include <wx/dir.h>
#include "precomp.h"
#include <wx/wx.h>
#ifdef USE_WEBVIEW
#include <wx/webview.h>
#endif
#include <wx/panel.h>
#include <vector>
#include <wx/sizer.h>
#include "Configuration.h"
#include "MaximaManual.h"
 
/* The help browser sidebar
 */
class HelpBrowser : public wxPanel
{
public:
  static bool AllowOnlineManualP(Configuration *configuration, wxWindow *parent);
  explicit HelpBrowser(wxWindow *parent, Configuration *configuration, MaximaManual *manual,
                       const wxString &url);
#ifdef USE_WEBVIEW
  void SetURL(const wxString &url);
  void JumpToKeyword(const wxString &keyword);
  void SelectKeywords(const std::vector<wxString> &keywords);
  wxString GetKeyword(wxWindowID id) const;
  bool HasContent() const { return m_webView != nullptr || !m_keywords.empty(); }
  void ShowStartPageIfEmpty();
 
private:
  void CreateIfNeeded();
  void OnTextEnter(wxCommandEvent& event);
  void OnSearchUp(wxCommandEvent& event);
  void OnSearchDown(wxCommandEvent& event);
  void OnSearchboxKeyDown(wxKeyEvent &event);
  void OnWebviewKeyDown(wxKeyEvent &event);
  void OnActivate(wxActivateEvent &event);
  void OnTopicButton(wxCommandEvent& event);
  bool AllowOnlineManualP(){return AllowOnlineManualP(m_configuration, this);}
 
  wxWindowIDRef m_topicButtonID0;
  std::vector<wxWindowIDRef> m_topicButtonIDs;
  MaximaManual *m_maximaManual = nullptr;
  wxWebView *m_webView = nullptr;
  wxTextCtrl *m_searchText = nullptr;
  Configuration *m_configuration;
  wxString m_startUrl;
  bool m_findDown = true;
  wxBoxSizer *m_vbox;
  wxPanel *m_browserPanel;
  wxPanel *m_topicPanel;
  wxBoxSizer *m_topicSizer;
  std::vector<wxString> m_keywords;
#endif
};
 
#endif // HELPBROWSER_H