initial commit

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

libs/wxWidgets-3.3.1/interface/wx/generic/aboutdlgg.h

@@ -0,0 +1,128 @@
+///////////////////////////////////////////////////////////////////////////////
+// Name:        wx/generic/aboutdlgg.h
+// Purpose:     generic wxAboutBox() implementation
+// Author:      eranon
+// Created:     2012-09-25
+// Copyright:   (c) 2012 wxWidgets development team
+// Licence:     wxWindows licence
+///////////////////////////////////////////////////////////////////////////////
+
+/**
+    @class wxGenericAboutDialog
+
+    This class defines a customizable @e About dialog.
+
+    Note that if you don't need customization, you should use the global
+    wxAboutBox() function that is both easier to use and shows the native
+    dialog if available.
+
+    To use this class, you need to derive your own class from it and override
+    the virtual method DoAddCustomControls().
+
+    To instantiate an object from your wxGenericAboutDialog-based class, you
+    can use either the default constructor followed by a call to Create(), or
+    directly using the alternate constructor. In either case, you have to
+    prepare a wxAboutDialogInfo containing standard information to display in
+    an about-box.
+
+    Example of usage, MyAboutDlg being a class derived from wxGenericAboutDialog:
+    @code
+    void MyFrame::OnAbout(wxCommandEvent& WXUNUSED(event))
+    {
+        wxAboutDialogInfo aboutInfo;
+
+        aboutInfo.SetName("MyApp");
+        aboutInfo.SetVersion(MY_APP_VERSION_STRING);
+        aboutInfo.SetDescription(_("My wxWidgets-based application!"));
+        aboutInfo.SetCopyright("(C) 1992-2025");
+        aboutInfo.SetWebSite("http://myapp.org");
+        aboutInfo.AddDeveloper("My Self");
+
+        MyAboutDlg dlgAbout(aboutInfo, this);
+        dlgAbout.ShowModal();
+    }
+    @endcode
+
+    @library{wxcore}
+    @category{cmndlg}
+
+    @see wxAboutDialogInfo
+*/
+class wxGenericAboutDialog
+{
+public:
+    /**
+        Default constructor, Create() must be called later.
+    */
+    wxGenericAboutDialog();
+
+    /**
+        Creates the dialog and initializes it with the given information.
+    */
+    wxGenericAboutDialog(const wxAboutDialogInfo& info, wxWindow* parent = nullptr);
+
+    /**
+        Initializes the dialog created using the default constructor.
+    */
+    bool Create(const wxAboutDialogInfo& info, wxWindow* parent = nullptr);
+
+protected:
+    /**
+        This virtual method may be overridden to add more controls to the
+        dialog.
+
+        The custom controls should be created with GetCustomControlParent() as
+        parent and then can be passed to the protected AddControl() method.
+        AddText() and AddCollapsiblePane() methods can also be used to add
+        simple static custom controls.
+
+        This method is called during the dialog creation and you don't need to
+        call it, only to override it.
+    */
+    virtual void DoAddCustomControls() { }
+
+    /**
+        Add arbitrary control to the sizer content with the specified flags.
+
+        For example, here is how to add an expandable line with a border of 3
+        pixels, then a line of text:
+        @code
+        AddControl(new wxStaticLine(this), wxSizerFlags().Expand().Border(wxALL, 3));
+
+        AddText(_("This line is just an example of custom text."));
+        @endcode
+    */
+    void AddControl(wxWindow *win, const wxSizerFlags& flags);
+
+    /**
+        Add arbitrary control to the sizer content and centre it.
+    */
+    void AddControl(wxWindow *win);
+
+    /**
+        Add the given (not empty) text to the sizer content.
+    */
+    void AddText(const wxString& text);
+
+    /**
+        Add a wxCollapsiblePane containing the given text.
+    */
+    void AddCollapsiblePane(const wxString& title, const wxString& text);
+
+    /**
+        Return the parent to use for custom controls.
+
+        See DoAddCustomControls().
+
+        @since 3.3.0
+     */
+    wxWindow* GetCustomControlParent() const;
+};
+
+/**
+    Show generic about dialog.
+
+    This function does the same thing as wxAboutBox() except that it always
+    uses the generic wxWidgets version of the dialog instead of the native one.
+*/
+void wxGenericAboutBox(const wxAboutDialogInfo& info, wxWindow* parent = nullptr);

libs/wxWidgets-3.3.1/interface/wx/generic/helpext.h

@@ -0,0 +1,154 @@
+/////////////////////////////////////////////////////////////////////////////
+// Name:        helpext.h
+// Purpose:     interface of wxExtHelpController
+// Author:      wxWidgets team
+// Licence:     wxWindows licence
+/////////////////////////////////////////////////////////////////////////////
+
+
+/**
+    @class wxExtHelpController
+
+    This class implements help via an external browser.
+    It requires the name of a directory containing the documentation
+    and a file mapping numerical Section numbers to relative URLS.
+
+    The map file contains two or three fields per line:
+    numeric_id  relative_URL  [; comment/documentation]
+
+    The numeric_id is the id used to look up the entry in
+    DisplaySection()/DisplayBlock(). The relative_URL is a filename of
+    an html file, relative to the help directory. The optional
+    comment/documentation field (after a ';') is used for keyword
+    searches, so some meaningful text here does not hurt.
+    If the documentation itself contains a ';', only the part before
+    that will be displayed in the listbox, but all of it used for search.
+
+    Lines starting with ';' will be ignored.
+
+    @library{wxcore}
+    @category{help}
+
+    @see wxHelpController
+*/
+class wxExtHelpController : public wxHelpControllerBase
+{
+public:
+    wxExtHelpController(wxWindow* parentWindow = nullptr);
+    virtual ~wxExtHelpController();
+
+    /**
+        Tell it which browser to use.
+        The Netscape support will check whether Netscape is already
+        running (by looking at the .netscape/lock file in the user's
+        home directory) and tell it to load the page into the existing window.
+
+        @param viewer
+            The command to call a browser/html viewer.
+        @param flags
+            Set this to wxHELP_NETSCAPE if the browser is some variant of Netscape.
+    */
+    virtual void SetViewer(const wxString& viewer = wxEmptyString,
+                           long flags = wxHELP_NETSCAPE);
+
+    /**
+        This must be called to tell the controller where to find the
+        documentation.
+        If a locale is set, look in file/localename, i.e.
+        If passed "/usr/local/myapp/help" and the current wxLocale is
+        set to be "de", then look in "/usr/local/myapp/help/de/"
+        first and fall back to "/usr/local/myapp/help" if that
+        doesn't exist.
+
+        @param dir
+            directory name where to fine the help files
+
+        @return @true on success
+    */
+    virtual bool Initialize(const wxString& dir);
+
+    /**
+        If file is "", reloads file given in Initialize.
+
+        @param file
+            Name of help directory.
+
+        @return @true on success
+    */
+    virtual bool LoadFile(const wxString& file = wxEmptyString);
+
+    /**
+        Display list of all help entries.
+
+        @return @true on success
+    */
+    virtual bool DisplayContents();
+
+    /**
+        Display help for id sectionNo.
+
+        @return @true on success
+    */
+    virtual bool DisplaySection(int sectionNo);
+
+    /**
+        Display help for id sectionNo -- identical with DisplaySection().
+
+        @return @true on success
+    */
+    virtual bool DisplaySection(const wxString& section);
+
+    /**
+        Display help for URL (using DisplayHelp) or keyword (using KeywordSearch)
+
+        @return @true on success
+    */
+    virtual bool DisplayBlock(long blockNo);
+
+    /**
+        Search comment/documentation fields in map file and present a
+        list to chose from.
+
+        @param k
+            string to search for, empty string will list all entries
+
+        @param mode
+            optional parameter allows the search the index (wxHELP_SEARCH_INDEX)
+            but this currently only supported by the wxHtmlHelpController.
+
+        @return @true on success
+    */
+    virtual bool KeywordSearch(const wxString& k,
+                                wxHelpSearchMode mode = wxHELP_SEARCH_ALL);
+
+    /**
+        Does nothing.
+    */
+    virtual bool Quit();
+
+    /**
+        Does nothing.
+    */
+    virtual void OnQuit();
+
+    /**
+        Call the browser using a relative URL.
+    */
+    virtual bool DisplayHelp(const wxString& relativeURL) ;
+
+    /**
+        Allows one to override the default settings for the help frame.
+    */
+    virtual void SetFrameParameters(const wxString& titleFormat,
+                                    const wxSize& size,
+                                    const wxPoint& pos = wxDefaultPosition,
+                                    bool newFrameEachTime = false);
+
+    /**
+        Obtains the latest settings used by the help frame and the help frame.
+    */
+    virtual wxFrame *GetFrameParameters(wxSize *size = nullptr,
+                                        wxPoint *pos = nullptr,
+                                        bool *newFrameEachTime = nullptr);
+};
+