wxruby3 0.9.0.pre.rc.2-x64-mingw-ucrt → 0.9.0.pre.rc.3-x64-mingw-ucrt

data/lib/wx/doc/gen/grid/grid_event.rb

@@ -12,22 +12,39 @@ module Wx::GRID
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::GRID::GridEvent} events.
   # Event handler methods:
+  # 
   # - {Wx::EvtHandler#evt_grid_cell_changing}(meth = nil, &block): The user is about to change the data in a cell. The new cell value as string is available from {Wx::GRID::GridEvent#get_string} event object method. This event can be vetoed if the change is not allowed. Processes a {Wx::GRID::EVT_GRID_CELL_CHANGING} event type. 
+  # 
   # - {Wx::EvtHandler#evt_grid_cell_changed}(meth = nil, &block): The user changed the data in a cell. The old cell value as string is available from {Wx::GRID::GridEvent#get_string} event object method. Notice that vetoing this event still works for backwards compatibility reasons but any new code should only veto EVT_GRID_CELL_CHANGING event and not this one. Processes a {Wx::GRID::EVT_GRID_CELL_CHANGED} event type. 
+  # 
   # - {Wx::EvtHandler#evt_grid_cell_left_click}(meth = nil, &block): The user clicked a cell with the left mouse button. Processes a {Wx::GRID::EVT_GRID_CELL_LEFT_CLICK} event type. 
+  # 
   # - {Wx::EvtHandler#evt_grid_cell_left_dclick}(meth = nil, &block): The user double-clicked a cell with the left mouse button. Processes a {Wx::GRID::EVT_GRID_CELL_LEFT_DCLICK} event type. 
+  # 
   # - {Wx::EvtHandler#evt_grid_cell_right_click}(meth = nil, &block): The user clicked a cell with the right mouse button. Processes a {Wx::GRID::EVT_GRID_CELL_RIGHT_CLICK} event type. 
+  # 
   # - {Wx::EvtHandler#evt_grid_cell_right_dclick}(meth = nil, &block): The user double-clicked a cell with the right mouse button. Processes a {Wx::GRID::EVT_GRID_CELL_RIGHT_DCLICK} event type. 
+  # 
   # - {Wx::EvtHandler#evt_grid_editor_hidden}(meth = nil, &block): The editor for a cell was hidden. Processes a {Wx::GRID::EVT_GRID_EDITOR_HIDDEN} event type. 
+  # 
   # - {Wx::EvtHandler#evt_grid_editor_shown}(meth = nil, &block): The editor for a cell was shown. Processes a {Wx::GRID::EVT_GRID_EDITOR_SHOWN} event type. 
+  # 
   # - {Wx::EvtHandler#evt_grid_label_left_click}(meth = nil, &block): The user clicked a label with the left mouse button. Processes a {Wx::GRID::EVT_GRID_LABEL_LEFT_CLICK} event type. 
+  # 
   # - {Wx::EvtHandler#evt_grid_label_left_dclick}(meth = nil, &block): The user double-clicked a label with the left mouse button. Processes a {Wx::GRID::EVT_GRID_LABEL_LEFT_DCLICK} event type. 
+  # 
   # - {Wx::EvtHandler#evt_grid_label_right_click}(meth = nil, &block): The user clicked a label with the right mouse button. Processes a {Wx::GRID::EVT_GRID_LABEL_RIGHT_CLICK} event type. 
+  # 
   # - {Wx::EvtHandler#evt_grid_label_right_dclick}(meth = nil, &block): The user double-clicked a label with the right mouse button. Processes a {Wx::GRID::EVT_GRID_LABEL_RIGHT_DCLICK} event type. 
+  # 
   # - {Wx::EvtHandler#evt_grid_select_cell}(meth = nil, &block): The given cell is about to be made current, either by user or by the program via a call to {Wx::GRID::Grid#set_grid_cursor} or {Wx::GRID::Grid#go_to_cell}. The event can be vetoed to prevent this from happening and {Wx::GRID::Grid#get_grid_cursor_coords} still returns the previous current cell coordinates during the event handler execution, while the new ones are available via the event object {Wx::GRID::GridEvent#get_row} and {Wx::GRID::GridEvent#get_col} functions. Processes a {Wx::GRID::EVT_GRID_SELECT_CELL} event type. 
+  # 
   # - {Wx::EvtHandler#evt_grid_row_move}(meth = nil, &block): The user tries to change the order of the rows in the grid by dragging the row specified by {Wx::GRID::GridEvent#get_row}. This event can be vetoed to either prevent the user from reordering the row change completely (but notice that if you don't want to allow it at all, you simply shouldn't call {Wx::GRID::Grid#enable_drag_row_move} in the first place), vetoed but handled in some way in the handler, e.g. by really moving the row to the new position at the associated table level, or allowed to proceed in which case {Wx::GRID::Grid#set_row_pos} is used to reorder the rows display order without affecting the use of the row indices otherwise. This event macro corresponds to {Wx::GRID::EVT_GRID_ROW_MOVE} event type. It is only available since wxWidgets 3.1.7. 
+  # 
   # - {Wx::EvtHandler#evt_grid_col_move}(meth = nil, &block): The user tries to change the order of the columns in the grid by dragging the column specified by {Wx::GRID::GridEvent#get_col}. This event can be vetoed to either prevent the user from reordering the column change completely (but notice that if you don't want to allow it at all, you simply shouldn't call {Wx::GRID::Grid#enable_drag_col_move} in the first place), vetoed but handled in some way in the handler, e.g. by really moving the column to the new position at the associated table level, or allowed to proceed in which case {Wx::GRID::Grid#set_col_pos} is used to reorder the columns display order without affecting the use of the column indices otherwise. This event macro corresponds to {Wx::GRID::EVT_GRID_COL_MOVE} event type. 
+  # 
   # - {Wx::EvtHandler#evt_grid_col_sort}(meth = nil, &block): This event is generated when a column is clicked by the user and its name is explained by the fact that the custom reaction to a click on a column is to sort the grid contents by this column. However the grid itself has no special support for sorting and it's up to the handler of this event to update the associated table. But if the event is handled (and not vetoed) the grid supposes that the table was indeed resorted and updates the column to indicate the new sort order and refreshes itself. This event macro corresponds to {Wx::GRID::EVT_GRID_COL_SORT} event type. 
+  # 
   # - {Wx::EvtHandler#evt_grid_tabbing}(meth = nil, &block): This event is generated when the user presses TAB or Shift-TAB in the grid. It can be used to customize the simple default TAB handling logic, e.g. to go to the next non-empty cell instead of just the next cell. See also {Wx::GRID::Grid#set_tab_behaviour}. This event is new since wxWidgets 2.9.5. 
   # 
   # === 
@@ -38,11 +55,11 @@ module Wx::GRID
   
     # @overload initialize()
     #   Default constructor.
-    #   @return [GridEvent]
+    #   @return [Wx::GRID::GridEvent]
     # @overload initialize(id, type, obj, row=-1, col=-1, x=-1, y=-1, sel=true, kbd=(Wx::KeyboardState.new()))
     #   Constructor for initializing all event attributes.
     #   @param id [Integer] 
-    #   @param type [Integer] 
+    #   @param type [Wx::AUI::AuiMDIChildFrame::EventType] 
     #   @param obj [Wx::Object] 
     #   @param row [Integer] 
     #   @param col [Integer] 
@@ -50,7 +67,7 @@ module Wx::GRID
     #   @param y [Integer] 
     #   @param sel [true,false] 
     #   @param kbd [Wx::KeyboardState] 
-    #   @return [GridEvent]
+    #   @return [Wx::GRID::GridEvent]
     def initialize(*args) end
     
     # Returns true if the Alt key was down at the time of the event.

data/lib/wx/doc/gen/grid/grid_range_select_event.rb

@@ -14,9 +14,13 @@ module Wx::GRID
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::GRID::GridRangeSelectEvent} events.
   # Event handler methods:
+  # 
   # - {Wx::EvtHandler#evt_grid_range_selecting}(meth = nil, &block): The user is selecting a group of contiguous cells. Processes a {Wx::GRID::EVT_GRID_RANGE_SELECTING} event type. This event is available in wxWidgets 3.1.5 and later only. 
+  # 
   # - {Wx::EvtHandler#evt_grid_cmd_range_selecting}(id, meth = nil, &block): The user is selecting a group of contiguous cells; variant taking a window identifier. Processes a {Wx::GRID::EVT_GRID_RANGE_SELECTING} event type. This event is available in wxWidgets 3.1.5 and later only. 
+  # 
   # - {Wx::EvtHandler#evt_grid_range_selected}(meth = nil, &block): The user selected a group of contiguous cells. Processes a {Wx::GRID::EVT_GRID_RANGE_SELECTED} event type. This event is available in wxWidgets 3.1.5 and later only and was called {Wx::EVT_GRID_RANGE_SELECT} in the previous versions. 
+  # 
   # - {Wx::EvtHandler#evt_grid_cmd_range_selected}(id, meth = nil, &block): The user selected a group of contiguous cells; variant taking a window identifier. Processes a {Wx::GRID::EVT_GRID_RANGE_SELECTED} event type. This event is available in wxWidgets 3.1.5 and later only and was called {Wx::EVT_GRID_CMD_RANGE_SELECT} in the previous versions. 
   # 
   # === 
@@ -27,17 +31,17 @@ module Wx::GRID
   
     # @overload initialize()
     #   Default constructor.
-    #   @return [GridRangeSelectEvent]
+    #   @return [Wx::GRID::GridRangeSelectEvent]
     # @overload initialize(id, type, obj, topLeft, bottomRight, sel=true, kbd=(Wx::KeyboardState.new()))
     #   Constructor for initializing all event attributes.
     #   @param id [Integer] 
-    #   @param type [Integer] 
+    #   @param type [Wx::AUI::AuiMDIChildFrame::EventType] 
     #   @param obj [Wx::Object] 
     #   @param topLeft [Wx::GridCellCoords] 
     #   @param bottomRight [Wx::GridCellCoords] 
     #   @param sel [true,false] 
     #   @param kbd [Wx::KeyboardState] 
-    #   @return [GridRangeSelectEvent]
+    #   @return [Wx::GRID::GridRangeSelectEvent]
     def initialize(*args) end
     
     # Returns true if the Alt key was down at the time of the event.

data/lib/wx/doc/gen/grid/grid_size_event.rb

@@ -11,11 +11,17 @@ module Wx::GRID
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::GRID::GridSizeEvent} events.
   # Event handler methods:
+  # 
   # - {Wx::EvtHandler#evt_grid_cmd_col_size}(id, meth = nil, &block): The user resized a column, corresponds to {Wx::GRID::EVT_GRID_COL_SIZE} event type. 
+  # 
   # - {Wx::EvtHandler#evt_grid_cmd_row_size}(id, meth = nil, &block): The user resized a row, corresponds to {Wx::GRID::EVT_GRID_ROW_SIZE} event type. 
+  # 
   # - {Wx::EvtHandler#evt_grid_row_auto_size}(meth = nil, &block): This event is sent when a row must be resized to its best size, e.g. when the user double clicks the row divider. The default implementation simply resizes the row to fit the row label (but not its contents as this could be too slow for big grids). This macro corresponds to {Wx::GRID::EVT_GRID_ROW_AUTO_SIZE} event type and is new since wxWidgets 3.1.7. 
+  # 
   # - {Wx::EvtHandler#evt_grid_col_size}(meth = nil, &block): Same as EVT_GRID_CMD_COL_SIZE() but uses {Wx::StandardID::ID_ANY} id. 
+  # 
   # - {Wx::EvtHandler#evt_grid_col_auto_size}(meth = nil, &block): This event is sent when a column must be resized to its best size, e.g. when the user double clicks the column divider. The default implementation simply resizes the column to fit the column label (but not its contents as this could be too slow for big grids). This macro corresponds to {Wx::GRID::EVT_GRID_COL_AUTO_SIZE} event type and is new since wxWidgets 2.9.5. 
+  # 
   # - {Wx::EvtHandler#evt_grid_row_size}(meth = nil, &block): Same as EVT_GRID_CMD_ROW_SIZE() but uses {Wx::StandardID::ID_ANY} id. 
   # 
   # === 
@@ -26,17 +32,17 @@ module Wx::GRID
   
     # @overload initialize()
     #   Default constructor.
-    #   @return [GridSizeEvent]
+    #   @return [Wx::GRID::GridSizeEvent]
     # @overload initialize(id, type, obj, rowOrCol=-1, x=-1, y=-1, kbd=(Wx::KeyboardState.new()))
     #   Constructor for initializing all event attributes.
     #   @param id [Integer] 
-    #   @param type [Integer] 
+    #   @param type [Wx::AUI::AuiMDIChildFrame::EventType] 
     #   @param obj [Wx::Object] 
     #   @param rowOrCol [Integer] 
     #   @param x [Integer] 
     #   @param y [Integer] 
     #   @param kbd [Wx::KeyboardState] 
-    #   @return [GridSizeEvent]
+    #   @return [Wx::GRID::GridSizeEvent]
     def initialize(*args) end
     
     # Returns true if the Alt key was down at the time of the event.

data/lib/wx/doc/gen/grid/grid_string_table.rb

@@ -13,12 +13,12 @@ module Wx::GRID
   
     # @overload initialize()
     #   Default constructor creates an empty table.
-    #   @return [GridStringTable]
+    #   @return [Wx::GRID::GridStringTable]
     # @overload initialize(numRows, numCols)
     #   Constructor taking number of rows and columns.
     #   @param numRows [Integer] 
     #   @param numCols [Integer] 
-    #   @return [GridStringTable]
+    #   @return [Wx::GRID::GridStringTable]
     def initialize(*args) end
     
     # Must be overridden to return the number of rows in the table.

data/lib/wx/doc/gen/grid/grid_table_base.rb

@@ -204,7 +204,7 @@ module Wx::GRID
     # Prefer to use {Wx::GRID::GridTableBase#get_attr_ptr} to avoid the need to call DecRef() on the returned pointer manually.
     # @param row [Integer] 
     # @param col [Integer] 
-    # @param kind [Wx::GridCellAttr::wxAttrKind] 
+    # @param kind [Wx::GRID::GridCellAttr::AttrKind] 
     # @return [Wx::GRID::GridCellAttr]
     def get_attr(row, col, kind) end
     alias_method :attr, :get_attr
@@ -212,7 +212,7 @@ module Wx::GRID
     # Set attribute of the specified cell.
     # By default this function is simply forwarded to Wx::GridCellAttrProvider#set_attr.
     # The table takes ownership of attr, i.e. will call DecRef() on it.
-    # @param attr [Wx::GridCellAttr] 
+    # @param attr [Wx::GRID::GridCellAttr] 
     # @param row [Integer] 
     # @param col [Integer] 
     # @return [void]
@@ -221,7 +221,7 @@ module Wx::GRID
     # Set attribute of the specified row.
     # By default this function is simply forwarded to Wx::GridCellAttrProvider#set_row_attr.
     # The table takes ownership of attr, i.e. will call DecRef() on it.
-    # @param attr [Wx::GridCellAttr] 
+    # @param attr [Wx::GRID::GridCellAttr] 
     # @param row [Integer] 
     # @return [void]
     def set_row_attr(attr, row) end
@@ -229,13 +229,13 @@ module Wx::GRID
     # Set attribute of the specified column.
     # By default this function is simply forwarded to Wx::GridCellAttrProvider#set_col_attr.
     # The table takes ownership of attr, i.e. will call DecRef() on it.
-    # @param attr [Wx::GridCellAttr] 
+    # @param attr [Wx::GRID::GridCellAttr] 
     # @param col [Integer] 
     # @return [void]
     def set_col_attr(attr, col) end
     
     # Default constructor.
-    # @return [GridTableBase]
+    # @return [Wx::GRID::GridTableBase]
     def initialize; end
     
     # Must be overridden to return the number of rows in the table.
@@ -264,13 +264,13 @@ module Wx::GRID
     
     # Called by the grid when the table is associated with it.
     # The default implementation stores the pointer and returns it from its {Wx::GRID::GridTableBase#get_view} and so only makes sense if the table cannot be associated with more than one grid at a time.
-    # @param grid [Wx::Grid] 
+    # @param grid [Wx::GRID::Grid] 
     # @return [void]
     def set_view(grid) end
     alias_method :view=, :set_view
     
     # Returns the last grid passed to {Wx::GRID::GridTableBase#set_view}.
-    # @return [Wx::Grid]
+    # @return [Wx::GRID::Grid]
     def get_view; end
     alias_method :view, :get_view
     

data/lib/wx/doc/gen/grid/grid_table_message.rb

@@ -15,24 +15,24 @@ module Wx::GRID
   
     # @overload initialize()
     #   Default constructor initializes the object to invalid state.
-    #   @return [GridTableMessage]
+    #   @return [Wx::GRID::GridTableMessage]
     # @overload initialize(table, id, comInt1=-1, comInt2=-1)
     #   Constructor really initialize the message.
-    #   @param table [Wx::GridTableBase]  Pointer to the grid table
+    #   @param table [Wx::GRID::GridTableBase]  Pointer to the grid table
     #   @param id [Integer]  One of {Wx::GRID::GridTableRequest} enum elements.
     #   @param comInt1 [Integer]  For the insert/delete messages, position after which the rows or columns are inserted/deleted. For the append messages, the number of rows or columns that were appended.
     #   @param comInt2 [Integer]  For the insert/deleted messages, number of rows or columns to be inserted/deleted. For the append messages, this parameter is not used.
-    #   @return [GridTableMessage]
+    #   @return [Wx::GRID::GridTableMessage]
     def initialize(*args) end
     
     # Sets the table object.
-    # @param table [Wx::GridTableBase] 
+    # @param table [Wx::GRID::GridTableBase] 
     # @return [void]
     def set_table_object(table) end
     alias_method :table_object=, :set_table_object
     
     # Gets the table object.
-    # @return [Wx::GridTableBase]
+    # @return [Wx::GRID::GridTableBase]
     def get_table_object; end
     alias_method :table_object, :get_table_object
     

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

@@ -151,7 +151,7 @@ module Wx
     # Constructor, with optional parameters to specify the gap between the rows and columns.
     # @param vgap [Integer] 
     # @param hgap [Integer] 
-    # @return [GridBagSizer]
+    # @return [Wx::GridBagSizer]
     def initialize(vgap=0, hgap=0) end
     
     # Called when the managed size of the sizer is needed or when layout needs done.
@@ -213,12 +213,12 @@ module Wx
   
     # @overload initialize()
     #   Default constructor, setting the rowspan and colspan to (1,1) meaning that the item occupies one cell in each direction.
-    #   @return [GBSpan]
+    #   @return [Wx::GBSpan]
     # @overload initialize(rowspan, colspan)
     #   Construct a new {Wx::GBSpan}, setting the rowspan and colspan.
     #   @param rowspan [Integer] 
     #   @param colspan [Integer] 
-    #   @return [GBSpan]
+    #   @return [Wx::GBSpan]
     def initialize(*args) end
     
     # Get the current colspan value.
@@ -261,12 +261,12 @@ module Wx
   
     # @overload initialize()
     #   Default constructor, setting the row and column to (0,0).
-    #   @return [GBPosition]
+    #   @return [Wx::GBPosition]
     # @overload initialize(row, col)
     #   Construct a new {Wx::GBPosition}, setting the row and column.
     #   @param row [Integer] 
     #   @param col [Integer] 
-    #   @return [GBPosition]
+    #   @return [Wx::GBPosition]
     def initialize(*args) end
     
     # Get the current column value.

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

@@ -26,7 +26,7 @@ module Wx
     #   @param cols [Integer] 
     #   @param vgap [Integer] 
     #   @param hgap [Integer] 
-    #   @return [GridSizer]
+    #   @return [Wx::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.
@@ -35,7 +35,7 @@ module Wx
     #   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]
+    #   @return [Wx::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.
@@ -46,7 +46,7 @@ module Wx
     #   @param cols [Integer] 
     #   @param vgap [Integer] 
     #   @param hgap [Integer] 
-    #   @return [GridSizer]
+    #   @return [Wx::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.
@@ -56,7 +56,7 @@ module Wx
     #   @param rows [Integer] 
     #   @param cols [Integer] 
     #   @param gap [Array(Integer, Integer), Wx::Size] 
-    #   @return [GridSizer]
+    #   @return [Wx::GridSizer]
     def initialize(*args) end
     
     # Returns the number of columns that has been specified for the sizer.

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

@@ -0,0 +1,132 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # A generic implementation of the GUI event loop.
+  # === 
+  # 
+  # Category:  Application and Process Management
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  class GUIEventLoop < ::Object
+  
+    # @return [Wx::GUIEventLoop]
+    def initialize; end
+    
+    # Start the event loop, return the exit code when it is finished.
+    # Logically, this method calls {Wx::GUIEventLoop#dispatch} in a loop until it returns false and also takes care of generating idle events during each loop iteration. However not all implementations of this class really implement it like this (e.g. wxGTK does not) so you shouldn't rely on {Wx::GUIEventLoop#dispatch} being called from inside this function.
+    # The argument passed to {Wx::GUIEventLoop#exit} which terminated this event loop.
+    # @return [Integer]
+    def run; end
+    
+    # Return true if this event loop is currently running.
+    # Notice that even if this event loop hasn't terminated yet but has just spawned a nested (e.g. modal) event loop, this method would return false.
+    # @return [true,false]
+    def is_running; end
+    alias_method :running?, :is_running
+    
+    # Use this to check whether the event loop was successfully created before using it.
+    # @return [true,false]
+    def is_ok; end
+    alias_method :ok?, :is_ok
+    
+    # Exit the currently running loop with the given exit code.
+    # The loop will exit, i.e. its {Wx::GUIEventLoop#run} method will return, during the next event loop iteration.
+    # Notice that this method can only be used if this event loop is the currently running one, i.e. its {Wx::GUIEventLoop#is_running} returns true. If this is not the case, an assert failure is triggered and nothing is done as outer event loops can't be exited from immediately. Use {Wx::GUIEventLoop#schedule_exit} if you'd like to exit this loop even if it doesn't run currently.
+    # @param rc [Integer] 
+    # @return [void]
+    def exit(rc=0) end
+    
+    # Schedule an exit from the loop with the given exit code.
+    # This method is similar to {Wx::GUIEventLoop#exit} but can be called even if this event loop is not the currently running one  and if it is the active loop, then it works in exactly the same way as {Wx::GUIEventLoop#exit}.
+    # The loop will exit as soon as the control flow returns to it, i.e. after any nested loops terminate.
+    # @param rc [Integer] 
+    # @return [void]
+    def schedule_exit(rc=0) end
+    
+    # Return true if any events are available.
+    # If this method returns true, calling {Wx::GUIEventLoop#dispatch} will not block.
+    # @return [true,false]
+    def pending; end
+    
+    # Dispatches the next event in the windowing system event queue.
+    # Blocks until an event appears if there are none currently (use {Wx::GUIEventLoop#pending} if this is not wanted).
+    # This can be used for programming event loops, e.g.
+    # 
+    # ```ruby
+    #   while evt_loop.pending
+    #     evt_loop.dispatch
+    # ```
+    # 
+    # false if the event loop should stop and true otherwise.
+    # @see Wx::GUIEventLoop#pending
+    # @see  Wx::EventLoopBase 
+    # @return [true,false]
+    def dispatch; end
+    
+    # Dispatch an event but not wait longer than the specified timeout for it.
+    # If an event is received before the specified timeout expires, it is processed and the function returns 1 normally or 0 if the event loop should quite. Otherwise, i.e. if the timeout expires, the functions returns -1 without processing any events.
+    # 
+    # 1 if an event was processed, 0 if the event loop should quit or -1 if the timeout expired.
+    # @param timeout [Integer]  The maximal time to wait for the events in milliseconds.
+    # @return [Integer]
+    def dispatch_timeout(timeout) end
+    
+    # Called by wxWidgets to wake up the event loop even if it is currently blocked inside {Wx::GUIEventLoop#dispatch}.
+    # @return [void]
+    def wake_up; end
+    
+    # Makes sure that idle events are sent again.
+    # @return [void]
+    def wake_up_idle; end
+    
+    # This virtual function is called when the application becomes idle and normally just sends {Wx::IdleEvent} to all interested parties.
+    # It should return true if more idle events are needed, false if not.
+    # @return [true,false]
+    def process_idle; end
+    
+    # Returns true if called from inside {Wx::GUIEventLoop#yield} or from inside {Wx::GUIEventLoop#yield_for}.
+    # @return [true,false]
+    def is_yielding; end
+    alias_method :yielding?, :is_yielding
+    
+    # Yields control to pending messages in the windowing system.
+    # This can be useful, for example, when a time-consuming process writes to a text window. Without an occasional yield, the text window will not be updated properly, and on systems with cooperative multitasking, other processes will not respond.
+    # Caution should be exercised, however, since yielding may allow the user to perform actions which are not compatible with the current task. Disabling menu items or whole menus during processing can avoid unwanted reentrance of code: see {Wx::SafeYield} for a better function.
+    # Note that {Wx::GUIEventLoop#yield} will not flush the message logs. This is intentional as calling {Wx::GUIEventLoop#yield} is usually done to quickly update the screen and popping up a message box dialog may be undesirable. If you do wish to flush the log messages immediately (otherwise it will be done during the next idle loop iteration), call {Wx::Log.flush_active}.
+    # If onlyIfNeeded parameter is true and the flow control is already inside {Wx::GUIEventLoop#yield}, i.e. {Wx::GUIEventLoop#is_yielding} returns true, the method just silently returns false and doesn't do anything.
+    # @param onlyIfNeeded [true,false] 
+    # @return [true,false]
+    def yield(onlyIfNeeded=false) end
+    
+    # Works like {Wx::GUIEventLoop#yield} with onlyIfNeeded == true, except that it allows the caller to specify a mask of the {Wx::EventCategory} values which indicates which events should be processed and which should instead be "delayed" (i.e.
+    # processed by the main loop later).
+    # Note that this is a safer alternative to {Wx::GUIEventLoop#yield} since it ensures that only the events you're interested to will be processed; i.e. this method helps to avoid unwanted reentrancies.
+    # Note that currently only wxMSW and wxGTK do support selective yield of native events coming from the underlying GUI toolkit. wxWidgets events posted using {Wx::EvtHandler#add_pending_event} or {Wx::EvtHandler#queue_event} are instead selectively processed by all ports.
+    # @see Wx::Event#get_event_category 
+    # @param eventsToProcess [Integer] 
+    # @return [true,false]
+    def yield_for(eventsToProcess) end
+    
+    # Returns true if the given event category is allowed inside a {Wx::GUIEventLoop#yield_for} call (i.e.
+    # compares the given category against the last mask passed to {Wx::GUIEventLoop#yield_for}).
+    # @see Wx::Event#get_event_category 
+    # @param cat [EventCategory] 
+    # @return [true,false]
+    def is_event_allowed_inside_yield(cat) end
+    alias_method :event_allowed_inside_yield?, :is_event_allowed_inside_yield
+    
+    # Returns true if this is the main loop executed by {Wx::App#on_run}.
+    # @return [true,false]
+    def is_main; end
+    alias_method :main?, :is_main
+    
+  end # GUIEventLoop
+  
+
+end

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

@@ -29,15 +29,18 @@ module Wx
   # 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).
+  # 
+  # - 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.
+  # 
+  # - {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. 
   # 
   # === 
   # 
@@ -52,7 +55,7 @@ module Wx
     # 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]
+    # @return [Wx::HelpController]
     def initialize(parentWindow=nil) end
     
     # If the help viewer is not running, runs it and displays the contents.
@@ -88,7 +91,10 @@ module Wx
     # 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}.
+    # - 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]
@@ -120,10 +126,10 @@ module Wx
     # 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);
+    # ```ruby
+    #   @help.set_viewer('kdehelp')
+    #   @help.set_viewer('gnome-help-browser')
+    #   @help.set_viewer('netscape', Wx::HELP_NETSCAPE)
     # ```
     # 
     # Todomodernize this function with {Wx::LaunchDefaultBrowser}