From 2dafdbbed01c673aadfdcb35cf5ee70fc139b15f Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Sun, 28 Aug 2022 20:44:34 +0200 Subject: [PATCH] Document change to wxGrid::ProcessTableMessage() signature Update the documentation after the change in the previous commit and improve it to make it more clear what this function does and when it should be called. --- interface/wx/grid.h | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/interface/wx/grid.h b/interface/wx/grid.h index fa2fd5c806..07a06c77d4 100644 --- a/interface/wx/grid.h +++ b/interface/wx/grid.h @@ -3111,9 +3111,12 @@ public: wxGridSelectionModes selmode = wxGridSelectCells); /** - Receive and handle a message from the table. + Reacts to a message notifying about a change to the grid shape. + + This function should be called by the wxGridTableBase-derived class to + notify the grid about any changes to its rows or columns. */ - bool ProcessTableMessage(wxGridTableMessage& msg); + bool ProcessTableMessage(const wxGridTableMessage& msg); ///@}