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

data/lib/wx/doc/gen/grid_sizer.rb

@@ -0,0 +1,135 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # A grid sizer is a sizer which lays out its children in a two-dimensional table with all table fields having the same size, i.e.
+  # the width of each field is the width of the widest child, the height of each field is the height of the tallest child.
+  # === 
+  # 
+  # Category:  Window Layout
+  # @see Wx::Sizer
+  # @see  Sizers Overview 
+  # 
+  # 
+  class GridSizer < Sizer
+  
+    # @overload initialize(cols, vgap, hgap)
+    #   {Wx::GridSizer} constructors.
+    #   Usually only the number of columns in the flex grid sizer needs to be specified using cols argument. The number of rows will be deduced automatically depending on the number of the elements added to the sizer.
+    #   If a constructor form with rows parameter is used (and the value of rows argument is not zero, meaning "unspecified") the sizer will check that no more than <code>cols*rows</code> elements are added to it, i.e. that no more than the given number of rows is used. Adding less than maximally allowed number of items is not an error however.
+    #   Finally, it is also possible to specify the number of rows and use 0 for cols. In this case, the sizer will use the given fixed number of rows and as many columns as necessary.
+    #   The gap (or vgap and hgap, which correspond to the height and width of the {Wx::Size} object) argument defines the size of the padding between the rows (its vertical component, or vgap) and columns (its horizontal component, or hgap), in pixels.
+    #   @param cols [Integer] 
+    #   @param vgap [Integer] 
+    #   @param hgap [Integer] 
+    #   @return [GridSizer]
+    # @overload initialize(cols, gap=(Wx::Size.new(0, 0)))
+    #   {Wx::GridSizer} constructors.
+    #   Usually only the number of columns in the flex grid sizer needs to be specified using cols argument. The number of rows will be deduced automatically depending on the number of the elements added to the sizer.
+    #   If a constructor form with rows parameter is used (and the value of rows argument is not zero, meaning "unspecified") the sizer will check that no more than <code>cols*rows</code> elements are added to it, i.e. that no more than the given number of rows is used. Adding less than maximally allowed number of items is not an error however.
+    #   Finally, it is also possible to specify the number of rows and use 0 for cols. In this case, the sizer will use the given fixed number of rows and as many columns as necessary.
+    #   The gap (or vgap and hgap, which correspond to the height and width of the {Wx::Size} object) argument defines the size of the padding between the rows (its vertical component, or vgap) and columns (its horizontal component, or hgap), in pixels.
+    #   @param cols [Integer] 
+    #   @param gap [Array(Integer, Integer), Wx::Size] 
+    #   @return [GridSizer]
+    # @overload initialize(rows, cols, vgap, hgap)
+    #   {Wx::GridSizer} constructors.
+    #   Usually only the number of columns in the flex grid sizer needs to be specified using cols argument. The number of rows will be deduced automatically depending on the number of the elements added to the sizer.
+    #   If a constructor form with rows parameter is used (and the value of rows argument is not zero, meaning "unspecified") the sizer will check that no more than <code>cols*rows</code> elements are added to it, i.e. that no more than the given number of rows is used. Adding less than maximally allowed number of items is not an error however.
+    #   Finally, it is also possible to specify the number of rows and use 0 for cols. In this case, the sizer will use the given fixed number of rows and as many columns as necessary.
+    #   The gap (or vgap and hgap, which correspond to the height and width of the {Wx::Size} object) argument defines the size of the padding between the rows (its vertical component, or vgap) and columns (its horizontal component, or hgap), in pixels.
+    #   @param rows [Integer] 
+    #   @param cols [Integer] 
+    #   @param vgap [Integer] 
+    #   @param hgap [Integer] 
+    #   @return [GridSizer]
+    # @overload initialize(rows, cols, gap)
+    #   {Wx::GridSizer} constructors.
+    #   Usually only the number of columns in the flex grid sizer needs to be specified using cols argument. The number of rows will be deduced automatically depending on the number of the elements added to the sizer.
+    #   If a constructor form with rows parameter is used (and the value of rows argument is not zero, meaning "unspecified") the sizer will check that no more than <code>cols*rows</code> elements are added to it, i.e. that no more than the given number of rows is used. Adding less than maximally allowed number of items is not an error however.
+    #   Finally, it is also possible to specify the number of rows and use 0 for cols. In this case, the sizer will use the given fixed number of rows and as many columns as necessary.
+    #   The gap (or vgap and hgap, which correspond to the height and width of the {Wx::Size} object) argument defines the size of the padding between the rows (its vertical component, or vgap) and columns (its horizontal component, or hgap), in pixels.
+    #   @param rows [Integer] 
+    #   @param cols [Integer] 
+    #   @param gap [Array(Integer, Integer), Wx::Size] 
+    #   @return [GridSizer]
+    def initialize(*args) end
+    
+    # Returns the number of columns that has been specified for the sizer.
+    # Returns zero if the sizer is automatically adjusting the number of columns depending on number of its children. To get the effective number of columns or rows being currently used, see {Wx::GridSizer#get_effective_cols_count}
+    # @return [Integer]
+    def get_cols; end
+    alias_method :cols, :get_cols
+    
+    # Returns the number of rows that has been specified for the sizer.
+    # Returns zero if the sizer is automatically adjusting the number of rows depending on number of its children. To get the effective number of columns or rows being currently used, see {Wx::GridSizer#get_effective_rows_count}.
+    # @return [Integer]
+    def get_rows; end
+    alias_method :rows, :get_rows
+    
+    # Returns the number of columns currently used by the sizer.
+    # This will depend on the number of children the sizer has if the sizer is automatically adjusting the number of columns/rows.
+    # @return [Integer]
+    def get_effective_cols_count; end
+    alias_method :effective_cols_count, :get_effective_cols_count
+    
+    # Returns the number of rows currently used by the sizer.
+    # This will depend on the number of children the sizer has if the sizer is automatically adjusting the number of columns/rows.
+    # @return [Integer]
+    def get_effective_rows_count; end
+    alias_method :effective_rows_count, :get_effective_rows_count
+    
+    # Returns the horizontal gap (in pixels) between cells in the sizer.
+    # @return [Integer]
+    def get_h_gap; end
+    alias_method :h_gap, :get_h_gap
+    
+    # Returns the vertical gap (in pixels) between the cells in the sizer.
+    # @return [Integer]
+    def get_v_gap; end
+    alias_method :v_gap, :get_v_gap
+    
+    # Sets the number of columns in the sizer.
+    # @param cols [Integer] 
+    # @return [void]
+    def set_cols(cols) end
+    alias_method :cols=, :set_cols
+    
+    # Sets the horizontal gap (in pixels) between cells in the sizer.
+    # @param gap [Integer] 
+    # @return [void]
+    def set_h_gap(gap) end
+    alias_method :h_gap=, :set_h_gap
+    
+    # Sets the number of rows in the sizer.
+    # @param rows [Integer] 
+    # @return [void]
+    def set_rows(rows) end
+    alias_method :rows=, :set_rows
+    
+    # Sets the vertical gap (in pixels) between the cells in the sizer.
+    # @param gap [Integer] 
+    # @return [void]
+    def set_v_gap(gap) end
+    alias_method :v_gap=, :set_v_gap
+    
+    # This method is abstract and has to be overwritten by any derived class.
+    # Here, the sizer will do the actual calculation of its children's minimal sizes.
+    # @return [Wx::Size]
+    def calc_min; end
+    
+    # Method which must be overridden in the derived sizer classes.
+    # The implementation should reposition the children using the current total size available to the sizer (m_size) and the size computed by the last call to {Wx::GridSizer#calc_min}.
+    # Note that you should never call this method directly, call {Wx::GridSizer#layout} instead if you need to manually update the sizer elements positions. This method is only called by wxWidgets itself.
+    # @param minSize [Array(Integer, Integer), Wx::Size] 
+    # @return [void]
+    def reposition_children(minSize) end
+    
+  end # GridSizer
+  
+
+end

data/lib/wx/doc/gen/help_controller.rb

@@ -0,0 +1,136 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  HELP_NETSCAPE = 1
+  
+  # Help search modes for {Wx::HelpController#keyword_search}.
+  # 
+  # 
+  # 
+  class HelpSearchMode < Wx::Enum
+  
+    # Search the index only.
+    # 
+    HELP_SEARCH_INDEX = Wx::HelpSearchMode.new(0)
+    
+    # Search all entries.
+    # 
+    HELP_SEARCH_ALL = Wx::HelpSearchMode.new(1)
+    
+  end # HelpSearchMode
+  
+  # This is an alias for one of a family of help controller classes which is most appropriate for the current platform.
+  # A help controller allows an application to display help, at the contents or at a particular topic, and shut the help program down on termination. This avoids proliferation of many instances of the help viewer whenever the user requests a different topic via the application's menus or buttons.
+  # Typically, an application will create a help controller instance when it starts, and immediately call {Wx::HelpController::Initialize} to associate a filename with it. The help viewer will only get run, however, just before the first call to display something.
+  # Most help controller classes actually derive from {Wx::HelpControllerBase} and have names of the form {Wx::XXXHelpController} or {Wx::HelpControllerXXX}. An appropriate class is aliased to the name {Wx::HelpController} for each platform, as follows:
+  # - On desktop Windows, {Wx::CHMHelpController} is used (MS HTML Help).- On all other platforms, {Wx::HTML::HtmlHelpController} is used if {Wx::HTML} is compiled into wxWidgets; otherwise {Wx::ExtHelpController} is used (for invoking an external browser).
+  # 
+  # The remaining help controller classes need to be named explicitly by an application that wishes to make use of them.
+  # The following help controller classes are defined:
+  # - {Wx::WinHelpController}, for controlling Windows Help.- {Wx::CHMHelpController}, for controlling MS HTML Help. To use this, you need to set {Wx::Setup::USE_MS_HTML_HELP} to 1 in setup.h and have the htmlhelp.h header from Microsoft's HTML Help kit. (You don't need the VC++-specific htmlhelp.lib because wxWidgets loads necessary DLL at runtime and so it works with all compilers.)- {Wx::BestHelpController}, for controlling MS HTML Help or, if Microsoft's runtime is not available, {Wx::HTML::HtmlHelpController}. You need to provide <b>both</b> CHM and HTB versions of the help file. For {Wx::MSW} only.- {Wx::ExtHelpController}, for controlling external browsers under Unix. The default browser is Netscape Navigator. The 'help' sample shows its use.- {Wx::HTML::HtmlHelpController}, a sophisticated help controller using {Wx::HTML}, in a similar style to the Microsoft HTML Help viewer and using some of the same files. Although it has an API compatible with other help controllers, it has more advanced features, so it is recommended that you use the specific API for this class instead. Note that if you use .zip or .htb formats for your books, you must add this line to your application initialization: 
+  # 
+  # wxFileSystem::AddHandler(new wxArchiveFSHandler); 
+  # or nothing will be shown in your help window.
+  # 
+  # === 
+  # 
+  # Category:  {Wx::HELP}
+  # @see Wx::HTML::HtmlHelpController
+  # @see  wxHTML Overview 
+  # 
+  # 
+  class HelpController < Object
+  
+    # Constructs a help instance object, but does not invoke the help viewer.
+    # If you provide a window, it will be used by some help controller classes, such as {Wx::CHMHelpController}, {Wx::WinHelpController} and {Wx::HTML::HtmlHelpController}, as the parent for the help window instead of the value of {Wx::App#get_top_window}.
+    # You can also change the parent window later with {Wx::HelpController#set_parent_window}.
+    # @param parentWindow [Wx::Window] 
+    # @return [HelpController]
+    def initialize(parentWindow=nil) end
+    
+    # If the help viewer is not running, runs it and displays the contents.
+    # @return [true,false]
+    def display_contents; end
+    
+    # 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
+    
+    # If the help viewer is not running, runs it, and searches for sections matching the given keyword.
+    # If one match is found, the file is displayed at this section. The optional parameter allows searching the index ({Wx::HelpSearchMode::HELP_SEARCH_INDEX}) but this currently is only supported by the {Wx::HTML::HtmlHelpController}.
+    # 
+    # - WinHelp, MS HTML Help: If more than one match is found, the first topic is displayed.- MS HTML Help: Pass an empty string to display the search page.- External HTML help, simple {Wx::HTML} help: If more than one match is found, a choice of topics is displayed.- {Wx::HTML::HtmlHelpController}: see {Wx::HTML::HtmlHelpController::KeywordSearch}.
+    # @param keyWord [String] 
+    # @param mode [HelpSearchMode] 
+    # @return [true,false]
+    def keyword_search(keyWord, mode=Wx::HELP_SEARCH_ALL) 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 # HelpController
+  
+
+end

data/lib/wx/doc/gen/help_provider.rb

@@ -0,0 +1,80 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # {Wx::HelpProvider} is an abstract class used by a program implementing context-sensitive help to show the help text for the given window.
+  # The current help provider must be explicitly set by the application using {Wx::HelpProvider.set}.
+  # === 
+  # 
+  # Category:  {Wx::HELP}
+  # @see Wx::ContextHelp
+  # @see  Wx::ContextHelpButton
+  # @see  Wx::SimpleHelpProvider
+  # @see  Wx::HelpControllerHelpProvider
+  # @see  Wx::Window#set_help_text
+  # @see  Wx::Window#get_help_text_at_point 
+  # 
+  # 
+  class HelpProvider < ::Object
+  
+    # @overload add_help(window, text)
+    #   Associates the text with the given window.
+    #   Although all help providers have these functions to allow making {Wx::Window#set_help_text} work, not all of them implement the functions.
+    #   @param window [Wx::Window] 
+    #   @param text [String] 
+    #   @return [void]
+    # @overload add_help(id, text)
+    #   Associates the text with the given ID.
+    #   This help text will be shown for all windows with ID id, unless they have more specific help text associated using the other {Wx::HelpProvider#add_help} prototype. May be used to set the same help string for all Cancel buttons in the application, for example.
+    #   Although all help providers have these functions to allow making {Wx::Window#set_help_text} work, not all of them implement the functions.
+    #   @param id [Integer] 
+    #   @param text [String] 
+    #   @return [void]
+    def add_help(*args) end
+    
+    # This version associates the given text with all windows with this id.
+    # May be used to set the same help string for all Cancel buttons in the application, for example.
+    # @param window [Wx::Window] 
+    # @return [String]
+    def get_help(window) end
+    alias_method :help, :get_help
+    
+    # Removes the association between the window pointer and the help text.
+    # This is called by the {Wx::Window} destructor. Without this, the table of help strings will fill up and when window pointers are reused, the wrong help string will be found.
+    # @param window [Wx::Window] 
+    # @return [void]
+    def remove_help(window) end
+    
+    # Shows help for the given window.
+    # Override this function if the help doesn't depend on the exact position inside the window, otherwise you need to override {Wx::HelpProvider#show_help_at_point}. Returns true if help was shown, or false if no help was available for this window.
+    # @param window [Wx::Window] 
+    # @return [true,false]
+    def show_help(window) end
+    
+    # This function may be overridden to show help for the window when it should depend on the position inside the window, By default this method forwards to {Wx::HelpProvider#show_help}, so it is enough to only implement the latter if the help doesn't depend on the position.
+    # true if help was shown, or false if no help was available for this window.
+    # @param window [Wx::Window]  Window to show help text for.
+    # @param point [Array(Integer, Integer), Wx::Point]  Coordinates of the mouse at the moment of help event emission.
+    # @param origin [Wx::HelpEvent::Origin]  Help event origin, see {Wx::HelpEvent#get_origin}.
+    # @return [true,false]
+    def show_help_at_point(window, point, origin) end
+    
+    # Returns pointer to help provider instance.
+    # Unlike some other classes, the help provider is not created on demand. This must be explicitly done by the application using {Wx::HelpProvider.set}.
+    # @return [Wx::HelpProvider]
+    def self.get; end
+    
+    # Set the current, application-wide help provider.
+    # Pointer to previous help provider or NULL if there wasn't any.
+    # @param helpProvider [Wx::HelpProvider] 
+    # @return [Wx::HelpProvider]
+    def self.set(helpProvider) end
+    
+  end # HelpProvider
+  
+
+end

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

@@ -0,0 +1,46 @@
+# ----------------------------------------------------------------------------
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# ----------------------------------------------------------------------------
+
+
+class Wx::EvtHandler
+
+  # @!group HTML Event handler methods
+  
+  # The mouse passed over a {Wx::HTML::HtmlCell}. See {Wx::HTML::HtmlCellEvent}. 
+  # Processes a {Wx::HTML::EVT_HTML_CELL_HOVER} event.
+  # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+  # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+  # @yieldparam [Wx::HTML::HtmlCellEvent] event the event to handle
+  def evt_html_cell_hover(id, meth = nil, &block) end
+  
+  # A {Wx::HTML::HtmlCell} was clicked. See {Wx::HTML::HtmlCellEvent}. 
+  # Processes a {Wx::HTML::EVT_HTML_CELL_CLICKED} event.
+  # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+  # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+  # @yieldparam [Wx::HTML::HtmlCellEvent] event the event to handle
+  def evt_html_cell_clicked(id, meth = nil, &block) end
+  
+  # A {Wx::HTML::HtmlCell} which contains a hyperlink was clicked. See {Wx::HTML::HtmlLinkEvent} 
+  # Processes a {Wx::HTML::EVT_HTML_LINK_CLICKED} event.
+  # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+  # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+  # @yieldparam [Wx::HTML::HtmlLinkEvent] event the event to handle
+  def evt_html_link_clicked(id, meth = nil, &block) end
+  
+  # Process a {Wx::EVT_LISTBOX} event, when an item on the list is selected. See {Wx::CommandEvent}. 
+  # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+  # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+  # @yieldparam [Wx::HTML::SimpleHtmlListBox] event the event to handle
+  def evt_listbox(id, meth = nil, &block) end
+  
+  # Process a {Wx::EVT_LISTBOX_DCLICK} event, when the listbox is double-clicked. See {Wx::CommandEvent}. 
+  # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+  # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+  # @yieldparam [Wx::HTML::SimpleHtmlListBox] event the event to handle
+  def evt_listbox_dclick(id, meth = nil, &block) end
+  
+  # @!endgroup
+
+end