Add the ability to specify platform-specific icons #2260
Conversation
freakboy3742
force-pushed
the
platform-icons
branch
from
27b1f7d
to
8b15e4c
Compare
freakboy3742
force-pushed
the
platform-icons
branch
from
0faf194
to
2c239be
Compare
|
I think this needs to be rebased again – it still contains all of #2259. |
Done. |
freakboy3742
force-pushed
the
platform-icons
branch
from
7e2318a
to
d84d920
Compare
| On GTK, Toga will look for (in order): | ||
| * ``myicon-linux-72.png`` |
There was a problem hiding this comment.
RST requires a blank line before a list.
| On GTK, Toga will look for (in order): | |
| * ``myicon-linux-72.png`` | |
| On GTK, Toga will look for (in order): | |
| * ``myicon-linux-72.png`` |
core/src/toga/icons.py
Outdated
| def TOGA_ICON(cls) -> Icon: | ||
| return Icon("resources/toga", system=True) | ||
| return Icon("toga", system=True) | ||
|
|
||
| @cachedicon | ||
| def DEFAULT_ICON(cls) -> Icon: | ||
| return Icon("resources/toga", system=True) | ||
| return Icon("toga", system=True) | ||
|
|
||
| @cachedicon | ||
| def OPTION_CONTAINER_DEFAULT_TAB_ICON(cls) -> Icon: |
There was a problem hiding this comment.
These should have some docstrings, which should at least explain the distinction between TOGA_ICON and DEFAULT_ICON. If there isn't any distinction, maybe we should deprecate one of them.
There was a problem hiding this comment.
Agreed documenting these is desirable... is it possible? How do you docstring a constant?
There was a problem hiding this comment.
Hm, I see these aren't normal @properties, so I'm not sure how Sphinx would deal with them. Maybe it could be done by making cachedicon copy the __doc__ attribute from the underlying method to itself. Or maybe we could use the #: syntax that works in Enums (e.g. in toga/core/src/toga/constants/__init__.py).
There was a problem hiding this comment.
Oh wait... these are properties... Forgot about that.
#2259 revealed a need for platform specific icons, as the toolbar icon used for iOS is unlikely to be useful on other platforms. This problem has been seen in other forms - for example, the default .png icon is a useful size for GTK toolbars, but not for Android toolbars.
This PR makes icons a resource that is provided by the backend, rather than the core package; this avoids shipping .icns or .ico files on to platforms that can't use those files.
It also modifies the icon loading process to include a platform-specific filename suffix as part of the lookup scheme (so it will look for
foobar-macOS.pngbefore looking forfoobar.png.Builds on #2259 because it corrects the OptionContainer tests to avoid the use of the "-iOS" suffix.
PR Checklist: