Metadata-Version: 2.1
Name: QSwitchControl
Version: 2.0.3.Beta
Summary: An easy-to-use and modern toggle switch for Qt Python binding PyQt
Home-page: https://github.com/Prx001/QSwitchControl
Author: Parsa.py
Author-email: munichbayern2005@gmail.com
License: MIT
Description: # This is the beta branch, there might be some known or unknown bugs that I would be happy if you report them in issues after your experience.
        ## Also there is no guarantee that new features will be available on the next stable release.
        ## The assets of beta version is available in latest Pre Release.
        
        
        # QSwitchControl
        ## Custom toggle-switch widget implemented in PyQt5 for PyQt5 applications!
        
        
        https://user-images.githubusercontent.com/67240789/128912103-b24d7321-a7d6-4b1b-bbdc-562dbd20b358.mp4
        
        
        
        ### An easy-to-use and modern toggle switch for Qt Python binding PyQt
        QSwitchControl is a custom toggle-switch widget inherited from 'QCheckBox' class, and acts as a checkbox alternative widget in your PyQt5 application.
        
        ## How to use?
        ### Installation
        The package is available on [PyPi](https://pypi.org/project/QSwitchControl/2.0.3.Beta/) so as always use pip for installation.
        
        ### Usage in your Python application
        First of all, as expected, you need to import the package.
        Import 'SwitchControl' class from the package:
        ```python
        from QSwitchControl import SwitchControl
        ```
        Now the class is ready to use!
        SwitchControl is an alternative widget for QCheckBox from Qt framework, same methods, same usage and that's how it works.
        There are things you can define for your SwitchControl, like the circle color, background color, active color, animation easing curve, animation duration and some other things, but you can use default values. The package contains a '__main__' script so you can test the widget easily:
        ```
        python -m QSwitchControl
        ```
        In '\_\_main\_\_' script we used the default values for our widget:
        ```python
        switch_control = SwitchControl()
        ```
        You can define the values yourself. Bellow is an example:
        ```python
        switch_control = SwitchControl(bg_color="#777777", circle_color="#DDD", active_color="#aa00ff", animation_curve=QtCore.QEasingCurve.InOutCubic, animation_duration=300, checked=True, change_cursor=False)
        ```
        # Qt Designer integration
        Qt Designer is a very extensible tool, even can support your custom widgets! It means you can interact with your custom widget just as you do with Qt widgets, like QPushButton, QCheckBox, you can drag and drop them on your form, change their sizes, set properties and so on.
        Qt Designer can load plugins, and you can load your custom widgets through plugins, then your custom widget is available in Qt Designer Widget Box. In C++, using Qt Creator IDE you can create your custom widgets and compile them to .dll file, then you put the dll file (your plugin) into Qt Designer's relative path for plugins, and that's it you can use your widget in Designer. But, here in python the story is a little different. PyQt supports this plugin developement and integrate *Python based* Qt custom widgets in Qt Designer. [Learn more about integrating PyQt custom widgets in Qt Designer](https://wiki.python.org/moin/PyQt/Using_Python_Custom_Widgets_in_Qt_Designer) There is the Qt Designer plugin for QSwitchControl in package, [QSwitchControlplugin.py](https://github.com/Prx001/QSwitchControl/tree/beta/QSwitchControl/Classic/QSwitchControlplugin.py). You can load it to your Qt Designer.
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: CPython
Description-Content-Type: text/markdown
