https://github.com/perazz/wxmaterialdesignartprovider
Icons Art Provider for wxWidgets with Material Design and other modern icon sets
https://github.com/perazz/wxmaterialdesignartprovider
cpp-gui fluent-ui fluent-ui-icons icons material-design material-ui wxpython wxwidgets
Last synced: about 1 month ago
JSON representation
Icons Art Provider for wxWidgets with Material Design and other modern icon sets
- Host: GitHub
- URL: https://github.com/perazz/wxmaterialdesignartprovider
- Owner: perazz
- License: apache-2.0
- Created: 2023-11-08T15:33:54.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-24T06:56:52.000Z (7 months ago)
- Last Synced: 2025-03-29T22:51:13.298Z (about 2 months ago)
- Topics: cpp-gui, fluent-ui, fluent-ui-icons, icons, material-design, material-ui, wxpython, wxwidgets
- Language: C++
- Homepage:
- Size: 16.6 MB
- Stars: 39
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Material Design icons Art Provider for wxWidgets
This project contains a custom Art Provider for the wxWidgets containing all Material Design icons.
The original icons were taken from the [SVG Material Design](https://github.com/marella/material-design-icons) icons, the [SimpleIcons](https://github.com/simple-icons/simple-icons/tree/develop), the [FontAwesome 6.4](https://github.com/FortAwesome/Font-Awesome) and the [FluentUI icons](https://github.com/microsoft/fluentui-system-icons) repositories.
Generation of the wxWidgets core header files is fully automated, hopefully in the future it will be integrated with the CI for updates to the base repo.
All SVG icons are hardcoded into headers such that no external files are needed to build the art provider class beyond those in `MaterialDesign/`.
So it should be relatively easy to add Material Design icon functionality to existing wxwidgets projects.
# Building, Using
A simple CodeBlocks project is provided to build the example on Windows (MSYS2) and MacOS (clang + homebrew). To add the `wxMaterialDesignArtProvider` class to your project,
just register it with the default art provider as:
```c++
// Register art provider
wxArtProvider::Push(new wxMaterialDesignArtProvider);
```
So that the new art IDs can be used. For each material design icon, an art ID is registered with the following pattern:
```c++
wxART_ICONNAME
```
where `iconname` is the name of the icon. The same names are available under five different clients, each of them corresponds to a different dataset:
*** Material Design
- `wxART_CLIENT_MATERIAL_FILLED` for filled icons;
- `wxART_CLIENT_MATERIAL_OUTLINE` for outlined icons;
- `wxART_CLIENT_MATERIAL_ROUND` for round icons;
- `wxART_CLIENT_MATERIAL_SHARP` for sharp icons;
- `wxART_CLIENT_MATERIAL_TWOTONE` for two-tone icons;
*** FontAwesome 6
- `wxART_CLIENT_AWESOME_BRANDS` for brand logos;
- `wxART_CLIENT_AWESOME_SOLID` for solid-style icons;
- `wxART_CLIENT_AWESOME_REGULAR` for regular icons;
*** SimpleIcons
- `wxART_CLIENT_SIMPLE_ICONS`;
*** FluentUI
- `wxART_CLIENT_FLUENTUI_REGULAR`
- `wxART_CLUENT_FLUENTUI_FILLED`.
# Colors
`wxMaterialDesignArtProvider` supports additional methods to provide the icons with a custom color. Color-based inputs are not available in the core `wxArtProvider` API,
so to use them, it is necessary to call them directly from the `wxMaterialDesignArtProvider` class. They're all static methods: no need to instantiate an art provider anywhere.
The color is provided as a `wxColour` additional input to the standard APIs, and resolves to `wxBLACK` if none is provided. For example, a generic art provider call with a color input will look like:
```c++
wxBitmap bmp;
if (wxMaterialDesignArtProvider::HasClient(client)) {
// Use Material Design API
bmp = wxMaterialDesignArtProvider::GetBitmap(id, client, size, color);
} else {
// Use default art provider (includes overrides, if present)
bmp = wxArtProvider::GetBitmap(id, client, size);
}
```
The attached project contains a sample icon browser, modelled on wxWidget's standard one, and can be used to navigate all art names and styles:
### License
- FontAwesome icons from the FontAwesome 6 SVG set are subject to the CC BY 4.0 License.
- Material Design icons are subject to the Apache 2.0 license.
- SimpleIcons are subject to the CC0 1.0 License.
- FluentUI icons are subject to the MIT License.
This provider is released under the Apache 2.0 license, that all dataset licenses should get along with.