Fix table row inserted/deleted documentation and windows implementation. #515
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* 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.
* Require the deleted row to have been removed from the
model before calling uiTableModelRowDeleted.
* Require the row count to be updated before calling
uiTableModelRowDeleted.
Notes
-----
darwin: Does not care about row counts internally.
unix: Requires the row to have been deleted prior to
calling this function:
> This should be called by models after a row has been removed.
> The location pointed to by path should be the location that the
> row previously was at. It may not be a valid location anymore.
windows: Does not state anything in the documentation but does keep
track of its own row count internally.
Fix double row insertion bug on uiTableModelRowInserted(). Fix uiTableModelRowDeleted() to match API. Remove redundant call to update row count. Remove TODOs that have been implemented. Use more readable win32 macros.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As I failed to understand the documentation of both
uiTableModelRowInserted()anduiTableModelRowDeleted()on when to insert to/delete from the underlying model and when to in/decrease theNumRows()counter - I decided to do some digging.As it stands the current implementation does not seem to be so sure itself. The windows code is completely broken. The TODOs regarding API clarification and compatability with unix and darwin were never implemented. This patch set fixes all that.
uiTableModelRowInserted()anduiTableModelRowDeleted()NumRows()to reflect the new row count before callinguiTableModelRowInserted()anduiTableModelRowDeleted()Strictly API wise speaking only gtk seems to require data insertion into the model before calling
uiTableModelRowInserted().With this patch set no implementation actually relies on the value in
NumRows().But my reasoning is that both functions are past tense. The operation has already been performed and hence the state of the model should represent that. Otherwise I would consider the function names to be buggy.
Oh and I used the win32 provided macros instead of the SendMessageW((CastARoo*))((FUNCTIONS))