#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 changes to the table data, but allow the view to react to changes to the model.

The table must be updated before sending the notification. For example, a custom wxGridTableBase::InsertRows() implementation should first insert the rows into its own data storage and only then notify the grid:

bool MyTable::InsertRows(size_t pos, size_t numRows)
{
    DoInsertRowsInDataModel(pos, numRows);
 
    if ( GetView() )
    {
        GetView()->ProcessTableMessage(
            this, wxGRIDTABLE_NOTIFY_ROWS_INSERTED, pos, numRows);
    }
 
    return true;
}

The same rule applies to the other row and column modification messages: update the table first, then notify the grid.

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

Constructor & Destructor Documentation

◆ wxGridTableMessage() [1/2]

wxGridTableMessage::wxGridTableMessage ( )

Default constructor initializes the object to invalid state.

◆ wxGridTableMessage() [2/2]

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

Constructor initializes the message.

Parameters

table	Pointer to the grid table
id	One of wxGridTableRequest enum elements.
comInt1	For the insert/delete messages, position at which the rows or columns are inserted/deleted. For the append messages, the number of rows or columns that were appended.
comInt2	For the insert/delete messages, number of rows or columns to be inserted/deleted. For the append messages, this parameter is not used.

Member Function Documentation

◆ GetCommandInt()

int wxGridTableMessage::GetCommandInt ( ) const

Get the position at which the insertion/deletion occurs.

◆ GetCommandInt2()

int wxGridTableMessage::GetCommandInt2 ( ) const

Get the number of rows to be inserted/deleted.

◆ GetId()

int wxGridTableMessage::GetId ( ) const

Gets an id.

◆ GetTableObject()

wxGridTableBase * wxGridTableMessage::GetTableObject ( ) const

Gets the table object.

◆ SetCommandInt()

void wxGridTableMessage::SetCommandInt ( int comInt1 )

Set the position at which the insertion/deletion occurs.

◆ SetCommandInt2()

void wxGridTableMessage::SetCommandInt2 ( int comInt2 )

Set the number of rows to be inserted/deleted.

◆ SetId()

void wxGridTableMessage::SetId ( int id )

Sets an id.

◆ SetTableObject()

void wxGridTableMessage::SetTableObject ( wxGridTableBase * table )

Sets the table object.