phoenix_title wx.grid.GridTableMessage

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.ProcessTableMessage 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.


class_hierarchy Class Hierarchy

Inheritance diagram for class GridTableMessage:

method_summary Methods Summary

__init__

Default constructor initializes the object to invalid state.

GetCommandInt

Get the position after which the insertion/deletion occur.

GetCommandInt2

Get the number of rows to be inserted/deleted.

GetId

Gets an id.

GetTableObject

Gets the table object.

SetCommandInt

Set the position after which the insertion/deletion occur.

SetCommandInt2

Set the number of rows to be inserted/deleted.

SetId

Sets an id.

SetTableObject

Sets the table object.


api Class API

class wx.grid.GridTableMessage(object)

Possible constructors:

GridTableMessage()

GridTableMessage(table, id, comInt1=-1, comInt2=-1)

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


Methods

__init__(self, *args, **kw)

overload Overloaded Implementations:



__init__ (self)

Default constructor initializes the object to invalid state.



__init__ (self, table, id, comInt1=-1, comInt2=-1)

Constructor really initialize the message.

Parameters
  • table (wx.grid.GridTableBase) – Pointer to the grid table

  • id (int) – One of GridTableRequest enum elements.

  • comInt1 (int) – 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 (int) – For the insert/deleted messages, number of rows or columns to be inserted/deleted. For the append messages, this parameter is not used.





GetCommandInt(self)

Get the position after which the insertion/deletion occur.

Return type

int



GetCommandInt2(self)

Get the number of rows to be inserted/deleted.

Return type

int



GetId(self)

Gets an id.

Return type

int



GetTableObject(self)

Gets the table object.

Return type

wx.grid.GridTableBase



SetCommandInt(self, comInt1)

Set the position after which the insertion/deletion occur.

Parameters

comInt1 (int) –



SetCommandInt2(self, comInt2)

Set the number of rows to be inserted/deleted.

Parameters

comInt2 (int) –



SetId(self, id)

Sets an id.

Parameters

id (int) –



SetTableObject(self, table)

Sets the table object.

Parameters

table (wx.grid.GridTableBase) –


Properties

CommandInt

See GetCommandInt and SetCommandInt



CommandInt2

See GetCommandInt2 and SetCommandInt2



Id

See GetId and SetId



TableObject

See GetTableObject and SetTableObject