Document wxGrid::RefreshBlock()

This function is useful and there is no reason to exclude it from public
API and it should have been done back in 00224e3f30 (Add
wxGrid::RefreshBlock() helper, 2019-07-11) when it was added.
This commit is contained in:
Vadim Zeitlin 2022-08-03 19:12:32 +02:00
parent c0f1ecf263
commit 7999102295
2 changed files with 24 additions and 2 deletions

View file

@ -5811,6 +5811,28 @@ public:
*/
void RefreshAttr(int row, int col);
/**
Redraw all the cells in the given block.
Refresh the block of cells with the given corners.
If the bottom right corner coordinates are invalid, i.e. set to `-1`,
the top left corner coordinates are used for it, i.e. just a single
cell is refreshed. If the top left corner coordinates are invalid as
well, the function simply returns without doing anything. Note,
however, that both coordinates need to be valid or invalid
simultaneously, i.e. setting the top row to `-1` but using a valid
value for the left column is unsupported and would result in an
assertion failure.
@since 3.1.3
*/
void RefreshBlock(const wxGridCellCoords& topLeft,
const wxGridCellCoords& bottomRight);
/// @overload
void RefreshBlock(int topRow, int leftCol,
int bottomRow, int rightCol);
/**
Draws part or all of a wxGrid on a wxDC for printing or display.

View file

@ -452,7 +452,7 @@ public:
*/
void SetQuality(wxPenQuality quality);
//@{
///@{
/**
The pen's colour is changed to the given colour.
@ -460,7 +460,7 @@ public:
*/
virtual void SetColour(wxColour& colour);
virtual void SetColour(unsigned char red, unsigned char green, unsigned char blue);
//@}
///@}
/**
Associates an array of dash values (defined as @c char in X, @c DWORD under