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

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

@@ -22,10 +22,12 @@ module Wx::GRID
   # @see  Wx::GRID::GridCellDateEditor 
   # 
   # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
   class GridCellEditor < ::Object
   
     # Default constructor.
-    # @return [GridCellEditor]
+    # @return [Wx::GRID::GridCellEditor]
     def initialize; end
     
     # Fetch the value from the table and prepare the edit control to begin editing.
@@ -33,12 +35,12 @@ module Wx::GRID
     # @see Wx::GRID::GridCellEditor#end_edit 
     # @param row [Integer] 
     # @param col [Integer] 
-    # @param grid [Wx::Grid] 
+    # @param grid [Wx::GRID::Grid] 
     # @return [void]
     def begin_edit(row, col, grid) end
     
     # Create a new object which is the copy of this one.
-    # @return [Wx::GridCellEditor]
+    # @return [Wx::GRID::GridCellEditor]
     def clone; end
     
     # Creates the actual edit control.
@@ -54,23 +56,26 @@ module Wx::GRID
     
     # 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.- Fill newval (which is never NULL) with the string representation of the new value.- Return true
+    # 
+    # - Save the new value internally so that {Wx::GRID::GridCellEditor#apply_edit} could apply it.
+    # - Fill newval (which is never NULL) with the string representation of the new value.
+    # - Return true
     # 
     # Notice that it must not modify the grid as the change could still be vetoed.
     # If the user-defined {Wx::GRID::EVT_GRID_CELL_CHANGING} event handler doesn't veto this change, {Wx::GRID::GridCellEditor#apply_edit} will be called next.
     # @param row [Integer] 
     # @param col [Integer] 
-    # @param grid [Wx::Grid] 
+    # @param grid [Wx::GRID::Grid] 
     # @param oldval [String] 
     # @param newval [String] 
-    # @return [true,false]
+    # @return [Boolean]
     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] 
-    # @param grid [Wx::Grid] 
+    # @param grid [Wx::GRID::Grid] 
     # @return [void]
     def apply_edit(row, col, grid) end
     
@@ -80,14 +85,14 @@ module Wx::GRID
     def handle_return(event) end
     
     # Returns true if the edit control has been created.
-    # @return [true,false]
+    # @return [Boolean]
     def is_created; end
     alias_method :created?, :is_created
     
     # Draws the part of the cell not occupied by the control: the base class version just fills it with background colour from the attribute.
     # @param dc [Wx::DC] 
     # @param rectCell [Wx::Rect] 
-    # @param attr [Wx::GridCellAttr] 
+    # @param attr [Wx::GRID::GridCellAttr] 
     # @return [void]
     def paint_background(dc, rectCell, attr) end
     
@@ -102,8 +107,8 @@ module Wx::GRID
     alias_method :size=, :set_size
     
     # Show or hide the edit control, use the specified attributes to set colours/fonts for it.
-    # @param show [true,false] 
-    # @param attr [Wx::GridCellAttr] 
+    # @param show [Boolean] 
+    # @param attr [Wx::GRID::GridCellAttr] 
     # @return [void]
     def show(show, attr=nil) end
     
@@ -119,7 +124,7 @@ module Wx::GRID
     # 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 [true,false]
+    # @return [Boolean]
     def is_accepted_key(event) end
     alias_method :accepted_key?, :is_accepted_key
     
@@ -159,7 +164,7 @@ module Wx::GRID
     # By default, Wx::GridActivationResult#do_edit is returned, meaning that this is a normal editor, using an edit control for changing the cell value.
     # @param row [Integer] 
     # @param col [Integer] 
-    # @param grid [Wx::Grid] 
+    # @param grid [Wx::GRID::Grid] 
     # @param actSource [Wx::GridActivationSource] 
     # @return [Wx::GridActivationResult]
     def try_activate(row, col, grid, actSource) end
@@ -168,7 +173,7 @@ module Wx::GRID
     # 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] 
-    # @param grid [Wx::Grid] 
+    # @param grid [Wx::GRID::Grid] 
     # @return [void]
     def do_activate(row, col, grid) end
     

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

@@ -21,11 +21,13 @@ module Wx::GRID
   # @see  Wx::GRID::GridCellDateEditor 
   # 
   # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
   class GridCellEnumEditor < GridCellChoiceEditor
   
     # Enum cell editor ctor.
     # @param choices [String]  Comma separated choice parameters "item1[,item2[...,itemN]]".
-    # @return [GridCellEnumEditor]
+    # @return [Wx::GRID::GridCellEnumEditor]
     def initialize(choices=('')) end
     
   end # GridCellEnumEditor

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

@@ -20,11 +20,13 @@ module Wx::GRID
   # @see  Wx::GRID::GridCellStringRenderer 
   # 
   # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
   class GridCellEnumRenderer < GridCellStringRenderer
   
     # Enum renderer ctor.
     # @param choices [String]  Comma separated string parameters "item1[,item2[...,itemN]]".
-    # @return [GridCellEnumRenderer]
+    # @return [Wx::GRID::GridCellEnumRenderer]
     def initialize(choices=('')) end
     
     # Sets the comma separated string content of the enum.

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

@@ -20,13 +20,15 @@ module Wx::GRID
   # @see  Wx::GRID::GridCellDateEditor 
   # 
   # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
   class GridCellFloatEditor < GridCellTextEditor
   
     # Float cell editor ctor.
     # @param width [Integer]  Minimum number of characters to be shown.
     # @param precision [Integer]  Number of digits after the decimal dot.
     # @param format [Integer]  The format to use for displaying the number, a combination of {Wx::GRID::GridCellFloatFormat} enum elements. This parameter is only available since wxWidgets 2.9.3.
-    # @return [GridCellFloatEditor]
+    # @return [Wx::GRID::GridCellFloatEditor]
     def initialize(width=-1, precision=-1, format=Wx::GRID::GridCellFloatFormat::GRID_FLOAT_FORMAT_DEFAULT) end
     
     # The parameters string format is "width[,precision[,format]]" where format should be chosen between f|e|g|E|G (f is used by default)

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

@@ -19,13 +19,15 @@ module Wx::GRID
   # @see  Wx::GRID::GridCellStringRenderer 
   # 
   # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
   class GridCellFloatRenderer < GridCellStringRenderer
   
     # Float cell renderer ctor.
     # @param width [Integer]  Minimum number of characters to be shown.
     # @param precision [Integer]  Number of digits after the decimal dot.
     # @param format [Integer]  The format used to display the string, must be a combination of {Wx::GRID::GridCellFloatFormat} enum elements. This parameter is only available since wxWidgets 2.9.3.
-    # @return [GridCellFloatRenderer]
+    # @return [Wx::GRID::GridCellFloatRenderer]
     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.

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

@@ -20,13 +20,15 @@ module Wx::GRID
   # @see  Wx::GRID::GridCellDateEditor 
   # 
   # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
   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] 
-    # @return [GridCellNumberEditor]
+    # @return [Wx::GRID::GridCellNumberEditor]
     def initialize(min=-1, max=-1) end
     
     # Parameters string format is "min,max".

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

@@ -19,10 +19,12 @@ module Wx::GRID
   # @see  Wx::GRID::GridCellStringRenderer 
   # 
   # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
   class GridCellNumberRenderer < GridCellStringRenderer
   
     # Default constructor.
-    # @return [GridCellNumberRenderer]
+    # @return [Wx::GRID::GridCellNumberRenderer]
     def initialize; end
     
   end # GridCellNumberRenderer

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

@@ -20,24 +20,26 @@ module Wx::GRID
   # @see  Wx::GRID::GridCellStringRenderer 
   # 
   # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
   class GridCellRenderer < ::Object
   
-    # @return [GridCellRenderer]
+    # @return [Wx::GRID::GridCellRenderer]
     def initialize; end
     
     # This function must be implemented in derived classes to return a copy of itself.
-    # @return [Wx::GridCellRenderer]
+    # @return [Wx::GRID::GridCellRenderer]
     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] 
-    # @param attr [Wx::GridCellAttr] 
+    # @param grid [Wx::GRID::Grid] 
+    # @param attr [Wx::GRID::GridCellAttr] 
     # @param dc [Wx::DC] 
     # @param rect [Wx::Rect] 
     # @param row [Integer] 
     # @param col [Integer] 
-    # @param isSelected [true,false] 
+    # @param isSelected [Boolean] 
     # @return [void]
     def draw(grid, attr, dc, rect, row, col, isSelected) end
     
@@ -45,8 +47,8 @@ module Wx::GRID
     # 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 
-    # @param grid [Wx::Grid] 
-    # @param attr [Wx::GridCellAttr] 
+    # @param grid [Wx::GRID::Grid] 
+    # @param attr [Wx::GRID::GridCellAttr] 
     # @param dc [Wx::DC] 
     # @param row [Integer] 
     # @param col [Integer] 
@@ -57,8 +59,8 @@ module Wx::GRID
     # 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] 
-    # @param attr [Wx::GridCellAttr] 
+    # @param grid [Wx::GRID::Grid] 
+    # @param attr [Wx::GRID::GridCellAttr] 
     # @param dc [Wx::DC] 
     # @param row [Integer] 
     # @param col [Integer] 
@@ -69,8 +71,8 @@ module Wx::GRID
     
     # 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] 
-    # @param attr [Wx::GridCellAttr] 
+    # @param grid [Wx::GRID::Grid] 
+    # @param attr [Wx::GRID::GridCellAttr] 
     # @param dc [Wx::DC] 
     # @param row [Integer] 
     # @param col [Integer] 
@@ -82,8 +84,8 @@ module Wx::GRID
     # 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] 
-    # @param attr [Wx::GridCellAttr] 
+    # @param grid [Wx::GRID::Grid] 
+    # @param attr [Wx::GRID::GridCellAttr] 
     # @param dc [Wx::DC] 
     # @return [Wx::Size]
     def get_max_best_size(grid, attr, dc) end

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

@@ -19,10 +19,12 @@ module Wx::GRID
   # @see  Wx::GRID::GridCellNumberRenderer 
   # 
   # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
   class GridCellStringRenderer < GridCellRenderer
   
     # Default constructor.
-    # @return [GridCellStringRenderer]
+    # @return [Wx::GRID::GridCellStringRenderer]
     def initialize; end
     
   end # GridCellStringRenderer

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

@@ -20,11 +20,13 @@ module Wx::GRID
   # @see  Wx::GRID::GridCellDateEditor 
   # 
   # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
   class GridCellTextEditor < GridCellEditor
   
     # Text cell editor constructor.
     # @param maxChars [Integer]  Maximum width of text (this parameter is supported starting since wxWidgets 2.9.5).
-    # @return [GridCellTextEditor]
+    # @return [Wx::GRID::GridCellTextEditor]
     def initialize(maxChars=0) end
     
     # The parameters string format is "n" where n is a number representing the maximum width.