WSJT-X/README.md

230 lines
5.6 KiB
Markdown
Raw Normal View History

2018-02-20 09:26:06 -05:00
# QDarkStylesheet
2013-03-10 10:32:24 -04:00
2014-01-02 10:30:44 -05:00
[![Build Status](https://travis-ci.org/ColinDuquesnoy/QDarkStyleSheet.png?branch=master)](https://travis-ci.org/ColinDuquesnoy/QDarkStyleSheet)
2015-05-28 13:46:58 -04:00
[![Latest PyPI version](https://img.shields.io/pypi/v/QDarkStyle.svg)](https://pypi.python.org/pypi/QDarkStyle)
2018-02-20 09:26:06 -05:00
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![License: CC BY 4.0](https://img.shields.io/badge/License-CC%20BY%204.0-lightgrey.svg)](https://creativecommons.org/licenses/by/4.0/)
2014-01-02 10:20:29 -05:00
A dark stylesheet for Qt applications (Qt4, Qt5, PySide, PyQt4, PyQt5, QtPy,
PyQtGraph).
2013-03-10 12:59:50 -04:00
2018-02-20 09:26:06 -05:00
## Installation
2013-03-10 12:59:50 -04:00
2018-02-20 09:26:06 -05:00
### Python
2013-03-10 12:59:50 -04:00
2018-02-20 09:26:06 -05:00
From PyPI: Get the lastest stable version of ``qdarkstyle`` package
using *pip* (preferable):
2013-03-10 12:59:50 -04:00
```bash
pip install qdarkstyle
2013-03-10 12:59:50 -04:00
```
2014-01-02 10:25:15 -05:00
From code: Download/clone the project, go to ``qdarkstyle`` folder then:
- You can use the *setup* script and pip install.
```bash
pip install .
```
- Or, you can use the *setup* script with Python:
```bash
python setup.py install
```
2018-02-20 09:26:06 -05:00
### C++
2013-03-10 12:59:50 -04:00
2018-02-20 09:26:06 -05:00
- Download/clone the project and copy the following files to your application
directory (keep the existing directory hierarchy):
2018-02-20 09:26:06 -05:00
- **qdarkstyle/style.qss**
- **qdarkstyle/style.qrc**
- **qdarkstyle/rc/** (the whole directory)
2018-02-20 09:26:06 -05:00
- Add **qdarkstyle/style.qrc** to your **.pro file**
2018-02-20 09:26:06 -05:00
- Load the stylesheet:
2014-01-02 10:25:15 -05:00
2018-02-20 09:26:06 -05:00
```cpp
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());
}
2018-02-20 09:26:06 -05:00
```
2012-08-23 08:30:23 -04:00
2018-02-20 09:26:06 -05:00
## Usage
2012-08-23 09:03:05 -04:00
2018-02-20 09:26:06 -05:00
Here is an example using PySide
2012-08-23 09:03:05 -04:00
2012-11-05 13:42:35 -05:00
```Python
import sys
2013-03-10 12:59:50 -04:00
import qdarkstyle
from PySide import QtGui
2013-03-10 12:59:50 -04:00
# create the application and the main window
app = QtGui.QApplication(sys.argv)
window = QtGui.QMainWindow()
# setup stylesheet
app.setStyleSheet(qdarkstyle.load_stylesheet_pyside())
# run
window.show()
app.exec_()
2012-11-05 13:42:35 -05:00
```
2012-08-23 09:03:05 -04:00
To use another wrapper for Qt, you just need to replace some lines.
See examples bellow.
2018-02-20 09:26:06 -05:00
To use PyQt4, change two lines
2014-01-02 10:20:29 -05:00
```Python
from PySide import QtGui
app.setStyleSheet(qdarkstyle.load_stylesheet_pyqt())
2014-01-02 10:20:29 -05:00
```
If PyQt5, more lines need to be changed because of its API,
see the complete example
2014-01-02 10:20:29 -05:00
```Python
import sys
import qdarkstyle
from PyQt5 import QtWidgets
2013-03-10 12:59:50 -04:00
# create the application and the main window
app = QtWidgets.QApplication(sys.argv)
window = QtWidgets.QMainWindow()
# setup stylesheet
app.setStyleSheet(qdarkstyle.load_stylesheet_pyqt5())
# run
window.show()
app.exec_()
```
If your project uses QtPy or you need to set it programmatically,
2018-02-20 09:26:06 -05:00
it is far more simple
```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'] = 'pyqt'
# 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
app.setStyleSheet(qdarkstyle.load_stylesheet_from_environment())
# run
window.show()
app.exec_()
```
2018-02-20 09:26:06 -05:00
It is also simple if you use PyQtGraph
2014-05-17 14:41:39 -04:00
```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)
2018-02-20 09:26:06 -05:00
os.environ['PYQTGRAPH_QT_LIB'] = 'PyQt'
# 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_from_environment(is_pyqtgraph=True))
# run
window.show()
app.exec_()
```
2014-05-17 14:41:39 -04:00
_There is an example included in the *example* folder.
You can run the script without installing qdarkstyle. You only need to have
PySide (or PyQt4 or PyQt5) installed on your system._
2013-03-10 12:59:50 -04:00
2018-02-20 09:26:06 -05:00
## Snapshots
2013-03-10 10:32:04 -04:00
Here are a few snapshots comparing the use of QDarkStyle and the default style.
Click in the image to zoom.
<table style="width:100%">
<tr>
<th colspan=2>Containers (no tabs) and Buttons</th>
</tr>
<tr>
<td><img src="./screenshots/qdarkstyle_containers_buttons.png"/></td>
<td><img src="./screenshots/no_dark_containers_buttons.png"/></td>
</tr>
<tr>
<th colspan=2>Containers (tabs) and Displays</th>
</tr>
<tr>
<td><img src="./screenshots/qdarkstyle_containers_tabs_displays.png"/></td>
<td><img src="./screenshots/no_dark_containers_tabs_displays.png"/></td>
</tr>
<tr>
<th colspan=2>Widgets and Inputs (with fields)</th>
</tr>
<tr>
<td><img src="./screenshots/qdarkstyle_widgets_inputs_fields.png"/></td>
<td><img src="./screenshots/no_dark_widgets_inputs_fields.png"/></td>
</tr>
<tr>
<th colspan=2>Views and Inputs (without fields)</th>
</tr>
<tr>
<td><img src="./screenshots/qdarkstyle_views_inputs_no_fields.png"/></td>
<td><img src="./screenshots/no_dark_views_inputs_no_fields.png"/></td>
</tr>
</table>
2018-02-20 09:26:06 -05:00
## Changelog
Please, see [CHANGES](CHANGES.md) file.
2018-02-20 09:26:06 -05:00
## License
This project is licensed under the MIT license.
Imagens contained in this project are licensed under CC-BY license.
For more information see [LICENSE](LICENSE.md) file.
2018-02-20 09:26:06 -05:00
## Authors
For more information see [AUTHORS](AUTHORS.md) file.
2018-02-20 09:26:06 -05:00
## Contribute
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.
2018-02-20 15:01:58 -05:00
If you want to contribute, see how to [CONTRIBUTE](CONTRIBUTE.md).