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

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

@@ -13,6 +13,8 @@ module Wx::GRID
   # 
   # Category:  Grid Related Classes
   # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
   class GridCellAttr < ::Object
   
     # Kind of the attribute to retrieve.
@@ -50,19 +52,14 @@ module Wx::GRID
       
     end # AttrKind
     
-    # @overload initialize(attrDefault=nil)
-    #   Default constructor.
-    #   @param attrDefault [Wx::GRID::GridCellAttr] 
-    #   @return [Wx::GRID::GridCellAttr]
-    # @overload initialize(colText, colBack, font, hAlign, vAlign)
-    #   Constructor specifying some of the often used attributes.
-    #   @param colText [Wx::Colour,String,Symbol] 
-    #   @param colBack [Wx::Colour,String,Symbol] 
-    #   @param font [Wx::Font,Wx::FontInfo] 
-    #   @param hAlign [Integer] 
-    #   @param vAlign [Integer] 
-    #   @return [Wx::GRID::GridCellAttr]
-    def initialize(*args) end
+    # Constructor specifying some of the often used attributes.
+    # @param colText [Wx::Colour,String,Symbol] 
+    # @param colBack [Wx::Colour,String,Symbol] 
+    # @param font [Wx::Font,Wx::FontInfo] 
+    # @param hAlign [Integer] 
+    # @param vAlign [Integer] 
+    # @return [Wx::GRID::GridCellAttr]
+    def initialize(colText, colBack, font, hAlign, vAlign) end
     
     # Creates a new copy of this object.
     # @return [Wx::GRID::GridCellAttr]
@@ -70,7 +67,7 @@ module Wx::GRID
     
     # Get the alignment to use for the cell with the given attribute.
     # If this attribute doesn't specify any alignment, the default attribute alignment is used (which can be changed using {Wx::GRID::Grid#set_default_cell_alignment} but is left and top by default).
-    # Notice that hAlign and vAlign values are always overwritten by this function, use {Wx::GRID::GridCellAttr#get_non_default_alignment} if this is not desirable.
+    # Notice that valid hAlign and vAlign values (default or non-default) are always returned by this function, use {Wx::GRID::GridCellAttr#get_non_default_alignment} if this is not desirable.
     # @return [Array(Integer,Integer)]
     def get_alignment; end
     alias_method :alignment, :get_alignment
@@ -95,12 +92,11 @@ module Wx::GRID
     alias_method :font, :get_font
     
     # Get the alignment defined by this attribute.
-    # Unlike {Wx::GRID::GridCellAttr#get_alignment} this function only modifies hAlign and vAlign if this attribute does define a non-default alignment. This means that they must be initialized before calling this function and that their values will be preserved unchanged if they are different from {Wx::Alignment::ALIGN_INVALID}.
+    # Unlike {Wx::GRID::GridCellAttr#get_alignment} this function only returns hAlign and vAlign if this attribute does define a non-default alignment. Otherwise the returned value will be {Wx::ALIGN_INVALID}.
     # For example, the following fragment can be used to use the cell alignment if one is defined but right-align its contents by default (instead of left-aligning it by default) while still using the default vertical alignment: 
-    # ```
-    #   int hAlign = wxALIGN_RIGHT,
-    #       vAlign = wxALIGN_INVALID;
-    #   attr.GetNonDefaultAlignment(&hAlign, &vAlign);
+    # ```ruby
+    #   h_align, v_align = attr.get_non_default_alignment
+    #   h_align = Wx::ALIGN_RIGHT if h_align == Wx::ALIGN_INVALID
     # ```
     # @return [Array(Integer,Integer)]
     def get_non_default_alignment; end
@@ -121,37 +117,37 @@ module Wx::GRID
     alias_method :text_colour, :get_text_colour
     
     # Returns true if this attribute has a valid alignment set.
-    # @return [true,false]
+    # @return [Boolean]
     def has_alignment; end
     alias_method :has_alignment?, :has_alignment
     
     # Returns true if this attribute has a valid background colour set.
-    # @return [true,false]
+    # @return [Boolean]
     def has_background_colour; end
     alias_method :has_background_colour?, :has_background_colour
     
     # Returns true if this attribute has a valid cell editor set.
-    # @return [true,false]
+    # @return [Boolean]
     def has_editor; end
     alias_method :has_editor?, :has_editor
     
     # Returns true if this attribute has a valid font set.
-    # @return [true,false]
+    # @return [Boolean]
     def has_font; end
     alias_method :has_font?, :has_font
     
     # Returns true if this attribute has a valid cell renderer set.
-    # @return [true,false]
+    # @return [Boolean]
     def has_renderer; end
     alias_method :has_renderer?, :has_renderer
     
     # Returns true if this attribute has a valid text colour set.
-    # @return [true,false]
+    # @return [Boolean]
     def has_text_colour; end
     alias_method :has_text_colour?, :has_text_colour
     
     # Returns true if this cell is set as read-only.
-    # @return [true,false]
+    # @return [Boolean]
     def is_read_only; end
     alias_method :read_only?, :is_read_only
     
@@ -168,13 +164,6 @@ module Wx::GRID
     def set_background_colour(colBack) end
     alias_method :background_colour=, :set_background_colour
     
-    # 
-    # TodoNeeds documentation.
-    # @param defAttr [Wx::GRID::GridCellAttr] 
-    # @return [void]
-    def set_def_attr(defAttr) end
-    alias_method :def_attr=, :set_def_attr
-    
     # Sets the editor to be used with the cells with this attribute.
     # @param editor [Wx::GRID::GridCellEditor] 
     # @return [void]
@@ -188,7 +177,7 @@ module Wx::GRID
     alias_method :font=, :set_font
     
     # Sets the cell as read-only.
-    # @param isReadOnly [true,false] 
+    # @param isReadOnly [Boolean] 
     # @return [void]
     def set_read_only(isReadOnly=true) end
     alias_method :read_only=, :set_read_only
@@ -206,10 +195,6 @@ module Wx::GRID
     def set_text_colour(colText) end
     alias_method :text_colour=, :set_text_colour
     
-    # @param mergefrom [Wx::GRID::GridCellAttr] 
-    # @return [void]
-    def merge_with(mergefrom) end
-    
     # @param num_rows [Integer] 
     # @param num_cols [Integer] 
     # @return [void]
@@ -217,34 +202,34 @@ module Wx::GRID
     
     # Specifies the behaviour of the cell contents if it doesn't fit into the available space.
     # 
-    # @see Wx::GridFitMode
-    # @param fitMode [Wx::GridFitMode] 
+    # @see Wx::GRID::GridFitMode
+    # @param fitMode [Wx::GRID::GridFitMode] 
     # @return [void]
     def set_fit_mode(fitMode) end
     alias_method :fit_mode=, :set_fit_mode
     
     # Specifies if cells using this attribute should overflow or clip their contents.
-    # This is the same as calling {Wx::GRID::GridCellAttr#set_fit_mode} with either Wx::GridFitMode#overflow or Wx::GridFitMode#clip argument depending on whether allow is true or false.
+    # This is the same as calling {Wx::GRID::GridCellAttr#set_fit_mode} with either {Wx::GRID::GridFitMode.overflow} or {Wx::GRID::GridFitMode.clip} argument depending on whether allow is true or false.
     # Prefer using {Wx::GRID::GridCellAttr#set_fit_mode} directly instead in the new code.
-    # @param allow [true,false] 
+    # @param allow [Boolean] 
     # @return [void]
     def set_overflow(allow=true) end
     alias_method :overflow=, :set_overflow
     
-    # @param kind [AttrKind] 
+    # @param kind [Wx::wxGridCellAttr::AttrKind] 
     # @return [void]
     def set_kind(kind) end
     alias_method :kind=, :set_kind
     
-    # @return [true,false]
+    # @return [Boolean]
     def has_read_write_mode; end
     alias_method :has_read_write_mode?, :has_read_write_mode
     
-    # @return [true,false]
+    # @return [Boolean]
     def has_overflow_mode; end
     alias_method :has_overflow_mode?, :has_overflow_mode
     
-    # @return [true,false]
+    # @return [Boolean]
     def has_size; end
     alias_method :has_size?, :has_size
     
@@ -253,24 +238,24 @@ module Wx::GRID
     alias_method :size, :get_size
     
     # Returns the fitting mode for the cells using this attribute.
-    # The returned {Wx::GridFitMode} is always specified, i.e. Wx::GridFitMode#is_specified always returns true. The default value, if {Wx::GRID::GridCellAttr#set_fit_mode} hadn't been called before, is "overflow".
-    # @return [Wx::GridFitMode]
+    # The returned {Wx::GRID::GridFitMode} is always specified, i.e. {Wx::GRID::GridFitMode#is_specified} always returns true. The default value, if {Wx::GRID::GridCellAttr#set_fit_mode} hadn't been called before, is "overflow".
+    # @return [Wx::GRID::GridFitMode]
     def get_fit_mode; end
     alias_method :fit_mode, :get_fit_mode
     
     # Returns true if the cells using this attribute overflow into the neighbouring cells.
     # Prefer using {Wx::GRID::GridCellAttr#get_fit_mode} in the new code.
-    # @return [true,false]
+    # @return [Boolean]
     def get_overflow; end
     alias_method :overflow, :get_overflow
     
     # Returns true if the cell will draw an overflowed text into the neighbouring cells.
     # Note that only left aligned cells currently can overflow. It means that {Wx::GRID::GridCellAttr#get_fit_mode}.IsOverflow() should returns true and GetAlignment should returns {Wx::Alignment::ALIGN_LEFT} for hAlign parameter.
-    # @return [true,false]
+    # @return [Boolean]
     def can_overflow; end
     alias_method :can_overflow?, :can_overflow
     
-    # @return [AttrKind]
+    # @return [Wx::wxGridCellAttr::AttrKind]
     def get_kind; end
     alias_method :kind, :get_kind
     

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

@@ -20,6 +20,8 @@ module Wx::GRID
   # @see  Wx::GRID::GridCellDateEditor 
   # 
   # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
   class GridCellAutoWrapStringEditor < GridCellTextEditor
   
     # @return [Wx::GRID::GridCellAutoWrapStringEditor]

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

@@ -20,6 +20,8 @@ module Wx::GRID
   # @see  Wx::GRID::GridCellStringRenderer 
   # 
   # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
   class GridCellAutoWrapStringRenderer < GridCellStringRenderer
   
     # Default constructor.

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

@@ -20,6 +20,8 @@ module Wx::GRID
   # @see  Wx::GRID::GridCellDateEditor 
   # 
   # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
   class GridCellBoolEditor < GridCellEditor
   
     # Default constructor.
@@ -28,7 +30,7 @@ module Wx::GRID
     
     # Returns true if the given value is equal to the string representation of the truth value we currently use (see {Wx::GRID::GridCellBoolEditor.use_string_values}).
     # @param value [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def self.is_true_value(value) end
     
     # This method allows you to customize the values returned by {Wx::GRID::GridCellBoolEditor#get_value} for the cell using this editor.

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

@@ -19,6 +19,8 @@ module Wx::GRID
   # @see  Wx::GRID::GridCellStringRenderer 
   # 
   # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
   class GridCellBoolRenderer < GridCellStringRenderer
   
     # Default constructor.

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

@@ -20,20 +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 GridCellChoiceEditor < GridCellEditor
   
-    # @overload initialize(count=0, choices=nil, allowOthers=false)
-    #   Choice cell renderer ctor.
-    #   @param count [Integer]  Number of strings from which the user can choose.
-    #   @param choices [Wx::String]  An array of strings from which the user can choose.
-    #   @param allowOthers [true,false]  If allowOthers is true, the user can type a string not in choices array.
-    #   @return [Wx::GRID::GridCellChoiceEditor]
-    # @overload initialize(choices, allowOthers=false)
-    #   Choice cell renderer ctor.
-    #   @param choices [Array<String>]  An array of strings from which the user can choose.
-    #   @param allowOthers [true,false]  If allowOthers is true, the user can type a string not in choices array.
-    #   @return [Wx::GRID::GridCellChoiceEditor]
-    def initialize(*args) end
+    # Choice cell renderer ctor.
+    # @param choices [Array<String>]  An array of strings from which the user can choose.
+    # @param allowOthers [Boolean]  If allowOthers is true, the user can type a string not in choices array.
+    # @return [Wx::GRID::GridCellChoiceEditor]
+    def initialize(choices, allowOthers=false) end
     
     # Parameters string format is "item1[,item2[...,itemN]]".
     # This method can be called before the editor is used for the first time, or later, in which case it replaces the previously specified strings with the new ones.

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

@@ -20,6 +20,8 @@ module Wx::GRID
   # @see  Wx::GRID::GridCellTextEditor
   # 
   # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
   class GridCellDateEditor < GridCellEditor
   
     # Date editor constructor.

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

@@ -21,6 +21,8 @@ module Wx::GRID
   # @see  Wx::GRID::GridCellDateTimeRenderer
   # 
   # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
   class GridCellDateRenderer < GridCellStringRenderer
   
     # Date renderer constructor.

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

@@ -21,6 +21,8 @@ module Wx::GRID
   # @see  Wx::GRID::GridCellDateRenderer 
   # 
   # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
   class GridCellDateTimeRenderer < GridCellDateRenderer
   
     # Date/time renderer constructor.

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

@@ -22,6 +22,8 @@ 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.
@@ -66,7 +68,7 @@ module 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.
@@ -83,7 +85,7 @@ 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
     
@@ -105,7 +107,7 @@ 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 show [Boolean] 
     # @param attr [Wx::GRID::GridCellAttr] 
     # @return [void]
     def show(show, attr=nil) end
@@ -122,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
     

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

@@ -21,6 +21,8 @@ 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.

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

@@ -20,6 +20,8 @@ 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.

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

@@ -20,6 +20,8 @@ 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.

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

@@ -19,6 +19,8 @@ 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.

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

@@ -20,6 +20,8 @@ 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.

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

@@ -19,6 +19,8 @@ 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.

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

@@ -20,6 +20,8 @@ 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 [Wx::GRID::GridCellRenderer]
@@ -37,7 +39,7 @@ module Wx::GRID
     # @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
     

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

@@ -19,6 +19,8 @@ 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.

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

@@ -20,6 +20,8 @@ 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.