The Qt Protobuf generator plugin generates Qt-based classes from
.proto files. You can use the classes to serialize and deserialize their associated protobuf messages.
Protocol buffers are a language-neutral, platform-neutral, and extensible mechanism for serializing structured data, which is compact and easy to use:
- A user defines the structure of data in
- Proto compiler is invoked at build time on
.protofiles to generate code in various programming languages.
The provided format is suitable for network traffic or long-term data storage.
Protocol buffers provide a serialization format for packets of typed and structured data that are up to a few megabytes in size. Moreover, it can be extended with new information without invalidating existing data or requiring code to be updated. For more information, see Protocol Buffers Overview.
You can use a Protocol buffers mechanism in any Qt-based project:
- No need to call a protocol buffer compiler explicitly.
- No need to integrate generated code into project tree manually.
- Convenient serialization and deserialization API.
- Integrated properties mechanism for generated protobuf messages.
- Integrated gRPC-client support (see QtGrpc module).
- Integrated QML-types support for generated protobuf messages. See Qt Protobuf QML types
- Enabled using Qt Core and Qt GUI types as a part of *.proto schema. See Protobuf Qt Core types module and Protobuf Qt GUI types module.
- Enabling gRPC-server support.
Google protocol buffers provide a generator called
protoc that supports extensions. The qtprotobufgen Tool is an extension for
protoc and requires that you install
protoc on your host system. For more information about the installation, see Protoc Installation.
Example of installation for Linux, using apt:
apt install -y protobuf-compiler protoc --version # Ensure compiler version is 3+
For more information about component API usage, see CMake API.
The QML types of the module are available through the QML and QML_URI options in the qt_add_protobuf macro. The import name is equal to the
.proto package name or defined by QML_URI option in the qt_add_protobuf macro. To use the types, add the following import statement to your .qml file:
find_package() command to locate the needed module component in the
find_package(Qt6 REQUIRED COMPONENTS Protobuf) target_link_libraries(mytarget PRIVATE Qt6::Protobuf)
For more details, see the Build with CMake overview.
- CMake Commands in Qt6 Protobuf
- Protobuf Qt Core types
- Protobuf Qt GUI types
- Qt Protobuf Well-Known types
© 2023 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.