Merge commit 'a743ad9496701894406c0d7ded6a44fcecd4219e' as 'deps/QDark'
This commit is contained in:
292
deps/QDark/README.rst
vendored
Normal file
292
deps/QDark/README.rst
vendored
Normal file
@ -0,0 +1,292 @@
|
||||
QDarkStylesheet
|
||||
===============
|
||||
|
||||
|Build Status| |Docs Status| |Latest PyPI version| |License: MIT|
|
||||
|License: CC BY 4.0| |Conduct|
|
||||
|
||||
The most complete dark stylesheet for Qt application (Qt4, Qt5, PySide,
|
||||
PySide2, PyQt4, PyQt5, QtPy, PyQtGraph, Qt.Py).
|
||||
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
|
||||
Python
|
||||
~~~~~~
|
||||
|
||||
From PyPI: Get the latest stable version of ``qdarkstyle`` package using
|
||||
*pip* (preferable):
|
||||
|
||||
.. code:: bash
|
||||
|
||||
pip install qdarkstyle
|
||||
|
||||
|
||||
From code: Download/clone the project, go to ``qdarkstyle`` folder then:
|
||||
|
||||
- You can use the *setup* script and pip install.
|
||||
|
||||
.. code:: bash
|
||||
|
||||
pip install .
|
||||
|
||||
|
||||
- Or, you can use the *setup* script with Python:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
python setup.py install
|
||||
|
||||
|
||||
C++
|
||||
~~~
|
||||
|
||||
- Download/clone the project and copy the following files to your
|
||||
application directory (keep the existing directory hierarchy):
|
||||
|
||||
- **qdarkstyle/style.qss**
|
||||
- **qdarkstyle/style.qrc**
|
||||
- **qdarkstyle/rc/** (the whole directory)
|
||||
|
||||
|
||||
- Add **qdarkstyle/style.qrc** to your **.pro file** as follows:
|
||||
|
||||
.. code:: c++
|
||||
|
||||
RESOURCES += qdarkstyle/style.qrc
|
||||
|
||||
|
||||
- Load the stylesheet:
|
||||
|
||||
.. code:: c++
|
||||
|
||||
QFile f(":qdarkstyle/style.qss");
|
||||
|
||||
if (!f.exists()) {
|
||||
printf("Unable to set stylesheet, file not found\n");
|
||||
}
|
||||
else {
|
||||
f.open(QFile::ReadOnly | QFile::Text);
|
||||
QTextStream ts(&f);
|
||||
qApp->setStyleSheet(ts.readAll());
|
||||
}
|
||||
|
||||
|
||||
Note: The ":" in the file name is necessary to define that file as a
|
||||
resource library. For more information see the discussion
|
||||
`here <https://github.com/ColinDuquesnoy/QDarkStyleSheet/pull/87>`__.
|
||||
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
If your project already uses QtPy or you need to set it programmatically,
|
||||
it is far more simple
|
||||
|
||||
.. code:: python
|
||||
|
||||
import sys
|
||||
import qdarkstyle
|
||||
import os
|
||||
|
||||
# set the environment variable to use a specific wrapper
|
||||
# it can be set to pyqt, pyqt5, pyside or pyside2 (not implemented yet)
|
||||
# you do not need to use QtPy to set this variable
|
||||
os.environ['QT_API'] = 'pyqt5'
|
||||
|
||||
# import from QtPy instead of doing it directly
|
||||
# note that QtPy always uses PyQt5 API
|
||||
from qtpy import QtWidgets
|
||||
|
||||
# create the application and the main window
|
||||
app = QtWidgets.QApplication(sys.argv)
|
||||
window = QtWidgets.QMainWindow()
|
||||
|
||||
# setup stylesheet
|
||||
# the default system in qdarkstyle uses qtpy environment variable
|
||||
app.setStyleSheet(qdarkstyle.load_stylesheet())
|
||||
|
||||
# run
|
||||
window.show()
|
||||
app.exec_()
|
||||
|
||||
|
||||
If you are using PyQt5 directly, see the complete example
|
||||
|
||||
.. code:: python
|
||||
|
||||
import sys
|
||||
import qdarkstyle
|
||||
from PyQt5 import QtWidgets
|
||||
|
||||
# create the application and the main window
|
||||
app = QtWidgets.QApplication(sys.argv)
|
||||
window = QtWidgets.QMainWindow()
|
||||
|
||||
# setup stylesheet
|
||||
app.setStyleSheet(qdarkstyle.load_stylesheet_pyqt5())
|
||||
# or in new API
|
||||
app.setStyleSheet(qdarkstyle.load_stylesheet(qt_api='pyqt5'))
|
||||
|
||||
# run
|
||||
window.show()
|
||||
app.exec_()
|
||||
|
||||
|
||||
Here is an example using PySide2
|
||||
|
||||
.. code:: python
|
||||
|
||||
import sys
|
||||
import qdarkstyle
|
||||
from PyQt5 import QtWidgets
|
||||
|
||||
# create the application and the main window
|
||||
app = QtWidgets.QApplication(sys.argv)
|
||||
window = QtWidgets.QMainWindow()
|
||||
|
||||
# setup stylesheet
|
||||
app.setStyleSheet(qdarkstyle.load_stylesheet_pyside2())
|
||||
# or in new API
|
||||
app.setStyleSheet(qdarkstyle.load_stylesheet(qt_api='pyside2'))
|
||||
|
||||
# run
|
||||
window.show()
|
||||
app.exec_()
|
||||
|
||||
|
||||
If you use PyQtGraph, then the code is
|
||||
|
||||
.. code:: python
|
||||
|
||||
import sys
|
||||
import qdarkstyle
|
||||
import os
|
||||
|
||||
# set the environment variable to use a specific wrapper
|
||||
# it can be set to PyQt, PyQt5, PySide or PySide2 (not implemented yet)
|
||||
os.environ['PYQTGRAPH_QT_LIB'] = 'PyQt5'
|
||||
|
||||
# import from pyqtgraph instead of doing it directly
|
||||
# note that PyQtGraph always uses PyQt4 API
|
||||
from pyqtgraph.Qt import QtGui
|
||||
|
||||
# create the application and the main window
|
||||
app = QtGui.QApplication(sys.argv)
|
||||
window = QtGui.QMainWindow()
|
||||
|
||||
# setup stylesheet
|
||||
app.setStyleSheet(qdarkstyle.load_stylesheet(qt_api=os.environ['PYQTGRAPH_QT_LIB'])
|
||||
|
||||
# run
|
||||
window.show()
|
||||
app.exec_()
|
||||
|
||||
If you are using Qt.py, which is different from qtpy, you should install
|
||||
qtpy then set both to the same binding.
|
||||
|
||||
|
||||
*There is an example included in the *example* folder. You can run the
|
||||
script without installing qdarkstyle. You only need to have PySide or
|
||||
PySide2 or PyQt4 or PyQt5 installed on your system.*
|
||||
|
||||
|
||||
What is new?
|
||||
------------
|
||||
|
||||
In the version 2.6 and later, a reestructure stylesheet is provided. The
|
||||
palette has only 9 colors. Most widgets are revised and their styles
|
||||
were improved. We also provide a command line (script) to get info that
|
||||
could be used when opening issues. See the image below.
|
||||
|
||||
From 2.7, we have added SCSS, so the palette can be accessed programatically.
|
||||
Also many scripts were added to give freedom fro developers who wants to
|
||||
change the colors of our palette. All images and icons were revised, also
|
||||
creating SVG files for all of them.
|
||||
|
||||
From 2.8, we moved to QtPy to simplify your code, thus this is a
|
||||
required dependency now.
|
||||
|
||||
|
||||
Screenshots
|
||||
-----------
|
||||
|
||||
Here are a few snapshots comparing the use of QDarkStyle and the
|
||||
default style. Click in the image to zoom.
|
||||
|
||||
|
||||
Containers (no tabs) and Buttons
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. image:: https://github.com/ColinDuquesnoy/QDarkStyleSheet/blob/master/images/dark_containers_buttons.png
|
||||
|
||||
.. image:: https://github.com/ColinDuquesnoy/QDarkStyleSheet/blob/master/images/images/no_dark_containers_buttons.png
|
||||
|
||||
|
||||
Containers (tabs) and Displays
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. image:: https://github.com/ColinDuquesnoy/QDarkStyleSheet/blob/master/images/dark_containers_tabs_displays.png
|
||||
|
||||
.. image:: https://github.com/ColinDuquesnoy/QDarkStyleSheet/blob/master/images/no_dark_containers_tabs_displays.png
|
||||
|
||||
|
||||
Widgets and Inputs (fields)
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. image:: https://github.com/ColinDuquesnoy/QDarkStyleSheet/blob/master/images/dark_widgets_inputs_fields.png
|
||||
|
||||
.. image:: https://github.com/ColinDuquesnoy/QDarkStyleSheet/blob/master/images/no_dark_widgets_inputs_fields.png
|
||||
|
||||
|
||||
Views and Inputs (no fields)
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. image:: https://github.com/ColinDuquesnoy/QDarkStyleSheet/blob/master/images/dark_views_inputs_no_fields.png
|
||||
|
||||
.. image:: https://github.com/ColinDuquesnoy/QDarkStyleSheet/blob/master/images/no_dark_views_inputs_no_fields.png
|
||||
|
||||
|
||||
Changelog
|
||||
---------
|
||||
|
||||
Please, see `CHANGES <CHANGES.rst>`__ file.
|
||||
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
This project is licensed under the MIT license. Images contained in this
|
||||
project are licensed under CC-BY license.
|
||||
|
||||
For more information see `LICENSE <LICENSE.rst>`__ file.
|
||||
|
||||
|
||||
Authors
|
||||
-------
|
||||
|
||||
For more information see `AUTHORS <AUTHORS.rst>`__ file.
|
||||
|
||||
|
||||
Contributing
|
||||
------------
|
||||
|
||||
Most widgets have been styled. If you find a widget that has not been
|
||||
style, just open an issue on the issue tracker or, better, submit a pull
|
||||
request.
|
||||
|
||||
If you want to contribute, see `CONTRIBUTING <CONTRIBUTING.rst>`__ file.
|
||||
|
||||
.. |Build Status| image:: https://travis-ci.org/ColinDuquesnoy/QDarkStyleSheet.png?branch=master
|
||||
:target: https://travis-ci.org/ColinDuquesnoy/QDarkStyleSheet
|
||||
.. |Docs Status| image:: https://readthedocs.org/projects/qdarkstylesheet/badge/?version=latest&style=flat
|
||||
:target: https://qdarkstylesheet.readthedocs.io
|
||||
.. |Latest PyPI version| image:: https://img.shields.io/pypi/v/QDarkStyle.svg
|
||||
:target: https://pypi.python.org/pypi/QDarkStyle
|
||||
.. |License: MIT| image:: https://img.shields.io/dub/l/vibe-d.svg?color=lightgrey
|
||||
:target: https://opensource.org/licenses/MIT
|
||||
.. |License: CC BY 4.0| image:: https://img.shields.io/badge/License-CC%20BY%204.0-lightgrey.svg
|
||||
:target: https://creativecommons.org/licenses/by/4.0/
|
||||
.. |Conduct| image:: https://img.shields.io/badge/code%20of%20conduct-contributor%20covenant-green.svg?style=flat&color=lightgrey
|
||||
:target: http://contributor-covenant.org/version/1/4/
|
||||
Reference in New Issue
Block a user