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

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

@@ -0,0 +1,230 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx::HTML
+
+  # 
+  # 
+  ID_HTML_PANEL = 6009
+  
+  # 
+  # 
+  ID_HTML_BACK = 6010
+  
+  # 
+  # 
+  ID_HTML_FORWARD = 6011
+  
+  # 
+  # 
+  ID_HTML_UPNODE = 6012
+  
+  # 
+  # 
+  ID_HTML_UP = 6013
+  
+  # 
+  # 
+  ID_HTML_DOWN = 6014
+  
+  # 
+  # 
+  ID_HTML_PRINT = 6015
+  
+  # 
+  # 
+  ID_HTML_OPENFILE = 6016
+  
+  # 
+  # 
+  ID_HTML_OPTIONS = 6017
+  
+  # 
+  # 
+  ID_HTML_BOOKMARKSLIST = 6018
+  
+  # 
+  # 
+  ID_HTML_BOOKMARKSADD = 6019
+  
+  # 
+  # 
+  ID_HTML_BOOKMARKSREMOVE = 6020
+  
+  # 
+  # 
+  ID_HTML_TREECTRL = 6021
+  
+  # 
+  # 
+  ID_HTML_INDEXPAGE = 6022
+  
+  # 
+  # 
+  ID_HTML_INDEXLIST = 6023
+  
+  # 
+  # 
+  ID_HTML_INDEXTEXT = 6024
+  
+  # 
+  # 
+  ID_HTML_INDEXBUTTON = 6025
+  
+  # 
+  # 
+  ID_HTML_INDEXBUTTONALL = 6026
+  
+  # 
+  # 
+  ID_HTML_NOTEBOOK = 6027
+  
+  # 
+  # 
+  ID_HTML_SEARCHPAGE = 6028
+  
+  # 
+  # 
+  ID_HTML_SEARCHTEXT = 6029
+  
+  # 
+  # 
+  ID_HTML_SEARCHLIST = 6030
+  
+  # 
+  # 
+  ID_HTML_SEARCHBUTTON = 6031
+  
+  # 
+  # 
+  ID_HTML_SEARCHCHOICE = 6032
+  
+  # 
+  # 
+  ID_HTML_COUNTINFO = 6033
+  
+  # This class is used by {Wx::HTML::HtmlHelpController} to display help within a frame or dialog, but you can use it yourself to create an embedded HTML help window.
+  # For example: 
+  # 
+  #   // 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(wxT("doc.zip")));
+  # 
+  # You should pass the style {Wx::HTML::HF_EMBEDDED} to the style parameter of {Wx::HTML::HtmlHelpController} to allow the embedded window to be destroyed independently of the help controller.
+  # === 
+  # 
+  # Category:  {Wx::HELP}, {Wx::HTML}
+  # 
+  class HtmlHelpWindow < Window
+  
+    # @overload initialize(data=nil)
+    #   @param data [Wx::HtmlHelpData] 
+    #   @return [HtmlHelpWindow]
+    # @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::TAB_TRAVERSAL|Wx::BORDER_NONE), helpStyle=Wx::HF_DEFAULT_STYLE, data=nil)
+    #   Constructor.
+    #   For the values of helpStyle, please see the documentation for {Wx::HTML::HtmlHelpController}.
+    #   @param parent [Wx::Window] 
+    #   @param id [Integer] 
+    #   @param pos [Array(Integer, Integer), Wx::Point] 
+    #   @param size [Array(Integer, Integer), Wx::Size] 
+    #   @param style [Integer] 
+    #   @param helpStyle [Integer] 
+    #   @param data [Wx::HtmlHelpData] 
+    #   @return [HtmlHelpWindow]
+    def initialize(*args) end
+    
+    # Creates the help window.
+    # See the constructor for a description of the parameters.
+    # @param parent [Wx::Window] 
+    # @param id [Integer] 
+    # @param pos [Array(Integer, Integer), Wx::Point] 
+    # @param size [Array(Integer, Integer), Wx::Size] 
+    # @param style [Integer] 
+    # @param helpStyle [Integer] 
+    # @return [true,false]
+    def create(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::TAB_TRAVERSAL|Wx::BORDER_NONE), helpStyle=Wx::HF_DEFAULT_STYLE) end
+    
+    # @overload display(x)
+    #   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 ...")
+    #   @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 form takes numeric ID as the parameter (uses an extension to MS format, param name="ID" value=id).
+    #   @param id [Integer] 
+    #   @return [true,false]
+    def display(*args) end
+    
+    # Displays contents panel.
+    # @return [true,false]
+    def display_contents; end
+    
+    # Displays index panel.
+    # @return [true,false]
+    def display_index; end
+    
+    # Returns the {Wx::HTML::HtmlHelpData} object, which is usually a pointer to the controller's data.
+    # @return [Wx::HtmlHelpData]
+    def get_data; end
+    alias_method :data, :get_data
+    
+    # Search for given keyword.
+    # Optionally it searches through the index (mode = {Wx::HelpSearchMode::HELP_SEARCH_INDEX}), default the content (mode = {Wx::HelpSearchMode::HELP_SEARCH_ALL}).
+    # @param keyword [String] 
+    # @param mode [HelpSearchMode] 
+    # @return [true,false]
+    def keyword_search(keyword, mode=Wx::HELP_SEARCH_ALL) end
+    
+    # Reads the user's settings for this window.
+    # 
+    # @see Wx::HTML::HtmlHelpController#read_customization 
+    # @param cfg [Wx::ConfigBase] 
+    # @param path [String] 
+    # @return [void]
+    def read_customization(cfg, path=Wx::EMPTY_STRING) end
+    
+    # Associates a {Wx::Config} object with the help window.
+    # It is recommended that you use {Wx::HTML::HtmlHelpController#use_config} instead.
+    # @param config [Wx::ConfigBase] 
+    # @param rootpath [String] 
+    # @return [void]
+    def use_config(config, rootpath=Wx::EMPTY_STRING) end
+    
+    # Saves the user's settings for this window.
+    # 
+    # @see Wx::HTML::HtmlHelpController#write_customization 
+    # @param cfg [Wx::ConfigBase] 
+    # @param path [String] 
+    # @return [void]
+    def write_customization(cfg, path=Wx::EMPTY_STRING) end
+    
+    # Refresh all panels.
+    # This is necessary if a new book was added.
+    # @return [void]
+    def refresh_lists; end
+    
+    # @return [Wx::HtmlHelpController]
+    def get_controller; end
+    alias_method :controller, :get_controller
+    
+    # @param controller [Wx::HtmlHelpController] 
+    # @return [void]
+    def set_controller(controller) end
+    alias_method :controller=, :set_controller
+    
+  end # HtmlHelpWindow
+  
+
+end

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

@@ -0,0 +1,36 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx::HTML
+
+  # This event class is used for the events generated by {Wx::HTML::HtmlWindow}.
+  # === Events using this class
+  # 
+  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::HTML::HtmlLinkEvent} events.
+  # Event handler methods:
+  # - {Wx::EvtHandler#evt_html_link_clicked}(id, meth = nil, &block): User clicked on a hyperlink. 
+  # 
+  # === 
+  # 
+  # Category:  {Wx::HTML}, {Wx::Events}
+  # 
+  class HtmlLinkEvent < CommandEvent
+  
+    # The constructor is not normally used by the user code.
+    # @param id [Integer] 
+    # @param linkinfo [Wx::HtmlLinkInfo] 
+    # @return [HtmlLinkEvent]
+    def initialize(id, linkinfo) end
+    
+    # Returns the {Wx::HTML::HtmlLinkInfo} which contains info about the cell clicked and the hyperlink it contains.
+    # @return [Wx::HtmlLinkInfo]
+    def get_link_info; end
+    alias_method :link_info, :get_link_info
+    
+  end # HtmlLinkEvent
+  
+
+end

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

@@ -0,0 +1,150 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx::HTML
+
+  # 
+  HLB_DEFAULT_STYLE = 134217728
+  
+  # 
+  HLB_MULTIPLE = 64
+  
+  # {Wx::HTML::HtmlListBox} is an implementation of {Wx::VListBox} which shows HTML content in the listbox rows.
+  # This is still an abstract base class and you will need to derive your own class from it (see htlbox sample for the example), but you will only need to override a single {Wx::HTML::HtmlListBox#on_get_item} function.
+  # === Events emitted by this class
+  # 
+  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::HTML::HtmlLinkEvent} events.
+  # Event handler methods for events emitted by this class:
+  # - {Wx::EvtHandler#evt_html_cell_clicked}(id, meth = nil, &block): A {Wx::HTML::HtmlCell} was clicked. 
+  # - {Wx::EvtHandler#evt_html_cell_hover}(id, meth = nil, &block): The mouse passed over a {Wx::HTML::HtmlCell}. 
+  # - {Wx::EvtHandler#evt_html_link_clicked}(id, meth = nil, &block): A {Wx::HTML::HtmlCell} which contains a hyperlink was clicked. 
+  # 
+  # === 
+  # 
+  # Category:  {Wx::Controls}
+  # @see Wx::HTML::SimpleHtmlListBox 
+  # 
+  # 
+  class HtmlListBox < VListBox
+  
+    # @overload initialize(parent, id=Wx::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::HTML_LIST_BOX_NAME_STR)
+    #   Normal constructor which calls {Wx::HTML::HtmlListBox#create} internally.
+    #   @param parent [Wx::Window] 
+    #   @param id [Integer] 
+    #   @param pos [Array(Integer, Integer), Wx::Point] 
+    #   @param size [Array(Integer, Integer), Wx::Size] 
+    #   @param style [Integer] 
+    #   @param name [String] 
+    #   @return [HtmlListBox]
+    # @overload initialize()
+    #   Default constructor, you must call {Wx::HTML::HtmlListBox#create} later.
+    #   @return [HtmlListBox]
+    def initialize(*args) end
+    
+    # Creates the control and optionally sets the initial number of items in it (it may also be set or changed later with {Wx::VListBox#set_item_count}).
+    # There are no special styles defined for {Wx::HTML::HtmlListBox}, in particular the {Wx::ListBox} styles (with the exception of {Wx::LB_MULTIPLE}) cannot be used here.
+    # Returns true on success or false if the control couldn't be created
+    # @param parent [Wx::Window] 
+    # @param id [Integer] 
+    # @param pos [Array(Integer, Integer), Wx::Point] 
+    # @param size [Array(Integer, Integer), Wx::Size] 
+    # @param style [Integer] 
+    # @param name [String] 
+    # @return [true,false]
+    def create(parent, id=Wx::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::HTML_LIST_BOX_NAME_STR) end
+    
+  end # HtmlListBox
+  
+  # {Wx::HTML::SimpleHtmlListBox} is an implementation of {Wx::HTML::HtmlListBox} which shows HTML content in the listbox rows.
+  # Unlike {Wx::HTML::HtmlListBox}, this is not an abstract class and thus it has the advantage that you can use it without deriving your own class from it. However, it also has the disadvantage that this is not a virtual control and thus it's not well-suited for those cases where you need to show a huge number of items: every time you add/insert a string, it will be stored internally and thus will take memory.
+  # The interface exposed by {Wx::HTML::SimpleHtmlListBox} fully implements the {Wx::ControlWithItems} interface, thus you should refer to {Wx::ControlWithItems}'s documentation for the API reference for adding/removing/retrieving items in the listbox. Also note that the {Wx::VListBox#set_item_count} function is protected in {Wx::HTML::SimpleHtmlListBox}'s context so that you cannot call it directly, {Wx::HTML::SimpleHtmlListBox} will do it for you.
+  # Note: in case you need to append a lot of items to the control at once, make sure to use the Append(const wxArrayString&) function.
+  # Thus the only difference between a {Wx::ListBox} and a {Wx::HTML::SimpleHtmlListBox} is that the latter stores strings which can contain HTML fragments (see the list of tags supported by wxHTML).
+  # Note that the HTML strings you fetch to {Wx::HTML::SimpleHtmlListBox} should not contain the <code><html></code> or <code><body></code> tags.
+  # === Styles
+  # 
+  # This class supports the following styles:
+  #  
+  # - {Wx::HTML::HLB_DEFAULT_STYLE}: The default style: {Wx::Border::BORDER_SUNKEN} 
+  # - {Wx::HTML::HLB_MULTIPLE}: Multiple-selection list: the user can toggle multiple items on and off. 
+  # 
+  # A {Wx::HTML::SimpleHtmlListBox} emits the same events used by {Wx::ListBox} and by {Wx::HTML::HtmlListBox}.
+  # === Events emitted by this class
+  # 
+  # Event handler methods for events emitted by this class:
+  #  
+  # - {Wx::EvtHandler#evt_listbox}(id, meth = nil, &block): Process a {Wx::EVT_LISTBOX} event, when an item on the list is selected. See {Wx::CommandEvent}. 
+  # - {Wx::EvtHandler#evt_listbox_dclick}(id, meth = nil, &block): Process a {Wx::EVT_LISTBOX_DCLICK} event, when the listbox is double-clicked. See {Wx::CommandEvent}. 
+  # - {Wx::EvtHandler#evt_html_cell_clicked}(id, meth = nil, &block): A {Wx::HTML::HtmlCell} was clicked. See {Wx::HTML::HtmlCellEvent}. 
+  # - {Wx::EvtHandler#evt_html_cell_hover}(id, meth = nil, &block): The mouse passed over a {Wx::HTML::HtmlCell}. See {Wx::HTML::HtmlCellEvent}. 
+  # - {Wx::EvtHandler#evt_html_link_clicked}(id, meth = nil, &block): A {Wx::HTML::HtmlCell} which contains a hyperlink was clicked. See {Wx::HTML::HtmlLinkEvent} 
+  # 
+  # === 
+  # 
+  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table class='appearance'><tr><td> Generic Appearance
+  #   </td></tr></table></div>
+  # @see Wx::HTML::SimpleHtmlListBox#create 
+  # 
+  # 
+  class SimpleHtmlListBox < HtmlListBox
+  
+    # @overload create(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, choices=nil, style=Wx::HLB_DEFAULT_STYLE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::SIMPLE_HTML_LIST_BOX_NAME_STR)
+    #   Creates the HTML listbox for two-step construction.
+    #   See {Wx::HTML::SimpleHtmlListBox#simple_html_list_box} for further details.
+    #   @param parent [Wx::Window] 
+    #   @param id [Integer] 
+    #   @param pos [Array(Integer, Integer), Wx::Point] 
+    #   @param size [Array(Integer, Integer), Wx::Size] 
+    #   @param choices [Array<String>] 
+    #   @param style [Integer] 
+    #   @param validator [Wx::Validator] 
+    #   @param name [String] 
+    #   @return [true,false]
+    # @overload create(parent, id, pos, size, choices, style=Wx::HLB_DEFAULT_STYLE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::SIMPLE_HTML_LIST_BOX_NAME_STR)
+    #   Creates the HTML listbox for two-step construction.
+    #   See {Wx::HTML::SimpleHtmlListBox#simple_html_list_box} for further details.
+    #   @param parent [Wx::Window] 
+    #   @param id [Integer] 
+    #   @param pos [Array(Integer, Integer), Wx::Point] 
+    #   @param size [Array(Integer, Integer), Wx::Size] 
+    #   @param choices [Array<String>] 
+    #   @param style [Integer] 
+    #   @param validator [Wx::Validator] 
+    #   @param name [String] 
+    #   @return [true,false]
+    def create(*args) end
+    
+    # @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, choices=nil, style=Wx::HLB_DEFAULT_STYLE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::SIMPLE_HTML_LIST_BOX_NAME_STR)
+    #   Constructor, creating and showing the HTML list box.
+    #   @param parent [Wx::Window]  Parent window. Must not be NULL.
+    #   @param id [Integer]  Window identifier. A value of -1 indicates a default value.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  Window position. If {Wx::DEFAULT_POSITION} is specified then a default position is chosen.
+    #   @param size [Array(Integer, Integer), Wx::Size]  Window size. If {Wx::DEFAULT_SIZE} is specified then the window is sized appropriately.
+    #   @param choices [Array<String>]  An array of strings with which to initialise the control.
+    #   @param style [Integer]  Window style. See {Wx::HLB_}* flags.
+    #   @param validator [Wx::Validator]  Window validator.
+    #   @param name [String]  Window name.
+    #   @return [SimpleHtmlListBox]
+    # @overload initialize(parent, id, pos, size, choices, style=Wx::HLB_DEFAULT_STYLE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::SIMPLE_HTML_LIST_BOX_NAME_STR)
+    #   Constructor, creating and showing the HTML list box.
+    #   @param parent [Wx::Window]  Parent window. Must not be NULL.
+    #   @param id [Integer]  Window identifier. A value of -1 indicates a default value.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  Window position.
+    #   @param size [Array(Integer, Integer), Wx::Size]  Window size. If {Wx::DEFAULT_SIZE} is specified then the window is sized appropriately.
+    #   @param choices [Array<String>]  An array of strings with which to initialise the control.
+    #   @param style [Integer]  Window style. See {Wx::HLB_}* flags.
+    #   @param validator [Wx::Validator]  Window validator.
+    #   @param name [String]  Window name.
+    #   @return [SimpleHtmlListBox]
+    # @overload initialize()
+    #   Default constructor, you must call {Wx::HTML::SimpleHtmlListBox#create} later.
+    #   @return [SimpleHtmlListBox]
+    def initialize(*args) end
+    
+  end # SimpleHtmlListBox
+  
+
+end

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

@@ -0,0 +1,87 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx::HTML
+
+  # This class serves as printout class for HTML documents.
+  # === 
+  # 
+  # Category:  {Wx::HTML}, Printing Framework
+  # 
+  class HtmlPrintout < Printout
+  
+    # Constructor.
+    # @param title [String] 
+    # @return [HtmlPrintout]
+    def initialize(title=("Wx::PRINTOUT")) end
+    
+    # This function sets font sizes and faces.
+    # See {Wx::HTML::HtmlWindow#set_fonts} for detailed description.
+    # @param normal_face [String] 
+    # @param fixed_face [String] 
+    # @param sizes [Array(Integer,Integer,Integer,Integer,Integer,Integer,Integer), nil] 
+    # @return [void]
+    def set_fonts(normal_face, fixed_face, sizes=nil) end
+    
+    # Set page footer.
+    # The following macros can be used inside it:
+    # - @DATE@ is replaced by the current date in default format- @PAGENUM@ is replaced by page number- @PAGESCNT@ is replaced by total number of pages- @TIME@ is replaced by the current time in default format- @TITLE@ is replaced with the title of the document
+    # @param footer [String]  HTML text to be used as footer.
+    # @param pg [Integer]  one of {Wx::HTML::PAGE_ODD}, {Wx::HTML::PAGE_EVEN} and {Wx::HTML::PAGE_ALL} constants.
+    # @return [void]
+    def set_footer(footer, pg=Wx::PAGE_ALL) end
+    alias_method :footer=, :set_footer
+    
+    # Set page header.
+    # The following macros can be used inside it:
+    # - @DATE@ is replaced by the current date in default format- @PAGENUM@ is replaced by page number- @PAGESCNT@ is replaced by total number of pages- @TIME@ is replaced by the current time in default format- @TITLE@ is replaced with the title of the document
+    # @param header [String]  HTML text to be used as header.
+    # @param pg [Integer]  one of {Wx::HTML::PAGE_ODD}, {Wx::HTML::PAGE_EVEN} and {Wx::HTML::PAGE_ALL} constants.
+    # @return [void]
+    def set_header(header, pg=Wx::PAGE_ALL) end
+    alias_method :header=, :set_header
+    
+    # Prepare the class for printing this HTML <b>file</b>.
+    # The file may be located on any virtual file system or it may be normal file.
+    # @param htmlfile [String] 
+    # @return [void]
+    def set_html_file(htmlfile) end
+    alias_method :html_file=, :set_html_file
+    
+    # Prepare the class for printing this HTML text.
+    # @param html [String]  HTML text. (NOT file!)
+    # @param basepath [String]  base directory (html string would be stored there if it was in file). It is used to determine path for loading images, for example.
+    # @param isdir [true,false]  false if basepath is filename, true if it is directory name (see {Wx::FileSystem} for detailed explanation).
+    # @return [void]
+    def set_html_text(html, basepath=Wx::EMPTY_STRING, isdir=true) end
+    alias_method :html_text=, :set_html_text
+    
+    # @overload set_margins(top=25.2, bottom=25.2, left=25.2, right=25.2, spaces=5)
+    #   Sets margins in millimeters.
+    #   Defaults to 1 inch for margins and 0.5cm for space between text and header and/or footer.
+    #   @param top [Float] 
+    #   @param bottom [Float] 
+    #   @param left [Float] 
+    #   @param right [Float] 
+    #   @param spaces [Float] 
+    #   @return [void]
+    # @overload set_margins(pageSetupData)
+    #   Sets margins from {Wx::PRT::PageSetupDialogData}.
+    #   @param pageSetupData [Wx::PageSetupDialogData] 
+    #   @return [void]
+    def set_margins(*args) end
+    alias_method :margins=, :set_margins
+    
+    # Adds a filter to the static list of filters for {Wx::HTML::HtmlPrintout}.
+    # See {Wx::HTML::HtmlFilter} for further information.
+    # @param filter [Wx::HtmlFilter] 
+    # @return [void]
+    def self.add_filter(filter) end
+    
+  end # HtmlPrintout
+  
+
+end