extend AboutWindow #157
extend AboutWindow #157
Conversation
+ implement previously missing bindings for the following fields: - applicationIcon - releaseNotes - comments - debugInfo - developers - designers - artists - documenters - licenseType - legalSections - credits - acknowledgements - links + adds more examples and extends the documentation
by adding "about_window.nim" to uncompileable examples.
owlkettle/adw.nim
Outdated
| LICENSE_UNKNOWN = 0 | ||
| LICENSE_CUSTOM = 1 | ||
| LICENSE_GPL_2_0 = 2 | ||
| LICENSE_GPL_3_0 = 3 | ||
| LICENSE_LGPL_2_1 = 4 | ||
| LICENSE_LGPL_3_0 = 5 | ||
| LICENSE_BSD = 6 | ||
| LICENSE_MIT_X11 = 7 | ||
| LICENSE_ARTISTIC = 8 | ||
| LICENSE_GPL_2_0_ONLY = 9 | ||
| LICENSE_GPL_3_0_ONLY = 10 | ||
| LICENSE_LGPL_2_1_ONLY = 11 | ||
| LICENSE_LGPL_3_0_ONLY = 12 | ||
| LICENSE_AGPL_3_0 = 13 | ||
| LICENSE_AGPL_3_0_ONLY = 14 | ||
| LICENSE_BSD_3 = 15 | ||
| LICENSE_APACHE_2_0 = 16 | ||
| LICENSE_MPL_2_0 = 17 | ||
| LICENSE_0BSD = 18 |
There was a problem hiding this comment.
Style: Enum entries of the public enum should be PascalCase
There was a problem hiding this comment.
Converted them to PascalCase, however I am not sure how well it works for licenses like LicenseLGPL2_1_Only 🤔.
let me know if they are fine now or if can think of a better way for the ones containing both appreviations and decimal numbers.
owlkettle/adw.nim
Outdated
| license: string ## Sets the license as a custom text if it can’t be set via licenseType (when set licenseType will be set to GTK_LICENSE_CUSTOM). | ||
| licenseType: LicenseType ## Sets the license for from a list of known license. | ||
| legalSections: seq[LegalSection] ## Adds an extra section to the Legal page. Extra sections will be displayed below the application’s own information. The parameters copyright, licenseType and license will be used to present the it the same way as AboutWindow:copyright, AboutWindow:licenseType and AboutWindow:license are for the application’s own information. See those properties for more details. This can be useful to attribute the application dependencies or data. |
There was a problem hiding this comment.
Using the GTK doc comments is an issue as
- They often do not apply to owlkettle. E.g. in this case copyright, licenseType and license are not parameters to legalSections, as it is a field, not a function.
- GTK is LGPL licensed. I am not a lawyer, but from my understanding, as this license also applies to the (doc) comments, using GTK's doc comments would require owlkettle to be relicensed under LGPL (or a compatible license).
There was a problem hiding this comment.
I adjusted the comments to not be a direct copy of the GTK docs and to better fit owlkettle usage in some cases.
| result = gui: | ||
| Window: | ||
| title = "About Dialog Example" | ||
| defaultSize = (400, 200) |
There was a problem hiding this comment.
I would consider increasing the window size a bit, as the small size seems to cause weird behavior when attempting to move the about window.
There was a problem hiding this comment.
I did increase the size as you requested, but did not observe any weird behaviour myself (Fedora 39, libadwaita 1.4.3-2).
owlkettle/adw.nim
Outdated
| credits: seq[(string, seq[string])] ## Adds additional credit sections with customizable titles | ||
| acknowledgements: seq[(string, seq[string])] ## Adds acknowledgment sections with customizable titles | ||
| links: seq[(string, string)] ## Adds additionals links placed in the details section |
There was a problem hiding this comment.
I would use tuples with named fields (tuple[x: float]) instead of anonymous tuples. Otherwise the purpose of the fields is not immediately obvious.
|
Regarding the Regarding optional values: I would say that if possible, use the empty string value as the NULL value. If the widget has different behavior when passing an empty string vs. passing NULL, use std/options. |
Co-authored-by: Can Lehmann <85876381+can-lehmann@users.noreply.github.com>
- use PascalCase for LicenseType enum - use tuples with named fields instead - tweak doc comments - increase example window size
nylki
force-pushed
the
extend-adwaita-aboutwindow
branch
from
99ec4f9
to
d384c50
Compare
|
I appreciate you taking the time to look into the PR! :)
Thanks! As it turns it in the case of the credits section ( |
can-lehmann
force-pushed
the
extend-adwaita-aboutwindow
branch
from
f4f00f3
to
917305b
Compare
|
Looks good, thanks for contributing! I fixed some typos before merging. I also changed the example values for the |
This PR implement previously missing bindings for the following fields in
AboutWindow(Adwaita):I also added an example for the Adwaita AboutWindow with a screenshot and everything. 🙂
Originally, I planned to implement all the missing fields.
But since I lack experience with both nim and GTK development, I didn't feel comfortable touching the
translatorsfield because it appears to ties into app localization which I was not sure if it was even supported in owlkettle yet.Some other things I wasn't sure about when implementing the bindings:
legalSections: I defined a custom type to be easier able to fill the list. However I am not sure if thats the way to go here, or if it could be made more concise with standard dictionary/tuple types (which I didn't manage to do).optional section name in
credits: I didn't make it optional in this MR, as I wasn't sure what's the best way to deal with optional values is in nim/owlkettle (see above).