saberbud/QDarkStyleSheet
1
0
Fork 0
mirror of https://github.com/ColinDuquesnoy/QDarkStyleSheet.git synced 2026-08-29 08:34:30 +08:00
Code Issues Packages Projects Releases Wiki Activity

Changing docs from MD to RST format

Browse Source
This commit is contained in:
dpizetta
2019-06-06 17:34:47 -03:00
parent 6d282b12e9
commit 7caeadce73
18 changed files with 1455 additions and 1059 deletions
Download Patch File Download Diff File Expand all files Collapse all files
AUTHORS.md
-40
View File
@@ -1,40 +0,0 @@
# Authors
## Mainteiner(s)
These people were/are mainteiners of this project.
* 2013-current
[Colin Duquesnoy](https://github.com/ColinDuquesnoy) -
<colin.duquesnoy@gmail.com> -
original author.
* 2018-current
[Daniel Pizetta](https://github.com/dpizetta) -
<daniel.pizetta@usp.br> -
bug fixes, improvements, features.
* 2019-current
[Gonzalo Peña-Castellanos](https://github.com/goanpeca) -
bug fixes, improvements, features.
* 2019-current
[Carlos Cordoba](https://github.com/ccordoba12)
## Contributor(s)
These people contribute to bug fixes, improvements and so on.
Please, insert your information after the last one.
- Year - Name - `<contact>` - contribution.
- 2018 - [mowoolli](https://github.com/mowoolli) - bug fixes.
- 2018 - Xingyun Wu - `xingyun.wu@foxmail.com` - bug fixes.
- 2018 - [KcHNST](https://github.com/KcHNST) - bug fixes.
- 2019 - [goanpeca](https://github.com/goanpeca) - bug fixes, improvements, features.
And all people that reported bugs, thank you all!
AUTHORS.rst
+30
View File
@@ -0,0 +1,30 @@
Authors
=======
Mainteiner(s)
-------------
These people were/are mainteiners of this project.
- 2013-current `Colin Duquesnoy <https://github.com/ColinDuquesnoy>`__ - colin.duquesnoy@gmail.com - original author.
- 2018-current `Daniel Pizetta <https://github.com/dpizetta>`__ - daniel.pizetta@usp.br - bug fixes, improvements, features.
- 2019-current `Gonzalo Peña-Castellanos <https://github.com/goanpeca>`__ - bug fixes, improvements, features.
- 2019-current `Carlos Cordoba <https://github.com/ccordoba12>`__
Contributor(s)
--------------
These people contribute to bug fixes, improvements and so on. Please,
insert your information after the last one.
- Year - Name - ``<contact>`` - contribution.
- 2018 - `mowoolli <https://github.com/mowoolli>`__ - bug fixes.
- 2018 - Xingyun Wu - ``xingyun.wu@foxmail.com`` - bug fixes.
- 2018 - `KcHNST <https://github.com/KcHNST>`__ - bug fixes.
- 2019 - `goanpeca <https://github.com/goanpeca>`__ - bug fixes, improvements, features.
And all people that reported bugs, thank you all!
CHANGES.md
-183
View File
@@ -1,183 +0,0 @@
# Changelog
- 2.7:
- Remove utils from import in qdarkstyle, #170
- Fix border colors in tool button #176
- Fix scroll area and stacked with 2px padding, #159
- Fix backgroung submenu color, #179
- Fix extra border aside header's arrow indicator, #180
- Fix menu right arrrow indicator
- Fix slide bars colors, #150
- Fix QLabels problems, #163, #139
- Fix problems with example settings using PySide2 and --no_dark #167
- Provide SVG files for all images, standard names and sizes, fix images, #149
- Improve images and add high resolution images, #140
- Improve docs
- Add check to scripts for generating images, #137
- Fix tox and travis scripts #76
- Provide docs in RTD, part of #160
- Add helpdev depedency for reports and checks, #147
- Update authors and maintainers
- 2.6.8:
- Fix double border in QtabWidget for pyqt5
- Fix widgets border in QTabWidget as QLabel #141, #123, #126
- Fix QTab scroller buttons background #136
- Update color from images, fix #127
- Add retina resolution @2x, fix #140
- Intermediate version before merge PR #142 adding scripts
- 2.6.7:
- Fix combobox indicator and padding #132
- Fix PyQtGraph plot axes covered by padding #134
- Update authors
- 2.6.6:
- Fix tabbed bordeless frames and add more examples, #123, #126
- Add feedback to pressed buttons, #133
- Change future warning to pending deprecation for developers, #125 in v2.x
- Fix hover in qtabwidget, #128
- 2.6.5:
- Fix borderless widgets inside QTabWidget, #123
- Fix palette table inside CSS file, header using the last column
- Tested on Python 27, 34, 36, 37
- 2.6.4:
- Python 2.7 compatibility, #121
- Fix MANIFEST
- 2.6.3:
- Palette color enhance, better contrast, contribute to #118
- Fixes Qslider background
- Better colors and format for tab and toolbox, contribute to #118
- 2.6.2:
- Enhance command link button
- Enhance tab colors and spacing, closes #118
- Start using tox, helping partially #77
- Fix example and other scripts issues
- 2.6.1:
- Fix and improve QSplitter and separators from tool bar and windows #115
- Fix README version screenshots and update them
- Add reset function into example to reset GUI settings, after you mess up with
- 2.6:
- Many other enhancements and fix #103, #111, #106
- Fix tab disabled, background and color
- Enhance tab selection
- Enhance spacing (padding and margin)
- Enhance table, list, tree and combo box selection
- Fix slider disabled and enhance size
- Fix the wrong upload of style.qss - sorry
- Fix almost all widgets backgrounds, and other not previously covered widgets with new style
- New palette color, almost whole new qss file, simplify configuration, partially #112, #101, #109,
- Add changes made by other people in the new style - merge does not work there #93, #92, #102
- Update README with Qt.py and PySide 2 information #110, #107, #83
- Update __init__ info
- Improve scripts for processing ui and qrc
- Add __main__ and setup entry, to access function directly
- Add function to get information about bindings and abstraction layers for
debbuging and/or issue tracker
- PySide 2 support
- Improve menu indicator position on QPushButton, #102
- 2.5.4
- Fix indicator image of checkable QGroupBox for check/uncheck states, #93
- Fix wrong comma position, #95
- Added image for the missing QTreeView/QListView undeterminated state, fix #92
- 2.5.3
- Add future warning and pending deprecation for 3.0 version preparation #89
- Add ISSUE_TEMPLATE to ask for default information on issue tracker
- 2.5.2:
- Modularize files from example/ui to simplify edition (developers)
- Add scripts to process files and run example more easiy (developers)
- Better documentation (developers)
- Add CONTRIBUTE, CODE_OF_CONDUCT, and PRODUCTION files
- Lint markdown to standardize files
- Fix and add mor information in C++ example
- 2.5.1:
- Fix travis files, needs more improvement #74
- Improve modules description
- Update setup.py, remove license
- Update and improve README, CHANGES and AUTHORS
- 2.5:
- Add new complete example with new files
- Add new screenshots for new example
- Update travis files
- Add support to example of QtPy and PyQtGraph
- Move scripts for compiling to scrip folder
- Update README, CHANGES
- 2.4:
- Add function to get Qt information from environment variable #69, #70, #73
- Add CC-BY license for images and transfer COPYING to LICENSE file #68
- Fix tabs style - selected tab color and shift #59, #72
- Restructure README creating AUTHORS, CHANGES, and LICENSE #71
- 2.3.1:
- Improve checkbox color (use accent color used in other widgets) and
darken view hover/selected colors to play nicer with other widget colors
- Shift to the right the first tab
- Update license year
- Update README (fix snapshots links and formatting)
- Removed QLineEdit top/bottom padding which cut off text while editing
QListView items
- 2.3.0:
- Add support for QDateEdit
- 2.2.2:
- Add hover to unselected item in QListView/QTreeView
- Fixes for vertical QToolBar, QToolBar Extend Button & QTabWidget's
Pane Misalignment
- Fixed consistency of QTabBar depending on position
- 2.2.1:
- Remove border of status bar widgets
- 2.2:
- Major update of the color scheme based on the Breeze Dark theme of KDE 5
- Fix issues #29, #30, #31, #32 and #35
- 2.1:
- Add style for QPushButton:checked
- Improve QCheckBox and QRadioButton style
- Add style for QMenu::right-arrow
- **2.0**:
- Improve stylesheet to make it look a bit more modern (see pull request #25)
- 1.16:
- Fix QGroupBox title padding (see issue #20)
- 1.15:
- Improve tristate checkbox graphics: undetermined state is now represented by a dash
- 1.14:
- Add support for tristate check boxes and for vertical and horizontal lines
- 1.13:
- Fix issue with horizontal scrollbar arrows, left and right were inversed.
- 1.12:
- Fix minimum size of input widgets (see issue #14)
- 1.11:
- Fix QDockWidget title position on Mac.
- Add QStatusBar support
- Improve QToolButton especially the MenuButtonPopup and InstantPopup modes
- 1.10:
- Add PyQt5 support
- Fix bug #12 (dock widget title not dark on OSX. Note that this reopens issue #8 for MAC users)
- 1.9:
- Improve QTabBar consistency and make selected tabs more distinctive
- 1.8:
- Add support for QToolBox
- Fix issue with grid line in QTableView if there is only ONE row/column
- 1.7:
- Fix appearance of bottom tab bars (invert gradient)
- Improve QTableView: add grid line and fix section borders
- Fix bug #7: bug when resizing QTableView
- Fix bug #8: text elidation no working on QDockWidget
- 1.6:
- Improve QToolButton style
- Add support for InstantPopup and MenuButtonPopup
- Improve QMenu style (better spacing with icons)
- Add \__version__ to python package.
- 1.5:
- Improve QTabBar style: now works with all tab bar positions (North, South, West and East)
- Fix bug #6: hide QTabBar base to avoid stange lines at the base of the tab bar.
- 1.4:
- Add style.qss to qrc file, this fix issues with cx_freeze
- 1.3:
- Remove outline on button, checkbox and radio button
- Add support for closable tabs
- Better disabled buttons
- Fix QTextEdit background color to match the color of QPlainTextEdit and QLineEdit
- Better hover/selected states for QTreeView and QListView
- Add QHeaderView support
- 1.2:
- Improve QTableView support
- 1.1:
- Switch to MIT license
- Add python 3 support
- **1.0**:
- First public release (LGPL v2)
CHANGES.rst
+207
View File
@@ -0,0 +1,207 @@
Changelog
=========
- 2.7:
- Remove utils from import in qdarkstyle, #170
- Fix border colors in tool button #176
- Fix scroll area and stacked with 2px padding, #159
- Fix backgroung submenu color, #179
- Fix extra border aside header's arrow indicator, #180
- Fix menu right arrrow indicator
- Fix slide bars colors, #150
- Fix QLabels problems, #163, #139
- Fix problems with example settings using PySide2 and --no\_dark #167
- Provide SVG files for all images, standard names and sizes, fix
images, #149
- Improve images and add high resolution images, #140
- Improve docs
- Add check to scripts for generating images, #137
- Fix tox and travis scripts #76
- Provide docs in RTD, part of #160
- Add helpdev depedency for reports and checks, #147
- Update authors and maintainers
- 2.6.8:
- Fix double border in QtabWidget for pyqt5
- Fix widgets border in QTabWidget as QLabel #141, #123, #126
- Fix QTab scroller buttons background #136
- Update color from images, fix #127
- Add retina resolution @2x, fix #140
- Intermediate version before merge PR #142 adding scripts
- 2.6.7:
- Fix combobox indicator and padding #132
- Fix PyQtGraph plot axes covered by padding #134
- Update authors
- 2.6.6:
- Fix tabbed bordeless frames and add more examples, #123, #126
- Add feedback to pressed buttons, #133
- Change future warning to pending deprecation for developers, #125 in
v2.x
- Fix hover in qtabwidget, #128
- 2.6.5:
- Fix borderless widgets inside QTabWidget, #123
- Fix palette table inside CSS file, header using the last column
- Tested on Python 27, 34, 36, 37
- 2.6.4:
- Python 2.7 compatibility, #121
- Fix MANIFEST
- 2.6.3:
- Palette color enhance, better contrast, contribute to #118
- Fixes Qslider background
- Better colors and format for tab and toolbox, contribute to #118
- 2.6.2:
- Enhance command link button
- Enhance tab colors and spacing, closes #118
- Start using tox, helping partially #77
- Fix example and other scripts issues
- 2.6.1:
- Fix and improve QSplitter and separators from tool bar and windows
#115
- Fix README version screenshots and update them
- Add reset function into example to reset GUI settings, after you mess
up with
- 2.6:
- Many other enhancements and fix #103, #111, #106
- Fix tab disabled, background and color
- Enhance tab selection
- Enhance spacing (padding and margin)
- Enhance table, list, tree and combo box selection
- Fix slider disabled and enhance size
- Fix the wrong upload of style.qss - sorry
- Fix almost all widgets backgrounds, and other not previously covered
widgets with new style
- New palette color, almost whole new qss file, simplify configuration,
partially #112, #101, #109,
- Add changes made by other people in the new style - merge does not
work there #93, #92, #102
- Update README with Qt.py and PySide 2 information #110, #107, #83
- Update **init** info
- Improve scripts for processing ui and qrc
- Add **main** and setup entry, to access function directly
- Add function to get information about bindings and abstraction layers
for debbuging and/or issue tracker
- PySide 2 support
- Improve menu indicator position on QPushButton, #102
- 2.5.4
- Fix indicator image of checkable QGroupBox for check/uncheck states,
#93
- Fix wrong comma position, #95
- Added image for the missing QTreeView/QListView undeterminated state,
fix #92
- 2.5.3
- Add future warning and pending deprecation for 3.0 version
preparation #89
- Add ISSUE\_TEMPLATE to ask for default information on issue tracker
- 2.5.2:
- Modularize files from example/ui to simplify edition (developers)
- Add scripts to process files and run example more easiy (developers)
- Better documentation (developers)
- Add CONTRIBUTE, CODE\_OF\_CONDUCT, and PRODUCTION files
- Lint markdown to standardize files
- Fix and add mor information in C++ example
- 2.5.1:
- Fix travis files, needs more improvement #74
- Improve modules description
- Update setup.py, remove license
- Update and improve README, CHANGES and AUTHORS
- 2.5:
- Add new complete example with new files
- Add new screenshots for new example
- Update travis files
- Add support to example of QtPy and PyQtGraph
- Move scripts for compiling to scrip folder
- Update README, CHANGES
- 2.4:
- Add function to get Qt information from environment variable #69,
#70, #73
- Add CC-BY license for images and transfer COPYING to LICENSE file #68
- Fix tabs style - selected tab color and shift #59, #72
- Restructure README creating AUTHORS, CHANGES, and LICENSE #71
- 2.3.1:
- Improve checkbox color (use accent color used in other widgets) and
darken view hover/selected colors to play nicer with other widget
colors
- Shift to the right the first tab
- Update license year
- Update README (fix snapshots links and formatting)
- Removed QLineEdit top/bottom padding which cut off text while editing
QListView items
- 2.3.0:
- Add support for QDateEdit
- 2.2.2:
- Add hover to unselected item in QListView/QTreeView
- Fixes for vertical QToolBar, QToolBar Extend Button & QTabWidget's
Pane Misalignment
- Fixed consistency of QTabBar depending on position
- 2.2.1:
- Remove border of status bar widgets
- 2.2:
- Major update of the color scheme based on the Breeze Dark theme of
KDE 5
- Fix issues #29, #30, #31, #32 and #35
- 2.1:
- Add style for QPushButton:checked
- Improve QCheckBox and QRadioButton style
- Add style for QMenu::right-arrow
- **2.0**:
- Improve stylesheet to make it look a bit more modern (see pull
request #25)
- 1.16:
- Fix QGroupBox title padding (see issue #20)
- 1.15:
- Improve tristate checkbox graphics: undetermined state is now
represented by a dash
- 1.14:
- Add support for tristate check boxes and for vertical and horizontal
lines
- 1.13:
- Fix issue with horizontal scrollbar arrows, left and right were
inversed.
- 1.12:
- Fix minimum size of input widgets (see issue #14)
- 1.11:
- Fix QDockWidget title position on Mac.
- Add QStatusBar support
- Improve QToolButton especially the MenuButtonPopup and InstantPopup
modes
- 1.10:
- Add PyQt5 support
- Fix bug #12 (dock widget title not dark on OSX. Note that this
reopens issue #8 for MAC users)
- 1.9:
- Improve QTabBar consistency and make selected tabs more distinctive
- 1.8:
- Add support for QToolBox
- Fix issue with grid line in QTableView if there is only ONE
row/column
- 1.7:
- Fix appearance of bottom tab bars (invert gradient)
- Improve QTableView: add grid line and fix section borders
- Fix bug #7: bug when resizing QTableView
- Fix bug #8: text elidation no working on QDockWidget
- 1.6:
- Improve QToolButton style
- Add support for InstantPopup and MenuButtonPopup
- Improve QMenu style (better spacing with icons)
- Add \_\_version\_\_ to python package.
- 1.5:
- Improve QTabBar style: now works with all tab bar positions (North,
South, West and East)
- Fix bug #6: hide QTabBar base to avoid stange lines at the base of
the tab bar.
- 1.4:
- Add style.qss to qrc file, this fix issues with cx\_freeze
- 1.3:
- Remove outline on button, checkbox and radio button
- Add support for closable tabs
- Better disabled buttons
- Fix QTextEdit background color to match the color of QPlainTextEdit
and QLineEdit
- Better hover/selected states for QTreeView and QListView
- Add QHeaderView support
- 1.2:
- Improve QTableView support
- 1.1:
- Switch to MIT license
- Add python 3 support
- **1.0**:
- First public release (LGPL v2)
CODE_OF_CONDUCT.md
-46
View File
@@ -1,46 +0,0 @@
# Contributor Covenant Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting
## Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
## Scope
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at daniel.pizetta@usp.br. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
CODE_OF_CONDUCT.rst
+82
View File
@@ -0,0 +1,82 @@
Contributor Covenant Code of Conduct
====================================
Our Pledge
----------
In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our
project and our community a harassment-free experience for everyone,
regardless of age, body size, disability, ethnicity, gender identity and
expression, level of experience, nationality, personal appearance, race,
religion, or sexual identity and orientation.
Our Standards
-------------
Examples of behavior that contributes to creating a positive environment
include:
- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
- The use of sexualized language or imagery and unwelcome sexual
attention or advances
- Trolling, insulting/derogatory comments, and personal or political
attacks
- Public or private harassment
- Publishing others' private information, such as a physical or
electronic address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting
Our Responsibilities
--------------------
Project maintainers are responsible for clarifying the standards of
acceptable behavior and are expected to take appropriate and fair
corrective action in response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit,
or reject comments, commits, code, wiki edits, issues, and other
contributions that are not aligned to this Code of Conduct, or to ban
temporarily or permanently any contributor for other behaviors that they
deem inappropriate, threatening, offensive, or harmful.
Scope
-----
This Code of Conduct applies both within project spaces and in public
spaces when an individual is representing the project or its community.
Examples of representing a project or community include using an
official project e-mail address, posting via an official social media
account, or acting as an appointed representative at an online or
offline event. Representation of a project may be further defined and
clarified by project maintainers.
Enforcement
-----------
Instances of abusive, harassing, or otherwise unacceptable behavior may
be reported by contacting the project team at daniel.pizetta@usp.br. The
project team will review and investigate all complaints, and will
respond in a way that it deems appropriate to the circumstances. The
project team is obligated to maintain confidentiality with regard to the
reporter of an incident. Further details of specific enforcement
policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in
good faith may face temporary or permanent repercussions as determined
by other members of the project's leadership.
Attribution
-----------
This Code of Conduct is adapted from the `Contributor
Covenant <http://contributor-covenant.org>`__, version 1.4, available at
`http://contributor-covenant.org/version/1/4 <http://contributor-covenant.org/version/1/4/>`__
CONTRIBUTING.md
-347
View File
@@ -1,347 +0,0 @@
# Contributing
This file describes a path to contribute to this project. Check out our
[CODE OF CONDUCT](./CODE_OF_CONDUCT.md).
## Bug Reports and Feature Requests
If you have encountered a problem with QDarkStyle or have an idea for a new
feature, please submit it to the
[issue tracker](https://github.com/ColinDuquesnoy/QDarkStyleSheet/issues).
## Contributing to QDarkStyle
The recommended way for new contributors to submit code to QDarkStyle is to
fork the repository on GitHub and then submit a pull request after
committing the changes. The pull request will then need to be approved by one
of the manteiners before it is merged into the main repository.
- Check for open issues or open a fresh issue to start a discussion around a
feature idea or a bug.
- Fork [the repository](https://github.com/ColinDuquesnoy/QDarkStyleSheet)
on GitHub to start making your changes to the master branch.
- Write a test which shows that the bug was fixed or that the feature works
as expected if its a function, or create a screenshot if you are changing
the stylesheet evidencing the changes.
- Send a pull request and bug the maintainer until it gets merged and
published. Make sure to add yourself to
[AUTHORS](./AUTHORS.md) and the change(s) to [CHANGES](./CHANGES.md).
## Getting Started
These are the basic steps needed to start developing on QDarkStyle.
- Create an account on GitHub
- Fork the main
[QDarkStyle repository](https://github.com/ColinDuquesnoy/QDarkStyleSheet)
using the GitHub interface.
- Clone the forked repository to your machine
```bash
git clone https://github.com/USERNAME/qdarkstyle
cd qdarkstyle
```
- Checkout the appropriate branch
```bash
git checkout master
```
- Setup a virtual environment (not essential, but highly recommended)
```bash
virtualenv ~/.venv
. ~/.venv/bin/activate
pip install -e .
```
- Create a new working branch. Choose any name you like
```bash
git checkout -b feature-xyz
```
- Hands on
For tips on working with the code, see the Code Guide.
- Test, test, test
Testing is best done through ``tox``, which provides a number of targets and
allows testing against multiple different Python environments:
- Add you and your changes
Please add a list item to [CHANGES](./CHANGES.md) if the fix or
feature is not trivial (small doc updates, typo fixes). Please add you
as an author to [AUTHORS](./AUTHORS.md).
- Add files to commit
Add files that are part of your changes, remember that each commit
must represent a small but functional change. Remember to add CHANGES.md
and AUTHORS.md too. To add all files changed do:
```bash
git add .
```
- Commiting changes.
GitHub recognizes certain phrases that can be used to automatically
update the issue tracker, so you can commit like this:
```bash
git commit -m "Add useful new feature that does this, close #42"
```
```bash
git commit -m "Fix returning problem for get_style(), fix #78"
```
- Push changes in the branch to your forked repository on GitHub.
```bash
git push origin feature-xyz
```
- Submit a pull request (PR).
Do it from your branch to the respective branch using the
[GitHub PR](https://github.com/ColinDuquesnoy/QDarkStyleSheet/pulls)
interface.
- Wait for a mainteiner to review your changes.
## Logging
Inside modules we provided a logging that should be used to inform the user.
Please, follow the levels bellow.
- debug: for debug information, high detailed one, directed to programers;
- info: something important for common user to know;
- warning: something that should not be a big problem or a desicision changed;
- error: some error, but not capable of stop program;
- critical: something that could stop the running program.
## Documentation
Documentation is the key to keep all information and necessary instructions to
others. We use the reStructured text format (rst) for all docs.
All new functions, classes, files, must be documented with all arguments,
returns, exceptions. Whithout this it should not pass the tests.
The better example is to see the current files to get the style. We are
using the Google Format and Sphinx for generating the docs.
## Guide to QDarkStyle
### Structure of the Example
Now you can use our example to work on the stylesheet. It has all possible
widget provided by Qt - common ones. Feel free to add more to them.
To simplify the structure, there are separated files in
[example.ui](./example/ui/) folder.
- `dw_buttons.ui`: all types of buttons;
- `dw_containers_no_tabs.ui`: all types of containers except for tabs;
- `dw_containers_tabs.ui`: all containers tabs;
- `dw_displays.ui`: all types of displays;
- `dw_inputs_fields.ui`: all types of inputs with fields;
- `dw_inputs_no_fields.ui`: all types of inputs without fields;
- `dw_views.ui`: all types of views;
- `dw_widgets.ui`: all types of widgets;
- `mw_menus.ui`: main window with all menus and toolbars.
*Obs.: ``dw`` stands for dock widget and ``mw`` for main window.*
The entire example is built at runtime, in
[example.py](./example/example.py). To see more information about it,
see its documentation.
### Modifying UI Files
Feel free to modify [ui](./example/ui) files with Qt Designer and recompile UI using
[process_ui.py](./script/process_ui.py) script, inside script folder, using:
```bash
python process_ui.py
```
It will generate all `_ui.py` files for PyQt4, PyQt5, PySide, QtPy, PyQtGraph.
### Modifying QSS File
If you are changing the [stylesheet](./qdarkstyle/style.qss), you will need
to recompile the QRC files using [process_qrc.py](./script/process_qrc.py)
script, inside script folder.
```bash
python process_qrc.py
```
This generates all `_rc.py` files for PyQt4, PyQt5, PySide, QtPy, PyQtGraph.
### Making It Easy
To simplify this process for the developer, if you are changing many things,
use the script [run_ui_css_edition.py](./script/run_ui_css_edition.py):
```bash
python run_ui_css_edition.py
```
This creates a loop that restarts the application, process ui and css
files.
For more information about those scripts, see their documentation.
### Qt, Stylesheets, Palettes and Icons
- [Box model](http://doc.qt.io/qt-5/images/stylesheet-boxmodel.png)
- [Box model with height and width](https://www.tutorialrepublic.com/lib/images/css-box-model.jpg)
- [Customizing Widgets](http://doc.qt.io/qt-5/stylesheet-customizing.html)
- [Window structure](http://doc.qt.io/qt-5/images/mainwindowlayout.png)
- [QMainWindow](http://doc.qt.io/qt-5/qmainwindow.html)
- [References](http://doc.qt.io/qt-5/stylesheet.html)
Create good palettes with these tools. For example, on paletton, choose
three colors from greyish light (foreground), greyish dark (background)
and three more colorfull colors (selection). Greyish colors have a litle
bit of the main color, so it is nice to change it if you change the main
color.
- [Paletton.com](http://paletton.com/)
- [Coolors.co](https://coolors.co/)
As a minimal guide to create new icons (svg) images, we list two main sources.
- [Material](https://material.io/design/iconography/product-icons.html#grid-keyline-shapes)
- [KDE](https://hig.kde.org/style/icon.html)
Main characteristics of SVG images are:
- Base size: 32px X 32px;
- Border: 2px space, except continuous lines;
- Corners and line end's: rounded;
- Line: 2px minimum thickness. Complementary thickness using multiples of 2px;
- Spacing: 4px when needed;
- Color: #ff0000, red for all images - programatically changed;
- Keep only structural changes in images, not colors, e.g, states hover and disabled;
- Lines and shapes should align with the grid centralized;
- Names: from basic form to specific, so they keep grouped. Ex.: arrow_left, arrow_up.
Some example are given below for the horizontal Handle, Minimize, and checked Checkbox.
<table style="width:100%">
<tr>
<th colspan=3>Examples of icons</th>
</tr>
<tr>
<td><img src="./images/icon_checkbox_indeterminated.png"/></td>
<td><img src="./images/icon_minimize.png"/></td>
<td><img src="./images/move.png"/></td>
</tr>
</table>
## Unit Testing and Fix Preview
It is a good practice, if you are writing functions to QDarkStyle or fixing
something related to those functions (not style), that you provide a test
for it.
If you are fixing something about style, please, at least, provide an
screenshot before and after the fix to comparison. This could be inserted
in the issue tracker, as a message. Better than that, use modules provided
in test folder to create a GUI test, creating a new file for it.
Check [test](./test) files to more details. Tests will keep our application stable.
## If You Are a Mantainer, Go Ahead to Production
Of course, until you start these steps, make sure the package have passed all
tests and checkers before continue. You must have accoutns to both test and
oficial PyPI website below along with be inserted as a maintainer in both.
1. Install `twine`
`pip install twine`
2. Generate a distribution (code package and wheel)
`python setup.py sdist bdist_wheel`
3. Check with `twine`, which also tests README format for PyPI
`twine check dist/*`
4. Try upload in [PyPI test page](https://test.pypi.org/project/QDarkStyle)
platform before the oficial
`twine upload --repository-url https://test.pypi.org/legacy/ dist/*`
5. Try to install from test
`pip install --no-deps --index-url https://test.pypi.org/simple/ qdarkstyle`
6. Then, remove it
`pip uninstall qdarkstyle -y`
7. Upload to [PyPI official page](https://pypi.python.org/pypi/QDarkStyle)
`twine upload --repository-url https://upload.pypi.org/legacy/ dist/*`
8. Try to install from oficial
`pip install qdarkstyle`
You can also use the tox environment to produce the release and upload the
distribution.
`tox -e release`
CONTRIBUTING.rst
+391
View File
@@ -0,0 +1,391 @@
Contributing
============
This file describes a path to contribute to this project. Check out our
`CODE OF CONDUCT <./CODE_OF_CONDUCT.md>`__.
Bug Reports and Feature Requests
--------------------------------
If you have encountered a problem with QDarkStyle or have an idea for a
new feature, please submit it to the `issue
tracker <https://github.com/ColinDuquesnoy/QDarkStyleSheet/issues>`__.
Contributing to QDarkStyle
--------------------------
The recommended way for new contributors to submit code to QDarkStyle is
to fork the repository on GitHub and then submit a pull request after
committing the changes. The pull request will then need to be approved
by one of the manteiners before it is merged into the main repository.
- Check for open issues or open a fresh issue to start a discussion
around a feature idea or a bug.
- Fork `the
repository <https://github.com/ColinDuquesnoy/QDarkStyleSheet>`__ on
GitHub to start making your changes to the master branch.
- Write a test which shows that the bug was fixed or that the feature
works as expected if its a function, or create a screenshot if you
are changing the stylesheet evidencing the changes.
- Send a pull request and bug the maintainer until it gets merged and
published. Make sure to add yourself to `AUTHORS <./AUTHORS.md>`__
and the change(s) to `CHANGES <./CHANGES.md>`__.
Getting Started
---------------
These are the basic steps needed to start developing on QDarkStyle.
- Create an account on GitHub
- Fork the main `QDarkStyle
repository <https://github.com/ColinDuquesnoy/QDarkStyleSheet>`__
using the GitHub interface.
- Clone the forked repository to your machine
.. code:: bash
git clone https://github.com/USERNAME/qdarkstyle
cd qdarkstyle
- Checkout the appropriate branch
.. code:: bash
git checkout master
- Setup a virtual environment (not essential, but highly recommended)
.. code:: bash
virtualenv ~/.venv
. ~/.venv/bin/activate
pip install -e .
- Create a new working branch. Choose any name you like
.. code:: bash
git checkout -b feature-xyz
- Hands on
For tips on working with the code, see the Code Guide.
- Test, test, test
Testing is best done through ``tox``, which provides a number of
targets and allows testing against multiple different Python
environments:
- Add you and your changes
Please add a list item to `CHANGES <./CHANGES.md>`__ if the fix or
feature is not trivial (small doc updates, typo fixes). Please add
you as an author to `AUTHORS <./AUTHORS.md>`__.
- Add files to commit
Add files that are part of your changes, remember that each commit
must represent a small but functional change. Remember to add
CHANGES.md and AUTHORS.md too. To add all files changed do:
::
```bash
git add .
```
- Commiting changes.
GitHub recognizes certain phrases that can be used to automatically
update the issue tracker, so you can commit like this:
::
```bash
git commit -m "Add useful new feature that does this, close #42"
```
```bash
git commit -m "Fix returning problem for get_style(), fix #78"
```
- Push changes in the branch to your forked repository on GitHub.
::
```bash
git push origin feature-xyz
```
- Submit a pull request (PR).
Do it from your branch to the respective branch using the `GitHub
PR <https://github.com/ColinDuquesnoy/QDarkStyleSheet/pulls>`__
interface.
- Wait for a mainteiner to review your changes.
Logging
-------
Inside modules we provided a logging that should be used to inform the
user. Please, follow the levels bellow.
- debug: for debug information, high detailed one, directed to
programers;
- info: something important for common user to know;
- warning: something that should not be a big problem or a desicision
changed;
- error: some error, but not capable of stop program;
- critical: something that could stop the running program.
Documentation
-------------
Documentation is the key to keep all information and necessary
instructions to others. We use the reStructured text format (rst) for
all docs.
All new functions, classes, files, must be documented with all
arguments, returns, exceptions. Whithout this it should not pass the
tests.
The better example is to see the current files to get the style. We are
using the Google Format and Sphinx for generating the docs.
Guide to QDarkStyle
-------------------
Structure of the Example
~~~~~~~~~~~~~~~~~~~~~~~~
Now you can use our example to work on the stylesheet. It has all
possible widget provided by Qt - common ones. Feel free to add more to
them.
To simplify the structure, there are separated files in
`example.ui <./example/ui/>`__ folder.
- ``dw_buttons.ui``: all types of buttons;
- ``dw_containers_no_tabs.ui``: all types of containers except for
tabs;
- ``dw_containers_tabs.ui``: all containers tabs;
- ``dw_displays.ui``: all types of displays;
- ``dw_inputs_fields.ui``: all types of inputs with fields;
- ``dw_inputs_no_fields.ui``: all types of inputs without fields;
- ``dw_views.ui``: all types of views;
- ``dw_widgets.ui``: all types of widgets;
- ``mw_menus.ui``: main window with all menus and toolbars.
*Obs.: ``dw`` stands for dock widget and ``mw`` for main window.*
The entire example is built at runtime, in
`example.py <./example/example.py>`__. To see more information about it,
see its documentation.
Modifying UI Files
~~~~~~~~~~~~~~~~~~
Feel free to modify `ui <./example/ui>`__ files with Qt Designer and
recompile UI using `process\_ui.py <./script/process_ui.py>`__ script,
inside script folder, using:
::
```bash
python process_ui.py
```
It will generate all ``_ui.py`` files for PyQt4, PyQt5, PySide, QtPy,
PyQtGraph.
Modifying QSS File
~~~~~~~~~~~~~~~~~~
If you are changing the `stylesheet <./qdarkstyle/style.qss>`__, you
will need to recompile the QRC files using
`process\_qrc.py <./script/process_qrc.py>`__ script, inside script
folder.
::
```bash
python process_qrc.py
```
This generates all ``_rc.py`` files for PyQt4, PyQt5, PySide, QtPy,
PyQtGraph.
Making It Easy
~~~~~~~~~~~~~~
To simplify this process for the developer, if you are changing many
things, use the script
`run\_ui\_css\_edition.py <./script/run_ui_css_edition.py>`__:
::
```bash
python run_ui_css_edition.py
```
This creates a loop that restarts the application, process ui and css
files.
For more information about those scripts, see their documentation.
Qt, Stylesheets, Palettes and Icons
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- `Box model <http://doc.qt.io/qt-5/images/stylesheet-boxmodel.png>`__
- `Box model with height and
width <https://www.tutorialrepublic.com/lib/images/css-box-model.jpg>`__
- `Customizing
Widgets <http://doc.qt.io/qt-5/stylesheet-customizing.html>`__
- `Window
structure <http://doc.qt.io/qt-5/images/mainwindowlayout.png>`__
- `QMainWindow <http://doc.qt.io/qt-5/qmainwindow.html>`__
- `References <http://doc.qt.io/qt-5/stylesheet.html>`__
Create good palettes with these tools. For example, on paletton, choose
three colors from greyish light (foreground), greyish dark (background)
and three more colorfull colors (selection). Greyish colors have a litle
bit of the main color, so it is nice to change it if you change the main
color.
- `Paletton.com <http://paletton.com/>`__
- `Coolors.co <https://coolors.co/>`__
As a minimal guide to create new icons (svg) images, we list two main
sources.
- `Material <https://material.io/design/iconography/product-icons.html#grid-keyline-shapes>`__
- `KDE <https://hig.kde.org/style/icon.html>`__
Main characteristics of SVG images are:
- Base size: 32px X 32px;
- Border: 2px space, except continuous lines;
- Corners and line end's: rounded;
- Line: 2px minimum thickness. Complementary thickness using multiples
of 2px;
- Spacing: 4px when needed;
- Color: #ff0000, red for all images - programatically changed;
- Keep only structural changes in images, not colors, e.g, states hover
and disabled;
- Lines and shapes should align with the grid centralized;
- Names: from basic form to specific, so they keep grouped. Ex.:
arrow\_left, arrow\_up.
Some example are given below for the horizontal Handle, Minimize, and
checked Checkbox.
.. raw:: html
<table style="width:100%">
.. raw:: html
<tr>
::
<th colspan=3>Examples of icons</th>
.. raw:: html
</tr>
.. raw:: html
<tr>
::
<td><img src="./images/icon_checkbox_indeterminated.png"/></td>
<td><img src="./images/icon_minimize.png"/></td>
<td><img src="./images/move.png"/></td>
.. raw:: html
</tr>
.. raw:: html
</table>
Unit Testing and Fix Preview
----------------------------
It is a good practice, if you are writing functions to QDarkStyle or
fixing something related to those functions (not style), that you
provide a test for it.
If you are fixing something about style, please, at least, provide an
screenshot before and after the fix to comparison. This could be
inserted in the issue tracker, as a message. Better than that, use
modules provided in test folder to create a GUI test, creating a new
file for it.
Check `test <./test>`__ files to more details. Tests will keep our
application stable.
If You Are a Mantainer, Go Ahead to Production
----------------------------------------------
Of course, until you start these steps, make sure the package have
passed all tests and checkers before continue. You must have accoutns to
both test and oficial PyPI website below along with be inserted as a
maintainer in both.
1. Install ``twine``
``pip install twine``
2. Generate a distribution (code package and wheel)
``python setup.py sdist bdist_wheel``
3. Check with ``twine``, which also tests README format for PyPI
``twine check dist/*``
4. Try upload in `PyPI test
page <https://test.pypi.org/project/QDarkStyle>`__ platform before
the oficial
``twine upload --repository-url https://test.pypi.org/legacy/ dist/*``
5. Try to install from test
``pip install --no-deps --index-url https://test.pypi.org/simple/ qdarkstyle``
6. Then, remove it
``pip uninstall qdarkstyle -y``
7. Upload to `PyPI official
page <https://pypi.python.org/pypi/QDarkStyle>`__
``twine upload --repository-url https://upload.pypi.org/legacy/ dist/*``
8. Try to install from oficial
``pip install qdarkstyle``
You can also use the tox environment to produce the release and upload
the distribution.
::
`tox -e release`
LICENSE.md
-183
View File
@@ -1,183 +0,0 @@
# License
## The MIT License (MIT) - Code
Copyright (c) 2013-2018 Colin Duquesnoy
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
## Creative Commons Attribution International 4.0 - Images
QDarkStyle (c) 2013-2018 Colin Duquesnoy
Creative Commons Corporation (“Creative Commons”) is not a law firm and does not provide legal services or legal advice. Distribution of Creative Commons public licenses does not create a lawyer-client or other relationship. Creative Commons makes its licenses and related information available on an “as-is” basis. Creative Commons gives no warranties regarding its licenses, any material licensed under their terms and conditions, or any related information. Creative Commons disclaims all liability for damages resulting from their use to the fullest extent possible.
### Using Creative Commons Public Licenses
Creative Commons public licenses provide a standard set of terms and conditions that creators and other rights holders may use to share original works of authorship and other material subject to copyright and certain other rights specified in the public license below. The following considerations are for informational purposes only, are not exhaustive, and do not form part of our licenses.
* __Considerations for licensors:__ Our public licenses are intended for use by those authorized to give the public permission to use material in ways otherwise restricted by copyright and certain other rights. Our licenses are irrevocable. Licensors should read and understand the terms and conditions of the license they choose before applying it. Licensors should also secure all rights necessary before applying our licenses so that the public can reuse the material as expected. Licensors should clearly mark any material not subject to the license. This includes other CC-licensed material, or material used under an exception or limitation to copyright. [More considerations for licensors](http://wiki.creativecommons.org/Considerations_for_licensors_and_licensees#Considerations_for_licensors).
* __Considerations for the public:__ By using one of our public licenses, a licensor grants the public permission to use the licensed material under specified terms and conditions. If the licensor’s permission is not necessary for any reason–for example, because of any applicable exception or limitation to copyright–then that use is not regulated by the license. Our licenses grant only permissions under copyright and certain other rights that a licensor has authority to grant. Use of the licensed material may still be restricted for other reasons, including because others have copyright or other rights in the material. A licensor may make special requests, such as asking that all changes be marked or described. Although not required by our licenses, you are encouraged to respect those requests where reasonable. [More considerations for the public](http://wiki.creativecommons.org/Considerations_for_licensors_and_licensees#Considerations_for_licensees).
## Creative Commons Attribution 4.0 International Public License
By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions.
### Section 1 – Definitions
a. __Adapted Material__ means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image.
b. __Adapter's License__ means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License.
c. __Copyright and Similar Rights__ means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights.
d. __Effective Technological Measures__ means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements.
e. __Exceptions and Limitations__ means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material.
f. __Licensed Material__ means the artistic or literary work, database, or other material to which the Licensor applied this Public License.
g. __Licensed Rights__ means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license.
h. __Licensor__ means the individual(s) or entity(ies) granting rights under this Public License.
i. __Share__ means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them.
j. __Sui Generis Database Rights__ means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world.
k. __You__ means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning.
### Section 2 – Scope
a. ___License grant.___
1. Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to:
A. reproduce and Share the Licensed Material, in whole or in part; and
B. produce, reproduce, and Share Adapted Material.
2. __Exceptions and Limitations.__ For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions.
3. __Term.__ The term of this Public License is specified in Section 6(a).
4. __Media and formats; technical modifications allowed.__ The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material.
5. __Downstream recipients.__
A. __Offer from the Licensor – Licensed Material.__ Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License.
B. __No downstream restrictions.__ You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material.
6. __No endorsement.__ Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i).
b. ___Other rights.___
1. Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise.
2. Patent and trademark rights are not licensed under this Public License.
3. To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties.
### Section 3 – License Conditions
Your exercise of the Licensed Rights is expressly made subject to the following conditions.
a. ___Attribution.___
1. If You Share the Licensed Material (including in modified form), You must:
A. retain the following if it is supplied by the Licensor with the Licensed Material:
i. identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated);
ii. a copyright notice;
iii. a notice that refers to this Public License;
iv. a notice that refers to the disclaimer of warranties;
v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable;
B. indicate if You modified the Licensed Material and retain an indication of any previous modifications; and
C. indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License.
2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information.
3. If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable.
4. If You Share Adapted Material You produce, the Adapter's License You apply must not prevent recipients of the Adapted Material from complying with this Public License.
### Section 4 – Sui Generis Database Rights
Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material:
a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database;
b. if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material; and
c. You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database.
For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights.
### Section 5 – Disclaimer of Warranties and Limitation of Liability
a. __Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You.__
b. __To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You.__
c. The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability.
### Section 6 – Term and Termination
a. This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically.
b. Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates:
1. automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or
2. upon express reinstatement by the Licensor.
For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License.
c. For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License.
d. Sections 1, 5, 6, 7, and 8 survive termination of this Public License.
### Section 7 – Other Terms and Conditions
a. The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed.
b. Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License.
### Section 8 – Interpretation
a. For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License.
b. To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions.
c. No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor.
d. Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority.
> Creative Commons is not a party to its public licenses. Notwithstanding, Creative Commons may elect to apply one of its public licenses to material it publishes and in those instances will be considered the “Licensor.” Except for the limited purpose of indicating that material is shared under a Creative Commons public license or as otherwise permitted by the Creative Commons policies published at [creativecommons.org/policies](http://creativecommons.org/policies), Creative Commons does not authorize the use of the trademark “Creative Commons” or any other trademark or logo of Creative Commons without its prior written consent including, without limitation, in connection with any unauthorized modifications to any of its public licenses or any other arrangements, understandings, or agreements concerning use of licensed material. For the avoidance of doubt, this paragraph does not form part of the public licenses.
>
> Creative Commons may be contacted at creativecommons.org
LICENSE.rst
+402
View File
@@ -0,0 +1,402 @@
License
=======
The MIT License (MIT) - Code
----------------------------
Copyright (c) 2013-2018 Colin Duquesnoy
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Creative Commons Attribution International 4.0 - Images
-------------------------------------------------------
QDarkStyle (c) 2013-2018 Colin Duquesnoy
Creative Commons Corporation (“Creative Commons”) is not a law firm and
does not provide legal services or legal advice. Distribution of
Creative Commons public licenses does not create a lawyer-client or
other relationship. Creative Commons makes its licenses and related
information available on an “as-is” basis. Creative Commons gives no
warranties regarding its licenses, any material licensed under their
terms and conditions, or any related information. Creative Commons
disclaims all liability for damages resulting from their use to the
fullest extent possible.
Using Creative Commons Public Licenses
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Creative Commons public licenses provide a standard set of terms and
conditions that creators and other rights holders may use to share
original works of authorship and other material subject to copyright and
certain other rights specified in the public license below. The
following considerations are for informational purposes only, are not
exhaustive, and do not form part of our licenses.
- **Considerations for licensors:** Our public licenses are intended
for use by those authorized to give the public permission to use
material in ways otherwise restricted by copyright and certain other
rights. Our licenses are irrevocable. Licensors should read and
understand the terms and conditions of the license they choose before
applying it. Licensors should also secure all rights necessary before
applying our licenses so that the public can reuse the material as
expected. Licensors should clearly mark any material not subject to
the license. This includes other CC-licensed material, or material
used under an exception or limitation to copyright. `More
considerations for
licensors <http://wiki.creativecommons.org/Considerations_for_licensors_and_licensees#Considerations_for_licensors>`__.
- **Considerations for the public:** By using one of our public
licenses, a licensor grants the public permission to use the licensed
material under specified terms and conditions. If the licensor’s
permission is not necessary for any reason–for example, because of
any applicable exception or limitation to copyright–then that use is
not regulated by the license. Our licenses grant only permissions
under copyright and certain other rights that a licensor has
authority to grant. Use of the licensed material may still be
restricted for other reasons, including because others have copyright
or other rights in the material. A licensor may make special
requests, such as asking that all changes be marked or described.
Although not required by our licenses, you are encouraged to respect
those requests where reasonable. `More considerations for the
public <http://wiki.creativecommons.org/Considerations_for_licensors_and_licensees#Considerations_for_licensees>`__.
Creative Commons Attribution 4.0 International Public License
-------------------------------------------------------------
By exercising the Licensed Rights (defined below), You accept and agree
to be bound by the terms and conditions of this Creative Commons
Attribution 4.0 International Public License ("Public License"). To the
extent this Public License may be interpreted as a contract, You are
granted the Licensed Rights in consideration of Your acceptance of these
terms and conditions, and the Licensor grants You such rights in
consideration of benefits the Licensor receives from making the Licensed
Material available under these terms and conditions.
Section 1 – Definitions
~~~~~~~~~~~~~~~~~~~~~~~
a. **Adapted Material** means material subject to Copyright and Similar
Rights that is derived from or based upon the Licensed Material and
in which the Licensed Material is translated, altered, arranged,
transformed, or otherwise modified in a manner requiring permission
under the Copyright and Similar Rights held by the Licensor. For
purposes of this Public License, where the Licensed Material is a
musical work, performance, or sound recording, Adapted Material is
always produced where the Licensed Material is synched in timed
relation with a moving image.
b. **Adapter's License** means the license You apply to Your Copyright
and Similar Rights in Your contributions to Adapted Material in
accordance with the terms and conditions of this Public License.
c. **Copyright and Similar Rights** means copyright and/or similar
rights closely related to copyright including, without limitation,
performance, broadcast, sound recording, and Sui Generis Database
Rights, without regard to how the rights are labeled or categorized.
For purposes of this Public License, the rights specified in Section
2(b)(1)-(2) are not Copyright and Similar Rights.
d. **Effective Technological Measures** means those measures that, in
the absence of proper authority, may not be circumvented under laws
fulfilling obligations under Article 11 of the WIPO Copyright Treaty
adopted on December 20, 1996, and/or similar international
agreements.
e. **Exceptions and Limitations** means fair use, fair dealing, and/or
any other exception or limitation to Copyright and Similar Rights
that applies to Your use of the Licensed Material.
f. **Licensed Material** means the artistic or literary work, database,
or other material to which the Licensor applied this Public License.
g. **Licensed Rights** means the rights granted to You subject to the
terms and conditions of this Public License, which are limited to all
Copyright and Similar Rights that apply to Your use of the Licensed
Material and that the Licensor has authority to license.
h. **Licensor** means the individual(s) or entity(ies) granting rights
under this Public License.
i. **Share** means to provide material to the public by any means or
process that requires permission under the Licensed Rights, such as
reproduction, public display, public performance, distribution,
dissemination, communication, or importation, and to make material
available to the public including in ways that members of the public
may access the material from a place and at a time individually
chosen by them.
j. **Sui Generis Database Rights** means rights other than copyright
resulting from Directive 96/9/EC of the European Parliament and of
the Council of 11 March 1996 on the legal protection of databases, as
amended and/or succeeded, as well as other essentially equivalent
rights anywhere in the world.
k. **You** means the individual or entity exercising the Licensed Rights
under this Public License. Your has a corresponding meaning.
Section 2 – Scope
~~~~~~~~~~~~~~~~~
a. ***License grant.***
1. Subject to the terms and conditions of this Public License, the
Licensor hereby grants You a worldwide, royalty-free,
non-sublicensable, non-exclusive, irrevocable license to exercise the
Licensed Rights in the Licensed Material to:
A. reproduce and Share the Licensed Material, in whole or in part;
and
B. produce, reproduce, and Share Adapted Material.
2. **Exceptions and Limitations.** For the avoidance of doubt, where
Exceptions and Limitations apply to Your use, this Public License
does not apply, and You do not need to comply with its terms and
conditions.
3. **Term.** The term of this Public License is specified in Section
6(a).
4. **Media and formats; technical modifications allowed.** The Licensor
authorizes You to exercise the Licensed Rights in all media and
formats whether now known or hereafter created, and to make technical
modifications necessary to do so. The Licensor waives and/or agrees
not to assert any right or authority to forbid You from making
technical modifications necessary to exercise the Licensed Rights,
including technical modifications necessary to circumvent Effective
Technological Measures. For purposes of this Public License, simply
making modifications authorized by this Section 2(a)(4) never
produces Adapted Material.
5. **Downstream recipients.**
A. **Offer from the Licensor – Licensed Material.** Every recipient
of the Licensed Material automatically receives an offer from the
Licensor to exercise the Licensed Rights under the terms and
conditions of this Public License.
B. **No downstream restrictions.** You may not offer or impose any
additional or different terms or conditions on, or apply any
Effective Technological Measures to, the Licensed Material if doing
so restricts exercise of the Licensed Rights by any recipient of the
Licensed Material.
6. **No endorsement.** Nothing in this Public License constitutes or may
be construed as permission to assert or imply that You are, or that
Your use of the Licensed Material is, connected with, or sponsored,
endorsed, or granted official status by, the Licensor or others
designated to receive attribution as provided in Section
3(a)(1)(A)(i).
b. ***Other rights.***
1. Moral rights, such as the right of integrity, are not licensed under
this Public License, nor are publicity, privacy, and/or other similar
personality rights; however, to the extent possible, the Licensor
waives and/or agrees not to assert any such rights held by the
Licensor to the limited extent necessary to allow You to exercise the
Licensed Rights, but not otherwise.
2. Patent and trademark rights are not licensed under this Public
License.
3. To the extent possible, the Licensor waives any right to collect
royalties from You for the exercise of the Licensed Rights, whether
directly or through a collecting society under any voluntary or
waivable statutory or compulsory licensing scheme. In all other cases
the Licensor expressly reserves any right to collect such royalties.
Section 3 – License Conditions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Your exercise of the Licensed Rights is expressly made subject to the
following conditions.
a. ***Attribution.***
1. If You Share the Licensed Material (including in modified form), You
must:
A. retain the following if it is supplied by the Licensor with the
Licensed Material:
::
i. identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated);
ii. a copyright notice;
iii. a notice that refers to this Public License;
iv. a notice that refers to the disclaimer of warranties;
v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable;
B. indicate if You modified the Licensed Material and retain an
indication of any previous modifications; and
C. indicate the Licensed Material is licensed under this Public
License, and include the text of, or the URI or hyperlink to, this
Public License.
2. You may satisfy the conditions in Section 3(a)(1) in any reasonable
manner based on the medium, means, and context in which You Share the
Licensed Material. For example, it may be reasonable to satisfy the
conditions by providing a URI or hyperlink to a resource that
includes the required information.
3. If requested by the Licensor, You must remove any of the information
required by Section 3(a)(1)(A) to the extent reasonably practicable.
4. If You Share Adapted Material You produce, the Adapter's License You
apply must not prevent recipients of the Adapted Material from
complying with this Public License.
Section 4 – Sui Generis Database Rights
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Where the Licensed Rights include Sui Generis Database Rights that apply
to Your use of the Licensed Material:
a. for the avoidance of doubt, Section 2(a)(1) grants You the right to
extract, reuse, reproduce, and Share all or a substantial portion of
the contents of the database;
b. if You include all or a substantial portion of the database contents
in a database in which You have Sui Generis Database Rights, then the
database in which You have Sui Generis Database Rights (but not its
individual contents) is Adapted Material; and
c. You must comply with the conditions in Section 3(a) if You Share all
or a substantial portion of the contents of the database.
For the avoidance of doubt, this Section 4 supplements and does not
replace Your obligations under this Public License where the Licensed
Rights include other Copyright and Similar Rights.
Section 5 – Disclaimer of Warranties and Limitation of Liability
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
a. **Unless otherwise separately undertaken by the Licensor, to the
extent possible, the Licensor offers the Licensed Material as-is and
as-available, and makes no representations or warranties of any kind
concerning the Licensed Material, whether express, implied,
statutory, or other. This includes, without limitation, warranties of
title, merchantability, fitness for a particular purpose,
non-infringement, absence of latent or other defects, accuracy, or
the presence or absence of errors, whether or not known or
discoverable. Where disclaimers of warranties are not allowed in full
or in part, this disclaimer may not apply to You.**
b. **To the extent possible, in no event will the Licensor be liable to
You on any legal theory (including, without limitation, negligence)
or otherwise for any direct, special, indirect, incidental,
consequential, punitive, exemplary, or other losses, costs, expenses,
or damages arising out of this Public License or use of the Licensed
Material, even if the Licensor has been advised of the possibility of
such losses, costs, expenses, or damages. Where a limitation of
liability is not allowed in full or in part, this limitation may not
apply to You.**
c. The disclaimer of warranties and limitation of liability provided
above shall be interpreted in a manner that, to the extent possible,
most closely approximates an absolute disclaimer and waiver of all
liability.
Section 6 – Term and Termination
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
a. This Public License applies for the term of the Copyright and Similar
Rights licensed here. However, if You fail to comply with this Public
License, then Your rights under this Public License terminate
automatically.
b. Where Your right to use the Licensed Material has terminated under
Section 6(a), it reinstates:
1. automatically as of the date the violation is cured, provided it is
cured within 30 days of Your discovery of the violation; or
2. upon express reinstatement by the Licensor.
For the avoidance of doubt, this Section 6(b) does not affect any right
the Licensor may have to seek remedies for Your violations of this
Public License.
c. For the avoidance of doubt, the Licensor may also offer the Licensed
Material under separate terms or conditions or stop distributing the
Licensed Material at any time; however, doing so will not terminate
this Public License.
d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
License.
Section 7 – Other Terms and Conditions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
a. The Licensor shall not be bound by any additional or different terms
or conditions communicated by You unless expressly agreed.
b. Any arrangements, understandings, or agreements regarding the
Licensed Material not stated herein are separate from and independent
of the terms and conditions of this Public License.
Section 8 – Interpretation
~~~~~~~~~~~~~~~~~~~~~~~~~~
a. For the avoidance of doubt, this Public License does not, and shall
not be interpreted to, reduce, limit, restrict, or impose conditions
on any use of the Licensed Material that could lawfully be made
without permission under this Public License.
b. To the extent possible, if any provision of this Public License is
deemed unenforceable, it shall be automatically reformed to the
minimum extent necessary to make it enforceable. If the provision
cannot be reformed, it shall be severed from this Public License
without affecting the enforceability of the remaining terms and
conditions.
c. No term or condition of this Public License will be waived and no
failure to comply consented to unless expressly agreed to by the
Licensor.
d. Nothing in this Public License constitutes or may be interpreted as a
limitation upon, or waiver of, any privileges and immunities that
apply to the Licensor or You, including from the legal processes of
any jurisdiction or authority.
Creative Commons is not a party to its public licenses.
Notwithstanding, Creative Commons may elect to apply one of its
public licenses to material it publishes and in those instances will
be considered the “Licensor.” Except for the limited purpose of
indicating that material is shared under a Creative Commons public
license or as otherwise permitted by the Creative Commons policies
published at
`creativecommons.org/policies <http://creativecommons.org/policies>`__,
Creative Commons does not authorize the use of the trademark
“Creative Commons” or any other trademark or logo of Creative
Commons without its prior written consent including, without
limitation, in connection with any unauthorized modifications to any
of its public licenses or any other arrangements, understandings, or
agreements concerning use of licensed material. For the avoidance of
doubt, this paragraph does not form part of the public licenses.
Creative Commons may be contacted at creativecommons.org
README.md
-254
View File
@@ -1,254 +0,0 @@
# QDarkStylesheet
[![Build Status](https://travis-ci.org/ColinDuquesnoy/QDarkStyleSheet.png?branch=master)](https://travis-ci.org/ColinDuquesnoy/QDarkStyleSheet)
[![Docs Status](https://readthedocs.org/projects/qdarkstylesheet/badge/?version=latest&style=flat)](https://qdarkstylesheet.readthedocs.io)
[![Latest PyPI version](https://img.shields.io/pypi/v/QDarkStyle.svg)](https://pypi.python.org/pypi/QDarkStyle)
[![License: MIT](https://img.shields.io/dub/l/vibe-d.svg?color=lightgrey)](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/)
[![conduct](https://img.shields.io/badge/code%20of%20conduct-contributor%20covenant-green.svg?style=flat&color=lightgrey)](http://contributor-covenant.org/version/1/4/)
A dark stylesheet for Qt applications (Qt4, Qt5, PySide, PySide2, PyQt4, PyQt5, QtPy,
PyQtGraph).
## Installation
### Python
From PyPI: Get the latest stable version of `qdarkstyle` package
using _pip_ (preferable):
```bash
pip install qdarkstyle
```
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
```
### 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:
```cpp
RESOURCES += qdarkstyle/style.qrc
```
- Load the stylesheet:
```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());
}
```
_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
Here is an example using PySide
```Python
import sys
import qdarkstyle
from PySide import QtGui
# 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_()
```
To use another wrapper for Qt, you need to replace some lines.
See examples below.
To use PyQt4, change two lines
```Python
from PySide import QtGui
app.setStyleSheet(qdarkstyle.load_stylesheet_pyqt())
```
If PyQt5, more lines need to be changed because of its API,
see the complete example
```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())
# run
window.show()
app.exec_()
```
If your project uses QtPy or you need to set it programmatically,
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_()
```
It is also simple if you use PyQtGraph
```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'] = '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_()
```
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.
```
qdarkstyle --all
```
<img src="./images/cmd.png"/>
## Snapshots
Here are a few snapshots comparing the use of QDarkStyle v2.6.1 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="./images/qdarkstyle_containers_buttons.png"/></td>
<td><img src="./images/no_dark_containers_buttons.png"/></td>
</tr>
<tr>
<th colspan=2>Containers (tabs) and Displays</th>
</tr>
<tr>
<td><img src="./images/qdarkstyle_containers_tabs_displays.png"/></td>
<td><img src="./images/no_dark_containers_tabs_displays.png"/></td>
</tr>
<tr>
<th colspan=2>Widgets and Inputs (fields)</th>
</tr>
<tr>
<td><img src="./images/qdarkstyle_widgets_inputs_fields.png"/></td>
<td><img src="./images/no_dark_widgets_inputs_fields.png"/></td>
</tr>
<tr>
<th colspan=2>Views and Inputs (no fields)</th>
</tr>
<tr>
<td><img src="./images/qdarkstyle_views_inputs_no_fields.png"/></td>
<td><img src="./images/no_dark_views_inputs_no_fields.png"/></td>
</tr>
</table>
## Changelog
Please, see [CHANGES](CHANGES.md) 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.md) file.
## Authors
For more information see [AUTHORS](AUTHORS.md) 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.md) file.
README.rst
+337
View File
@@ -0,0 +1,337 @@
QDarkStylesheet
===============
|Build Status| |Docs Status| |Latest PyPI version| |License: MIT|
|License: CC BY 4.0| |Conduct|
A dark stylesheet for Qt applications (Qt4, Qt5, PySide, PySide2, PyQt4,
PyQt5, QtPy, PyQtGraph).
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.
``bash pip install .``
- Or, you can use the *setup* script with Python:
``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:
``cpp 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
-----
Here is an example using PySide
.. code:: python
import sys
import qdarkstyle
from PySide import QtGui
# 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_()
To use another wrapper for Qt, you need to replace some lines. See
examples below.
To use PyQt4, change two lines
.. code:: python
from PySide import QtGui
app.setStyleSheet(qdarkstyle.load_stylesheet_pyqt())
If PyQt5, more lines need to be changed because of its API, 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())
# run
window.show()
app.exec_()
If your project 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'] = '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_()
It is also simple if you use PyQtGraph
.. 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'] = '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_()
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.
::
qdarkstyle --all
Snapshots
---------
Here are a few snapshots comparing the use of QDarkStyle v2.6.1 and the
default style. Click in the image to zoom.
.. raw:: html
<table style="width:100%">
.. raw:: html
<tr>
::
<th colspan=2>Containers (no tabs) and Buttons</th>
.. raw:: html
</tr>
.. raw:: html
<tr>
::
<td><img src="./images/qdarkstyle_containers_buttons.png"/></td>
<td><img src="./images/no_dark_containers_buttons.png"/></td>
.. raw:: html
</tr>
.. raw:: html
<tr>
::
<th colspan=2>Containers (tabs) and Displays</th>
.. raw:: html
</tr>
.. raw:: html
<tr>
::
<td><img src="./images/qdarkstyle_containers_tabs_displays.png"/></td>
<td><img src="./images/no_dark_containers_tabs_displays.png"/></td>
.. raw:: html
</tr>
.. raw:: html
<tr>
::
<th colspan=2>Widgets and Inputs (fields)</th>
.. raw:: html
</tr>
.. raw:: html
<tr>
::
<td><img src="./images/qdarkstyle_widgets_inputs_fields.png"/></td>
<td><img src="./images/no_dark_widgets_inputs_fields.png"/></td>
.. raw:: html
</tr>
.. raw:: html
<tr>
::
<th colspan=2>Views and Inputs (no fields)</th>
.. raw:: html
</tr>
.. raw:: html
<tr>
::
<td><img src="./images/qdarkstyle_views_inputs_no_fields.png"/></td>
<td><img src="./images/no_dark_views_inputs_no_fields.png"/></td>
.. raw:: html
</tr>
.. raw:: html
</table>
Changelog
---------
Please, see `CHANGES <CHANGES.md>`__ 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.md>`__ file.
Authors
-------
For more information see `AUTHORS <AUTHORS.md>`__ 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.md>`__ 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/
doc/authors.rst
+1 -1
View File
@@ -1 +1 @@
.. mdinclude:: ../AUTHORS.md
.. mdinclude:: ../AUTHORS.rst
doc/changes.rst
+1 -1
View File
@@ -1 +1 @@
.. mdinclude:: ../CHANGES.md
.. mdinclude:: ../CHANGES.rst
doc/code_of_conduct.rst
+1 -1
View File
@@ -1 +1 @@
.. mdinclude:: ../CODE_OF_CONDUCT.md
.. mdinclude:: ../CODE_OF_CONDUCT.rst
doc/contributing.rst
+1 -1
View File
@@ -1 +1 @@
.. mdinclude:: ../CONTRIBUTING.md
.. mdinclude:: ../CONTRIBUTING.rst
doc/license.rst
+1 -1
View File
@@ -1 +1 @@
.. mdinclude:: ../LICENSE.md
.. mdinclude:: ../LICENSE.rst
doc/readme.rst
+1 -1
View File
@@ -1 +1 @@
.. mdinclude:: ../README.md
.. mdinclude:: ../README.rst