Version: 3.1.3
wxGridTableMessage Class Reference

#include <wx/grid.h>

Detailed Description

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 wxGrid::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.

Public Member Functions

 wxGridTableMessage ()
 Default constructor initializes the object to invalid state. More...
 
 wxGridTableMessage (wxGridTableBase *table, int id, int comInt1=-1, int comInt2=-1)
 Constructor really initialize the message. More...
 
void SetTableObject (wxGridTableBase *table)
 Sets the table object. More...
 
wxGridTableBaseGetTableObject () const
 Gets the table object. More...
 
void SetId (int id)
 Sets an id. More...
 
int GetId ()
 Gets an id. More...
 
void SetCommandInt (int comInt1)
 Set the position after which the insertion/deletion occur. More...
 
int GetCommandInt ()
 Get the position after which the insertion/deletion occur. More...
 
void SetCommandInt2 (int comInt2)
 Set the number of rows to be inserted/deleted. More...
 
int GetCommandInt2 ()
 Get the number of rows to be inserted/deleted. More...
 

Constructor & Destructor Documentation

wxGridTableMessage::wxGridTableMessage ( )

Default constructor initializes the object to invalid state.

wxGridTableMessage::wxGridTableMessage ( wxGridTableBase table,
int  id,
int  comInt1 = -1,
int  comInt2 = -1 
)

Constructor really initialize the message.

Parameters
tablePointer to the grid table
idOne of wxGridTableRequest enum elements.
comInt1Position after which the rows are inserted/deleted
comInt2Number of rows to be inserted/deleted

Member Function Documentation

int wxGridTableMessage::GetCommandInt ( )

Get the position after which the insertion/deletion occur.

int wxGridTableMessage::GetCommandInt2 ( )

Get the number of rows to be inserted/deleted.

int wxGridTableMessage::GetId ( )

Gets an id.

wxGridTableBase* wxGridTableMessage::GetTableObject ( ) const

Gets the table object.

void wxGridTableMessage::SetCommandInt ( int  comInt1)

Set the position after which the insertion/deletion occur.

void wxGridTableMessage::SetCommandInt2 ( int  comInt2)

Set the number of rows to be inserted/deleted.

void wxGridTableMessage::SetId ( int  id)

Sets an id.

void wxGridTableMessage::SetTableObject ( wxGridTableBase table)

Sets the table object.