PyQt5

https://www.riverbankcomputing.com/static/Docs/PyQt5/
Admin
PyQt5 is a set of Python bindings for Qt v5 that provides cross-platform abstractions for graphical...
Tokens:3,684,001
Snippets:30,862
Trust Score:9.7
Update:1 day ago
Show doc for...
Tokens:
Raw
### QMediaRecorder usage example

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/api/qtmultimedia/qmediarecorder.html

Shows how to create a QMediaRecorder with a camera, configure audio settings, set the output location, and start recording.

```cpp
#     recorder = new QMediaRecorder(camera);

#     QAudioEncoderSettings audioSettings;
#     audioSettings.setCodec("audio/amr");
#     audioSettings.setQuality(QMultimedia::HighQuality);

#     recorder->setAudioSettings(audioSettings);

#     recorder->setOutputLocation(QUrl::fromLocalFile(fileName));
#     recorder->record();
```

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

### QTime start() timing example

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/api/qtcore/qtime.html

Shows how to use QTime.start() to measure elapsed time of a lengthy task. The example is in C++ style comments, but demonstrates the intended usage. The elapsed() method returns milliseconds since start().

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

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

### QAudioProbe usage example with QAudioRecorder

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/api/qtmultimedia/qaudioprobe.html

This example shows how to create a QAudioProbe, connect its audioBufferProbed signal to a slot, set the source to a QAudioRecorder, and start recording. It assumes the audio recorder is configured beforehand.

```cpp
QAudioRecorder *recorder = new QAudioRecorder();
QAudioProbe *probe = new QAudioProbe;

// ... configure the audio recorder (skipped)

connect(probe, SIGNAL(audioBufferProbed(QAudioBuffer)), this, SLOT(processBuffer(QAudioBuffer)));

probe->setSource(recorder); // Returns true, hopefully.

recorder->record(); // Now we can do things like calculating levels or performing an FFT
```

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

### Set up QCameraImageCapture with QCamera and viewfinder

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/api/qtmultimedia/qcameraimagecapture.html

Shows how to create a QCamera, attach a QCameraViewfinder, create a QCameraImageCapture instance, set the capture mode to CaptureStillImage, and start the camera. This is the basic setup for capturing still images.

```cpp
#     camera = new QCamera;

#     viewfinder = new QCameraViewfinder();
#     viewfinder->show();

#     camera->setViewfinder(viewfinder);

#     imageCapture = new QCameraImageCapture(camera);

#     camera->setCaptureMode(QCamera::CaptureStillImage);
#     camera->start();
```

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

### QTranslator main() example

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/api/qtcore/qtranslator.html

Shows the typical usage of QTranslator: load a translation file, install it, and use it. The translator must be created before the application's widgets. The example uses QLocale, QLatin1String, and a translation file path.

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

#     QTranslator translator;
#     // look up e.g. :/translations/myapp_de.qm
#     if (translator.load(QLocale(), QLatin1String("myapp"), QLatin1String("_"), QLatin1String(":/translations")))
#         app.installTranslator(&translator);

#     QPushButton hello(QCoreApplication::translate("main", "Hello world!"));
#     hello.resize(100, 30);

#     hello.show();
#     return app.exec();
# }
```

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

### QRadioTuner usage example

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/api/qtmultimedia/qradiotuner.html

Shows how to create a QRadioTuner, connect to its frequencyChanged signal, check if FM band is supported, set the band and frequency, set volume, and start the radio. Note that the code is commented out with '#' as it is a C++ example, not Python.

```cpp
#     radio = new QRadioTuner;
#     connect(radio, SIGNAL(frequencyChanged(int)), this, SLOT(freqChanged(int)));
#     if (radio->isBandSupported(QRadioTuner::FM)) {
#         radio->setBand(QRadioTuner::FM);
#         radio->setFrequency(yourRadioStationFrequency);
#         radio->setVolume(100);
#         radio->start();
#     }
```

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

### Basic QClipboard text access example

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/api/qtgui/qclipboard.html

Shows how to get the clipboard instance, retrieve the current text, and set new text. The code is commented out and uses C++ syntax, indicating it is a conceptual example.

```cpp
# QClipboard *clipboard = QGuiApplication::clipboard();
# QString originalText = clipboard->text();
# ...
# clipboard->setText(newText);
```

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

### Create and use QMediaPlaylist with QMediaPlayer

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/api/qtmultimedia/qmediaplaylist.html

Shows how to create a QMediaPlaylist, add media URLs, set the current index, and associate it with a QMediaPlayer for playback. The example also sets up a QVideoWidget for video output and starts playback.

```cpp
#     playlist = new QMediaPlaylist;
#     playlist->addMedia(QUrl("http://example.com/movie1.mp4"));
#     playlist->addMedia(QUrl("http://example.com/movie2.mp4"));
#     playlist->addMedia(QUrl("http://example.com/movie3.mp4"));
#     playlist->setCurrentIndex(1);

#     player = new QMediaPlayer;
#     player->setPlaylist(playlist);

#     videoWidget = new QVideoWidget;
#     player->setVideoOutput(videoWidget);
#     videoWidget->show();

#     player->play();
```

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

### Display a QMovie in a QLabel

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

Shows how to create a QMovie from a file, set it on a QLabel, and start playback. The example uses a C++-style syntax with '#' as comment markers, as shown in the PyQt5 documentation.

```cpp
# QLabel label;
# QMovie *movie = new QMovie("animations/fire.gif");

# label.setMovie(movie);
# movie->start();
```

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

### QStateMachine Example

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/api/qtcore/qstatemachine.html

A code snippet demonstrating how to create a state machine that finishes when a button is clicked, showing the usage of addState, setInitialState, and start.

```APIDOC
## QStateMachine Example

### Description
This example shows how to create a state machine that finishes when a button is clicked.

### Code
```cpp
# QPushButton button;

# QStateMachine machine;
# QState *s1 = new QState();
# s1->assignProperty(&button, "text", "Click me");

# QFinalState *s2 = new QFinalState();
# s1->addTransition(&button, SIGNAL(clicked()), s2);

# machine.addState(s1);
# machine.addState(s2);
# machine.setInitialState(s1);
# machine.start();
```
```

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

### Install PyQt5 with sip-install

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

Run this command from the top-level directory of the unpacked sdist to build and install PyQt5.

```bash
sip-install
```

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

### start(mode: Union[OpenMode, OpenModeFlag] = ReadWrite)

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

Starts the program with the current program and arguments.

```APIDOC
## start(mode: Union[OpenMode, OpenModeFlag] = ReadWrite)

### Description
Starts the program with the current program and arguments.

### Method
start

### Parameters
- **mode** (Union[OpenMode, OpenModeFlag]) - Optional - The open mode (default: ReadWrite).
```

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

### QCoreApplication.applicationFilePath() → str

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

Returns the file path of the application executable. For example, if Qt is installed in /usr/local/qt and you run the regexp example, it returns "/usr/local/qt/examples/tools/regexp/regexp". On Linux, it tries to get the path from /proc, otherwise assumes argv[0] contains the absolute file name.

```APIDOC
## QCoreApplication.applicationFilePath() → str

### Description
Returns the file path of the application executable. For example, if Qt is installed in /usr/local/qt and you run the regexp example, it returns "/usr/local/qt/examples/tools/regexp/regexp". On Linux, it tries to get the path from /proc, otherwise assumes argv[0] contains the absolute file name.

### Method
Static method

### Returns
- **str** - The file path of the application executable.

```

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

### QHelpEngineCore.setupData()

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

Initializes the help engine. Must be called before using the help engine. Emits setupStarted at the beginning and setupFinished at the end.

```APIDOC
## setupData()

### Description
Initializes the help engine. Must be called before using the help engine. Emits setupStarted at the beginning and setupFinished at the end.

### Method
setupData()

### Parameters
None

### Returns
None

### Signals
- setupStarted: Emitted at the beginning of the setup process.
- setupFinished: Emitted when the setup process is finished.
```

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

### Get captured substring offsets

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

Shows how to retrieve the start and end offsets of a captured substring using capturedStart(1) and capturedEnd(1). The example captures "123" from the subject string.

```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
#     // ...
# }
```

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

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

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/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.

```APIDOC
## __init__(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.

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

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

### Set up audio encoding and record

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/api/qtmultimedia/qaudiorecorder.html

Shows how to create a QAudioRecorder, configure audio encoding settings (codec, quality), set the output location, and start recording.

```cpp
#     audioRecorder = new QAudioRecorder;

#     QAudioEncoderSettings audioSettings;
#     audioSettings.setCodec("audio/amr");
#     audioSettings.setQuality(QMultimedia::HighQuality);

#     audioRecorder->setEncodingSettings(audioSettings);

#     audioRecorder->setOutputLocation(QUrl::fromLocalFile("test.amr"));
#     audioRecorder->record();
```

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

### QFileInfo suffix() example

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

Shows how to get the file suffix using QFileInfo. The example creates a QFileInfo for '/tmp/archive.tar.gz' and retrieves the suffix, which is 'gz'.

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

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

### begin(QPaintDevice)

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

Begins painting on the given paint device.

```APIDOC
## begin(QPaintDevice)

### Description
Begins painting on the given paint device.

### Method
Method

### Signature
`begin(QPaintDevice) → bool`

### Parameters
- **QPaintDevice** (QPaintDevice) - Required - The paint device to begin painting on.

### Returns
- **bool** - True if painting was successfully started, otherwise False.
```

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

### QFileInfo absoluteFilePath example

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

Shows how to get the absolute file path from a QFileInfo object. The example uses a Windows-style path and demonstrates the result.

```cpp
QFileInfo fi("c:/temp/foo"); => fi.absoluteFilePath() => "C:/temp/foo"
```

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

### setupData() -> bool

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

Sets up the help engine by processing the information found in the collection file.

```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.

### Method
setupData

### Returns
- **bool** - True if successful, otherwise false.
```

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

### QFileInfo suffix example

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

Shows how to get the suffix from a QFileInfo object. The example uses a .tar.gz file and demonstrates that suffix() returns the last suffix.

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

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

### Running the PyQt5 chapter6-plugins example

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/qml.html

This command runs the example from the PyQt5 quick tutorials, setting QML2_IMPORT_PATH to the current directory and invoking qmlscene with app.qml. On Linux, LD_LIBRARY_PATH may also need to be set.

```bash
cd /path/to/examples/quick/tutorials/extending/chapter6-plugins
QML2_IMPORT_PATH=. /path/to/qmlscene app.qml
```

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

### QFileInfo completeSuffix example

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

Shows how to get the complete suffix from a QFileInfo object. The example uses a .tar.gz file and demonstrates that completeSuffix() returns all suffixes after the first dot.

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

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

### QFileInfo fileName example

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

Shows how to get the file name from a QFileInfo object. The example uses a .tar.gz file and demonstrates that fileName() returns the full file name.

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

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

### C++ example: Setting up QLevelOfDetail

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/api/qt3drender/qlevelofdetail.html

Shows how to create a QLevelOfDetail component, set thresholds, and attach it to an entity. The example includes includes for Qt3DCore and Qt3DRender, and demonstrates connecting to the currentIndexChanged signal.

```cpp
 #include <Qt3DCore/QEntity>
 #include <Qt3DRender/QGeometryRenderer>
 #include <Qt3DRender/QLevelOfDetail>

// Scene
Qt3DCore::QEntity *rootEntity = new Qt3DCore::Qt3DCore::QEntity;

Qt3DCore::QEntity *renderableEntity = new Qt3DCore::QEntity(rootEntity);
Qt3DRender::QGeometryRenderer *geometryRenderer = new Qt3DCore::QGeometryRenderer(renderableEntity);
renderableEntity->addComponent(geometryRenderer);
Qt3DRender::QLevelOfDetail* lod = new Qt3Render::QLevelOfDetail(renderableEntity);
QVector<qreal> thresholds = {20, 35, 50, 65};
lod->setThresholds(thresholds);
lod->setCamera(mainCamera);
renderableEntity->addComponent(lod);

// connect to QLevelOfDetail::currentIndexChanged to toggle rendering
...
```

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

### QFontMetricsF usage example

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/api/qtgui/qfontmetricsf.html

Shows how to create a QFontMetricsF object from a QFont and use it to get the horizontal advance and height of a text string. The example uses a 24-point Times font.

```cpp
# QFont font("times", 24);
# QFontMetricsF fm(font);
# qreal pixelsWide = fm.horizontalAdvance("What's the width of this text?");
# qreal pixelsHigh = fm.height();
```

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

### Basic QMediaPlayer usage

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/api/qtmultimedia/qmediaplayer.html

Shows how to create a QMediaPlayer, connect to its positionChanged signal, set media from a local file, set volume, and start playback.

```cpp
#     player = new QMediaPlayer;
#     connect(player, SIGNAL(positionChanged(qint64)), this, SLOT(positionChanged(qint64)));
#     player->setMedia(QUrl::fromLocalFile("/Users/me/Music/coolsong.mp3"));
#     player->setVolume(50);
#     player->play();
```

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

### QFileInfo baseName example

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

Shows how to get the base name from a QFileInfo object. The example uses a .tar.gz file and demonstrates that baseName() returns the name without the last suffix.

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

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

### QAudioInput::start()

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/api/qtmultimedia/qaudioinput.html

Starts the audio input, beginning the recording session.

```APIDOC
## QAudioInput::start()

### Description
Starts the audio input, beginning the recording session.

### Method
start()

### Parameters
None

### Return Value
None
```

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

### __init__([QWindow])

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/api/qtgui/qbackingstore.html

Constructs a QBackingStore object associated with the given QWindow.

```APIDOC
## __init__([QWindow])

### Description
Constructs a QBackingStore object associated with the given QWindow.

### Method
Constructor

### Parameters
- **window** (QWindow) - Optional - The window to associate with the backing store.

```

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

### QFileInfo bundleName example

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

Shows how to get the bundle name from a QFileInfo object. The example uses a .app bundle and demonstrates that bundleName() returns the bundle name without the extension.

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

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

### Set up and start QAudioOutput playback

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/api/qtmultimedia/qaudiooutput.html

Configures a QAudioFormat, checks device support, creates a QAudioOutput, and starts playing a raw audio file. Emits a warning if the format is not supported.

```cpp
# {
#     sourceFile.setFileName("/tmp/test.raw");
#     sourceFile.open(QIODevice::ReadOnly);

#     QAudioFormat format;
#     // Set up the format, eg.
#     format.setSampleRate(8000);
#     format.setChannelCount(1);
#     format.setSampleSize(8);
#     format.setCodec("audio/pcm");
#     format.setByteOrder(QAudioFormat::LittleEndian);
#     format.setSampleType(QAudioFormat::UnSignedInt);

#     QAudioDeviceInfo info(QAudioDeviceInfo::defaultOutputDevice());
#     if (!info.isFormatSupported(format)) {
#         qWarning() << "Raw audio format not supported by backend, cannot play audio.";
#         return;
#     }

#     audio = new QAudioOutput(format, this);
#     connect(audio, SIGNAL(stateChanged(QAudio::State)), this, SLOT(handleStateChanged(QAudio::State)));
#     audio->start(&sourceFile);
# }

```

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

### peek example: Check if file is executable

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/api/qtcore/qiodevice.html

Example from the peek method documentation showing how to check if a file starts with 'MZ' by peeking at the first two bytes. The code is commented out in the source.

```python
# bool isExeFile(QFile *file)
# {
#     return file->peek(2) == "MZ";
# }
```

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

### QFileInfo completeBaseName example

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

Shows how to get the complete base name from a QFileInfo object. The example uses a .tar.gz file and demonstrates that completeBaseName() returns the name without the last suffix.

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

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

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

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

Constructor for QApplication. Initializes the application with a list of command-line arguments.

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

### Description
Constructor for QApplication. Initializes the application with a list of command-line arguments.

### Method
Constructor

### Parameters
- **List[str]** - Required - List of command-line arguments.

```

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

### begin(QPaintDevice, QWidget) -> bool

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/api/qtwidgets/qstylepainter.html

Begins painting on the given paint device and widget. Returns true if successful, false otherwise.

```APIDOC
## begin(QPaintDevice, QWidget) -> bool

### Description
Begins painting on the given paint device and widget. Returns true if successful, false otherwise.

### Method
begin

### Signature
`begin(device: QPaintDevice, widget: QWidget) -> bool`

### Parameters
- **device** (QPaintDevice) - The paint device to begin painting on.
- **widget** (QWidget) - The widget associated with the painting.

### Returns
- **bool** - True if painting began successfully, false otherwise.

```

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

### Match with offset

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

Shows how to start a match at an arbitrary offset in the subject string. The example starts at offset 1, so "12 abc" is not matched, but "45 def" is captured.

```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"
#     // ...
# }
```

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

### QMetaType::type, create, destroy

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/api/qtcore/qmetatype.html

Example showing how to get the type ID, create an instance, and destroy it.

```APIDOC
## QMetaType::type, create, destroy

### Description
This example demonstrates how to use QMetaType to dynamically create and destroy an instance of a custom type.

### Method
N/A (C++ example)

### Endpoint
N/A

### Parameters
#### Static Methods
- **type(name)** (string) - Required - Returns the type ID for the given type name.
- **create(id)** (int) - Required - Allocates and constructs an instance of the type identified by id.
- **destroy(id, ptr)** (int, void*) - Required - Destroys the instance pointed to by ptr.

### Request Example
```cpp
int id = QMetaType::type("MyClass");
if (id != QMetaType::UnknownType) {
    void *myClassPtr = QMetaType::create(id);
    // ...
    QMetaType::destroy(id, myClassPtr);
    myClassPtr = 0;
}
```

### Response
#### Success Response
No return value for destroy; create returns a void pointer to the new instance; type returns an int ID.

#### Response Example
N/A
```

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

### __init__(QSize)

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/api/qtgui/qopenglpaintdevice.html

Constructs a QOpenGLPaintDevice with the given size. The device is only valid for the current context.

```APIDOC
## __init__(QSize)

### Description
Constructs a QOpenGLPaintDevice with the given size. The device is only valid for the current context.

### Method
Constructor

### Signature
`__init__(size: QSize)`

### Parameters
- **size** (QSize) - Required - The size of the paint device.

### Notes
- The QOpenGLPaintDevice is only valid for the current context.
- See also: currentContext()
```

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

### __init__(QBluetoothDeviceInfo)

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/api/qtbluetooth/qbluetoothdeviceinfo.html

Copy constructor that creates a new QBluetoothDeviceInfo from an existing one.

```APIDOC
## __init__(QBluetoothDeviceInfo)

### Description
Copy constructor that creates a new QBluetoothDeviceInfo from an existing one.

### Method
Constructor

### Signature
`__init__(QBluetoothDeviceInfo)`

### Parameters
- **QBluetoothDeviceInfo** (QBluetoothDeviceInfo) - Required - The device info to copy.

### Returns
None
```

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

### QElapsedTimer Class Overview

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

Overview of the QElapsedTimer class with usage examples for start(), elapsed(), restart(), and hasExpired().

```APIDOC
## QElapsedTimer Class

### Description
The QElapsedTimer class provides a fast way to calculate elapsed times. It is typically used to measure the time taken by an operation or to implement timeouts.

### Methods

#### start()
- **Description**: Starts the timer.
- **Parameters**: None
- **Returns**: None

#### elapsed()
- **Description**: Returns the number of milliseconds since the timer was started.
- **Parameters**: None
- **Returns**: int (milliseconds)

#### restart()
- **Description**: Restarts the timer and returns the number of milliseconds elapsed since the previous start.
- **Parameters**: None
- **Returns**: int (milliseconds)

#### hasExpired(int timeout)
- **Description**: Returns true if the number of milliseconds elapsed since the timer was started is greater than or equal to the timeout.
- **Parameters**:
  - **timeout** (int) - The timeout in milliseconds.
- **Returns**: bool

### Usage Examples

#### Basic Usage
```cpp
QElapsedTimer timer;
timer.start();

slowOperation1();

qDebug() << "The slow operation took" << timer.elapsed() << "milliseconds";
```

#### Using elapsed() for Timeout Calculation
```cpp
void executeSlowOperations(int timeout)
{
    QElapsedTimer timer;
    timer.start();
    slowOperation1();

    int remainingTime = timeout - timer.elapsed();
    if (remainingTime > 0)
        slowOperation2(remainingTime);
}
```

#### Using hasExpired() for Time-Limited Execution
```cpp
void executeOperationsForTime(int ms)
{
    QElapsedTimer timer;
    timer.start();

    while (!timer.hasExpired(ms))
        slowOperation1();
}
```

#### Using restart() for Repeated Operations
```cpp
int restartExample()
{
    QElapsedTimer timer;

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

    return count;
}
```
```

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

### __init__()

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/api/qtbluetooth/qbluetoothdeviceinfo.html

Default constructor for QBluetoothDeviceInfo.

```APIDOC
## __init__()

### Description
Default constructor for QBluetoothDeviceInfo.

### Method
Constructor

### Signature
`__init__()`

### Parameters
None

### Returns
None
```

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

### Build PyQt5 with sip-build and make

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

Alternative build steps: run sip-build --no-make, then make, then make install to build and install PyQt5.

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

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

### Create and use a QSystemSemaphore

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/api/qtcore/qsystemsemaphore.html

Shows how to create a QSystemSemaphore with a key and initial resource count, then acquire and release resources. The comments indicate the available resource count after each operation.

```cpp
# QSystemSemaphore sem("market", 3, QSystemSemaphore::Create);
#                              // resources available == 3
# sem.acquire();               // resources available == 2
# sem.acquire();               // resources available == 1
# sem.acquire();               // resources available == 0
# sem.release();               // resources available == 1
# sem.release(2);              // resources available == 3
```

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

### C++ syntax highlighter example for multi-line comments

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/api/qtgui/qsyntaxhighlighter.html

This example shows how to use QSyntaxHighlighter's block state functions to highlight multi-line comments in C++ code. It sets the current block state to 0, checks the previous block state to determine if the block starts inside a comment, and uses setFormat() to apply the comment format. The code uses QRegularExpression to find the start and end comment markers.

```cpp
# QTextCharFormat multiLineCommentFormat;
# multiLineCommentFormat.setForeground(Qt::red);

# QRegularExpression startExpression("/\\*");
# QRegularExpression endExpression("\\*/");

# setCurrentBlockState(0);

# int startIndex = 0;
# if (previousBlockState() != 1)
#     startIndex = text.indexOf(startExpression);

# while (startIndex >= 0) {
#    QRegularExpressionMatch endMatch;
#    int endIndex = text.indexOf(endExpression, startIndex, &endMatch);
#    int commentLength;
#    if (endIndex == -1) {
#        setCurrentBlockState(1);
#        commentLength = text.length() - startIndex;
#    } else {
#        commentLength = endIndex - startIndex
#                        + endMatch.capturedLength();
#    }
#    setFormat(startIndex, commentLength, multiLineCommentFormat);
#    startIndex = text.indexOf(startExpression,
#                              startIndex + commentLength);
# }

```

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

### QPaintEngine.begin

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/api/qtgui/qpaintengine.html

Begins painting on the given paint device. The documentation is marked as TODO, so no further details are provided.

```APIDOC
## QPaintEngine.begin

### Description
Begins painting on the given paint device. The documentation is marked as TODO, so no further details are provided.

### Method
begin

### Signature
begin(QPaintDevice) → bool

### Parameters
- **device** (QPaintDevice) - Required - The paint device to begin painting on.

### Returns
bool - True if successful, False otherwise.
```

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

### QElapsedTimer usage example (C++)

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

This example demonstrates how to use QElapsedTimer to measure elapsed time, calculate remaining time for timeouts, and loop until a time limit expires. It includes functions for starting the timer, checking elapsed time, and restarting the timer.

```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 QtNetwork module 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);
# }
```

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

### start()

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/api/qtmultimedia/qaudioinput.html

Starts recording audio to the given QIODevice. The device must be opened for writing. If the format is not supported, an error will be emitted.

```APIDOC
## start()

### Description
Starts recording audio from the input device to the specified QIODevice. The device must be opened for writing. If the format is not supported, an error will be emitted.

### Method
start

### Parameters
- **device** (QIODevice) - Required - The device to write the audio data to.

### Example
```python
destinationFile = QFile("/tmp/test.raw")
destinationFile.open(QIODevice.WriteOnly | QIODevice.Truncate)
audio.start(destinationFile)
```
```

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

### QFileInfo fileName() example

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

Shows how to use QFileInfo::fileName() to get the file name from a path. The example creates a QFileInfo for '/tmp/archive.tar.gz' and assigns the result of fileName() to a QString variable 'name', which will be 'archive.tar.gz'. Note that if the path ends with a slash, the file name is considered empty.

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

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

### QCamera.start

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

Starts the camera.

```APIDOC
## QCamera.start

### Description
Starts the camera.

### Method
start()

### Returns
None
```

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

### allKeys() example: retrieve all keys

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/api/qtcore/qsettings.html

Shows how to use allKeys() to get a list of all keys, including subkeys. The example sets several values and then retrieves the keys, resulting in ["fridge/color", "fridge/size", "sofa", "tv"].

```cpp
# QSettings settings;
# settings.setValue("fridge/color", QColor(Qt::white));
# settings.setValue("fridge/size", QSize(32, 96));
# settings.setValue("sofa", true);
# settings.setValue("tv", false);

# QStringList keys = settings.allKeys();
# // keys: ["fridge/color", "fridge/size", "sofa", "tv"]
```

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

### QSyntaxHighlighter State Management Example

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/api/qtgui/qsyntaxhighlighter.html

Example demonstrating how to use currentBlockState(), previousBlockState(), setCurrentBlockState(), and setFormat() to implement a simple C++ syntax highlighter.

```APIDOC
## QSyntaxHighlighter State Management Example

### Description
This example shows how to use the QSyntaxHighlighter state functions to highlight multi-line comments in C++ code. It demonstrates setting the current block state, checking the previous block state, and applying formatting.

### Functions Used
- `currentBlockState()` - Returns the current block state as an int.
- `previousBlockState()` - Returns the previous block state as an int.
- `setCurrentBlockState(int state)` - Sets the current block state.
- `setFormat(int start, int count, QTextCharFormat format)` - Applies formatting to a range of text.

### Example Code
```cpp
# QTextCharFormat multiLineCommentFormat;
# multiLineCommentFormat.setForeground(Qt::red);

# QRegularExpression startExpression("/\\*");
# QRegularExpression endExpression("\\*/");

# setCurrentBlockState(0);

# int startIndex = 0;
# if (previousBlockState() != 1)
#     startIndex = text.indexOf(startExpression);

# while (startIndex >= 0) {
#    QRegularExpressionMatch endMatch;
#    int endIndex = text.indexOf(endExpression, startIndex, &endMatch);
#    int commentLength;
#    if (endIndex == -1) {
#        setCurrentBlockState(1);
#        commentLength = text.length() - startIndex;
#    } else {
#        commentLength = endIndex - startIndex
#                        + endMatch.capturedLength();
#    }
#    setFormat(startIndex, commentLength, multiLineCommentFormat);
#    startIndex = text.indexOf(startExpression,
#                              startIndex + commentLength);
# }
```

### Notes
- The state values are integers; -1 indicates no state set.
- The state persists until changed or the paragraph is deleted.
- Use `setCurrentBlockUserData()` to attach custom data to a block.
```

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

### Get font metrics with QFontMetrics

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/api/qtgui/qfont.html

Uses QFontMetrics to measure text width and height in pixels. The example creates a QFontMetrics from a QFont and calls horizontalAdvance() and height().

```cpp
# QFontMetrics fm(f1);
# int textWidthInPixels = fm.horizontalAdvance("How many pixels wide is this text?");
# int textHeightInPixels = fm.height();
```

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

### __init__(parent: QNode = None)

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/api/qt3dinput/qkeyboarddevice.html

Constructs a new QKeyboardDevice instance with the given parent.

```APIDOC
## __init__(parent: QNode = None)

### Description
Constructs a new QKeyboardDevice instance with the specified parent.

### Parameters
- **parent** (QNode) - Optional - The parent QNode for this device.

### Returns
None
```

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

### Check volume validity and readiness for application directory

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

Example from the QStorageInfo constructor documentation showing how to get the volume on which the application is located and check that it is valid and ready.

```cpp
#     QStorageInfo storage(qApp->applicationDirPath());
#     if (storage.isValid() && storage.isReady()) {
#         // ...
#     }
```

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

### __init__(parent: QNode = None)

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/api/qt3dinput/qlogicaldevice.html

Constructs a new QLogicalDevice instance with the given parent.

```APIDOC
## __init__(parent: QNode = None)

### Description
Constructs a new QLogicalDevice instance with the specified parent.

### Method
Constructor

### Parameters
- **parent** (QNode) - Optional - The parent QNode for this logical device.

### Returns
None
```

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

### QCoreApplication.applicationDirPath() → str

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

Returns the directory that contains the application executable. For example, if Qt is installed in C:\Qt and you run the regexp example, it returns "C:/Qt/examples/tools/regexp". On macOS and iOS, it points to the directory actually containing the executable, which may be inside an application bundle.

```APIDOC
## QCoreApplication.applicationDirPath() → str

### Description
Returns the directory that contains the application executable. For example, if Qt is installed in C:\Qt and you run the regexp example, it returns "C:/Qt/examples/tools/regexp". On macOS and iOS, it points to the directory actually containing the executable, which may be inside an application bundle.

### Method
Static method

### Returns
- **str** - The directory containing the application executable.

```

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

### Access element text with QDomElement.text()

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/api/qtxml/qdomelement.html

Shows how to get the text of a QDomElement using the text() function. The example uses C++ syntax with comments indicating placeholder code.

```cpp
# QDomElement e = //...
# //...
# QString s = e.text()
```

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

### Simple shader example - add shaders and get locations

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/api/qtgui/qopenglshaderprogram.html

Adds vertex and fragment shaders from source code, links and binds the program, then retrieves attribute and uniform locations.

```cpp
# program.addShaderFromSourceCode(QOpenGLShader::Vertex,
#     "attribute highp vec4 vertex;\n"
#     "uniform highp mat4 matrix;\n"
#     "void main(void)\n"
#     "{\n"
#     "   gl_Position = matrix * vertex;\n"
#     "}");
# program.addShaderFromSourceCode(QOpenGLShader::Fragment,
#     "uniform mediump vec4 color;\n"
#     "void main(void)\n"
#     "{\n"
#     "   gl_FragColor = color;\n"
#     "}");
# program.link();
# program.bind();

# int vertexLocation = program.attributeLocation("vertex");
# int matrixLocation = program.uniformLocation("matrix");
# int colorLocation = program.uniformLocation("color");
```

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

### QBrush.__init__(Any)

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

TODO

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

### Description
TODO

### Method
Constructor

### Signature
`__init__(arg__1: Any)`

### Parameters
- **arg__1** (Any) - Required - The argument.

### Returns
A new QBrush object.

```

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

### QBluetoothDeviceDiscoveryAgent.start (overload)

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

Starts the device discovery process with specified discovery methods.

```APIDOC
## start(Union[DiscoveryMethods, DiscoveryMethod])

### Description
Starts the device discovery process using the specified discovery methods.

### Parameters
- **Union[DiscoveryMethods, DiscoveryMethod]** - Required - The discovery methods to use.

### Returns
None
```

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

### Using staticMetaObject and metaObject to get class name

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/api/qtcore/qobject.html

Shows how to use staticMetaObject and metaObject to retrieve the class name of a QObject instance. The example is in C++ and demonstrates the expected output.

```cpp
# QPushButton::staticMetaObject.className();  // returns "QPushButton"

# QObject *obj = new QPushButton;
# obj->metaObject()->className();             // returns "QPushButton"
```

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

### __init__(QTouchDevice)

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/api/qtgui/qtouchdevice.html

TODO: This constructor is documented but the description is not provided in the source.

```APIDOC
## __init__(QTouchDevice)

### Description
TODO

### Method
Constructor

### Parameters
- **QTouchDevice** - The source does not provide details.

### Returns
None
```

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

### Set URL scheme with QUrl.setScheme()

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/api/qtcore/qurl.html

Shows how to set the scheme of a QUrl to 'ftp'. The scheme must start with an ASCII letter and contain only ASCII characters. This example is from the setScheme() method documentation.

```cpp
#     QUrl url;
#     url.setScheme("ftp");
```

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

### Basic QBuffer read/write example

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

Shows how to open a QBuffer in ReadWrite mode, write a string, seek to the beginning, and read characters one by one using getChar(). The comments indicate the expected character values after each read.

```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'
```

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

### Implement highlightBlock() to apply formatting

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/api/qtgui/qsyntaxhighlighter.html

Example implementation of highlightBlock() that applies a QTextCharFormat to matches of a regular expression. It sets the font weight to bold and foreground to dark magenta for words starting with 'My'.

```cpp
# void MyHighlighter::highlightBlock(const QString &text)
# {
#     QTextCharFormat myClassFormat;
#     myClassFormat.setFontWeight(QFont::Bold);
#     myClassFormat.setForeground(Qt::darkMagenta);

#     QRegularExpression expression("\\bMy[A-Za-z]+\\b");
#     QRegularExpressionMatchIterator i = expression.globalMatch(text);
#     while (i.hasNext())
#     {
#       QRegularExpressionMatch match = i.next();
#       setFormat(match.capturedStart(), match.capturedLength(), myClassFormat);
#     }
# }
```

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

### Get actual font attributes with QFontInfo

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/api/qtgui/qfont.html

Uses QFontInfo to retrieve the actual family name of a font used by the window system. The example shows creating a QFontInfo from a QFont and calling family().

```cpp
# QFontInfo info(f1);
# QString family = info.family();
```

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

### __init__()

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/api/qtgui/qopenglpaintdevice.html

Constructs a QOpenGLPaintDevice. The device is only valid for the current context.

```APIDOC
## __init__()

### Description
Constructs a QOpenGLPaintDevice. The device is only valid for the current context.

### Method
Constructor

### Signature
`__init__()`

### Parameters
None

### Notes
- The QOpenGLPaintDevice is only valid for the current context.
- See also: currentContext()
```

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

### Connect to host with encryption using QSslSocket

Source: https://www.riverbankcomputing.com/static/Docs/PyQt5/api/qtnetwork/qsslsocket.html

Shows how to create a QSslSocket, connect its encrypted signal to a slot, and start an encrypted connection to a server using connectToHostEncrypted(). The example uses C++ syntax with commented-out lines.

```cpp
# QSslSocket *socket = new QSslSocket(this);
# connect(socket, SIGNAL(encrypted()), this, SLOT(ready()));

# socket->connectToHostEncrypted("imap.example.com", 993);
```

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

### QBrush.__init__(Union[QBrush, QColor, GlobalColor, QGradient])

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

Constructs a copy of other.

```APIDOC
## QBrush.__init__(Union[QBrush, QColor, GlobalColor, QGradient])

### Description
Constructs a copy of other.

### Method
Constructor

### Signature
`__init__(other: Union[QBrush, QColor, GlobalColor, QGradient])`

### Parameters
- **other** (Union[QBrush, QColor, GlobalColor, QGradient]) - Required - The brush to copy.

### Returns
A new QBrush object that is a copy of other.

```
Tokens:
Raw