libraries/libqaccessibilityclient/README.md

0001 QAccessibilityClient
0002 ====================
0003
0004 This library is used when writing accessibility clients such as screen readers.
0005 It comes with some examples demonstrating the API. These small helpers may be useful when testing accessibility.
0006 One of them writes all accessibiliy interfaces an application provides as text output.
0007 The other, more advanced application shows a tree of objects and allows some interaction and exploration.
0008
0009 Coding style: <https://community.kde.org/Policies/Frameworks_Coding_Style>
0010 Generally this library follows <https://community.kde.org/Policies/Library_Code_Policy>
0011
0012 Be aware that it is in an early stage of development right now so no compatibility is guaranteered.
0013
0014 All public API is in:
0015 src/qaccessibilityclient
0016
0017 The abstraction of DBus and related at-spi tools should go into
0018 src/atspi
0019 but not exported.
0020
0021 You can generate documentation (see docs folder README).
0022
0023 Using CMake with QAccessibilityClient
0024 -------------------------------------
0025
0026 Use:
0027
0028 ```cmake
0029 find_package(QAccessibilityClient)
0030 set_package_properties(QAccessibilityClient PROPERTIES
0031     DESCRIPTION "Client-side accessibility library for Qt"
0032     URL "https://commits.kde.org/libqaccessibilityclient"
0033     TYPE REQUIRED
0034     PURPOSE "Required to enable accessibility features."
0035 )
0036
0037 target_link_libraries(targetname qaccessibilityclient)
0038 ```
0039
0040 In your code `#include <qaccessibilityclient/accessibleobject.h>` etc.
0041
0042 Creating releases
0043 -----------------
0044
0045 There are no translations for QAccessibilityClient since the library does not contain any strings that should be shown to users.
0046 The examples are not translated, that could potentially be considered.
0047 Follow <https://community.kde.org/ReleasingSoftware>, skip the translation parts.
0048
0049 * Set the project version in the top-level CMakeLists.txt, push.
0050 * `./tarme.rb --version 0.3.0 --origin stable libqaccessibilityclient`
0051 * tarme.rb has nice output that gives instructions.
0052 * `./tagme.rb --version 0.3.0 libqaccessibilityclient`
0053 * upload as directed
0054 * file sysadmin ticket
0055 * `./logme.rb` to create changelog
0056 * `./tagme --version 0.3.0` to push tag
0057 * blog/send mail