PyQt6

https://www.riverbankcomputing.com/static/Docs/PyQt6/
Admin
PyQt6 is a comprehensive set of Python bindings for the Qt application framework, enabling Python...
Tokens:5,219,581
Snippets:53,329
Trust Score:9.7
Update:9 hours ago
Show doc for...
Tokens:
Raw
### Start a process with QProcess::start() using program and arguments

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtcore/qprocess.html

Pass the program name and command line arguments as individual strings to start(). The example runs the analog clock example in Fusion style on X11 by passing "-style" and "fusion" as two arguments.

```cpp
#     QObject *parent;
```

```cpp
#     QString program = "./path/to/Qt/examples/widgets/analogclock";
```

```cpp
#     QStringList arguments;
#     arguments << "-style" << "fusion";

#     QProcess *myProcess = new QProcess(parent);
#     myProcess->start(program, arguments);
```

--------------------------------

### Install PyQt-builder to get pyqt-bundle

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/installation.html

Installs PyQt-builder, which provides the pyqt-bundle program used to bundle a custom Qt installation with commercial PyQt6.

```bash
pip install PyQt-builder
```

--------------------------------

### QProcess startCommand with arguments separated by spaces

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtcore/qprocess.html

Use startCommand() to start a program with a single command string. Arguments are separated by spaces; this example is equivalent to calling start() with a list of arguments.

```cpp
# QProcess process;
# process.startCommand("del /s *.txt");
# // same as process.start("del", QStringList() << "/s" << "*.txt");
# ...
```

--------------------------------

### Camera permission and activation example (C++ source)

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtmultimedia/qcamera.html

This C++ example requests camera permissions at application start and activates the camera if granted. It is marked as needing porting to Python.

```cpp
# This code needs porting to Python.

# /****************************************************************************
# **
# ** Copyright (C) 2016 The Qt Company Ltd.
# ** Contact: https://www.qt.io/licensing/
# **
# ** This file is part of the Qt Mobility Components.
# **
# ** $QT_BEGIN_LICENSE:LGPL$
# ** Commercial License Usage
# ** Licensees holding valid commercial Qt licenses may use this file in
# ** accordance with the commercial license agreement provided with the
# ** Software or, alternatively, in accordance with the terms contained in
# ** a written agreement between you and The Qt Company. For licensing terms
# ** and conditions see https://www.qt.io/terms-conditions. For further
# ** information use the contact form at https://www.qt.io/contact-us.
# **
# ** GNU Lesser General Public License Usage
# ** Alternatively, this file may be used under the terms of the GNU Lesser
# ** General Public License version 3 as published by the Free Software
# ** Foundation and appearing in the file LICENSE.LGPL3 included in the
# ** packaging of this file. Please review the following information to
# ** ensure the GNU Lesser General Public License version 3 requirements
# ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
# **
# ** GNU General Public License Usage
# ** Alternatively, this file may be used under the terms of the GNU
# ** General Public License version 2.0 or (at your option) the GNU General
# ** Public license version 3 or any later version approved by the KDE Free
# ** Qt Foundation. The licenses are as published by the Free Software
# ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
# ** included in the packaging of this file. Please review the following
# ** information to ensure the GNU General Public License requirements will
# ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
# ** https://www.gnu.org/licenses/gpl-3.0.html.
# **
# ** $QT_END_LICENSE$
# **
# ****************************************************************************/

# /* Camera snippets */

# #include "qcamera.h"
# #include "qcameradevice.h"
# #include "qmediarecorder.h"
# #include "qmediadevices.h"
# #include "qmediacapturesession.h"
# #include "qimagecapture.h"
# #include "qvideosink.h"
# #include <QtMultimediaWidgets/qvideowidget.h>
# #include <QtGui/qscreen.h>
# #include <QtGui/qguiapplication.h>
# #include <QtGui/qimage.h>

# /* Globals so that everything is consistent. */
# QCamera *camera = 0;
# QMediaRecorder *recorder = 0;
# QImageCapture *imageCapture = 0;

# #! [Camera overview check]
# bool checkCameraAvailability()
# {
#     if (QMediaDevices::videoInputs().count() > 0)
#         return true;
#     else
#         return false;
# }
# #! [Camera overview check]

# void overview_viewfinder()
# {
#     #! [Camera overview viewfinder]
#     QMediaCaptureSession captureSession;
#     camera = new QCamera;
#     captureSession.setCamera(camera);
#     QVideoWidget *preview = new QVideoWidget;
#     camera->setVideoOutput(preview);
#     preview->show();

#     camera->start(); // to start the camera
#     #! [Camera overview viewfinder]
# }
```

--------------------------------

### start()

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtgui/qmovie.html

Starts the movie. QMovie will enter Running state, and start emitting updated and resized as the movie progresses.

```APIDOC
## start()

### Description
Starts the movie. QMovie will enter Running state, and start emitting updated and resized as the movie progresses.

If QMovie is in the Paused state, this function is equivalent to calling setPaused()(false). If QMovie is already in the Running state, this function does nothing.

### Method
start

### See Also
stop(), setPaused().
```

--------------------------------

### start(program, arguments, mode)

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtcore/qprocess.html

Starts the given program in a new process, passing the command line arguments in arguments. The OpenMode is set to mode. No further splitting of the arguments is performed. The QProcess object will immediately enter the Starting state.

```APIDOC
## start(program, arguments, mode)

### Description
Starts the given program in a new process, passing the command line arguments in arguments. The OpenMode is set to mode. No further splitting of the arguments is performed. The QProcess object will immediately enter the Starting state.

### Method
start

### Parameters
- **program** (str or None) - Required - The program to start.
- **arguments** (Iterable[str or None]) - Optional - The command line arguments. Default is empty list.
- **mode** (OpenModeFlag) - Optional - The open mode. Default is ReadWrite.

### See Also
processId(), started, waitForStarted(), setNativeArguments()
```

--------------------------------

### Get capture group offsets with capturedStart() and capturedEnd()

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtcore/qregularexpressionmatch.html

Use capturedStart() and capturedEnd() to obtain the start and end positions of a capture group. The example matches a pattern and retrieves offsets for group 1.

```cpp
QRegularExpression re("abc(\\d+)def");
QRegularExpressionMatch match = re.match("XYZabc123defXYZ");
if (match.hasMatch()) {
    int startOffset = match.capturedStart(1); // startOffset == 6
    int endOffset = match.capturedEnd(1); // endOffset == 9
    // ...
}
```

--------------------------------

### Set up QWizard with pages in main

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtwidgets/qwizard.html

Creates a QApplication and QWizard, then adds the intro, registration, and conclusion pages. Includes optional translation setup.

```cpp
int main(int argc, char *argv[])
{
    QApplication app(argc, argv);

#ifndef QT_NO_TRANSLATION
    QString translatorFileName = QLatin1String("qtbase_");
    translatorFileName += QLocale::system().name();
    QTranslator *translator = new QTranslator(&app);
    if (translator->load(translatorFileName, QLibraryInfo::path(QLibraryInfo::TranslationsPath)))
        app.installTranslator(translator);
#endif

    QWizard wizard;
    wizard.addPage(createIntroPage());
    wizard.addPage(createRegistrationPage());
    wizard.addPage(createConclusionPage());
```

--------------------------------

### Measure elapsed time with QTime::start and elapsed

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtcore/qdatetime.html

Use QTime::start to begin timing and QTime::elapsed to get the number of milliseconds since the start. The example measures the duration of some_lengthy_task().

```cpp
QTime t;
t.start();
some_lengthy_task();
qDebug("Time elapsed: %d ms", t.elapsed());
```

--------------------------------

### setupData() → bool

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qthelp/qhelpenginecore.html

Sets up the help engine by processing the information found in the collection file and returns true if successful; otherwise returns false. By calling the function, the help engine is forced to initialize itself immediately. Most of the times, this function does not have to be called explicitly because getter functions which depend on a correctly set up help engine do that themselves.

```APIDOC
## setupData() → bool

### Description
Sets up the help engine by processing the information found in the collection file and returns true if successful; otherwise returns false. By calling the function, the help engine is forced to initialize itself immediately. Most of the times, this function does not have to be called explicitly because getter functions which depend on a correctly set up help engine do that themselves.

### Method
setupData() → bool

### Parameters
None

### Response
#### Success Response
- **bool** - true if successful; otherwise false.
```

--------------------------------

### Restart QElapsedTimer in a loop

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtcore/qelapsedtimer.html

Use QElapsedTimer::restart() to reset the timer and get the elapsed time since the last start or restart. This example doubles a count until the time since the last restart reaches 250 milliseconds.

```cpp
    QElapsedTimer timer;

    int count = 1;
    timer.start();
    do {
        count *= 2;
        slowOperation2(count);
    } while (timer.restart() < 250);

    return count;
```

--------------------------------

### QHelpSearchEngineCore(QHelpEngineCore, parent: QObject = None)

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qthelp/qhelpsearchenginecore.html

Constructs a new search engine with the given parent. The search engine uses the given helpEngine to access the documentation that needs to be indexed. The QHelpEngineCore's setupFinished() signal is automatically connected to the QHelpSearchEngineCore's indexing function, so that new documentation will be indexed after the signal is emitted.

```APIDOC
## QHelpSearchEngineCore(QHelpEngineCore, parent: QObject = None)

### Description
Constructs a new search engine with the given parent. The search engine uses the given helpEngine to access the documentation that needs to be indexed. The QHelpEngineCore's setupFinished() signal is automatically connected to the QHelpSearchEngineCore's indexing function, so that new documentation will be indexed after the signal is emitted.

### Method
Constructor

### Parameters
- **helpEngine** (QHelpEngineCore) - Required - The help engine used to access the documentation that needs to be indexed.
- **parent** (QObject) - Optional - The parent object.
```

--------------------------------

### device()

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtcore/qstorageinfo.html

Returns the device for this volume. For example, on Unix filesystems (including macOS), this returns the devpath like /dev/sda0 for local storages. On Windows, it returns the UNC path starting with \\?\ for local storages (in other words, the volume GUID).

```APIDOC
## device()

### Description
Returns the device for this volume. For example, on Unix filesystems (including macOS), this returns the devpath like /dev/sda0 for local storages. On Windows, it returns the UNC path starting with \\?\ for local storages (in other words, the volume GUID).

### Method
device()

### Parameters
None

### Returns
- **QByteArray** - The device identifier.
```

--------------------------------

### QScreenCapture.start()

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtmultimedia/qscreencapture.html

Starts screen capture.

```APIDOC
## QScreenCapture.start()

### Description
Starts screen capture.

### Method
start
```

--------------------------------

### start()

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtmultimedia/qcamera.html

Starts the camera. This is equivalent to calling setActive(true). If the camera cannot be started, the errorOccurred signal is emitted.

```APIDOC
## start()

### Description
Starts the camera. This is equivalent to calling setActive(true). If the camera cannot be started, the errorOccurred signal is emitted.

### Method
start
```

--------------------------------

### Build PyQt6 with sip-build and make

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/installation.html

Use this sequence to run make separately instead of letting sip-install invoke it. Run sip-build first, then make, then make install.

```bash
sip-build --no-make
make
make install
```

--------------------------------

### QByteArray::startsWith

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtcore/qbytearray.html

Returns true if the byte array starts with the given byte array. The example checks if a URL starts with 'ftp:'.

```APIDOC
## QByteArray::startsWith

### Description
Returns true if the byte array starts with the given byte array.

### Method
startsWith

### Parameters
- **str** (QByteArrayView) - Required - The byte array to check.

### Example
```cpp
QByteArray url("ftp://ftp.qt-project.org/");
if (url.startsWith("ftp:"))
    ...
```
```

--------------------------------

### __init__()

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtgui/qnativeinterface-qwaylandapplication.html

Initializes a QWaylandApplication instance. This constructor is used to create a new QWaylandApplication object.

```APIDOC
## __init__()

### Description
Initializes a QWaylandApplication instance. This constructor is used to create a new QWaylandApplication object.

### Method
Constructor

### Parameters
None

### Response
Returns a new QWaylandApplication instance.
```

--------------------------------

### Build and install PyQt6 with sip-install

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/installation.html

Run from the top-level directory of the unpacked PyQt6 sdist to build and install PyQt6. For the commercial version, copy the pyqt-commercial.sip license file to the sip sub-directory first.

```bash
sip-install
```

--------------------------------

### setBufferSize(int)

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtmultimedia/qaudiosink.html

Sets the buffer size for the audio sink. This function can be called anytime before start() and calls after start() are ignored. The actual buffer size used may differ; use bufferSize() after start() to get the actual size.

```APIDOC
## setBufferSize(int)

### Description
Sets the buffer size for the audio sink. This function can be called anytime before start() and calls after start() are ignored. The actual buffer size used may differ; use bufferSize() after start() to get the actual size.

### Method
setBufferSize

### Parameters
- **size** (int) - Required - The desired buffer size in bytes.

### Notes
- This function can be called anytime before start(). Calls to this are ignored after start().
- It should not be assumed that the buffer size set is the actual buffer size used - call bufferSize() anytime after start() to return the actual buffer size being used.

### See Also
- bufferSize()
- setBufferFrameCount()
```

--------------------------------

### QHelpSearchEngine(QHelpEngineCore, parent: QObject = None)

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qthelp/qhelpsearchengine.html

Constructs a new search engine with the given parent. The search engine uses the given helpEngine to access the documentation that needs to be indexed. The QHelpEngine's setupFinished() signal is automatically connected to the QHelpSearchEngine's indexing function, so that new documentation will be indexed after the signal is emitted.

```APIDOC
## QHelpSearchEngine(QHelpEngineCore, parent: QObject = None)

### Description
Constructs a new search engine with the given parent. The search engine uses the given helpEngine to access the documentation that needs to be indexed. The QHelpEngine's setupFinished() signal is automatically connected to the QHelpSearchEngine's indexing function, so that new documentation will be indexed after the signal is emitted.

### Method
Constructor

### Parameters
- **helpEngine** (QHelpEngineCore) - Required - The help engine to access documentation for indexing.
- **parent** (QObject) - Optional - The parent object.

### Returns
QHelpSearchEngine instance
```

--------------------------------

### requestMethod() → QByteArray

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtwebenginecore/qwebengineurlrequestinfo.html

Returns the HTTP method of the request (for example, GET or POST).

```APIDOC
## requestMethod() → QByteArray

### Description
Returns the HTTP method of the request (for example, GET or POST).

### Method
requestMethod()

### Returns
- **QByteArray** - The HTTP method.
```

--------------------------------

### __init__(QWaylandApplication)

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtgui/qnativeinterface-qwaylandapplication.html

Initializes a QWaylandApplication instance from an existing QWaylandApplication object. This constructor is used to create a copy of an existing QWaylandApplication.

```APIDOC
## __init__(QWaylandApplication)

### Description
Initializes a QWaylandApplication instance from an existing QWaylandApplication object. This constructor is used to create a copy of an existing QWaylandApplication.

### Method
Constructor

### Parameters
- **QWaylandApplication** (QWaylandApplication) - Required - The QWaylandApplication instance to copy.

### Response
Returns a new QWaylandApplication instance.
```

--------------------------------

### installPath()

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtwebenginecore/qwebengineextensionmanager.html

Returns the installation path of the extension. This path can be used to query where the extension is installed.

```APIDOC
## installPath()

### Description
Returns the installation path of the extension. This path can be used to query where the extension is installed.

### Method
installPath()

### Parameters
None

### Response
- **str** - The installation path.
```

--------------------------------

### QFileInfo suffix example

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtcore/qfileinfo.html

Shows how to get the suffix from a QFileInfo object.

```cpp
# QFileInfo fi("/tmp/archive.tar.gz");
# QString ext = fi.suffix();  // ext = "gz"
```

--------------------------------

### QColorSpace.__init__(QColorSpace)

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtgui/qcolorspace.html

TODO

```APIDOC
## QColorSpace.__init__(QColorSpace)

### Description
TODO

### Method
Constructor

### Endpoint
QColorSpace(QColorSpace)

### Parameters
- **QColorSpace** (QColorSpace) - Required - The color space to copy.

### Response
Returns a new QColorSpace instance.
```

--------------------------------

### QColor.__init__(Any)

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtgui/qcolor.html

TODO

```APIDOC
## QColor.__init__(Any)

### Description
TODO

### Method
Constructor

### Parameters
- **Any** - Required - TODO

### Returns
QColor instance
```

--------------------------------

### QByteArray::startsWith example

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtcore/qbytearray.html

Checks if a QByteArray starts with a given prefix.

```cpp
# QByteArray url("ftp://ftp.qt-project.org/");
# if (url.startsWith("ftp:"))
#     ...
```

--------------------------------

### installExtension(str|None)

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtwebenginecore/qwebengineextensionmanager.html

Installs an extension from the specified path to the profile's directory and loads it. The path should point to a directory or a zip file containing the extension's manifest file. The installFinished signal is emitted after the installation process finishes.

```APIDOC
## installExtension(str|None)

### Description
Installs an extension from the specified path to the profile's directory and loads it. The path should point to a directory or a zip file containing the extension's manifest file. The installFinished signal is emitted after the installation process finishes.

### Method
installExtension(str|None)

### Parameters
- **path** (str|None) - Required - The path to the extension directory or zip file.

### Response
None
```

--------------------------------

### QTextListFormat.setStart(int)

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtgui/qtextlistformat.html

Sets the list format's start index. This allows you to start a list with an index other than 1. This can be used with all sorted list types: for example if the style() is ListLowerAlpha and start() is 4, the first list item begins with "d". It does not have any effect on unsorted list types. The default start is 1.

```APIDOC
## QTextListFormat.setStart(int)

### Description
Sets the list format's start index. This allows you to start a list with an index other than 1. This can be used with all sorted list types: for example if the style() is ListLowerAlpha and start() is 4, the first list item begins with "d". It does not have any effect on unsorted list types. The default start is 1.

### Method
setStart(int)

### Parameters
- **start** (int) - The start index.

### Returns
None

### See Also
start()
```

--------------------------------

### QX11Application.__init__()

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtgui/qnativeinterface-qx11application.html

Initializes a QX11Application instance. The source documentation marks this method as TODO, so no further details are available.

```APIDOC
## __init__()

### Description
Initializes a QX11Application instance. The source documentation marks this method as TODO, so no further details are available.

### Method
__init__()

### Parameters
None documented.
```

--------------------------------

### QFileInfo completeSuffix example

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtcore/qfileinfo.html

Shows how to get the complete suffix from a QFileInfo object.

```cpp
# QFileInfo fi("/tmp/archive.tar.gz");
# QString ext = fi.completeSuffix();  // ext = "tar.gz"
```

--------------------------------

### Show sip-install command line options

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/installation.html

Displays all available command line options for sip-install.

```bash
sip-install -h
```

--------------------------------

### QPen.__init__(Any)

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtgui/qpen.html

TODO

```APIDOC
## QPen.__init__(Any)

### Description
TODO

### Method
Constructor

### Parameters
- **any** (Any) - Required - TODO

### Returns
QPen instance
```

--------------------------------

### QFileInfo baseName example

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtcore/qfileinfo.html

Shows how to get the base name from a QFileInfo object.

```cpp
# QFileInfo fi("/tmp/archive.tar.gz");
# QString base = fi.baseName();  // base = "archive"
```

--------------------------------

### QFileInfo bundleName example

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtcore/qfileinfo.html

Shows how to get the bundle name from a QFileInfo object.

```cpp
# QFileInfo fi("/Applications/Safari.app");
# QString bundle = fi.bundleName();                // name = "Safari"
```

--------------------------------

### QHelpEngine.__init__(str|None, parent: QObject = None)

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qthelp/qhelpengine.html

Constructs a new help engine with the given parent. The help engine uses the information stored in the collectionFile for providing help. If the collection file does not already exist, it will be created.

```APIDOC
## QHelpEngine.__init__(str|None, parent: QObject = None)

### Description
Constructs a new help engine with the given parent. The help engine uses the information stored in the collectionFile for providing help. If the collection file does not already exist, it will be created.

### Method
Constructor

### Parameters
- **collectionFile** (str|None) - Required - The path to the collection file.
- **parent** (QObject) - Optional - The parent object. Defaults to None.
```

--------------------------------

### begin() error examples

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtgui/qpainter.html

Examples of errors that can occur when calling begin(), such as passing a null paint device, a null image, or attempting to use multiple painters on the same device.

```cpp
# painter->begin(0); // impossible - paint device cannot be 0

# QPixmap image(0, 0);
# painter->begin(&image); // impossible - image.isNull() == true;

# painter->begin(myWidget);
# painter2->begin(myWidget); // impossible - only one painter at a time
```

--------------------------------

### QFileInfo fileName example

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtcore/qfileinfo.html

Shows how to get the file name from a QFileInfo object.

```cpp
# QFileInfo fi("/tmp/archive.tar.gz");
# QString name = fi.fileName();                // name = "archive.tar.gz"
```

--------------------------------

### __init__(QUrl, parent: QObject = None)

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtqml/qqmlapplicationengine.html

Create a new QQmlApplicationEngine and loads the QML file at the given url. This is provided as a convenience, and is the same as using the empty constructor and calling load afterwards.

```APIDOC
## __init__(QUrl, parent: QObject = None)

### Description
Create a new QQmlApplicationEngine and loads the QML file at the given url. This is provided as a convenience, and is the same as using the empty constructor and calling load afterwards.

### Method
Constructor

### Parameters
- **url** (QUrl) - Required - The URL of the QML file to load.
- **parent** (QObject) - Optional - The parent object.
```

--------------------------------

### restart()

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtcore/qelapsedtimer.html

Restarts the timer and returns the number of milliseconds elapsed since the previous start. This function is equivalent to obtaining the elapsed time with elapsed() and then starting the timer again with start(), but it does so in one single operation, avoiding the need to obtain the clock value twice. Calling this function on a QElapsedTimer that is invalid results in undefined behavior. The following example illustrates how to use this function to calibrate a parameter to a slow operation (for example, an iteration count) so that this operation takes at least 250 milliseconds:

```APIDOC
## restart()

### Description
Restarts the timer and returns the number of milliseconds elapsed since the previous start. This function is equivalent to obtaining the elapsed time with elapsed() and then starting the timer again with start(), but it does so in one single operation, avoiding the need to obtain the clock value twice. Calling this function on a QElapsedTimer that is invalid results in undefined behavior. The following example illustrates how to use this function to calibrate a parameter to a slow operation (for example, an iteration count) so that this operation takes at least 250 milliseconds:

### Method
Instance method

### Parameters
None

### Response
Returns an int representing milliseconds elapsed since previous start.
```

--------------------------------

### QFileInfo completeBaseName example

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtcore/qfileinfo.html

Shows how to get the complete base name from a QFileInfo object.

```cpp
# QFileInfo fi("/tmp/archive.tar.gz");
# QString base = fi.completeBaseName();  // base = "archive.tar"
```

--------------------------------

### startingUp

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtcore/qcoreapplication.html

Returns true if an application object has not been created yet; otherwise returns false. See also closingDown().

```APIDOC
## startingUp

### Description
Returns true if an application object has not been created yet; otherwise returns false.

### Method
startingUp

### Returns
- **bool** - true if an application object has not been created yet; otherwise false.

### See Also
closingDown().
```

--------------------------------

### QStringConverter.hasError()

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtcore/qstringconverter.html

Returns true if a conversion could not correctly convert a character. This could for example get triggered by an invalid UTF-8 sequence or when a character can’t get converted due to limitations in the target encoding.

```APIDOC
## hasError()

### Description
Returns true if a conversion could not correctly convert a character. This could for example get triggered by an invalid UTF-8 sequence or when a character can’t get converted due to limitations in the target encoding.

### Method
Instance method

### Endpoint
hasError()

### Response
#### Success Response
- **bool** - True if a conversion error occurred, false otherwise.
```

--------------------------------

### QX11Application.__init__(QX11Application)

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtgui/qnativeinterface-qx11application.html

Initializes a QX11Application instance from another QX11Application. The source documentation marks this method as TODO, so no further details are available.

```APIDOC
## __init__(QX11Application)

### Description
Initializes a QX11Application instance from another QX11Application. The source documentation marks this method as TODO, so no further details are available.

### Method
__init__(QX11Application)

### Parameters
- **QX11Application** - The source QX11Application instance.
```

--------------------------------

### QSemaphore tryAcquire() example: non-blocking acquisition

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtcore/qsemaphore.html

Demonstrates tryAcquire() returning false immediately when the requested number of resources exceeds available(), and true when enough resources are available. The example starts with a semaphore guarding 5 resources.

```python
# QSemaphore sem(5);      // sem.available() == 5
# sem.tryAcquire(250);    // sem.available() == 5, returns false
# sem.tryAcquire(3);      // sem.available() == 2, returns true
```

--------------------------------

### QSemaphore release() example: create resources

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtcore/qsemaphore.html

Shows how release() can be used to create resources in addition to releasing them. The example starts with a semaphore guarding 5 resources, acquires all 5, releases them, then releases 10 more to create new resources.

```python
# QSemaphore sem(5);      // a semaphore that guards 5 resources
# sem.acquire(5);         // acquire all 5 resources
# sem.release(5);         // release the 5 resources
# sem.release(10);        // "create" 10 new resources
```

--------------------------------

### QColor.__init__(QColor)

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtgui/qcolor.html

TODO

```APIDOC
## QColor.__init__(QColor)

### Description
TODO

### Method
Constructor

### Parameters
- **QColor** (QColor) - Required - TODO

### Returns
QColor instance
```

--------------------------------

### startUpdates()

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtpositioning/qgeopositioninfosource.html

TODO

```APIDOC
## startUpdates()

### Description
TODO

### Method
Instance method
```

--------------------------------

### Audio input example with QAudioSource (needs porting to Python)

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtmultimedia/qaudiosink.html

C++ example showing audio input setup using QAudioSource, including class members and format configuration. The source notes this code needs porting to Python.

```cpp
# This code needs porting to Python.

# /****************************************************************************
# **
# ** Copyright (C) 2016 The Qt Company Ltd.
# ** Contact: https://www.qt.io/licensing/
# **
# ** This file is part of the Qt Mobility Components.
# **
# ** $QT_BEGIN_LICENSE:LGPL$
# ** Commercial License Usage
# ** Licensees holding valid commercial Qt licenses may use this file in
# ** accordance with the commercial license agreement provided with the
# ** Software or, alternatively, in accordance with the terms contained in
# ** a written agreement between you and The Qt Company. For licensing terms
# ** and conditions see https://www.qt.io/terms-conditions. For further
# ** information use the contact form at https://www.qt.io/contact-us.
# **
# ** GNU Lesser General Public License Usage
# ** Alternatively, this file may be used under the terms of the GNU Lesser
# ** General Public License version 3 as published by the Free Software
# ** Foundation and appearing in the file LICENSE.LGPL3 included in the
# ** packaging of this file. Please review the following information to
# ** ensure the GNU Lesser General Public License version 3 requirements
# ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
# **
# ** GNU General Public License Usage
# ** Alternatively, this file may be used under the terms of the GNU
# ** General Public License version 2.0 or (at your option) the GNU General
# ** Public license version 3 or any later version approved by the KDE Free
# ** Qt Foundation. The licenses are as published by the Free Software
# ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
# ** included in the packaging of this file. Please review the following
# ** information to ensure the GNU General Public License requirements will
# ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
# ** https://www.gnu.org/licenses/gpl-3.0.html.
# **
# ** $QT_END_LICENSE$
# **
# ****************************************************************************/

# /* Audio related snippets */
# #include <QFile>
# #include <QTimer>
# #include <QDebug>
# #include <qobject.h>
# #include <qfile.h>

# #include "qaudiodevice.h"
# #include "qaudiosource.h"
# #include "qaudiooutput.h"
# #include "qaudiodecoder.h"
# #include "qmediaplayer.h"
# #include "qmediadevices.h"

# class AudioInputExample : public QObject {
#     Q_OBJECT
# public:
#     void setup();


# public Q_SLOTS:
#     void stopRecording();
#     void handleStateChanged(QAudio::State newState);

# private:
#     #! [Audio input class members]
#     QFile destinationFile;   // Class member
#     QAudioSource* audio; // Class member
#     #! [Audio input class members]
# };


# void AudioInputExample::setup()
# #! [Audio input setup]
# {
#     destinationFile.setFileName("/tmp/test.raw");
#     destinationFile.open( QIODevice::WriteOnly | QIODevice::Truncate );

#     QAudioFormat format;
#     // Set up the desired format, for example:
#     format.setSampleRate(8000);
#     format.setChannelCount(1);
#     format.setSampleFormat(QAudioFormat::UInt8);
```

--------------------------------

### __init__(Any)

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtgui/qpixmap.html

TODO: Documentation for this constructor is not yet available.

```APIDOC
## __init__(Any)

### Description
TODO

### Method
Constructor

### Parameters
- **Any** (Any) - Required - TODO

### Returns
A new QPixmap instance.
```

--------------------------------

### requestMethod() → QByteArray

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtwebenginecore/qwebengineurlrequestjob.html

Returns the HTTP method of the request (for example, GET or POST). This indicates the type of request being made.

```APIDOC
## requestMethod() → QByteArray

### Description
Returns the HTTP method of the request (for example, GET or POST).

### Method
requestMethod

### Returns
- **QByteArray** - The HTTP method of the request.
```

--------------------------------

### __init__(str|None, parent: QObject = None)

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtqml/qqmlapplicationengine.html

Create a new QQmlApplicationEngine and loads the QML file at the given filePath, which must be a local file or qrc path. If a relative path is given then it will be interpreted as relative to the working directory of the application. This is provided as a convenience, and is the same as using the empty constructor and calling load afterwards.

```APIDOC
## __init__(str|None, parent: QObject = None)

### Description
Create a new QQmlApplicationEngine and loads the QML file at the given filePath, which must be a local file or qrc path. If a relative path is given then it will be interpreted as relative to the working directory of the application. This is provided as a convenience, and is the same as using the empty constructor and calling load afterwards.

### Method
Constructor

### Parameters
- **filePath** (str|None) - Required - The path to the QML file.
- **parent** (QObject) - Optional - The parent object.
```

--------------------------------

### start(DiscoveryMethod)

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtbluetooth/qbluetoothdevicediscoveryagent.html

Starts Bluetooth device discovery, if it is not already started and the provided methods are supported. The discovery methods limit the scope of the device search. For example, if the target service or device is a Bluetooth Low Energy device, this function could be used to limit the search to Bluetooth Low Energy devices and thereby reduces the discovery time significantly.

```APIDOC
## start(DiscoveryMethod)

### Description
Starts Bluetooth device discovery, if it is not already started and the provided _methods_ are supported. The discovery _methods_ limit the scope of the device search. For example, if the target service or device is a Bluetooth Low Energy device, this function could be used to limit the search to Bluetooth Low Energy devices and thereby reduces the discovery time significantly.

**Note:** _methods_ only determines the type of discovery and does not imply the filtering of the results. For example, the search may still contain classic bluetooth devices despite _methods_ being set to LowEnergyMethod only. This may happen due to previously cached search results which may be incorporated into the search results.

**Note:** Some platforms (e.g. Windows) may also provide cached results for the devices that are not currently advertising. Other platforms (like `iOS`) only provide information about currently advertising devices. You can store the received device UUID (or Bluetooth address) upon first discovery, and then use it later to establish a connection directly (see QBluetoothDeviceInfo). This way the applications can omit the later device discovery phases. Using the Bluetooth address requires that the remote device’s Bluetooth address does not change.

### Method
Method

### Parameters
- **methods** (DiscoveryMethod) - Required - The discovery methods to use.

### Returns
None
```

--------------------------------

### Obtain QModelIndex from QStandardItem using index()

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtgui/qstandarditemmodel.html

Call index() on a QStandardItem to get its QModelIndex, for example when passing it to a view function like scrollTo().

```cpp
# treeView->scrollTo(item->index());
```

--------------------------------

### QElapsedTimer usage example (C++ code needing porting to Python)

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtcore/qelapsedtimer.html

This example shows typical usage of QElapsedTimer to measure elapsed time for slow operations. It includes start(), elapsed(), hasExpired(), and restart() methods. The code is marked as needing porting to Python.

```cpp
# This code needs porting to Python.

# /****************************************************************************
# **
# ** Copyright (C) 2016 The Qt Company Ltd.
# ** Contact: https://www.qt.io/licensing/
# **
# ** This file is part of the documentation of the Qt Toolkit.
# **
# ** $QT_BEGIN_LICENSE:BSD$
# ** Commercial License Usage
# ** Licensees holding valid commercial Qt licenses may use this file in
# ** accordance with the commercial license agreement provided with the
# ** Software or, alternatively, in accordance with the terms contained in
# ** a written agreement between you and The Qt Company. For licensing terms
# ** and conditions see https://www.qt.io/terms-conditions. For further
# ** information use the contact form at https://www.qt.io/contact-us.
# **
# ** BSD License Usage
# ** Alternatively, you may use this file under the terms of the BSD license
# ** as follows:
# **
# ** "Redistribution and use in source and binary forms, with or without
# ** modification, are permitted provided that the following conditions are
# ** met:
# **   * Redistributions of source code must retain the above copyright
# **     notice, this list of conditions and the following disclaimer.
# **   * Redistributions in binary form must reproduce the above copyright
# **     notice, this list of conditions and the following disclaimer in
# **     the documentation and/or other materials provided with the
# **     distribution.
# **   * Neither the name of The Qt Company Ltd nor the names of its
# **     contributors may be used to endorse or promote products derived
# **     from this software without specific prior written permission.
# **
# **
# ** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# ** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# ** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# ** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# ** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# ** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# ** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# ** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# ** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# ** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# ** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
# **
# ** $QT_END_LICENSE$
# **
# ****************************************************************************/
# #include <QtCore>

# void slowOperation1()
# {
#     static char buf[256];
#     for (int i = 0; i < (1<<20); ++i)
#         buf[i % sizeof buf] = i;
# }

# void slowOperation2(int) { slowOperation1(); }

# void startExample()
# {
# //![0]
#     QElapsedTimer timer;
#     timer.start();

#     slowOperation1();

#     qDebug() << "The slow operation took" << timer.elapsed() << "milliseconds";
# //![0]
# }

# //![1]
# void executeSlowOperations(int timeout)
# {
#     QElapsedTimer timer;
#     timer.start();
#     slowOperation1();

#     int remainingTime = timeout - timer.elapsed();
#     if (remainingTime > 0)
#         slowOperation2(remainingTime);
# }
# //![1]

# //![2]
# void executeOperationsForTime(int ms)
# {
#     QElapsedTimer timer;
#     timer.start();

#     while (!timer.hasExpired(ms))
#         slowOperation1();
# }
# //![2]

# int restartExample()
# {
# //![3]
#     QElapsedTimer timer;

#     int count = 1;
#     timer.start();
#     do {
#         count *= 2;
#         slowOperation2(count);
#     } while (timer.restart() < 250);

#     return count;
# //![3]
# }

# int main(int argc, char **argv)
# {
#     QCoreApplication app(argc, argv);

#     startExample();
#     restartExample();
#     executeSlowOperations(5);
#     executeOperationsForTime(5);
# }
```

--------------------------------

### createHostWindow(bool, QByteArray|bytes|bytearray|memoryview) → bool

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qaxcontainer/qaxwidget.html

Creates the client site for the ActiveX control, and returns true if the control could be embedded successfully, otherwise returns false. If initialized is false the control will be initialized using the data. The control will be initialized through either IPersistStreamInit or IPersistStorage interface. If the control needs to be initialized using custom data, call this function in your reimplementation of initialize(). This function is not called by the default implementation of initialize().

```APIDOC
## createHostWindow(bool, QByteArray|bytes|bytearray|memoryview) → bool

### Description
Creates the client site for the ActiveX control, and returns true if the control could be embedded successfully, otherwise returns false. If initialized is false the control will be initialized using the data. The control will be initialized through either IPersistStreamInit or IPersistStorage interface. If the control needs to be initialized using custom data, call this function in your reimplementation of initialize(). This function is not called by the default implementation of initialize().

### Method
Method

### Parameters
- **initialized** (bool) - Indicates whether the control has already been initialized.
- **data** (QByteArray or bytes or bytearray or memoryview) - The data to initialize the control with.

### Returns
- **bool** - True if the control could be embedded successfully, otherwise false.
```

--------------------------------

### QColorSpace.__init__(QPointF, QPointF, QPointF, QPointF, Iterable[int], Iterable[int], Iterable[int])

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtgui/qcolorspace.html

TODO

```APIDOC
## QColorSpace.__init__(QPointF, QPointF, QPointF, QPointF, Iterable[int], Iterable[int], Iterable[int])

### Description
TODO

### Method
Constructor

### Endpoint
QColorSpace(QPointF, QPointF, QPointF, QPointF, Iterable[int], Iterable[int], Iterable[int])

### Parameters
- **QPointF** (QPointF) - Required - The white point.
- **QPointF** (QPointF) - Required - The red point.
- **QPointF** (QPointF) - Required - The green point.
- **QPointF** (QPointF) - Required - The blue point.
- **Iterable[int]** (Iterable[int]) - Required - The red transfer function table.
- **Iterable[int]** (Iterable[int]) - Required - The green transfer function table.
- **Iterable[int]** (Iterable[int]) - Required - The blue transfer function table.

### Response
Returns a new QColorSpace instance.
```

--------------------------------

### Start a match at a specific offset with match()

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtcore/qregularexpression.html

Pass an offset to match() to begin matching at that position in the subject string. In this example, matching starts at offset 1, so "12 abc" is skipped and the match is "45 def".

```cpp
# QRegularExpression re("\\d\\d \\w+");
# QRegularExpressionMatch match = re.match("12 abc 45 def", 1);
# if (match.hasMatch()) {
#     QString matched = match.captured(0); // matched == "45 def"
#     // ...
# }
```

--------------------------------

### Using begin() and end() in paintEvent

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtgui/qpainter.html

Example of using begin() and end() to paint on a widget in a paintEvent. The painter is explicitly started and ended.

```cpp
# void MyWidget::paintEvent(QPaintEvent *)
# {
#     QPainter p;
#     p.begin(this);
#     p.drawLine(drawingCode);        // drawing code
#     p.end();
# }
```

--------------------------------

### QApplication.__init__(list[str])

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtwidgets/qapplication.html

Initializes a QApplication instance with the given command-line arguments. This constructor sets up the application object required for managing GUI application control flow and settings.

```APIDOC
## QApplication.__init__(list[str])

### Description
Initializes a QApplication instance with the given command-line arguments. This constructor sets up the application object required for managing GUI application control flow and settings.

### Method
Constructor

### Parameters
- **list[str]** (list of strings) - Required - Command-line arguments passed to the application.

### Notes
TODO: Additional details not provided in the source.
```

--------------------------------

### QBuffer basic read/write example

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtcore/qbuffer.html

Demonstrates opening a QBuffer for read/write, writing a string, seeking to the start, and reading characters using getChar().

```cpp
#     QBuffer buffer;
#     char ch;

#     buffer.open(QBuffer::ReadWrite);
#     buffer.write("Qt rocks!");
#     buffer.seek(0);
#     buffer.getChar(&ch);  // ch == 'Q'
#     buffer.getChar(&ch);  // ch == 't'
#     buffer.getChar(&ch);  // ch == ' '
#     buffer.getChar(&ch);  // ch == 'r'
```

--------------------------------

### stopLogging()

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtopengl/qopengldebuglogger.html

Stops logging messages from the OpenGL server. This function restores the OpenGL debug output settings and any user-defined debug callback that was installed before logging was started.

```APIDOC
## stopLogging()

### Description
Stops logging messages from the OpenGL server.

### Method
stopLogging()

### Parameters
None

### See Also
startLogging()
```

--------------------------------

### qInfo example: printf-style formatting

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtcore/qtcore-module.html

Calls the message handler with an informational message. If no message handler is installed, the message is printed to stderr. Does nothing if QT_NO_INFO_OUTPUT was defined during compilation.

```cpp
# qInfo("Items in list: %d", myList.size());
```

--------------------------------

### QBrush.__init__(Any)

Source: https://www.riverbankcomputing.com/static/Docs/PyQt6/api/qtgui/qbrush.html

TODO

```APIDOC
## QBrush.__init__(Any)

### Description
TODO

### Method
Constructor

### Parameters
- **any** (Any) - Required - TODO

### Returns
QBrush instance
```
Tokens:
Raw