aboutsummaryrefslogtreecommitdiff
path: root/lib/BreezeStyleSheets/README.md
diff options
context:
space:
mode:
authorFelix (xq) Queißner <git@mq32.de>2020-06-07 10:46:23 +0200
committerFelix (xq) Queißner <git@mq32.de>2020-06-07 10:46:23 +0200
commit425f9d41cd337133d5677744eef937a8a2a61212 (patch)
tree6cd5c2603e1499b89aae4fe5e56c6e650cb2117e /lib/BreezeStyleSheets/README.md
parentec95bb371e54116a2627c162eac3357ec13f06ad (diff)
downloadkristall-425f9d41cd337133d5677744eef937a8a2a61212.tar.gz
Adds support for light/dark widget theme, adds experiemental support for http style sheets.
Diffstat (limited to 'lib/BreezeStyleSheets/README.md')
-rw-r--r--lib/BreezeStyleSheets/README.md96
1 files changed, 96 insertions, 0 deletions
diff --git a/lib/BreezeStyleSheets/README.md b/lib/BreezeStyleSheets/README.md
new file mode 100644
index 0000000..fd2c406
--- /dev/null
+++ b/lib/BreezeStyleSheets/README.md
@@ -0,0 +1,96 @@
+BreezeStyleSheets
+=================
+
+Breeze and BreezeDark-like stylesheets for Qt Applications.
+
+C++ Installation
+================
+
+Copy `breeze.qrc`, `dark.qss`, `light.qss` and the `dark` and `light` folders into your project directory and add the qrc file to your project file.
+
+For example:
+
+```qmake
+TARGET = app
+SOURCES = main.cpp
+RESOURCES = breeze.qrc
+```
+
+To load the stylesheet in C++, load the file using QFile and read the data. For example, to load BreezeDark, run:
+
+```cpp
+
+#include <QApplication>
+#include <QFile>
+#include <QTextStream>
+
+
+int main(int argc, char *argv[])
+{
+ QApplication app(argc, argv);
+
+ // set stylesheet
+ QFile file(":/dark.qss");
+ file.open(QFile::ReadOnly | QFile::Text);
+ QTextStream stream(&file);
+ app.setStyleSheet(stream.readAll());
+
+ // code goes here
+
+ return app.exec();
+}
+```
+
+PyQt5 Installation
+==================
+
+To compile the stylesheet for use with PyQt5, compile with the following command `pyrcc5 breeze.qrc -o breeze_resources.py`, and import the stylesheets. Afterwards, to load the stylesheet in Python, load the file using QFile and read the data. For example, to load BreezeDark, run:
+
+
+```python
+
+from PyQt5 import QtWidgets
+from PyQt5.QtCore import QFile, QTextStream
+import breeze_resources
+
+
+def main():
+ app = QtWidgets.QApplication(sys.argv)
+
+ # set stylesheet
+ file = QFile(":/dark.qss")
+ file.open(QFile.ReadOnly | QFile.Text)
+ stream = QTextStream(file)
+ app.setStyleSheet(stream.readAll())
+
+ # code goes here
+
+ app.exec_()
+}
+```
+
+License
+=======
+
+MIT, see [license](/LICENSE.md).
+
+Example
+=======
+
+**Breeze/BreezeDark**
+
+Example user interface using the Breeze and BreezeDark stylesheets side-by-side.
+
+![BreezeDark](/assets/Breeze.gif)
+
+Acknowledgements
+================
+
+BreezeStyleSheets is a fork of [QDarkStyleSheet](https://github.com/ColinDuquesnoy/QDarkStyleSheet).
+
+Contact
+=======
+
+Email: ahuszagh@gmail.com
+Twitter: KardOnIce
+