wxruby3 1.6.0 → 1.7.0

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

@@ -0,0 +1,108 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  module 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
+    # @see  Wx::GRID::GridCellBoolRenderer
+    # @see  Wx::GRID::GridCellDateTimeRenderer
+    # @see  Wx::GRID::GridCellEnumRenderer
+    # @see  Wx::GRID::GridCellFloatRenderer
+    # @see  Wx::GRID::GridCellNumberRenderer
+    # @see  Wx::GRID::GridCellStringRenderer 
+    # 
+    # 
+    # @wxrb_require USE_GRID
+    class GridCellRenderer < ::Object
+    
+      # @return [Wx::GRID::GridCellRenderer]
+      def initialize; end
+      
+      # This function must be implemented in derived classes to return a copy of itself.
+      # @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::Grid] 
+      # @param attr [Wx::GRID::GridCellAttr] 
+      # @param dc [Wx::DC] 
+      # @param rect [Wx::Rect] 
+      # @param row [Integer] 
+      # @param col [Integer] 
+      # @param isSelected [Boolean] 
+      # @return [void]
+      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 
+      # @param grid [Wx::GRID::Grid] 
+      # @param attr [Wx::GRID::GridCellAttr] 
+      # @param dc [Wx::DC] 
+      # @param row [Integer] 
+      # @param col [Integer] 
+      # @return [Wx::Size]
+      def get_best_size(grid, attr, dc, row, col) end
+      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] 
+      # @param attr [Wx::GRID::GridCellAttr] 
+      # @param dc [Wx::DC] 
+      # @param row [Integer] 
+      # @param col [Integer] 
+      # @param width [Integer] 
+      # @return [Integer]
+      def get_best_height(grid, attr, dc, row, col, width) end
+      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] 
+      # @param dc [Wx::DC] 
+      # @param row [Integer] 
+      # @param col [Integer] 
+      # @param height [Integer] 
+      # @return [Integer]
+      def get_best_width(grid, attr, dc, row, col, height) end
+      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] 
+      # @param attr [Wx::GRID::GridCellAttr] 
+      # @param dc [Wx::DC] 
+      # @return [Wx::Size]
+      def get_max_best_size(grid, attr, dc) end
+      alias_method :max_best_size, :get_max_best_size
+      
+      
+      protected
+      
+    end # GridCellRenderer
+    
+
+  end
+
+end

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

@@ -0,0 +1,35 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  module 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
+    # @see  Wx::GRID::GridCellAutoWrapStringRenderer
+    # @see  Wx::GRID::GridCellBoolRenderer
+    # @see  Wx::GRID::GridCellDateTimeRenderer
+    # @see  Wx::GRID::GridCellEnumRenderer
+    # @see  Wx::GRID::GridCellFloatRenderer
+    # @see  Wx::GRID::GridCellNumberRenderer 
+    # 
+    # 
+    # @wxrb_require USE_GRID
+    class GridCellStringRenderer < GridCellRenderer
+    
+      # Default constructor.
+      # @return [Wx::GRID::GridCellStringRenderer]
+      def initialize; end
+      
+    end # GridCellStringRenderer
+    
+
+  end
+
+end

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

@@ -0,0 +1,49 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  module GRID
+
+    # Grid cell editor for string/text data.
+    # 
+    # Category:  Grid Related Classes
+    # @see Wx::GRID::GridCellEditor
+    # @see  Wx::GRID::GridCellAutoWrapStringEditor
+    # @see  Wx::GRID::GridCellBoolEditor
+    # @see  Wx::GRID::GridCellChoiceEditor
+    # @see  Wx::GRID::GridCellEnumEditor
+    # @see  Wx::GRID::GridCellFloatEditor
+    # @see  Wx::GRID::GridCellNumberEditor
+    # @see  Wx::GRID::GridCellDateEditor 
+    # 
+    # 
+    # @wxrb_require USE_GRID
+    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 [Wx::GRID::GridCellTextEditor]
+      def initialize(maxChars=0) end
+      
+      # The parameters string format is "n" where n is a number representing the maximum width.
+      # @param params [String] 
+      # @return [void]
+      def set_parameters(params) end
+      alias_method :parameters=, :set_parameters
+      
+      # Set validator to validate user input.
+      # @param validator [Wx::Validator] 
+      # @return [void]
+      def set_validator(validator) end
+      alias_method :validator=, :set_validator
+      
+    end # GridCellTextEditor
+    
+
+  end
+
+end