doc: Add QT MVC structure to style guide #950
Open
Conversation
This file contains hidden or 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
|
class structure guide inspired by: https://www.pythonguis.com/tutorials/pyside6-modelview-architecture/ |
Computerdores
changed the title
8 tasks
CyanVoxel
added
Type: Documentation
CyanVoxel
reviewed
Jun 7, 2025
STYLE.md
Outdated
| - The Controller is just called `MyCoolWidget` instead of `MyCoolWidgetController` as it will be directly used by other code | ||
| - the ui elements are in private variables | ||
| - this enforces that the controller shouldn't directly access UI elements | ||
| - instead the view should provide a protected API (e.g. `_get_color()`) for things like setting/getting the value of a dropdown, etc. |
There was a problem hiding this comment.
Might be also worth giving properties a shoutout here
STYLE.md
Outdated
Comment on lines
71
to
76
| - the ui elements are in private variables | ||
| - this enforces that the controller shouldn't directly access UI elements | ||
| - instead the view should provide a protected API (e.g. `_get_color()`) for things like setting/getting the value of a dropdown, etc. | ||
| - the callback methods are already defined as protected methods with NotImplementedErrors | ||
| - defines the interface the callbacks | ||
| - enforces that UI events be handled |
There was a problem hiding this comment.
Small general nit for capitalization
There was a problem hiding this comment.
should be better now
|
I have now added everything I wanted to and thus this is ready for final review |
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.
Summary
Splits the style guide into a separate file, and documents the intended future structure of the qt part of the code base.
Tasks Completed
Not applicable