Metadata-Version: 2.1
Name: wx-icons-hicolor
Version: 0.2.0
Summary: Hicolor icon theme for wxPython.
Home-page: https://github.com/domdfcoding/custom_wx_icons_hicolor
Author: Dominic Davis-Foster
Author-email: dominic@davis-foster.co.uk
License: GNU Lesser General Public License v3 or later (LGPLv3+)
Project-URL: Documentation, https://custom_wx_icons_hicolor.readthedocs.io
Project-URL: Issue_Tracker, https://github.com/domdfcoding/custom_wx_icons_hicolor/issues
Project-URL: Source_Code, https://github.com/domdfcoding/custom_wx_icons_hicolor
Keywords: wxPython,icons,iconset
Platform: Windows
Platform: macOS
Platform: Linux
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: X11 Applications :: GTK
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Desktop Environment :: Gnome
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: User Interfaces
Classifier: Typing :: Typed
Requires-Python: >=3.6.1
Description-Content-Type: text/x-rst
Requires-Dist: cairosvg (>=2.4.2)
Requires-Dist: consolekit (>=0.6.0)
Requires-Dist: domdf-python-tools (>=1.7.0)
Requires-Dist: memoized-property (>=1.0.3)
Requires-Dist: python-magic (>=0.4.15)
Requires-Dist: typing-extensions (>=3.7.4.3)
Requires-Dist: wxpython (>=4.0.7) ; platform_system == "Darwin" and python_version < "3.9"
Requires-Dist: wxpython (>=4.0.7) ; platform_system == "Windows" and python_version < "3.9"
Provides-Extra: all

=====================
wx_icons_hicolor
=====================

.. start short_desc

**Hicolor icon theme for wxPython.**

.. end short_desc

This package provides a wxPython wxArtProvider class with icons from the Hicolor/Gnome Icon Theme.

.. start shields

.. list-table::
	:stub-columns: 1
	:widths: 10 90

	* - Docs
	  - |docs| |docs_check|
	* - Tests
	  - |travis| |actions_windows| |actions_macos| |codefactor| |pre_commit_ci|
	* - PyPI
	  - |pypi-version| |supported-versions| |supported-implementations| |wheel|
	* - Activity
	  - |commits-latest| |commits-since| |maintained|
	* - Other
	  - |license| |language| |requires| |pre_commit|

.. |docs| image:: https://img.shields.io/readthedocs/custom_wx_icons_hicolor/latest?logo=read-the-docs
	:target: https://custom_wx_icons_hicolor.readthedocs.io/en/latest/?badge=latest
	:alt: Documentation Build Status

.. |docs_check| image:: https://github.com/domdfcoding/custom_wx_icons_hicolor/workflows/Docs%20Check/badge.svg
	:target: https://github.com/domdfcoding/custom_wx_icons_hicolor/actions?query=workflow%3A%22Docs+Check%22
	:alt: Docs Check Status

.. |travis| image:: https://github.com/domdfcoding/custom_wx_icons_hicolor/workflows/Linux%20Tests/badge.svg
	:target: https://github.com/domdfcoding/custom_wx_icons_hicolor/actions?query=workflow%3A%22Linux+Tests%22
	:alt: Linux Test Status

.. |actions_windows| image:: https://github.com/domdfcoding/custom_wx_icons_hicolor/workflows/Windows%20Tests/badge.svg
	:target: https://github.com/domdfcoding/custom_wx_icons_hicolor/actions?query=workflow%3A%22Windows+Tests%22
	:alt: Windows Test Status

.. |actions_macos| image:: https://github.com/domdfcoding/custom_wx_icons_hicolor/workflows/macOS%20Tests/badge.svg
	:target: https://github.com/domdfcoding/custom_wx_icons_hicolor/actions?query=workflow%3A%22macOS+Tests%22
	:alt: macOS Test Status

.. |requires| image:: https://requires.io/github/domdfcoding/custom_wx_icons_hicolor/requirements.svg?branch=master
	:target: https://requires.io/github/domdfcoding/custom_wx_icons_hicolor/requirements/?branch=master
	:alt: Requirements Status

.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/domdfcoding/custom_wx_icons_hicolor?logo=codefactor
	:target: https://www.codefactor.io/repository/github/domdfcoding/custom_wx_icons_hicolor
	:alt: CodeFactor Grade

.. |pypi-version| image:: https://img.shields.io/pypi/v/wx_icons_hicolor
	:target: https://pypi.org/project/wx_icons_hicolor/
	:alt: PyPI - Package Version

.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/wx_icons_hicolor?logo=python&logoColor=white
	:target: https://pypi.org/project/wx_icons_hicolor/
	:alt: PyPI - Supported Python Versions

.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/wx_icons_hicolor
	:target: https://pypi.org/project/wx_icons_hicolor/
	:alt: PyPI - Supported Implementations

.. |wheel| image:: https://img.shields.io/pypi/wheel/wx_icons_hicolor
	:target: https://pypi.org/project/wx_icons_hicolor/
	:alt: PyPI - Wheel

.. |license| image:: https://img.shields.io/github/license/domdfcoding/custom_wx_icons_hicolor
	:target: https://github.com/domdfcoding/custom_wx_icons_hicolor/blob/master/LICENSE
	:alt: License

.. |language| image:: https://img.shields.io/github/languages/top/domdfcoding/custom_wx_icons_hicolor
	:alt: GitHub top language

.. |commits-since| image:: https://img.shields.io/github/commits-since/domdfcoding/custom_wx_icons_hicolor/v0.2.0
	:target: https://github.com/domdfcoding/custom_wx_icons_hicolor/pulse
	:alt: GitHub commits since tagged version

.. |commits-latest| image:: https://img.shields.io/github/last-commit/domdfcoding/custom_wx_icons_hicolor
	:target: https://github.com/domdfcoding/custom_wx_icons_hicolor/commit/master
	:alt: GitHub last commit

.. |maintained| image:: https://img.shields.io/maintenance/yes/2020
	:alt: Maintenance

.. |pre_commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
	:target: https://github.com/pre-commit/pre-commit
	:alt: pre-commit

.. |pre_commit_ci| image:: https://results.pre-commit.ci/badge/github/domdfcoding/custom_wx_icons_hicolor/master.svg
	:target: https://results.pre-commit.ci/latest/github/domdfcoding/custom_wx_icons_hicolor/master
	:alt: pre-commit.ci status

.. end shields

Installation
===============

.. start installation

``wx_icons_hicolor`` can be installed from PyPI.

To install with ``pip``:

.. code-block:: bash

	$ python -m pip install wx_icons_hicolor

.. end installation

Usage
============

To use ``wx_icons_hicolor`` in your application:

.. code-block:: python

	from wx_icons_hicolor import wxHicolorIconTheme

	class MyApp(wx.App):
		def OnInit(self):
			wx.ArtProvider.Push(wxHicolorIconTheme())
			self.frame = TestFrame(None, wx.ID_ANY)
			self.SetTopWindow(self.frame)
			self.frame.Show()
			return True

And then the icons can be accessed through wx.ArtProvider:

.. code-block:: python

	wx.ArtProvider.GetBitmap('document-new', wx.ART_OTHER, wx.Size(48, 48))

Any `FreeDesktop Icon Theme Specification <https://specifications.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html>`_ name can be used.

Currently the `Client ID` is not used, so just pass `wx.ART_OTHER`.


