{% extends "layout.html" %}
{% set title = 'Overview' %}
{% block body %}
<div class="section">
  <h1>PySide {{ version }} Reference</h1>

    <p><a href="http://www.qt.io/">Qt</a> is a complete cross-platform software framework.
    PySide aims to provide Python developers access to the Qt libraries in the most natural way.</p>

    <p>PySide is built using the Shiboken binding generator.</p>

  <h2>Notes</h2>

    <h3>About 0 vs None</h3>

    <p>The PySide class reference documentation is automatically generated from the original
    Qt documentation for C++, some parts were tuned to fit the Python world. However, it's not
    possible to rewrite all Qt docs as it would require a really huge effort, so if the
    documentation says you can use 0 on an QObject argument, interpret it as None.</p>

    <h3>About keyword arguments</h3>

    <p>Only optional arguments can be used as keyword arguments.</p>

  <h2>Modules</h2>

  <table class="contentstable" align="center" ><tr>
    <td width="50%">
      <p class="biglink"><a class="biglink" href="{{ pathto("PySide2/Qt3DAnimation/index") }}">Qt3DAnimation</a><br/>
         <span class="linkdescr">provides a set of prebuilt elements to help you get started with Qt 3D</span></p>
      <p class="biglink"><a class="biglink" href="{{ pathto("PySide2/Qt3DCore/index") }}">Qt3DCore</a><br/>
         <span class="linkdescr">contains functionality to support near-realtime simulation systems</span></p>
      <p class="biglink"><a class="biglink" href="{{ pathto("PySide2/Qt3DExtras/index") }}">Qt3DExtras</a><br/>
         <span class="linkdescr"> provides a set of prebuilt elements to help you get started with Qt 3D</span></p>
      <p class="biglink"><a class="biglink" href="{{ pathto("PySide2/Qt3DInput/index") }}">Qt3DInput</a><br/>
         <span class="linkdescr"></span>provides classes for handling user input in applications using Qt3D</p>
      <p class="biglink"><a class="biglink" href="{{ pathto("PySide2/Qt3DLogic/index") }}">Qt3DLogic</a><br/>
         <span class="linkdescr">enables synchronizing frames with the Qt 3D backend</span></p>
      <p class="biglink"><a class="biglink" href="{{ pathto("PySide2/Qt3DRender/index") }}">Qt3DRender</a><br/>
         <span class="linkdescr"></span>contains functionality to support 2D and 3D rendering using Qt 3D</p>
      <p class="biglink"><a class="biglink" href="{{ pathto("PySide2/QtAxContainer/index") }}">QtAxContainer</a><br/>
         <span class="linkdescr">provides QAxObject and QAxWidget which act as
           containers for COM objects and ActiveX controls</span></p>
      <p class="biglink"><a class="biglink" href="{{ pathto("PySide2/QtCharts/index") }}">QtCharts</a><br/>
         <span class="linkdescr">provides a set of easy to use chart components</span></p>
      <p class="biglink"><a class="biglink" href="{{ pathto("PySide2/QtConcurrent/index") }}">QtConcurrent</a><br/>
         <span class="linkdescr">provides high-level APIs that make it possible
           to write multi-threaded programs without using low-level threading
           primitives such as mutexes, read-write locks, wait conditions, or semaphores</span></p>
      <p class="biglink"><a class="biglink" href="{{ pathto("PySide2/QtCore/index") }}">QtCore</a><br/>
         <span class="linkdescr">core non-GUI functionality</span></p>
      <p class="biglink"><a class="biglink" href="{{ pathto("PySide2/QtDataVisualization/index") }}">QtDataVisualization</a><br/>
         <span class="linkdescr">provides a way to visualize data in 3D as bar, scatter, and surface graphs</span></p>
      <p class="biglink"><a class="biglink" href="{{ pathto("PySide2/QtGui/index") }}">QtGui</a><br/>
         <span class="linkdescr">extends QtCore with GUI functionality.</span></p>
      <p class="biglink"><a class="biglink" href="{{ pathto("PySide2/QtMacExtras/index") }}">QtMacExtras</a><br/>
         <span class="linkdescr">provides classes and functions specific to
           macOS and iOS operating systems</span></p>
      <p class="biglink"><a class="biglink" href="{{ pathto("PySide2/QtHelp/index") }}">QtHelp</a><br/>
         <span class="linkdescr">provides classes for integrating online documentation in applications</span></p>
      <p class="biglink"><a class="biglink" href="{{ pathto("PySide2/QtMultimedia/index") }}">QtMultimedia</a><br/>
         <span class="linkdescr">provides low-level multimedia functionality</span></p>
      <p class="biglink"><a class="biglink" href="{{ pathto("PySide2/QtMultimediaWidgets/index") }}">QtMultimediaWidgets</a><br/>
         <span class="linkdescr">provides the widget-based multimedia API</span></p>
      <p class="biglink"><a class="biglink" href="{{ pathto("PySide2/QtNetwork/index") }}">QtNetwork</a><br/>
         <span class="linkdescr">offers classes that allow you to write TCP/IP clients and servers</span></p>
    </td>
    <td width="50%">
      <p class="biglink"><a class="biglink" href="{{ pathto("PySide2/QtOpenGL/index") }}">QtOpenGL</a><br/>
         <span class="linkdescr">offers classes that make it easy to use OpenGL in Qt applications</span></p>
      <p class="biglink"><a class="biglink" href="{{ pathto("PySide2/QtPrintSupport/index") }}">QtPrintSupport</a><br/>
         <span class="linkdescr">provides cross-platform support for printing</span></p>
      <p class="biglink"><a class="biglink" href="{{ pathto("PySide2/QtQml/index") }}">QtQml</a><br/>
         <span class="linkdescr">Python API for Qt QML</span></p>
      <p class="biglink"><a class="biglink" href="{{ pathto("PySide2/QtQuick/index") }}">QtQuick</a><br/>
         <span class="linkdescr">provides classes for embedding Qt Quick in Qt applications</span></p>
      <p class="biglink"><a class="biglink" href="{{ pathto("PySide2/QtQuickWidgets/index") }}">QtQuickWidgets</a><br/>
         <span class="linkdescr">provides the QQuickWidget class for embedding Qt Quick in widget-based applications</span></p>
      <p class="biglink"><a class="biglink" href="{{ pathto("PySide2/QtTextToSpeech/index") }}">QtTextToSpeech</a><br/>
         <span class="linkdescr">provides C++ API to access text-to-speech engines</span></p>
      <p class="biglink"><a class="biglink" href="{{ pathto("PySide2/QtSql/index") }}">QtSql</a><br/>
         <span class="linkdescr">helps you provide seamless database integration to your Qt applications</span></p>
      <p class="biglink"><a class="biglink" href="{{ pathto("PySide2/QtSvg/index") }}">QtSvg</a><br/>
         <span class="linkdescr">provides classes for displaying the contents of SVG files</span></p>
      <p class="biglink"><a class="biglink" href="{{ pathto("PySide2/QtTest/index") }}">QtTest</a><br/>
         <span class="linkdescr">provides classes for unit testing Qt applications and libraries</span></p>
      <p class="biglink"><a class="biglink" href="{{ pathto("PySide2/QtUiTools/index") }}">QtUiTools</a><br/>
         <span class="linkdescr">provides classes to handle forms created with Qt Designer</span></p>
      <p class="biglink"><a class="biglink" href="{{ pathto("PySide2/QtWebChannel/index") }}">QtWebChannel</a><br/>
         <span class="linkdescr">enables peer-to-peer communication between a server and a client
           (HTML/JavaScript or QML application)</span></p>
      <p class="biglink"><a class="biglink" href="{{ pathto("PySide2/QtWebSockets/index") }}">QtWebSockets</a><br/>
         <span class="linkdescr"></span>provides interfaces that enable Qt applications
           to act as a server that can process WebSocket requests, or a client that
           can consume data received from the server, or both</p>
      <p class="biglink"><a class="biglink" href="{{ pathto("PySide2/QtWidgets/index") }}">QtWidgets</a><br/>
         <span class="linkdescr">extends Qt GUI with C++ widget functionality.</span></p>
      <p class="biglink"><a class="biglink" href="{{ pathto("PySide2/QtWinExtras/index") }}">QtWinExtras</a><br/>
         <span class="linkdescr">provides classes and functions for using some Windows APIs in a Qt way</span></p>
      <p class="biglink"><a class="biglink" href="{{ pathto("PySide2/QtX11Extras/index") }}">QtX11Extras</a><br/>
         <span class="linkdescr">provides information about the X display configuration</span></p>
      <p class="biglink"><a class="biglink" href="{{ pathto("PySide2/QtXml/index") }}">QtXml</a><br/>
         <span class="linkdescr">provides a stream reader and writer for XML documents</span></p>
      <p class="biglink"><a class="biglink" href="{{ pathto("PySide2/QtXmlPatterns/index") }}">QtXmlPatterns</a><br/>
         <span class="linkdescr">provides support for XPath, XQuery, XSLT and XML Schema validation</span></p>
    </td></tr>
  </table>

  <h2>Tutorials and examples</h2>

  <p>A collection of <a href="{{ pathto("tutorials/index") }}">tutorials</a> and "walkthrough" guides are provided with PySide to help new users get started with PySide development. These documents were ported from C++ to Python and cover a range of topics, from basic use of widgets to step-by-step <a href="{{ pathto("tutorials/index") }}">tutorials</a> that show how an application is put together.</p>

  <h2>Other stuff</h2>

  <ul>
    <li class="toctree-l1"><a class="reference internal" href="pysideapi2.html">PySide API 2</a></li>
    <li class="toctree-l1"><a class="reference internal" href="pysideversion.html">Getting PySide and Qt version</a></li>
  </ul>
</div>
{% endblock %}