Metadata-Version: 2.1
Name: qtsasstheme
Version: 0.0.55
Summary: Set the Qt theme (e.g. darkgray/lightgray/darkblue/lightblue) easily
Home-page: https://github.com/yjg30737/qtsasstheme.git
Author: Jung Gyu Yoon
Author-email: yjg30737@gmail.com
License: MIT
Description-Content-Type: text/markdown
License-File: LICENSE


# qtsasstheme

Set the Qt theme (e.g. darkgray/lightgray/darkblue/lightblue) easily



This is using SCSS to set the light/dark theme to PyQt GUI, which is quite efficient.



Old name of this is `qt-sass-theme-getter`.



## Setup

`python -m pip install qtsasstheme`



## Included Packages

* <a href="https://github.com/spyder-ide/qtpy">qtpy</a> - support pyqt5/pyside2/pyqt6/pyside6

* <a href="https://github.com/spyder-ide/qtsass">qtsass</a> - for converting sass into css

* <a href="https://github.com/yjg30737/pyqt-svg-button">pyqt-svg-button</a> - for supporting svg button



## Detailed Description 

### Method Overview

#### `getThemeFiles(theme: str = 'dark_gray', background_darker=False, output_path=os.getcwd())`

Currently there are 4 official theme being supported:

* dark_gray

* dark_blue

* light_gray

* light_blue



You can also make your own theme with [customizing theme](#customizing-theme).



`background_darker` decides whether the background color is going to be darker than general widget color or not.



If that is set to `True`, background color is darker than general widget color. See image below.



![image](https://user-images.githubusercontent.com/55078043/176577420-83dbb591-a007-43a8-9228-d901d087f3b9.png)



If that is set to `False`(which is set by default), background color is lighter than general widget color. See image below.



![image](https://user-images.githubusercontent.com/55078043/176577358-4da71649-63e7-4a67-a041-49b381cf320c.png)



`output_path` is the path that 'res' directory will be made which is holding a bunch of theme files after you called `getThemeFiles`.



'res' directory looks like below.



![image](https://user-images.githubusercontent.com/55078043/174504918-43e66f7f-21cb-4555-a446-7a476b69d62e.png)



`ico` directory holds icon files which will be being used in theme. For example, light icons will be being used in dark theme, dark icons will be being used in light theme. `_icons.scss` makes sass files in `sass` directory refer to icons in this directory.



`sass` directory holds the scss files which will be converted into css files.



`var` directory holds the `_variables.scss` which contains the color(e.g. color of background/widget/border...) variables. 



<hr>



#### `setThemeFiles(main_window: QWidget, input_path='res', exclude_type_lst: list = [])`

Right after calling `getThemeFiles`, you can set the style with calling `setThemeFiles`.



After calling it, 'res' directory looks like this:



![image](https://user-images.githubusercontent.com/55078043/174504820-b6262c1e-e1b8-4c56-8c98-1f8c93d87175.png)



scss files successfully convert into css files.



Note: Don't change the current directory with function such as `os.chdir` after calling `getThemeFiles` and before calling `setThemeFiles`. `FileNotFoundError` will be most likely occurred.



### Customizing Theme



There are two ways to customize theme.



#### 1. Giving color string to <a href="https://github.com/yjg30737/qtsasstheme#getthemefilestheme-str--dark_gray-background_darkerfalse-output_pathosgetcwd">`getThemeFiles`</a>



You can give the 6-digit hex string(e.g. #FF0000) to `getThemeFiles`'s `theme` argument.



In this case, widget's color will be set based on the hex color you given.



This is the way how to do it:



```python

//..

app = QApplication(sys.argv)

w = SampleWidget()

g = QtSassTheme()

g.getThemeFiles(theme='#6f495f')

g.setThemeFiles(w)

w.show()

app.exec()

```



![image](https://user-images.githubusercontent.com/55078043/176577019-40067d89-16ea-499b-961e-ca2a750a76f1.png)



#### 2. Modify `_variables.scss`'s color directly



This is the way how to do it:



1. Calling `getThemeFiles`

```python

g = QtSassTheme()

g.getThemeFiles() 

```



![image](https://user-images.githubusercontent.com/55078043/174504918-43e66f7f-21cb-4555-a446-7a476b69d62e.png)



'res' directory like above will be generated. You can see `_variables.scss`.



2. Change the variables



open the `_variables.scss` and change the `$bgcolor`'s value.



This is `_variables.scss`'s contents(dark-gray theme).



```scss

$bgcolor: #555555;

$widgetcolor: darken($bgcolor, 10);

$altwidgetcolor: lighten($widgetcolor, 18);

$textcolor: #DDDDDD;

$hovercolor: lighten($widgetcolor, 6);

$bordercolor: lighten($widgetcolor, 20);

$selectcolor: darken($widgetcolor, 6);

$disabledcolor: #AAAAAA;

$textwidgetcolor: darken($widgetcolor, 12);

$scrollhandlecolor: lighten($widgetcolor, 30);

$splitterhandlecolor: darken($widgetcolor, 10);

```



You can change any colors.



In this example i will change the $bgcolor from #555555 to #006600(dark-green).



3. Calling `setThemeFiles`

```python

//..

app = QApplication(sys.argv)

w = SampleWidget()

g = QtSassTheme()

g.setThemeFiles(w)

w.show()

app.exec()

```



![image](https://user-images.githubusercontent.com/55078043/176577665-061ecd5f-5044-4d5f-9419-5e22da1c57dc.png)



## Example

### Code Sample



```python

from PyQt5.QtWidgets import QApplication

# from PyQt6.QtWidgets import QApplication

# from PySide2.QtWidgets import QApplication

# from PySide6.QtWidgets import QApplication

from pyqt_timer.settingsDialog import SettingsDialog

from qt_sass_theme import QtSassTheme



if __name__ == "__main__":

    import sys



    app = QApplication(sys.argv)

    widget = SettingsDialog()

    g = QtSassTheme()

    g.getThemeFiles(theme='dark_gray')

    # g.getThemeFiles(theme='dark_blue') - if you want to set dark blue theme

    g.setThemeFiles(main_window=widget)

    widget.show()

    app.exec()

```



### Result

Preview widget is <a href="https://github.com/yjg30737/pyqt-timer.git">pyqt-timer</a>'s settings dialog.



Dark gray theme



![image](https://user-images.githubusercontent.com/55078043/176577358-4da71649-63e7-4a67-a041-49b381cf320c.png)



Dark blue theme



![image](https://user-images.githubusercontent.com/55078043/176577732-a3fe1575-73ad-44a4-8219-df196b954a7e.png)



Light gray theme



![image](https://user-images.githubusercontent.com/55078043/176577755-4534f3c1-9e35-48b1-8b9f-3fc770dac528.png)



Light blue theme



![image](https://user-images.githubusercontent.com/55078043/176577792-d47ce959-bd07-4ff4-9cf9-b309ab061d0b.png)

