wxruby3 1.7.0 → 1.8.0

data/lib/wx/doc/gen/aui/aui_tool_bar_event.rb

@@ -10,23 +10,23 @@ module Wx
 
     # 
     # 
-    EVT_AUITOOLBAR_TOOL_DROPDOWN = 10367
+    EVT_AUITOOLBAR_TOOL_DROPDOWN = 10370
     
     # 
     # 
-    EVT_AUITOOLBAR_OVERFLOW_CLICK = 10368
+    EVT_AUITOOLBAR_OVERFLOW_CLICK = 10371
     
     # 
     # 
-    EVT_AUITOOLBAR_RIGHT_CLICK = 10369
+    EVT_AUITOOLBAR_RIGHT_CLICK = 10372
     
     # 
     # 
-    EVT_AUITOOLBAR_MIDDLE_CLICK = 10370
+    EVT_AUITOOLBAR_MIDDLE_CLICK = 10373
     
     # 
     # 
-    EVT_AUITOOLBAR_BEGIN_DRAG = 10371
+    EVT_AUITOOLBAR_BEGIN_DRAG = 10374
     
     # {Wx::AUI::AuiToolBarStyle} is part of the {Wx::AUI} class framework, used to define the appearance of a {Wx::AUI::AuiToolBar}.
     # 

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

@@ -193,8 +193,9 @@ module Wx
     # @return [Boolean]
     def insert_page(index, page, text, select=false, imageId=Wx::AUI::AuiNotebook::NO_IMAGE) end
     
-    # Deletes the specified page, without deleting the associated window.
+    # Deletes the specified page, without deleting the associated window The window will be hidden, though, so you may need to call {Wx::BookCtrlBase#show} after e.g.
     # 
+    # reparenting it.
     # See {Wx::BookCtrlBase#delete_page} for a note about the events generated by this function.
     # @param page [Integer] 
     # @return [Boolean]

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

@@ -98,23 +98,23 @@ module Wx
   
   # 
   # 
-  EVT_CALENDAR_SEL_CHANGED = 10251
+  EVT_CALENDAR_SEL_CHANGED = 10254
   
   # 
   # 
-  EVT_CALENDAR_PAGE_CHANGED = 10252
+  EVT_CALENDAR_PAGE_CHANGED = 10255
   
   # 
   # 
-  EVT_CALENDAR_DOUBLECLICKED = 10253
+  EVT_CALENDAR_DOUBLECLICKED = 10256
   
   # 
   # 
-  EVT_CALENDAR_WEEKDAY_CLICKED = 10254
+  EVT_CALENDAR_WEEKDAY_CLICKED = 10257
   
   # 
   # 
-  EVT_CALENDAR_WEEK_CLICKED = 10255
+  EVT_CALENDAR_WEEK_CLICKED = 10258
   
   # The {Wx::CalendarEvent} class is used together with {Wx::CalendarCtrl}.
   # 

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

@@ -26,11 +26,11 @@ module Wx
   
   # 
   # 
-  EVT_CHOICEBOOK_PAGE_CHANGED = 10232
+  EVT_CHOICEBOOK_PAGE_CHANGED = 10235
   
   # 
   # 
-  EVT_CHOICEBOOK_PAGE_CHANGING = 10231
+  EVT_CHOICEBOOK_PAGE_CHANGING = 10234
   
   # {Wx::Choicebook} is a class similar to {Wx::Notebook}, but uses a {Wx::Choice} control to show the labels instead of the tabs.
   # 

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

@@ -14,7 +14,7 @@ module Wx
   
   # 
   # 
-  EVT_COLLAPSIBLEPANE_CHANGED = 10145
+  EVT_COLLAPSIBLEPANE_CHANGED = 10148
   
   # A collapsible pane is a container with an embedded button-like control which can be used by the user to collapse or expand the pane's contents.
   # 

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

@@ -8,7 +8,7 @@ module Wx
 
   # 
   # 
-  EVT_COLOUR_CHANGED = 10151
+  EVT_COLOUR_CHANGED = 10154
   
   # Shows the colour selection dialog and returns the colour selected by user or invalid colour (use {Wx::Colour#is_ok} to test whether a colour is valid) if the dialog was cancelled.
   # @param parent [Wx::Window]  The parent window for the colour selection dialog.

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

@@ -20,15 +20,15 @@ module Wx
   
   # 
   # 
-  EVT_COLOURPICKER_CHANGED = 10148
+  EVT_COLOURPICKER_CHANGED = 10151
   
   # 
   # 
-  EVT_COLOURPICKER_CURRENT_CHANGED = 10149
+  EVT_COLOURPICKER_CURRENT_CHANGED = 10152
   
   # 
   # 
-  EVT_COLOURPICKER_DIALOG_CANCELLED = 10150
+  EVT_COLOURPICKER_DIALOG_CANCELLED = 10153
   
   # This event class is used for the events generated by {Wx::ColourPickerCtrl}.
   # 

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

@@ -52,58 +52,5 @@ module Wx
     
   end # ContextHelpButton
   
-  # This class changes the cursor to a query and puts the application into a 'context-sensitive help mode'.
-  # 
-  # When the user left-clicks on a window within the specified window, a {Wx::EVT_HELP} event is sent to that control, and the application may respond to it by popping up some help.
-  # For example: 
-  # ```ruby
-  #   # puts the application into a 'context-sensitive help mode' for my_window
-  #   context_help = Wx::ContextHelp.new(my_window)
-  #   ...
-  #   ...
-  #   # ends the 'context-sensitive help mode' for my_window
-  #   context_help.end_context_help            
-  # ```
-  # 
-  # There are a couple of ways to invoke this behaviour implicitly:
-  # 
-  # - Use the {Wx::DIALOG_EX_CONTEXTHELP} style for a dialog (Windows only). This will put a question mark in the titlebar, and Windows will put the application into context-sensitive help mode automatically, with further programming.
-  # - Create a {Wx::ContextHelpButton}, whose predefined behaviour is to create a context help object. Normally you will write your application so that this button is only added to a dialog for non-Windows platforms (use {Wx::DIALOG_EX_CONTEXTHELP} on Windows).
-  # 
-  # Note that on macOS, the cursor does not change when in context-sensitive help mode.
-  # 
-  # Category:  {Wx::HELP}
-  # @see Wx::HelpEvent
-  # @see  Wx::HelpController
-  # @see  Wx::ContextHelpButton 
-  # 
-  # 
-  # @wxrb_require USE_HELP
-  class ContextHelp < Object
-  
-    # Constructs a context help object, calling {Wx::ContextHelp#begin_context_help} if doNow is true (the default).
-    # 
-    # If window is nil, the top window is used.
-    # @param window [Wx::Window] 
-    # @param doNow [Boolean] 
-    # @return [Wx::ContextHelp]
-    def initialize(window=nil, doNow=true) end
-    
-    # Puts the application into context-sensitive help mode.
-    # 
-    # window is the window which will be used to catch events; if nil, the top window will be used.
-    # Returns true if the application was successfully put into context-sensitive help mode. This function only returns when the event loop has finished.
-    # @param window [Wx::Window] 
-    # @return [Boolean]
-    def begin_context_help(window) end
-    
-    # Ends context-sensitive help mode.
-    # 
-    # Not normally called by the application.
-    # @return [Boolean]
-    def end_context_help; end
-    
-  end # ContextHelp
-  
 
 end

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

@@ -7,19 +7,19 @@
 module Wx
 
   # wxRuby version string
-  WXRUBY_VERSION = '1.7.0'
+  WXRUBY_VERSION = '1.8.0'
 
   # wxRuby version release type (alpha, beta, rc)
   WXRUBY_RELEASE_TYPE = ''
   # wxRuby major version number
   WXRUBY_MAJOR = 1
   # wxRuby minor version number
-  WXRUBY_MINOR = 7
+  WXRUBY_MINOR = 8
   # wxRuby release number
   WXRUBY_RELEASE = 0
 
   # Convenience string for WxWidgets version info
-  WXWIDGETS_VERSION = '3.3.2'
+  WXWIDGETS_VERSION = '3.3.3'
 
   # Integer constant reflecting the major version of the wxWidgets release used to build wxRuby
   WXWIDGETS_MAJOR_VERSION = 3
@@ -28,7 +28,7 @@ module Wx
   WXWIDGETS_MINOR_VERSION = 3
 
   # Integer constant reflecting the release number of the wxWidgets release used to build wxRuby
-  WXWIDGETS_RELEASE_NUMBER = 2
+  WXWIDGETS_RELEASE_NUMBER = 3
 
   # Integer constant reflecting the sub-release number of the wxWidgets release used to build wxRuby
   WXWIDGETS_SUBRELEASE_NUMBER = 0

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

@@ -8,11 +8,11 @@ module Wx
 
   # 
   # 
-  EVT_WEBREQUEST_STATE = 10337
+  EVT_WEBREQUEST_STATE = 10340
   
   # 
   # 
-  EVT_WEBREQUEST_DATA = 10338
+  EVT_WEBREQUEST_DATA = 10341
   
   # This class represents a dialog that requests a user name and a password from the user.
   # 

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

@@ -8,11 +8,11 @@ module Wx
 
   # 
   # 
-  EVT_DATE_CHANGED = 10249
+  EVT_DATE_CHANGED = 10252
   
   # 
   # 
-  EVT_TIME_CHANGED = 10250
+  EVT_TIME_CHANGED = 10253
   
   # This event class holds information about a date change and is used together with {Wx::DatePickerCtrl}.
   # 

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

@@ -7,10 +7,10 @@
 module Wx
 
   # connected event
-  EVT_DIALUP_CONNECTED = 10134
+  EVT_DIALUP_CONNECTED = 10137
   
   # disconnected event
-  EVT_DIALUP_DISCONNECTED = 10135
+  EVT_DIALUP_DISCONNECTED = 10138
   
   # This is the event class for the dialup events sent by {Wx::DialUpManager}.
   # 

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

@@ -36,11 +36,11 @@ module Wx
   
   # 
   # 
-  EVT_DIRCTRL_SELECTIONCHANGED = 10234
+  EVT_DIRCTRL_SELECTIONCHANGED = 10237
   
   # 
   # 
-  EVT_DIRCTRL_FILEACTIVATED = 10235
+  EVT_DIRCTRL_FILEACTIVATED = 10238
   
   # 
   # 

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

@@ -480,151 +480,151 @@ module Wx
   
   # 
   # 
-  EVT_GESTURE_PAN = 10076
+  EVT_GESTURE_PAN = 10079
   
   # 
   # 
-  EVT_GESTURE_ZOOM = 10077
+  EVT_GESTURE_ZOOM = 10080
   
   # 
   # 
-  EVT_GESTURE_ROTATE = 10078
+  EVT_GESTURE_ROTATE = 10081
   
   # 
   # 
-  EVT_TWO_FINGER_TAP = 10079
+  EVT_TWO_FINGER_TAP = 10082
   
   # 
   # 
-  EVT_LONG_PRESS = 10080
+  EVT_LONG_PRESS = 10083
   
   # 
   # 
-  EVT_PRESS_AND_TAP = 10081
+  EVT_PRESS_AND_TAP = 10084
   
   # 
   # 
-  EVT_SIZE = 10082
+  EVT_SIZE = 10085
   
   # 
   # 
-  EVT_MOVE = 10084
+  EVT_MOVE = 10087
   
   # 
   # 
-  EVT_CLOSE_WINDOW = 10088
+  EVT_CLOSE_WINDOW = 10091
   
   # 
   # 
-  EVT_END_SESSION = 10089
+  EVT_END_SESSION = 10092
   
   # 
   # 
-  EVT_QUERY_END_SESSION = 10090
+  EVT_QUERY_END_SESSION = 10093
   
   # 
   # 
-  EVT_ACTIVATE_APP = 10092
+  EVT_ACTIVATE_APP = 10095
   
   # 
   # 
-  EVT_ACTIVATE = 10093
+  EVT_ACTIVATE = 10096
   
   # 
   # 
-  EVT_CREATE = 10094
+  EVT_CREATE = 10097
   
   # 
   # 
-  EVT_DESTROY = 10095
+  EVT_DESTROY = 10098
   
   # 
   # 
-  EVT_SHOW = 10096
+  EVT_SHOW = 10099
   
   # 
   # 
-  EVT_ICONIZE = 10097
+  EVT_ICONIZE = 10100
   
   # 
   # 
-  EVT_MAXIMIZE = 10098
+  EVT_MAXIMIZE = 10101
   
   # 
   # 
-  EVT_FULLSCREEN = 10099
+  EVT_FULLSCREEN = 10102
   
   # 
   # 
-  EVT_PAINT = 10102
+  EVT_PAINT = 10105
   
   # 
   # 
-  EVT_ERASE_BACKGROUND = 10103
+  EVT_ERASE_BACKGROUND = 10106
   
   # 
   # 
-  EVT_NC_PAINT = 10104
+  EVT_NC_PAINT = 10107
   
   # 
   # 
-  EVT_MENU_OPEN = 10105
+  EVT_MENU_OPEN = 10108
   
   # 
   # 
-  EVT_MENU_CLOSE = 10106
+  EVT_MENU_CLOSE = 10109
   
   # 
   # 
-  EVT_MENU_HIGHLIGHT = 10107
+  EVT_MENU_HIGHLIGHT = 10110
   
   # 
   # 
-  EVT_CONTEXT_MENU = 10108
+  EVT_CONTEXT_MENU = 10111
   
   # 
   # 
-  EVT_SYS_COLOUR_CHANGED = 10109
+  EVT_SYS_COLOUR_CHANGED = 10112
   
   # 
   # 
-  EVT_SYS_METRIC_CHANGED = 10110
+  EVT_SYS_METRIC_CHANGED = 10113
   
   # 
   # 
-  EVT_DPI_CHANGED = 10112
+  EVT_DPI_CHANGED = 10115
   
   # 
   # 
-  EVT_QUERY_NEW_PALETTE = 10113
+  EVT_QUERY_NEW_PALETTE = 10116
   
   # 
   # 
-  EVT_PALETTE_CHANGED = 10114
+  EVT_PALETTE_CHANGED = 10117
   
   # 
   # 
-  EVT_JOY_BUTTON_DOWN = 10115
+  EVT_JOY_BUTTON_DOWN = 10118
   
   # 
   # 
-  EVT_JOY_BUTTON_UP = 10116
+  EVT_JOY_BUTTON_UP = 10119
   
   # 
   # 
-  EVT_JOY_MOVE = 10117
+  EVT_JOY_MOVE = 10120
   
   # 
   # 
-  EVT_JOY_ZMOVE = 10118
+  EVT_JOY_ZMOVE = 10121
   
   # 
   # 
-  EVT_DROP_FILES = 10119
+  EVT_DROP_FILES = 10122
   
   # 
   # 
-  EVT_INIT_DIALOG = 10120
+  EVT_INIT_DIALOG = 10123
   
   # 
   # 
@@ -632,75 +632,75 @@ module Wx
   
   # 
   # 
-  EVT_UPDATE_UI = 10121
+  EVT_UPDATE_UI = 10124
   
   # 
   # 
-  EVT_SIZING = 10083
+  EVT_SIZING = 10086
   
   # 
   # 
-  EVT_MOVING = 10085
+  EVT_MOVING = 10088
   
   # 
   # 
-  EVT_MOVE_START = 10086
+  EVT_MOVE_START = 10089
   
   # 
   # 
-  EVT_MOVE_END = 10087
+  EVT_MOVE_END = 10090
   
   # 
   # 
-  EVT_HIBERNATE = 10091
+  EVT_HIBERNATE = 10094
   
   # 
   # 
-  EVT_TEXT_COPY = 10122
+  EVT_TEXT_COPY = 10125
   
   # 
   # 
-  EVT_TEXT_CUT = 10123
+  EVT_TEXT_CUT = 10126
   
   # 
   # 
-  EVT_TEXT_PASTE = 10124
+  EVT_TEXT_PASTE = 10127
   
   # 
   # 
-  EVT_COMMAND_LEFT_CLICK = 10125
+  EVT_COMMAND_LEFT_CLICK = 10128
   
   # 
   # 
-  EVT_COMMAND_LEFT_DCLICK = 10126
+  EVT_COMMAND_LEFT_DCLICK = 10129
   
   # 
   # 
-  EVT_COMMAND_RIGHT_CLICK = 10127
+  EVT_COMMAND_RIGHT_CLICK = 10130
   
   # 
   # 
-  EVT_COMMAND_RIGHT_DCLICK = 10128
+  EVT_COMMAND_RIGHT_DCLICK = 10131
   
   # 
   # 
-  EVT_COMMAND_SET_FOCUS = 10129
+  EVT_COMMAND_SET_FOCUS = 10132
   
   # 
   # 
-  EVT_COMMAND_KILL_FOCUS = 10130
+  EVT_COMMAND_KILL_FOCUS = 10133
   
   # 
   # 
-  EVT_COMMAND_ENTER = 10131
+  EVT_COMMAND_ENTER = 10134
   
   # 
   # 
-  EVT_HELP = 10132
+  EVT_HELP = 10135
   
   # 
   # 
-  EVT_DETAILED_HELP = 10133
+  EVT_DETAILED_HELP = 10136
   
   # 
   # 
@@ -708,13 +708,13 @@ module Wx
   
   # 
   # 
-  EVT_WINDOW_MODAL_DIALOG_CLOSED = 10152
+  EVT_WINDOW_MODAL_DIALOG_CLOSED = 10155
   
   # 
-  EVT_MENU_HIGHLIGHT_ALL = 10107
+  EVT_MENU_HIGHLIGHT_ALL = 10110
   
   # 
-  EVT_NC_PAINT = 10104
+  EVT_NC_PAINT = 10107
   
   # Generates a new unique event type.
   # 

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

@@ -28,9 +28,9 @@ module Wx
     # 
     # 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 [String]  The command to call a browser/html viewer.
-    # @param flags [Integer]  Set this to {Wx::HELP_NETSCAPE} if the browser is some variant of Netscape.
+    # @param flags [Integer]  Set this to {Wx::HTML::HELP_NETSCAPE} if the browser is some variant of Netscape.
     # @return [void]
-    def set_viewer(viewer=(''), flags=Wx::HELP_NETSCAPE) end
+    def set_viewer(viewer=(''), flags=Wx::HTML::HELP_NETSCAPE) end
     alias_method :viewer=, :set_viewer
     
     # This must be called to tell the controller where to find the documentation.
@@ -42,20 +42,6 @@ module Wx
     # @return [Boolean]
     def init(dir) end
     
-    # Display list of all help entries.
-    # 
-    # true on success
-    # @return [Boolean]
-    def display_contents; end
-    
-    # Search comment/documentation fields in map file and present a list to chose from.
-    # 
-    # true on success
-    # @param k [String]  string to search for, empty string will list all entries
-    # @param mode [Wx::HelpSearchMode]  optional parameter allows the search the index ({Wx::HelpSearchMode::HELP_SEARCH_INDEX}) but this currently only supported by the {Wx::HTML::HtmlHelpController}.
-    # @return [Boolean]
-    def keyword_search(k, mode=Wx::HelpSearchMode::HELP_SEARCH_ALL) end
-    
     # Does nothing.
     # @return [void]
     def on_quit; end
@@ -73,6 +59,21 @@ module Wx
     # @return [void]
     def set_frame_parameters(titleFormat, size, pos=Wx::DEFAULT_POSITION, newFrameEachTime=false) end
     
+    # If the help viewer is not running, runs it and displays the file at the given block number.
+    # 
+    # - WinHelp: Refers to the context number.
+    # - MS HTML Help: Refers to the context number.
+    # - External HTML help: the same as for {display_section}.
+    # - {Wx::HTML::HtmlHelpController}: sectionNo is an identifier as specified in the <code></code>.hhc file. See Help Files Format.
+    # DeprecatedThis function is for backward compatibility only, and applications should use {display_section} instead.
+    # @param blockNo [Integer] 
+    # @return [Boolean]
+    def display_block(blockNo) 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.
@@ -80,6 +81,23 @@ module Wx
     # @return [Boolean]
     def display_context_popup(contextId) end
     
+    # @overload display_section(section)
+    #   If the help viewer is not running, runs it and displays the given section.
+    #   
+    #   The interpretation of section differs between help viewers. For most viewers, this call is equivalent to KeywordSearch. For MS HTML Help, {Wx::HTML} help and external HTML help, if section has a .htm or .html extension, that HTML file will be displayed; otherwise a keyword search is done.
+    #   @param section [String] 
+    #   @return [Boolean]
+    # @overload display_section(sectionNo)
+    #   If the help viewer is not running, runs it and displays the given section.
+    #   
+    #   - WinHelp, MS HTML Help sectionNo is a context id.
+    #   - MS HTML Help: Pass -1 in sectionNo to display the index.
+    #   - External HTML help: {Wx::ExtHelpController} implements sectionNo as an id in a map file, which is of the form:
+    #   - {Wx::HTML::HtmlHelpController}: sectionNo is an identifier as specified in the <code></code>.hhc file. See Help Files Format. See also the help sample for notes on how to specify section numbers for various help file formats.
+    #   @param sectionNo [Integer] 
+    #   @return [Boolean]
+    def display_section(*args) end
+    
     # Displays the text in a popup window, if possible.
     # 
     # Returns false if unsuccessful or not implemented.
@@ -95,6 +113,34 @@ module Wx
     def get_parent_window; end
     alias_method :parent_window, :get_parent_window
     
+    # 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
+    
+    # If the help viewer is not running, runs it and loads the given file.
+    # 
+    # If the filename is not supplied or is empty, the file specified in {initialize} is used.
+    # If the viewer is already displaying the specified file, it will not be reloaded. This member function may be used before each display call in case the user has opened another file.
+    # {Wx::HTML::HtmlHelpController} ignores this call.
+    # @param file [String] 
+    # @return [Boolean]
+    def load_file(file=('')) end
+    
+    # If the viewer is running, quits it by disconnecting.
+    # 
+    # For Windows Help, the viewer will only close if no other application is using it.
+    # @return [Boolean]
+    def quit; 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}.