wxruby3 0.9.0.pre.beta.2-x64-mingw-ucrt-3.2-3.2.2

data/lib/wx/doc/gen/html/html_help_controller.rb

@@ -0,0 +1,256 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx::HTML
+
+  # 
+  ID_HTML_HELPFRAME = 6000
+  
+  # 
+  HF_EMBEDDED = 32768
+  
+  # 
+  HF_DIALOG = 65536
+  
+  # 
+  HF_FRAME = 131072
+  
+  # 
+  HF_MODAL = 262144
+  
+  # 
+  HELP_NETSCAPE = 1
+  
+  # Help search modes for {Wx::HelpController#keyword_search}.
+  # 
+  # 
+  # 
+  class HelpSearchMode < Wx::Enum
+  
+    # Search the index only.
+    # 
+    HELP_SEARCH_INDEX = Wx::HTML::HelpSearchMode.new(0)
+    
+    # Search all entries.
+    # 
+    HELP_SEARCH_ALL = Wx::HTML::HelpSearchMode.new(1)
+    
+  end # HelpSearchMode
+  
+  # This help controller provides an easy way of displaying HTML help in your application (see HTML Sample, test example).
+  # The help system is based on <b>books</b> (see {Wx::HTML::HtmlHelpController#add_book}). A book is a logical section of documentation (for example "User's Guide" or "Programmer's Guide" or "C++ Reference" or "wxWidgets Reference"). The help controller can handle as many books as you want.
+  # Although this class has an API compatible with other wxWidgets help controllers as documented by {Wx::HelpController}, it is recommended that you use the enhanced capabilities of {Wx::HTML::HtmlHelpController}'s API.
+  # {Wx::HTML} uses Microsoft's HTML Help Workshop project files (.hhp, .hhk, .hhc) as its native format. The file format is described in Help Files Format. The directory helpfiles in the HTML Sample contains sample project files.
+  # Note that the Microsoft's HTML Help Workshop (http://www.microsoft.com/downloads/details.aspx?FamilyID=00535334-c8a6-452f-9aa0-d597d16580cc) also runs on other platforms using WINE (http://www.winehq.org/) and it can be used to create the .hpp, .hhk and .hhc files through a friendly GUI. The commercial tool HelpBlocks (http://www.helpblocks.com) can also create these files.
+  # === 
+  # 
+  # Category:  {Wx::HELP}, {Wx::HTML}
+  # @see wxBestHelpController
+  # @see  Wx::HTML::HtmlHelpFrame
+  # @see  Wx::HtmlHelpDialog
+  # @see  Wx::HTML::HtmlHelpWindow
+  # @see  Wx::HtmlModalHelp 
+  # 
+  # 
+  class HtmlHelpController < Object
+  
+    # @overload initialize(style=Wx::HF_DEFAULT_STYLE, parentWindow=nil)
+    #   Constructor.
+    #   @param style [Integer]  This is a combination of these flags:
+    #     - {Wx::HTML::HF_TOOLBAR}: The help window has a toolbar.- {Wx::HTML::HF_FLAT_TOOLBAR}: The help window has a toolbar with flat buttons (aka coolbar).- {Wx::HTML::HF_CONTENTS}: The help window has a contents panel.- {Wx::HTML::HF_INDEX}: The help window has an index panel.- {Wx::HTML::HF_SEARCH}: The help window has a search panel.- {Wx::HTML::HF_BOOKMARKS}: The help window has bookmarks controls.- {Wx::HTML::HF_OPEN_FILES}: Allows user to open arbitrary HTML document.- {Wx::HTML::HF_PRINT}: The toolbar contains "print" button.- {Wx::HTML::HF_MERGE_BOOKS}: The contents pane does not show book nodes. All books are merged together and appear as single book to the user.- {Wx::HTML::HF_ICONS_BOOK}: All nodes in contents pane have a book icon. This is how Microsoft's HTML help viewer behaves.- {Wx::HTML::HF_ICONS_FOLDER}: Book nodes in contents pane have a book icon, book's sections have a folder icon. This is the default.- {Wx::HTML::HF_ICONS_BOOK_CHAPTER}: Both book nodes and nodes of top-level sections of a book (i.e. chapters) have a book icon, all other sections (sections, subsections, ...) have a folder icon.- {Wx::HTML::HF_EMBEDDED}: Specifies that the help controller controls an embedded window of class {Wx::HTML::HtmlHelpWindow} that should not be destroyed when the controller is destroyed.- {Wx::HTML::HF_DIALOG}: Specifies that the help controller should create a dialog containing the help window.- {Wx::HTML::HF_FRAME}: Specifies that the help controller should create a frame containing the help window. This is the default if neither {Wx::HTML::HF_DIALOG} nor {Wx::HTML::HF_EMBEDDED} is specified.- {Wx::HTML::HF_MODAL}: Specifies that the help controller should create a modal dialog containing the help window (used with the {Wx::HTML::HF_DIALOG} style).- {Wx::HTML::HF_DEFAULT_STYLE}: {Wx::HTML::HF_TOOLBAR} | {Wx::HTML::HF_CONTENTS} | {Wx::HTML::HF_INDEX} | {Wx::HTML::HF_SEARCH} | {Wx::HTML::HF_BOOKMARKS} | {Wx::HTML::HF_PRINT}
+    #   @param parentWindow [Wx::Window]  This is an optional window to be used as the parent for the help window.
+    #   @return [HtmlHelpController]
+    # @overload initialize(parentWindow, style=Wx::HF_DEFAULT_STYLE)
+    #   @param parentWindow [Wx::Window] 
+    #   @param style [Integer] 
+    #   @return [HtmlHelpController]
+    def initialize(*args) end
+    
+    # @overload add_book(bookFile, showWaitMsg=false)
+    #   Adds a book (i.e.
+    #   a .hhp file; an HTML Help Workshop project file) into the list of loaded books.
+    #   This must be called at least once before displaying any help. bookFile or bookUrl may be either <code>".hhp"</code> file or a ZIP archive that contains an arbitrary number of <code>".hhp"</code> files in its top-level directory. This ZIP archive must have <code>".zip"</code> or <code>".htb"</code> extension (the latter stands for "HTML book"). In other words, 
+    #   
+    #     AddBook(wxFileName("help.zip"))
+    #    is possible and is the recommended way.
+    #   @param bookFile [Wx::FileName]  Help book filename. It is recommended to use this prototype instead of the one taking URL, because it is less error-prone.
+    #   @param showWaitMsg [true,false]  If true then a decoration-less window with progress message is displayed.
+    #   @return [true,false]
+    # @overload add_book(bookUrl, showWaitMsg=false)
+    #   Adds a book (i.e.
+    #   a .hhp file; an HTML Help Workshop project file) into the list of loaded books.
+    #   See the other overload for additional info.
+    #   @param bookUrl [String]  Help book URL (note that syntax of filename and URL is different on most platforms).
+    #   @param showWaitMsg [true,false]  If true then a decoration-less window with progress message is displayed.
+    #   @return [true,false]
+    def add_book(*args) end
+    
+    # @overload display(x)
+    #   Displays page x.
+    #   This is THE important function - it is used to display the help in application. You can specify the page in many ways:
+    #   - as direct filename of HTML document- as chapter name (from contents) or as a book name- as some word from index- even as any word (will be searched)
+    #   
+    #   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 named 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 ...")- switch to Search panel and start searching
+    #   @param x [String] 
+    #   @return [true,false]
+    # @overload display(id)
+    #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    #   This alternative form is used to search help contents by numeric IDs.
+    #   @param id [Integer] 
+    #   @return [true,false]
+    def display(*args) end
+    
+    # Displays help window and focuses contents panel.
+    # @return [true,false]
+    def display_contents; end
+    
+    # Displays help window and focuses index panel.
+    # @return [true,false]
+    def display_index; end
+    
+    # Displays the help window, focuses search panel and starts searching.
+    # Returns true if the keyword was found. Optionally it searches through the index (mode = {Wx::HelpSearchMode::HELP_SEARCH_INDEX}), default the content (mode = {Wx::HelpSearchMode::HELP_SEARCH_ALL}).
+    # {Wx::HTML::HtmlHelpController#keyword_search} searches only pages listed in <code>".hhc"</code> file(s). You should list all pages in the contents file.
+    # @param keyword [String] 
+    # @param mode [HelpSearchMode] 
+    # @return [true,false]
+    def keyword_search(keyword, mode=Wx::HELP_SEARCH_ALL) end
+    
+    # Reads the controller's setting (position of window, etc.)
+    # @param cfg [Wx::ConfigBase] 
+    # @param path [String] 
+    # @return [void]
+    def read_customization(cfg, path=Wx::EMPTY_STRING) end
+    
+    # Sets whether the help frame should prevent application from exiting if it's the only remaining top level window.
+    # 
+    # @see Wx::App#set_exit_on_frame_delete
+    # @param enable [true,false]  If true, the application will not quit unless the help frame is closed. Default is false, i.e. the application does exit if only the help window remains opened.
+    # @return [void]
+    def set_should_prevent_app_exit(enable) end
+    alias_method :should_prevent_app_exit=, :set_should_prevent_app_exit
+    
+    # Sets the path for storing temporary files - cached binary versions of index and contents files.
+    # These binary forms are much faster to read. Default value is empty string (empty string means that no cached data are stored). Note that these files are not deleted when program exits.
+    # Once created these cached files will be used in all subsequent executions of your application. If cached files become older than corresponding <code>".hhp"</code> file (e.g. if you regenerate documentation) it will be refreshed.
+    # @param path [String] 
+    # @return [void]
+    def set_temp_dir(path) end
+    alias_method :temp_dir=, :set_temp_dir
+    
+    # Sets format of title of the frame.
+    # Must contain exactly one "%s" (for title of displayed HTML page).
+    # @param format [String] 
+    # @return [void]
+    def set_title_format(format) end
+    alias_method :title_format=, :set_title_format
+    
+    # Associates the config object with the controller.
+    # If there is associated config object, {Wx::HTML::HtmlHelpController} automatically reads and writes settings (including {Wx::HTML::HtmlWindow}'s settings) when needed. The only thing you must do is create {Wx::Config} object and call {Wx::HTML::HtmlHelpController#use_config}.
+    # If you do not use {Wx::HTML::HtmlHelpController#use_config}, {Wx::HTML::HtmlHelpController} will use the default {Wx::Config} object if available (for details see Wx::ConfigBase::Get and Wx::ConfigBase::Set).
+    # @param config [Wx::ConfigBase] 
+    # @param rootpath [String] 
+    # @return [void]
+    def use_config(config, rootpath=Wx::EMPTY_STRING) end
+    
+    # Stores controllers setting (position of window etc.)
+    # @param cfg [Wx::ConfigBase] 
+    # @param path [String] 
+    # @return [void]
+    def write_customization(cfg, path=Wx::EMPTY_STRING) end
+    
+    # Get the current help window.
+    # @return [Wx::HtmlHelpWindow]
+    def get_help_window; end
+    alias_method :help_window, :get_help_window
+    
+    # Set the help window to be managed by this controller.
+    # This makes it possible to have a help window that might not be in a {Wx::HTML::HtmlHelpFrame} or dialog but is embedded in some other window in the application. Be sure to use the {Wx::HTML::HF_EMBEDDED} style in this case.
+    # @param helpWindow [Wx::HtmlHelpWindow] 
+    # @return [void]
+    def set_help_window(helpWindow) end
+    alias_method :help_window=, :set_help_window
+    
+    # Returns the current help frame.
+    # (May be NULL.)
+    # @return [Wx::HtmlHelpFrame]
+    def get_frame; end
+    alias_method :frame, :get_frame
+    
+    # Returns the current help dialog.
+    # (May be NULL.)
+    # @return [Wx::HtmlHelpDialog]
+    def get_dialog; end
+    alias_method :dialog, :get_dialog
+    
+    # Displays the section as a popup window using a context id.
+    # Returns false if unsuccessful or not implemented.
+    # @param contextId [Integer] 
+    # @return [true,false]
+    def display_context_popup(contextId) end
+    
+    # Displays the text in a popup window, if possible.
+    # Returns false if unsuccessful or not implemented.
+    # @param text [String] 
+    # @param pos [Array(Integer, Integer), Wx::Point] 
+    # @return [true,false]
+    def display_text_popup(text, pos) end
+    
+    # Returns the window to be used as the parent for the help window.
+    # This window is used by {Wx::CHMHelpController}, {Wx::WinHelpController} and {Wx::HTML::HtmlHelpController}.
+    # @return [Wx::Window]
+    def get_parent_window; end
+    alias_method :parent_window, :get_parent_window
+    
+    # Initializes the help instance with a help filename.
+    # Does not invoke the help viewer. This must be called directly after the help instance object is created and before any attempts to communicate with the viewer.
+    # You may omit the file extension and a suitable one will be chosen. For {Wx::HTML::HtmlHelpController}, the extensions zip, htb and hhp will be appended while searching for a suitable file. For WinHelp, the hlp extension is appended.
+    # @param file [String] 
+    # @return [true,false]
+    def init(file) end
+    
+    # Overridable member called when this application's viewer is quit by the user.
+    # This does not work for all help controllers.
+    # @return [void]
+    def on_quit; end
+    
+    # Set the parameters of the frame window.
+    # For {Wx::HTML::HtmlHelpController}, titleFormat specifies the title string format (with s being replaced by the actual page title) and size and position specify the geometry of the frame.
+    # For all other help controllers this function has no effect.
+    # Finally, newFrameEachTime is always ignored currently.
+    # @param titleFormat [String] 
+    # @param size [Array(Integer, Integer), Wx::Size] 
+    # @param pos [Array(Integer, Integer), Wx::Point] 
+    # @param newFrameEachTime [true,false] 
+    # @return [void]
+    def set_frame_parameters(titleFormat, size, pos=Wx::DEFAULT_POSITION, newFrameEachTime=false) end
+    
+    # Sets the window to be used as the parent for the help window.
+    # This is used by {Wx::CHMHelpController}, {Wx::WinHelpController} and {Wx::HTML::HtmlHelpController}.
+    # @param parentWindow [Wx::Window] 
+    # @return [void]
+    def set_parent_window(parentWindow) end
+    alias_method :parent_window=, :set_parent_window
+    
+    # Sets detailed viewer information.
+    # So far this is only relevant to {Wx::ExtHelpController}. Some examples of usage:
+    # 
+    #   m_help.SetViewer("kdehelp");
+    #   m_help.SetViewer("gnome-help-browser");
+    #   m_help.SetViewer("netscape", wxHELP_NETSCAPE);
+    # 
+    # Todomodernize this function with {Wx::LaunchDefaultBrowser}
+    # @param viewer [String]  This defaults to "netscape" for {Wx::ExtHelpController}.
+    # @param flags [Integer]  This defaults to {Wx::HELP_NETSCAPE} for {Wx::ExtHelpController}, indicating that the viewer is a variant of Netscape Navigator.
+    # @return [void]
+    def set_viewer(viewer, flags=Wx::HELP_NETSCAPE) end
+    alias_method :viewer=, :set_viewer
+    
+  end # HtmlHelpController
+  
+
+end

data/lib/wx/doc/gen/html/html_help_data.rb

@@ -0,0 +1,144 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx::HTML
+
+  # This class is used by {Wx::HTML::HtmlHelpController} and {Wx::HTML::HtmlHelpFrame} to access HTML help items.
+  # It is internal class and should not be used directly - except for the case you're writing your own HTML help controller.
+  # === 
+  # 
+  # Category:  {Wx::HELP}, {Wx::HTML}
+  # 
+  class HtmlHelpData < Object
+  
+    # Constructor.
+    # @return [HtmlHelpData]
+    def initialize; end
+    
+    # Adds new book.
+    # book_url is URL (not filename!) of HTML help project (hhp) or ZIP file that contains arbitrary number of .hhp projects (this zip file can have either .zip or .htb extension, htb stands for "html book").
+    # Returns success.
+    # @param book_url [String] 
+    # @return [true,false]
+    def add_book(book_url) end
+    
+    # Returns page's URL based on integer ID stored in project.
+    # @param id [Integer] 
+    # @return [String]
+    def find_page_by_id(id) end
+    
+    # Returns page's URL based on its (file)name.
+    # @param page [String] 
+    # @return [String]
+    def find_page_by_name(page) end
+    
+    # Returns array with help books info.
+    # @return [Array<Wx::HtmlBookRecord>]
+    def get_book_rec_array; end
+    alias_method :book_rec_array, :get_book_rec_array
+    
+    # Returns reference to array with contents entries.
+    # @return [Array<Wx::HtmlHelpDataItem>]
+    def get_contents_array; end
+    alias_method :contents_array, :get_contents_array
+    
+    # Returns reference to array with index entries.
+    # @return [Array<Wx::HtmlHelpDataItem>]
+    def get_index_array; end
+    alias_method :index_array, :get_index_array
+    
+    # Sets the temporary directory where binary cached versions of MS HTML Workshop files will be stored.
+    # (This is turned off by default and you can enable this feature by setting non-empty temp dir.)
+    # @param path [String] 
+    # @return [void]
+    def set_temp_dir(path) end
+    alias_method :temp_dir=, :set_temp_dir
+    
+  end # HtmlHelpData
+  
+  # Helper class for {Wx::HTML::HtmlHelpData}.
+  # 
+  # 
+  class HtmlBookRecord < ::Object
+  
+    # @param bookfile [String] 
+    # @param basepath [String] 
+    # @param title [String] 
+    # @param start [String] 
+    # @return [HtmlBookRecord]
+    def initialize(bookfile, basepath, title, start) end
+    
+    # @return [String]
+    def get_book_file; end
+    alias_method :book_file, :get_book_file
+    
+    # @return [String]
+    def get_title; end
+    alias_method :title, :get_title
+    
+    # @return [String]
+    def get_start; end
+    alias_method :start, :get_start
+    
+    # @return [String]
+    def get_base_path; end
+    alias_method :base_path, :get_base_path
+    
+    # @param start [Integer] 
+    # @param end_ [Integer] 
+    # @return [void]
+    def set_contents_range(start, end_) end
+    
+    # @return [Integer]
+    def get_contents_start; end
+    alias_method :contents_start, :get_contents_start
+    
+    # @return [Integer]
+    def get_contents_end; end
+    alias_method :contents_end, :get_contents_end
+    
+    # @param title [String] 
+    # @return [void]
+    def set_title(title) end
+    alias_method :title=, :set_title
+    
+    # @param path [String] 
+    # @return [void]
+    def set_base_path(path) end
+    alias_method :base_path=, :set_base_path
+    
+    # @param start [String] 
+    # @return [void]
+    def set_start(start) end
+    alias_method :start=, :set_start
+    
+    # @param page [String] 
+    # @return [String]
+    def get_full_path(page) end
+    alias_method :full_path, :get_full_path
+    
+  end # HtmlBookRecord
+  
+  # Helper class for {Wx::HTML::HtmlHelpData}.
+  # 
+  # 
+  class HtmlHelpDataItem < ::Object
+  
+    # @return [HtmlHelpDataItem]
+    def initialize; end
+    
+    # @return [String]
+    def get_full_path; end
+    alias_method :full_path, :get_full_path
+    
+    # @return [String]
+    def get_indented_name; end
+    alias_method :indented_name, :get_indented_name
+    
+  end # HtmlHelpDataItem
+  
+
+end

data/lib/wx/doc/gen/html/html_help_frame.rb

@@ -0,0 +1,112 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx::HTML
+
+  # 
+  HF_TOOLBAR = 1
+  
+  # 
+  HF_CONTENTS = 2
+  
+  # 
+  HF_INDEX = 4
+  
+  # 
+  HF_SEARCH = 8
+  
+  # 
+  HF_BOOKMARKS = 16
+  
+  # 
+  HF_OPEN_FILES = 32
+  
+  # 
+  HF_PRINT = 64
+  
+  # 
+  HF_FLAT_TOOLBAR = 128
+  
+  # 
+  HF_MERGE_BOOKS = 256
+  
+  # 
+  HF_ICONS_BOOK = 512
+  
+  # 
+  HF_ICONS_BOOK_CHAPTER = 1024
+  
+  # 
+  HF_ICONS_FOLDER = 0
+  
+  # 
+  HF_DEFAULT_STYLE = 95
+  
+  # This class is used by {Wx::HTML::HtmlHelpController} to display help.
+  # It is an internal class and should not be used directly - except for the case when you're writing your own HTML help controller.
+  # === 
+  # 
+  # Category:  {Wx::HELP}, {Wx::HTML}
+  # 
+  class HtmlHelpFrame < Frame
+  
+    # @overload initialize(data=nil)
+    #   @param data [Wx::HtmlHelpData] 
+    #   @return [HtmlHelpFrame]
+    # @overload initialize(parent, id, title=Wx::EMPTY_STRING, style=Wx::HF_DEFAULT_STYLE, data=nil, config=nil, rootpath=Wx::EMPTY_STRING)
+    #   Constructor.
+    #   For the possible values of style, please see {Wx::HTML::HtmlHelpController}.
+    #   @param parent [Wx::Window] 
+    #   @param id [Integer] 
+    #   @param title [String] 
+    #   @param style [Integer] 
+    #   @param data [Wx::HtmlHelpData] 
+    #   @param config [Wx::ConfigBase] 
+    #   @param rootpath [String] 
+    #   @return [HtmlHelpFrame]
+    def initialize(*args) end
+    
+    # You may override this virtual method to add more buttons to the help window's toolbar.
+    # toolBar is a pointer to the toolbar and style is the style flag as passed to the {Wx::HTML::HtmlHelpFrame#create} method.
+    # {Wx::ToolBar#realize} is called immediately after returning from this function.
+    # @param toolBar [Wx::ToolBar] 
+    # @param style [Integer] 
+    # @return [void]
+    def add_toolbar_buttons(toolBar, style) end
+    
+    # Creates the frame.
+    # See the constructor for a description of the parameters.
+    # @param parent [Wx::Window] 
+    # @param id [Integer] 
+    # @param title [String] 
+    # @param style [Integer] 
+    # @param config [Wx::ConfigBase] 
+    # @param rootpath [String] 
+    # @return [true,false]
+    def create(parent, id, title=Wx::EMPTY_STRING, style=Wx::HF_DEFAULT_STYLE, config=nil, rootpath=Wx::EMPTY_STRING) end
+    
+    # Returns the help controller associated with the frame.
+    # @return [Wx::HtmlHelpController]
+    def get_controller; end
+    alias_method :controller, :get_controller
+    
+    # Sets the help controller associated with the frame.
+    # @param controller [Wx::HtmlHelpController] 
+    # @return [void]
+    def set_controller(controller) end
+    alias_method :controller=, :set_controller
+    
+    # Sets the frame's title format.
+    # format must contain exactly one "%s" (it will be replaced by the page title).
+    # @param format [String] 
+    # @return [void]
+    def set_title_format(format) end
+    alias_method :title_format=, :set_title_format
+    
+  end # HtmlHelpFrame
+  
+
+end