initial commit

Signed-off-by: Peter Siegmund <mars3142@noreply.mars3142.dev>

libs/wxWidgets-3.3.1/interface/wx/html/helpwnd.h

@@ -0,0 +1,197 @@
+/////////////////////////////////////////////////////////////////////////////
+// Name:        html/helpwnd.h
+// Purpose:     interface of wxHtmlHelpWindow
+// Author:      wxWidgets team
+// Licence:     wxWindows licence
+/////////////////////////////////////////////////////////////////////////////
+
+/*!
+ * Command IDs
+ */
+enum
+{
+    //wxID_HTML_HELPFRAME = wxID_HIGHEST + 1,
+    wxID_HTML_PANEL = wxID_HIGHEST + 10,
+    wxID_HTML_BACK,
+    wxID_HTML_FORWARD,
+    wxID_HTML_UPNODE,
+    wxID_HTML_UP,
+    wxID_HTML_DOWN,
+    wxID_HTML_PRINT,
+    wxID_HTML_OPENFILE,
+    wxID_HTML_OPTIONS,
+    wxID_HTML_BOOKMARKSLIST,
+    wxID_HTML_BOOKMARKSADD,
+    wxID_HTML_BOOKMARKSREMOVE,
+    wxID_HTML_TREECTRL,
+    wxID_HTML_INDEXPAGE,
+    wxID_HTML_INDEXLIST,
+    wxID_HTML_INDEXTEXT,
+    wxID_HTML_INDEXBUTTON,
+    wxID_HTML_INDEXBUTTONALL,
+    wxID_HTML_NOTEBOOK,
+    wxID_HTML_SEARCHPAGE,
+    wxID_HTML_SEARCHTEXT,
+    wxID_HTML_SEARCHLIST,
+    wxID_HTML_SEARCHBUTTON,
+    wxID_HTML_SEARCHCHOICE,
+    wxID_HTML_COUNTINFO
+};
+
+
+/**
+    @class wxHtmlHelpWindow
+
+    This class is used by wxHtmlHelpController to display help within a frame or
+    dialog, but you can use it yourself to create an embedded HTML help window.
+
+    For example:
+    @code
+        // m_embeddedHelpWindow is a wxHtmlHelpWindow
+        // m_embeddedHtmlHelp is a wxHtmlHelpController
+
+        // Create embedded HTML Help window
+        m_embeddedHelpWindow = new wxHtmlHelpWindow;
+        m_embeddedHtmlHelp.UseConfig(config, rootPath); // Set your own config object here
+        m_embeddedHtmlHelp.SetHelpWindow(m_embeddedHelpWindow);
+        m_embeddedHelpWindow->Create(this, wxID_ANY, wxDefaultPosition, GetClientSize(),
+                                     wxTAB_TRAVERSAL|wxBORDER_NONE, wxHF_DEFAULT_STYLE);
+        m_embeddedHtmlHelp.AddBook(wxFileName("doc.zip"));
+    @endcode
+
+    You should pass the style wxHF_EMBEDDED to the style parameter of
+    wxHtmlHelpController to allow the embedded window to be destroyed
+    independently of the help controller.
+
+    @library{wxhtml}
+    @category{help,html}
+*/
+class wxHtmlHelpWindow : public wxWindow
+{
+public:
+    wxHtmlHelpWindow(wxHtmlHelpData* data = nullptr);
+
+    /**
+        Constructor.
+
+        For the values of @a helpStyle, please see the documentation for
+        wxHtmlHelpController.
+    */
+    wxHtmlHelpWindow(wxWindow* parent, wxWindowID id,
+                     const wxPoint& pos = wxDefaultPosition,
+                     const wxSize& size = wxDefaultSize,
+                     int style = wxTAB_TRAVERSAL|wxBORDER_NONE,
+                     int helpStyle = wxHF_DEFAULT_STYLE,
+                     wxHtmlHelpData* data = nullptr);
+
+    /**
+        Creates the help window. See @ref wxHtmlHelpWindow() "the constructor"
+        for a description of the parameters.
+    */
+    bool Create(wxWindow* parent, wxWindowID id,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize, int style = wxTAB_TRAVERSAL|wxBORDER_NONE,
+                int helpStyle = wxHF_DEFAULT_STYLE);
+
+    /**
+        Displays page x.
+        If not found it will give the user the choice of searching books.
+        Looking for the page runs in these steps:
+        -# try to locate file named x (if x is for example "doc/howto.htm")
+        -# try to open starting page of book x
+        -# try to find x in contents (if x is for example "How To ...")
+        -# try to find x in index (if x is for example "How To ...")
+    */
+    bool Display(const wxString& x);
+
+    /**
+        @overload
+
+        This form takes numeric ID as the parameter (uses an extension to MS format,
+        param name="ID" value=id).
+    */
+    bool Display(int id);
+
+    /**
+        Displays contents panel.
+    */
+    bool DisplayContents();
+
+    /**
+        Displays index panel.
+    */
+    bool DisplayIndex();
+
+    /**
+        Returns the wxHtmlHelpData object, which is usually a pointer to the
+        controller's data.
+    */
+    wxHtmlHelpData* GetData();
+
+    /**
+        Search for given keyword. Optionally it searches through the index
+        (mode = @c wxHELP_SEARCH_INDEX), default the content (mode = @c wxHELP_SEARCH_ALL).
+    */
+    bool KeywordSearch(const wxString& keyword,
+                       wxHelpSearchMode mode = wxHELP_SEARCH_ALL);
+
+    /**
+        Reads the user's settings for this window.
+
+        @see wxHtmlHelpController::ReadCustomization
+    */
+    void ReadCustomization(wxConfigBase* cfg,
+                           const wxString& path = wxEmptyString);
+
+    /**
+        Associates a wxConfig object with the help window. It is recommended that you
+        use wxHtmlHelpController::UseConfig instead.
+    */
+    void UseConfig(wxConfigBase* config,
+                   const wxString& rootpath = wxEmptyString);
+
+    /**
+        Saves the user's settings for this window.
+
+        @see wxHtmlHelpController::WriteCustomization
+    */
+    void WriteCustomization(wxConfigBase* cfg,
+                            const wxString& path = wxEmptyString);
+
+    /**
+        Refresh all panels. This is necessary if a new book was added.
+    */
+    void RefreshLists();
+
+
+    wxHtmlHelpController* GetController() const;
+    void SetController(wxHtmlHelpController* controller);
+
+protected:
+
+    /**
+        Creates search panel.
+    */
+    void CreateSearch();
+
+    /**
+        You may override this virtual method to add more buttons to the help window's
+        toolbar. @a toolBar is a pointer to the toolbar and @a style is the style
+        flag as passed to the Create() method.
+
+        wxToolBar::Realize is called immediately after returning from this function.
+        See @c samples/html/helpview for an example.
+    */
+    virtual void AddToolbarButtons(wxToolBar* toolBar, int style);
+
+    /**
+        Creates contents panel. (May take some time.)
+    */
+    void CreateContents();
+
+    /**
+        Creates index panel. (May take some time.)
+    */
+    void CreateIndex();
+};
+