# :stopdoc: # This file is automatically generated by the WXRuby3 documentation # generator. Do not alter this file. # :startdoc: module Wx::GRID # Simplest type of data table for a grid for small tables of strings that are stored in memory. # The number of rows and columns in the table can be specified initially but may also be changed later dynamically. # class GridStringTable < GridTableBase # @overload initialize() # Default constructor creates an empty table. # @return [GridStringTable] # @overload initialize(numRows, numCols) # Constructor taking number of rows and columns. # @param numRows [Integer] # @param numCols [Integer] # @return [GridStringTable] def initialize(*args) end # Must be overridden to return the number of rows in the table. # For backwards compatibility reasons, this method is not const. Use {Wx::GRID::GridStringTable#get_rows_count} instead of it in const methods of derived table classes. # @return [Integer] def get_number_rows; end alias_method :number_rows, :get_number_rows # Must be overridden to return the number of columns in the table. # For backwards compatibility reasons, this method is not const. Use {Wx::GRID::GridStringTable#get_cols_count} instead of it in const methods of derived table classes, # @return [Integer] def get_number_cols; end alias_method :number_cols, :get_number_cols # Must be overridden to implement accessing the table values as text. # @param row [Integer] # @param col [Integer] # @return [String] def get_value(row, col) end alias_method :value, :get_value # Must be overridden to implement setting the table values as text. # @param row [Integer] # @param col [Integer] # @param value [String] # @return [void] def set_value(row, col, value) end # Clear the table contents. # This method is used by {Wx::GRID::Grid#clear_grid}. # @return [void] def clear; end # Insert additional rows into the table. # @param pos [Integer] The position of the first new row. # @param numRows [Integer] The number of rows to insert. # @return [true,false] def insert_rows(pos=0, numRows=1) end # Append additional rows at the end of the table. # This method is provided in addition to {Wx::GRID::GridStringTable#insert_rows} as some data models may only support appending rows to them but not inserting them at arbitrary locations. In such case you may implement this method only and leave {Wx::GRID::GridStringTable#insert_rows} unimplemented. # @param numRows [Integer] The number of rows to add. # @return [true,false] def append_rows(numRows=1) end # Delete rows from the table. # @param pos [Integer] The first row to delete. # @param numRows [Integer] The number of rows to delete. # @return [true,false] def delete_rows(pos=0, numRows=1) end # Exactly the same as {Wx::GRID::GridStringTable#insert_rows} but for columns. # @param pos [Integer] # @param numCols [Integer] # @return [true,false] def insert_cols(pos=0, numCols=1) end # Exactly the same as {Wx::GRID::GridStringTable#append_rows} but for columns. # @param numCols [Integer] # @return [true,false] def append_cols(numCols=1) end # Exactly the same as {Wx::GRID::GridStringTable#delete_rows} but for columns. # @param pos [Integer] # @param numCols [Integer] # @return [true,false] def delete_cols(pos=0, numCols=1) end # Set the given label for the specified row. # The default version does nothing, i.e. the label is not stored. You must override this method in your derived class if you wish {Wx::GRID::Grid#set_row_label_value} to work. # @param row [Integer] # @param label [String] # @return [void] def set_row_label_value(row, label) end # Exactly the same as {Wx::GRID::GridStringTable#set_row_label_value} but for columns. # @param col [Integer] # @param label [String] # @return [void] def set_col_label_value(col, label) end # Set the given label for the grid's corner. # The default version does nothing, i.e. the label is not stored. You must override this method in your derived class if you wish {Wx::GRID::Grid#get_corner_label_value} to work. # @param arg [String] # @return [void] def set_corner_label_value(arg) end alias_method :corner_label_value=, :set_corner_label_value # Return the label of the specified row. # @param row [Integer] # @return [String] def get_row_label_value(row) end alias_method :row_label_value, :get_row_label_value # Return the label of the specified column. # @param col [Integer] # @return [String] def get_col_label_value(col) end alias_method :col_label_value, :get_col_label_value # Return the label of the grid's corner. # @return [String] def get_corner_label_value; end alias_method :corner_label_value, :get_corner_label_value end # GridStringTable end