wxruby3 0.9.1-x64-mingw-ucrt → 0.9.3-x64-mingw-ucrt

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

@@ -7,8 +7,8 @@
 module Wx::GRID
 
   # Grid cell editor for dates.
+  # 
   # Uses {Wx::DatePickerCtrl} as actual edit control.
-  # === 
   # 
   # Category:  Grid Related Classes
   # @see Wx::GRID::GridCellEditor
@@ -22,6 +22,7 @@ module Wx::GRID
   # 
   # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_GRID
   class GridCellDateEditor < GridCellEditor
   
     # Date editor constructor.

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

@@ -7,8 +7,8 @@
 module Wx::GRID
 
   # This class may be used to show a date, without time, in a cell.
+  # 
   # See {Wx::GRID::GridCellDateTimeRenderer} for a date/time version. Wx::DateTime#format is used internally to render the date representation. Wx::DateTime#parse_date is used to parse the string data entered in the cell.
-  # === 
   # 
   # Category:  Grid Related Classes
   # @see Wx::GRID::GridCellRenderer
@@ -23,6 +23,7 @@ module Wx::GRID
   # 
   # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_GRID
   class GridCellDateRenderer < GridCellStringRenderer
   
     # Date renderer constructor.

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

@@ -7,8 +7,8 @@
 module Wx::GRID
 
   # This class may be used to format a date/time data in a cell.
+  # 
   # The class {Wx::DateTime} is used internally to display the local date/time or to parse the string date entered in the cell thanks to the defined format.
-  # === 
   # 
   # Category:  Grid Related Classes
   # @see Wx::GRID::GridCellRenderer
@@ -23,6 +23,7 @@ module Wx::GRID
   # 
   # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_GRID
   class GridCellDateTimeRenderer < GridCellDateRenderer
   
     # Date/time renderer constructor.

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

@@ -7,9 +7,9 @@
 module Wx::GRID
 
   # This class is responsible for providing and manipulating the in-place edit controls for the grid.
+  # 
   # Instances of {Wx::GRID::GridCellEditor} (actually, instances of derived classes since it is an abstract class) can be associated with the cell attributes for individual cells, rows, columns, or even for the entire grid.
   # Normally {Wx::GRID::GridCellEditor} shows some UI control allowing the user to edit the cell, but starting with wxWidgets 3.1.4 it's also possible to define "activatable" cell editors, that change the value of the cell directly when it's activated (typically by pressing Space key or clicking on it), see {Wx::GRID::GridCellEditor#try_activate} method. Note that when implementing an editor which is always activatable, i.e. never shows any in-place editor, it is more convenient to derive its class from {Wx::GRID::GridCellActivatableEditor} than from {Wx::GRID::GridCellEditor} itself.
-  # === 
   # 
   # Category:  Grid Related Classes
   # @see Wx::GRID::GridCellAutoWrapStringEditor
@@ -24,6 +24,7 @@ module Wx::GRID
   # 
   # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_GRID
   class GridCellEditor < ::Object
   
     # Default constructor.
@@ -31,6 +32,7 @@ module Wx::GRID
     def initialize; end
     
     # Fetch the value from the table and prepare the edit control to begin editing.
+    # 
     # This function should save the original value of the grid cell at the given row and col and show the control allowing the user to change it.
     # @see Wx::GRID::GridCellEditor#end_edit 
     # @param row [Integer] 
@@ -55,6 +57,7 @@ module Wx::GRID
     def destroy; end
     
     # End editing the cell.
+    # 
     # This function must check if the current value of the editing control is valid and different from the original value (available as oldval in its string form and possibly saved internally using its real type by {Wx::GRID::GridCellEditor#begin_edit}). If it isn't, it just returns false, otherwise it must do the following:
     # 
     # - Save the new value internally so that {Wx::GRID::GridCellEditor#apply_edit} could apply it.
@@ -72,6 +75,7 @@ module Wx::GRID
     def end_edit(row, col, grid, oldval, newval) end
     
     # Effectively save the changes in the grid.
+    # 
     # This function should save the value of the control in the grid. It is called only after {Wx::GRID::GridCellEditor#end_edit} returns true.
     # @param row [Integer] 
     # @param col [Integer] 
@@ -122,6 +126,7 @@ module Wx::GRID
     def starting_key(event) end
     
     # Return true to allow the given key to start editing: the base class version only checks that the event has no modifiers.
+    # 
     # If the key is F2 (special), editing will always start and this method will not be called at all (but {Wx::GRID::GridCellEditor#starting_key} will)
     # @param event [Wx::KeyEvent] 
     # @return [Boolean]
@@ -145,6 +150,7 @@ module Wx::GRID
     alias_method :window=, :set_window
     
     # Get the {Wx::Control} used by this editor.
+    # 
     # This function is preserved for compatibility, but {Wx::GRID::GridCellEditor#get_window} should be preferred in the new code as the associated window doesn't need to be of a {Wx::Control}-derived class.
     # Note that if {Wx::GRID::GridCellEditor#set_window} had been called with an object not deriving from {Wx::Control}, this method will return NULL.
     # @return [Wx::Control]
@@ -152,6 +158,7 @@ module Wx::GRID
     alias_method :control, :get_control
     
     # Set the {Wx::Control} that will be used by this cell editor for editing the value.
+    # 
     # This function is preserved for compatibility, but {Wx::GRID::GridCellEditor#set_window} should be preferred in the new code, see {Wx::GRID::GridCellEditor#get_control}.
     # @param control [Wx::Control] 
     # @return [void]
@@ -159,6 +166,7 @@ module Wx::GRID
     alias_method :control=, :set_control
     
     # Function allowing to create an "activatable" editor.
+    # 
     # As explained in this class description, activatable editors don't show any edit control but change the cell value directly, when it is activated (by any way described by {Wx::GridActivationSource}).
     # To create such editor, this method must be overridden to return Wx::GridActivationResult#do_change passing it the new value of the cell. If the change is not vetoed by {Wx::GRID::EVT_GRID_CELL_CHANGING} handler, {Wx::GRID::GridCellEditor#do_activate} will be called to actually change the value, so it must be overridden as well if {Wx::GRID::GridCellEditor#try_activate} is overridden.
     # By default, Wx::GridActivationResult#do_edit is returned, meaning that this is a normal editor, using an edit control for changing the cell value.
@@ -170,6 +178,7 @@ module Wx::GRID
     def try_activate(row, col, grid, actSource) end
     
     # Function which must be overridden for "activatable" editors.
+    # 
     # If {Wx::GRID::GridCellEditor#try_activate} is overridden to return "change" action, this function will be called to actually apply this change. Note that it is not passed the value to apply, as it is assumed that the editor class stores this value as a member variable anyhow.
     # @param row [Integer] 
     # @param col [Integer] 

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

@@ -7,8 +7,8 @@
 module Wx::GRID
 
   # Grid cell editor which displays an enum number as a textual equivalent (e.g.
+  # 
   # data in cell is 0,1,2 ... n the cell could be displayed as "John","Fred"..."Bob" in the combo choice box).
-  # === 
   # 
   # Category:  Grid Related Classes
   # @see Wx::GRID::GridCellEditor
@@ -23,6 +23,7 @@ module Wx::GRID
   # 
   # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_GRID
   class GridCellEnumEditor < GridCellChoiceEditor
   
     # Enum cell editor ctor.

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

@@ -7,8 +7,8 @@
 module Wx::GRID
 
   # This class may be used to render in a cell a number as a textual equivalent.
+  # 
   # The corresponding text strings are specified as comma-separated items in the string passed to this renderer ctor or {Wx::GRID::GridCellEnumRenderer#set_parameters} method. For example, if this string is <code>"John,Fred,Bob"</code> the cell will be rendered as "John", "Fred" or "Bob" if its contents is 0, 1 or 2 respectively.
-  # === 
   # 
   # Category:  Grid Related Classes
   # @see Wx::GRID::GridCellRenderer
@@ -22,6 +22,7 @@ module Wx::GRID
   # 
   # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_GRID
   class GridCellEnumRenderer < GridCellStringRenderer
   
     # Enum renderer ctor.

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

@@ -7,7 +7,6 @@
 module Wx::GRID
 
   # The editor for floating point numbers data.
-  # === 
   # 
   # Category:  Grid Related Classes
   # @see Wx::GRID::GridCellEditor
@@ -22,6 +21,7 @@ module Wx::GRID
   # 
   # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_GRID
   class GridCellFloatEditor < GridCellTextEditor
   
     # Float cell editor ctor.

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

@@ -7,7 +7,6 @@
 module Wx::GRID
 
   # This class may be used to format floating point data in a cell.
-  # === 
   # 
   # Category:  Grid Related Classes
   # @see Wx::GRID::GridCellRenderer
@@ -21,6 +20,7 @@ module Wx::GRID
   # 
   # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_GRID
   class GridCellFloatRenderer < GridCellStringRenderer
   
     # Float cell renderer ctor.
@@ -31,6 +31,7 @@ module Wx::GRID
     def initialize(width=-1, precision=-1, format=Wx::GRID::GridCellFloatFormat::GRID_FLOAT_FORMAT_DEFAULT) end
     
     # Returns the specifier used to format the data to string.
+    # 
     # The returned value is a combination of {Wx::GRID::GridCellFloatFormat} elements.
     # @return [Integer]
     def get_format; end

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

@@ -7,7 +7,6 @@
 module Wx::GRID
 
   # Grid cell editor for numeric integer data.
-  # === 
   # 
   # Category:  Grid Related Classes
   # @see Wx::GRID::GridCellEditor
@@ -22,9 +21,11 @@ module Wx::GRID
   # 
   # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_GRID
   class GridCellNumberEditor < GridCellTextEditor
   
     # Allows you to specify the range for acceptable data.
+    # 
     # Values equal to -1 for both min and max indicate that no range checking should be done.
     # @param min [Integer] 
     # @param max [Integer] 

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

@@ -7,7 +7,6 @@
 module Wx::GRID
 
   # This class may be used to format integer data in a cell.
-  # === 
   # 
   # Category:  Grid Related Classes
   # @see Wx::GRID::GridCellRenderer
@@ -21,6 +20,7 @@ module Wx::GRID
   # 
   # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_GRID
   class GridCellNumberRenderer < GridCellStringRenderer
   
     # Default constructor.

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

@@ -7,8 +7,8 @@
 module Wx::GRID
 
   # This class is responsible for actually drawing the cell in the grid.
+  # 
   # You may pass it to the {Wx::GRID::GridCellAttr} (below) to change the format of one given cell or to {Wx::GRID::Grid#set_default_renderer} to change the view of all cells. This is an abstract class, and you will normally use one of the predefined derived classes or derive your own class from it.
-  # === 
   # 
   # Category:  Grid Related Classes
   # @see Wx::GRID::GridCellAutoWrapStringRenderer
@@ -22,6 +22,7 @@ module Wx::GRID
   # 
   # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_GRID
   class GridCellRenderer < ::Object
   
     # @return [Wx::GRID::GridCellRenderer]
@@ -32,6 +33,7 @@ module Wx::GRID
     def clone; end
     
     # Draw the given cell on the provided DC inside the given rectangle using the style specified by the attribute and the default or selected state corresponding to the isSelected value.
+    # 
     # This pure virtual function has a default implementation which will prepare the DC using the given attribute: it will draw the rectangle with the background colour from attr and set the text colour and font.
     # @param grid [Wx::GRID::Grid] 
     # @param attr [Wx::GRID::GridCellAttr] 
@@ -44,6 +46,7 @@ module Wx::GRID
     def draw(grid, attr, dc, rect, row, col, isSelected) end
     
     # Get the preferred size of the cell for its contents.
+    # 
     # This method must be overridden in the derived classes to return the minimal fitting size for displaying the content of the given grid cell.
     # @see Wx::GRID::GridCellRenderer#get_best_height
     # @see  Wx::GRID::GridCellRenderer#get_best_width 
@@ -57,6 +60,7 @@ module Wx::GRID
     alias_method :best_size, :get_best_size
     
     # Get the preferred height of the cell at the given width.
+    # 
     # Some renderers may not have a well-defined best size, but only be able to provide the best height at the given width, e.g. this is the case of the standard {Wx::GRID::GridCellAutoWrapStringRenderer}. In this case, they should override this method, in addition to {Wx::GRID::GridCellRenderer#get_best_size}.
     # @see Wx::GRID::GridCellRenderer#get_best_width
     # @param grid [Wx::GRID::Grid] 
@@ -70,6 +74,7 @@ module Wx::GRID
     alias_method :best_height, :get_best_height
     
     # Get the preferred width of the cell at the given height.
+    # 
     # See {Wx::GRID::GridCellRenderer#get_best_height}, this method is symmetric to it.
     # @param grid [Wx::GRID::Grid] 
     # @param attr [Wx::GRID::GridCellAttr] 
@@ -82,6 +87,7 @@ module Wx::GRID
     alias_method :best_width, :get_best_width
     
     # Get the maximum possible size for a cell using this renderer, if possible.
+    # 
     # This function may be overridden in the derived class if it can return the maximum size needed for displaying the cells rendered it without iterating over all cells. The base class version simply returns {Wx::DEFAULT_SIZE}, indicating that this is infeasible and that {Wx::GRID::GridCellRenderer#get_best_size} should be called for each cell individually.
     # Note that this method will only be used if {Wx::GRID::GridTableBase#can_measure_col_using_same_attr} is overridden to return true.
     # @param grid [Wx::GRID::Grid] 

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

@@ -7,7 +7,6 @@
 module Wx::GRID
 
   # This class may be used to format string data in a cell; it is the default for string cells.
-  # === 
   # 
   # Category:  Grid Related Classes
   # @see Wx::GRID::GridCellRenderer
@@ -21,6 +20,7 @@ module Wx::GRID
   # 
   # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_GRID
   class GridCellStringRenderer < GridCellRenderer
   
     # Default constructor.

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

@@ -7,7 +7,6 @@
 module Wx::GRID
 
   # Grid cell editor for string/text data.
-  # === 
   # 
   # Category:  Grid Related Classes
   # @see Wx::GRID::GridCellEditor
@@ -22,6 +21,7 @@ module Wx::GRID
   # 
   # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_GRID
   class GridCellTextEditor < GridCellEditor
   
     # Text cell editor constructor.