Class: Wx::GRID::GridTableMessage

Inherits:
Object
  • Object
show all
Defined in:
lib/wx/doc/gen/grid/grid_table_message.rb

Overview

Note:

This class is untracked and should not be derived from nor instances extended!

Message class used by the grid table to send requests and notifications to the grid view.

A message object of this class must be sent to the grid using Wx::GRID::Grid#process_table_message every time the table changes, e.g. rows are added/deleted. The messages are just notifications and don’t result in any actual changes but just allow the view to react to changes to the model.

Requires:

  • USE_GRID

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Wx::GRID::GridTableMessage #initialize(table, id, comInt1 = -1, comInt2 = -1) ⇒ Wx::GRID::GridTableMessage

Returns a new instance of GridTableMessage.

Overloads:

  • #initialize ⇒ Wx::GRID::GridTableMessage

    Default constructor initializes the object to invalid state.

  • #initialize(table, id, comInt1 = -1, comInt2 = -1) ⇒ Wx::GRID::GridTableMessage

    Constructor really initialize the message.

    Parameters:

    • table (Wx::GRID::GridTableBase) —

      Pointer to the grid table

    • id (Integer) —

      One of Wx::GRID::GridTableRequest enum elements.

    • comInt1 (Integer) (defaults to: -1) —

      For the insert/delete messages, position after which the rows or columns are inserted/deleted. For the append messages, the number of rows or columns that were appended.

    • comInt2 (Integer) (defaults to: -1) —

      For the insert/deleted messages, number of rows or columns to be inserted/deleted. For the append messages, this parameter is not used.



30
 
# File 'lib/wx/doc/gen/grid/grid_table_message.rb', line 30

def initialize(*args) end

Instance Method Details

#get_command_int ⇒ Integer Also known as: command_int

Get the position after which the insertion/deletion occur.

Returns:

  • (Integer) 


62
 
# File 'lib/wx/doc/gen/grid/grid_table_message.rb', line 62

def get_command_int; end

#get_command_int2 ⇒ Integer Also known as: command_int2

Get the number of rows to be inserted/deleted.

Returns:

  • (Integer) 


73
 
# File 'lib/wx/doc/gen/grid/grid_table_message.rb', line 73

def get_command_int2; end

#get_id ⇒ Integer Also known as: id

Gets an id.

Returns:

  • (Integer) 


51
 
# File 'lib/wx/doc/gen/grid/grid_table_message.rb', line 51

def get_id; end

#get_table_object ⇒ Wx::GRID::GridTableBase Also known as: table_object

Gets the table object.

Returns:



40
 
# File 'lib/wx/doc/gen/grid/grid_table_message.rb', line 40

def get_table_object; end

#set_command_int(comInt1) ⇒ void Also known as: command_int=

This method returns an undefined value.

Set the position after which the insertion/deletion occur.

Parameters:

  • comInt1 (Integer) 


57
 
# File 'lib/wx/doc/gen/grid/grid_table_message.rb', line 57

def set_command_int(comInt1) end

#set_command_int2(comInt2) ⇒ void Also known as: command_int2=

This method returns an undefined value.

Set the number of rows to be inserted/deleted.

Parameters:

  • comInt2 (Integer) 


68
 
# File 'lib/wx/doc/gen/grid/grid_table_message.rb', line 68

def set_command_int2(comInt2) end

#set_id(id) ⇒ void Also known as: id=

This method returns an undefined value.

Sets an id.

Parameters:

  • id (Integer) 


46
 
# File 'lib/wx/doc/gen/grid/grid_table_message.rb', line 46

def set_id(id) end

#set_table_object(table) ⇒ void Also known as: table_object=

This method returns an undefined value.

Sets the table object.

Parameters:



35
 
# File 'lib/wx/doc/gen/grid/grid_table_message.rb', line 35

def set_table_object(table) end