PySimpleGUI/PySimpleGUIQt/readme.md

  
    
      
      
      
      
![pysimplegui_logo](https://user-images.githubusercontent.com/13696193/43165867-fe02e3b2-8f62-11e8-9fd0-cc7c86b11772.png)      
      
[![Downloads](http://pepy.tech/badge/pysimpleguiqt)](http://pepy.tech/project/pysimplegui)      

    
 ![Awesome Meter](https://img.shields.io/badge/Awesome_meter-1000-yellow.svg)
       
 ![Python Version](https://img.shields.io/badge/Python-3.x-yellow.svg)      
      
      
      
      
      
      
# PySimpleGUIQt      
      
      
## The Alpha Release   
      
[Announcements of Latest Developments](https://github.com/MikeTheWatchGuy/PySimpleGUI/issues/142)      
            

      
  -----      
## Getting Started with PySimpleGUIQt

Welcome to the Alpha Release of PySimpleGUI for Qt!

You can use the exact same code that you are running on the older, tkinter, version of PySimpleGUI.  

PySimpleGUIQt uses **PySide2** OR **PyQt5** for access to Qt.

## Porting your PySimpleGUI code to PySimpleGUIQt


To "port" your code from the tkinter implementation. Follow these steps:

1. Change `import PySimpleGUI` to `PySimpleGUIQt`

That's it!  OK, maybe I should have said step instead of steps.


## Differences between PySimpleGUI and PySimpleGUIQt

#### Sizes

While you can use "Character-based" sizes like you did in tkinter, it's best to use pixel based sizes as that is what Qt uses.  PySimpleGUIQt does some very rough / basic conversions from the character sizes to pixel sizes.  It's enough that your elements will at least be visible.  But the conversion is likely to not be ideal.

#### Fonts

Fonts should be in the format (font family, size).  You can use the older string based too, but it will not work with setting like bold and italics.  PySimpleGUIQt converts from the string 'Courier 20' to the tuple ('Courier', 20) for you.


### Installing PySimpleGUIQt for  Python 3      
      
    pip install --upgrade PySimpleGUIQt
      
On Linux systems you need to run pip3.      
      
    pip3 install --upgrade PySimpleGUIQt     
      

### Installing PySide2 or PyQt5 for Python 3

It is recommended that you use PySide2, however, if that cannot be found, then PyQt5 will be attempted.  To install either of these:

```pip install PySide2```
     
or

```pip install PyQt5``` 
    
      
## Testing your installation      
      
Once you have installed, or copied the .py file to your app folder, you can test the installation using python.  At the command prompt start up Python.      
```      
python3      
>>> import PySimpleGUIQt    
>>> PySimpleGUIQt.main()      
```      
      
You will see a sample window in the center of your screen.  If it's not installed correctly you are likely to get an error message during one of those commands      
      
Here is the window you should see:      
      
![sample window](https://user-images.githubusercontent.com/13696193/46097669-79efa500-c190-11e8-885c-e5d4d5d09ea6.jpg)      
      
      
      
## Prerequisites      
Python 3      
PySide2 or PyQt5
      
      
      
## Using  - Python 3      
      
To use in your code, simply import....      
 `import PySimpleGUIQt as sg`      
      
Then use the exact same code as any other PySimpleGUI program that runs on tkinter.  

## Status

### FEATURE COMPLETE! 

All of the major features are DONE.  They may not have all of their options working, but they can be added to your windows.  It's been an amazing week to get here.

I hope you enjoy this ALPHA release!  Please post a screenshot on the GitHub site.  There is an Issue where users have been posting their applications.  It's a place for you to show-off and a place for others to learn from your designs.  Your window does not have to be complex.... all GUIs, no matter how simple, are something we can learn from.


### Functioning features
Features are being added daily to this Qt port of PySimpleGUI.  
These Elements are "complete" (a relative term... more are more complete than others):
* Text
* Input single line
* Input multiline
* Output multiline (new)
* Dial (new)
* Output - reroute stdout
* Spinner
* Sliders
* Buttons - RButtons, CButtons, Short-cut Buttons
* Checkbox
* Radio Buttons
* Listbox
* ComboBox
* Labeled Frames
* Columns - enables you to make pretty much any layout!
* Alpha channel for windows
* No Title Bar setting
* Enter submits for multiline
* Fonts
* Colors for text and background
* Timeouts for Read calls
* Change Submits parametes for most Elements
* Table
   * Basic display
   * Read selected rows
   * change_submits events
   * Updates
* Image as a background (new feature)
* Graph - Draw line, draw circle, draw text
* Image Element
* Tree Element
* Tabs
* Menus

  

## Missing Features

Notable MISSING features at the moment include:
* Graphs Element Methods - erasing, draw arc, etc
* Change submits - for radio buttons
 

## Design      
            
## Author      
MikeTheWatchGuy      
      
## Demo Code Contributors      
 
      
## License      
      
GNU Lesser General Public License (LGPL 3) +      
      
## Acknowledgments