wxruby3 1.6.1 → 1.7.0

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

@@ -0,0 +1,133 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  # 
+  HD_ALLOW_REORDER = 1
+  
+  # 
+  # 
+  HD_ALLOW_HIDE = 2
+  
+  # 
+  # 
+  HD_BITMAP_ON_RIGHT = 4
+  
+  # 
+  # 
+  HD_DEFAULT_STYLE = 1
+  
+  # 
+  # 
+  EVT_HEADER_CLICK = 10165
+  
+  # 
+  # 
+  EVT_HEADER_RIGHT_CLICK = 10166
+  
+  # 
+  # 
+  EVT_HEADER_MIDDLE_CLICK = 10167
+  
+  # 
+  # 
+  EVT_HEADER_DCLICK = 10168
+  
+  # 
+  # 
+  EVT_HEADER_RIGHT_DCLICK = 10169
+  
+  # 
+  # 
+  EVT_HEADER_MIDDLE_DCLICK = 10170
+  
+  # 
+  # 
+  EVT_HEADER_SEPARATOR_DCLICK = 10171
+  
+  # 
+  # 
+  EVT_HEADER_BEGIN_RESIZE = 10172
+  
+  # 
+  # 
+  EVT_HEADER_RESIZING = 10173
+  
+  # 
+  # 
+  EVT_HEADER_END_RESIZE = 10174
+  
+  # 
+  # 
+  EVT_HEADER_BEGIN_REORDER = 10175
+  
+  # 
+  # 
+  EVT_HEADER_END_REORDER = 10176
+  
+  # 
+  # 
+  EVT_HEADER_DRAGGING_CANCELLED = 10177
+  
+  # Event class representing the events generated by {Wx::HeaderCtrl}.
+  # 
+  # Category:  {Wx::Events}
+  # @see Wx::HeaderCtrl 
+  # 
+  # 
+  class HeaderCtrlEvent < NotifyEvent
+  
+    # @overload initialize(commandType=Wx::EVT_NULL, winid=0)
+    #   @param commandType [Wx::TipWindow::EventType] 
+    #   @param winid [Integer] 
+    #   @return [Wx::HeaderCtrlEvent]
+    # @overload initialize(event)
+    #   @param event [Wx::HeaderCtrlEvent] 
+    #   @return [Wx::HeaderCtrlEvent]
+    def initialize(*args) end
+    
+    # Return the index of the column affected by this event.
+    # 
+    # This method can be called for all header control events.
+    # @return [Integer]
+    def get_column; end
+    alias_method :column, :get_column
+    
+    # @param col [Integer] 
+    # @return [void]
+    def set_column(col) end
+    alias_method :column=, :set_column
+    
+    # Return the current width of the column.
+    # 
+    # This method can only be called for the dragging events.
+    # @return [Integer]
+    def get_width; end
+    alias_method :width, :get_width
+    
+    # @param width [Integer] 
+    # @return [void]
+    def set_width(width) end
+    alias_method :width=, :set_width
+    
+    # Return the new order of the column.
+    # 
+    # This method can only be called for a reorder event for which it indicates the tentative new position for the column {Wx::HeaderCtrlEvent#get_column} selected by the user. If the event is not vetoed, this will become the new column position in {Wx::HeaderCtrl#get_columns_order}.
+    # @return [Integer]
+    def get_new_order; end
+    alias_method :new_order, :get_new_order
+    
+    # @param order [Integer] 
+    # @return [void]
+    def set_new_order(order) end
+    alias_method :new_order=, :set_new_order
+    
+  end # HeaderCtrlEvent
+  
+
+end

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

@@ -0,0 +1,195 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  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
+  
+  # 
+  HELP_NETSCAPE = 1
+  
+  # Help search modes for {Wx::HelpController#keyword_search}.
+  # 
+  # 
+  # 
+  # @wxrb_require USE_HELP
+  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 WXMSW 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 in Ruby the required filesystem handlers for .zip or .htb books are always loaded. 
+  # 
+  # Category:  {Wx::HELP}
+  # @see Wx::HTML::HtmlHelpController
+  # @see  wxHTML Overview 
+  # 
+  # 
+  # @wxrb_require USE_HELP
+  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 [Wx::HelpController]
+    def initialize(parentWindow=nil) end
+    
+    # If the help viewer is not running, runs it and displays the contents.
+    # @return [Boolean]
+    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 [Boolean]
+    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 [Boolean]
+    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 [Boolean]
+    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 [Wx::HelpSearchMode] 
+    # @return [Boolean]
+    def keyword_search(keyWord, mode=Wx::HelpSearchMode::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 [Boolean] 
+    # @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:
+    # 
+    # ```ruby
+    #   @help.set_viewer('kdehelp')
+    #   @help.set_viewer('gnome-help-browser')
+    #   @help.set_viewer('netscape', Wx::HELP_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,98 @@
+# :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 
+  # 
+  # 
+  # @wxrb_require USE_HELP
+  class HelpProvider < ::Object
+  
+    # @overload add_help(window, text)
+    #   Associates the text with the given window.
+    #   
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>Although all help providers have these functions to allow making {Wx::Window#set_help_text} work, not all of them implement the functions. 
+    #   </p>
+    #   </div>
+    #   @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.
+    #   
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>Although all help providers have these functions to allow making {Wx::Window#set_help_text} work, not all of them implement the functions. 
+    #   </p>
+    #   </div>
+    #   @param id [Integer] 
+    #   @param text [String] 
+    #   @return [void]
+    def add_help(*args) end
+    
+    # Get the help string for the given window.
+    # 
+    # The interpretation of the returned string is help provider dependent, but empty string always means that no help is associated with this window.
+    # @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 [Boolean]
+    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 [Boolean]
+    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 nil 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,38 @@
+# ----------------------------------------------------------------------------
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# ----------------------------------------------------------------------------
+
+
+module Wx
+
+  class 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
+    
+    # @!endgroup
+
+  end
+
+end