interesting
/
libui
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Clarify uiTableModelRowInserted API documentation. 

* Require the new row to have been added to the model
  before calling uiTableModelRowInserted.
* Require the row count to be updated before calling
  uiTableModelRowInserted.

Notes
-----

darwin: does not care about row counts internally. From the docs:
        > The numberOfRows in the table view is automatically increased
        > by the count of indexes.

unix: does not state anything regarding order in the documentation.

windows: does not state anything in the documentation but does keep
         track of its own row count internally.

So in theory we do not have to require increasing the row count before
calling uiTableModelRowInserted, but just by the very nature of the
function name (past tense) we should.
This commit is contained in:
Angelo Haller 2020-09-20 18:00:08 -05:00
parent 34d1d0ac48
commit 3f42463bf4
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
ui.h
View File

@ -1324,11 +1324,13 @@ _UI_EXTERN uiTableModel *uiNewTableModel(uiTableModelHandler *mh);
// free table models currently associated with a uiTable.
_UI_EXTERN void uiFreeTableModel(uiTableModel *m);
// uiTableModelRowInserted() tells any uiTable associated with m
// that a new row has been added to m at index index. You call
// this function when the number of rows in your model has
// changed; after calling it, NumRows() should returm the new row
// count.
// uiTableModelRowInserted() tell all uiTables associated with
// the uiTableModel m that a new row has been added to m at
// index newIndex.
// You must insert the row data in your model before calling this
// function.
// NumRows() must represent the new row count before you call
// this function.
_UI_EXTERN void uiTableModelRowInserted(uiTableModel *m, int newIndex);
// uiTableModelRowChanged() tells any uiTable associated with m