diff options
author | Andreas Buhr <andreas.buhr@qt.io> | 2021-08-19 12:33:31 +0200 |
---|---|---|
committer | Andreas Buhr <andreas.buhr@qt.io> | 2021-08-19 22:29:11 +0200 |
commit | 391fd67c685bc8fe1f769b5ae3c65095f1322ad0 (patch) | |
tree | 7a2d87960a1777c2eca4b58c3b61265c289dc527 /src/bluetooth/doc | |
parent | f58597edfe7b228698d3977fce498d292259c092 (diff) |
Beautify QtBluetooth 6 migration guide
Better styling, working links.
Pick-to: 6.2
Fixes: QTBUG-94905
Change-Id: I3526c64fd15897bd0e0e33c4f78c9852d54fd2ae
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/bluetooth/doc')
-rw-r--r-- | src/bluetooth/doc/qt6-changes.qdoc | 126 |
1 files changed, 71 insertions, 55 deletions
diff --git a/src/bluetooth/doc/qt6-changes.qdoc b/src/bluetooth/doc/qt6-changes.qdoc index 468263c5..b584908f 100644 --- a/src/bluetooth/doc/qt6-changes.qdoc +++ b/src/bluetooth/doc/qt6-changes.qdoc @@ -43,107 +43,123 @@ \section1 General - - qbluetoothglobal.h was removed. qtbluetoothglobal.h is the official header with the same purpose. + \list + \li qbluetoothglobal.h was removed. qtbluetoothglobal.h is the official header with the same purpose. - - Every usage of QVector has been replaced by QList. + \li Every usage of QVector has been replaced by QList. - - Win32 backend has been removed. There will not be a working Bluetooth backend when Qt is built with mingw. + \li Win32 backend has been removed. There will not be a working Bluetooth backend when Qt is built with mingw. - - Since there is now only one Windows backend, the logging category qt.bluetooth.winrt was removed. - The corresponding log messages are now in qt.bluetooth.windows. + \li Since there is now only one Windows backend, the logging category qt.bluetooth.winrt was removed. + The corresponding log messages are now in qt.bluetooth.windows. + \endlist \section1 QBluetooth namespace - - The enums QBluetooth::Security and QBluetooth::AttAccessConstraint have been changed - to a scoped enums for improved type safety. + The enums QBluetooth::Security and QBluetooth::AttAccessConstraint have been changed + to a scoped enums for improved type safety. \section1 QBluetoothDeviceDiscoveryAgent - - QBluetoothDeviceDiscoveryAgent::inquiryType property and related setter/getter & enum were removed. - The API element was never implemented and/or supported. + QBluetoothDeviceDiscoveryAgent::inquiryType property and related setter/getter & enum were removed. + The API element was never implemented and/or supported. \section1 QBluetoothDeviceInfo - - manufacturerData() returns a QMultiHash rather than QHash. Since Qt 6 - QMultiHash is no longer derived from QHash. + \list + \li manufacturerData() returns a QMultiHash rather than QHash. Since Qt 6 + QMultiHash is no longer derived from QHash. - - DataCompleteness was removed without replacement as the related API elements - no longer served a purpose + \li DataCompleteness was removed without replacement as the related API elements + no longer served a purpose - - setServiceUuids(const QList<QBluetoothUuid>, DataCompleteness) was replaced by - setServiceUuids(const QList<QBluetoothUuid> &uuids) + \li setServiceUuids(const QList<QBluetoothUuid>, DataCompleteness) was replaced by + setServiceUuids(const QList<QBluetoothUuid> &uuids) - - DataCompleteness serviceUuidsCompleteness() const was removed without replacement. + \li DataCompleteness serviceUuidsCompleteness() const was removed without replacement. - - QList<QBluetoothUuid> serviceUuids(DataCompleteness *completeness = nullptr) const was replaced by - QList<QBluetoothUuid> serviceUuids() const. + \li QList<QBluetoothUuid> serviceUuids(DataCompleteness *completeness = nullptr) const was replaced by + QList<QBluetoothUuid> serviceUuids() const. + \endlist \section1 QBluetoothLocalDevice - - The pairing agent related API was removed without replacement. This includes pairingConfirmation(bool), - pairingDisplayPinCode(..) & pairingDisplayConfirmation(..). Except for Android and BlueZ 4 there was - never an implementation for it. Bluez 4 support was removed in Qt 6 and Android's implementation - required unobtainable BLUETOOTH_PRIVILEGED for at least parts of the code. + The pairing agent related API was removed without replacement. This includes pairingConfirmation(bool), + pairingDisplayPinCode(..) & pairingDisplayConfirmation(..). Except for Android and BlueZ 4 there was + never an implementation for it. Bluez 4 support was removed in Qt 6 and Android's implementation + required unobtainable BLUETOOTH_PRIVILEGED for at least parts of the code. \section1 QLowEnergyService - - Renamed ServiceState enum values: - - "DiscoveryRequired" becomes "RemoteService" - - "DiscoveringServices" becomes "RemoteServiceDiscovering" - - "ServiceDiscovered" becomes "RemoteServiceDiscovered" - This change happens in anticipation that service discovery might become an optional - step in the future. + Renamed ServiceState enum values: + \list + \li \l{QLowEnergyService::DiscoveryRequired}{DiscoveryRequired} becomes \l{QLowEnergyService::RemoteService}{RemoteService} + \li \l{QLowEnergyService::DiscoveringService}{DiscoveringService} becomes \l{QLowEnergyService::RemoteServiceDiscovering}{RemoteServiceDiscovering} + \li \l{QLowEnergyService::ServiceDiscovered}{ServiceDiscovered} becomes \l{QLowEnergyService::RemoteServiceDiscovered}{RemoteServiceDiscovered} + \endlist + This change happens in anticipation that service discovery might become an optional + step in the future. \section1 QBluetoothUuid - - enums ProtocolUuid, ServiceClassUuid, CharacteristicType, and DescriptorType are now scoped enums. - The usage of enum items has to be adapted in user code. + enums \l{QBluetoothUuid::ProtocolUuid}{ProtocolUuid}, + \l{QBluetoothUuid::ServiceClassUuid}{ServiceClassUuid}, + \l{QBluetoothUuid::CharacteristicType}{CharacteristicType}, and + \l{QBluetoothUuid::DescriptorType}{DescriptorType} are now scoped enums. + The usage of enum items has to be adapted in user code. \section1 QLowEnergyController - - Existing ctors and create*() functions with remote QBluetoothAddress parameters have been removed. QBluetoothAddress - is not sufficient to indicate remote devices on Apple systems. It requires UUIDs to "name" devices. This can only - be satisfied by QBluetoothDeviceInfo. + \list + \li Existing ctors and create*() functions with remote QBluetoothAddress parameters have been removed. QBluetoothAddress + is not sufficient to indicate remote devices on Apple systems. It requires UUIDs to "name" devices. This can only + be satisfied by QBluetoothDeviceInfo. - - Remaining QLowEnergyController ctors have been made private. The createPeripheral() and createCentral() functions - should be used to obtain QLowEnergyController instances. + \li Remaining QLowEnergyController ctors have been made private. The createPeripheral() and createCentral() functions + should be used to obtain QLowEnergyController instances. + \endlist \section1 QLowEnergyCharacteristic - - The new method clientCharacteristicConfiguration() has been introduced to conveniently obtain the - Client Characteristic Configuration Descriptor. - - The constants CCCDDisable, CCCDEnableNotification, and CCCDEnableIndication have been introduced - which hold the possible values for the Client Characteristic Configuration Descriptor. - - The handle() method is no longer part of the public Bluetooth LE interfaces. It's purpose as identifier - for characteristics was replaced. The QLowEnergyCharacteristic instances itself serve as identifier. + \list + \li The new method clientCharacteristicConfiguration() has been introduced to conveniently obtain the + Client Characteristic Configuration Descriptor. + \li The constants + \l{QLowEnergyCharacteristic::CCCDDisable}{CCCDDisable}, + \l{QLowEnergyCharacteristic::CCCDEnableNotification}{CCCDEnableNotification}, and + \l{QLowEnergyCharacteristic::CCCDEnableIndication}{CCCDEnableIndication} have been introduced + which hold the possible values for the Client Characteristic Configuration Descriptor. + \li The handle() method is no longer part of the public Bluetooth LE interfaces. It's purpose as identifier + for characteristics was replaced. The QLowEnergyCharacteristic instances itself serve as identifier. + \endlist \section1 QLowEnergyDescriptor - - The handle() method is no longer part of the public Bluetooth LE interfaces. It's purpose as identifier - for descriptors was replaced. The QLowEnergyDescriptor instances itself serve as identifier. + The handle() method is no longer part of the public Bluetooth LE interfaces. It's purpose as identifier + for descriptors was replaced. The QLowEnergyDescriptor instances itself serve as identifier. \section1 QBluetoothTransferManager - - QBluetoothTransferManager, QBluetoothTransferRequest, and QBluetoothTransferReply have been removed - without replacement. + QBluetoothTransferManager, QBluetoothTransferRequest, and QBluetoothTransferReply have been removed + without replacement. \section1 QBluetoothSocket - - QBluetoothSocket::SocketState and QBluetoothSocket::SocketError are now scoped enums. The usage of enum - items has to be adapted in user code. + QBluetoothSocket::SocketState and QBluetoothSocket::SocketError are now scoped enums. The usage of enum + items has to be adapted in user code. \section1 QML Interface - - The QML interface has been removed because socket programming via QML is not advisable. - QDeclarativeBluetoothService, QDeclarativeBluetoothSocket, and QDeclarativeBluetoothDiscoveryModel - (in QML: BluetoothService, BluetoothSocket, and BluetoothDiscoveryModel) - have been removed without replacement. + The QML interface has been removed because socket programming via QML is not advisable. + QDeclarativeBluetoothService, QDeclarativeBluetoothSocket, and QDeclarativeBluetoothDiscoveryModel + (in QML: BluetoothService, BluetoothSocket, and BluetoothDiscoveryModel) + have been removed without replacement. \section1 "error" signals - - The "error" signals in QBluetoothDeviceDiscoveryAgent, QBluetoothLocalDevice, QBluetoothServer, - QBluetoothServiceDiscoveryAgent, QBluetoothSocket, QLowEnergyController, and QLowEnergyService - have been renamed to "errorOccurred" to remove ambiguities between the "error" signal and the - "error" getter. + The "error" signals in QBluetoothDeviceDiscoveryAgent, QBluetoothLocalDevice, QBluetoothServer, + QBluetoothServiceDiscoveryAgent, QBluetoothSocket, QLowEnergyController, and QLowEnergyService + have been renamed to "errorOccurred" to remove ambiguities between the "error" signal and the + "error" getter. */ |