QAccessibleClient::Registry
#include <registry.h>
Public Types | |
enum | EventListener { NoEventListeners = 0x0 , Window = 0x1 , Focus = 0x2 , StateChanged = 0x20 , ChildrenChanged = 0x40 , VisibleDataChanged = 0x80 , SelectionChanged = 0x100 , ModelChanged = 0x200 , TextCaretMoved = 0x400 , TextChanged = 0x800 , TextSelectionChanged = 0x1000 , PropertyChanged = 0x2000 , AllEventListeners = 0xffffffff } |
typedef QFlags< EventListener > | EventListeners |
Public Types inherited from QObject | |
typedef | QObjectList |
Public Slots | |
AccessibleObject | accessibleFromUrl (const QUrl &url) const |
QList< AccessibleObject > | applications () const |
bool | isEnabled () const |
bool | isScreenReaderEnabled () const |
void | setEnabled (bool enable) |
void | setScreenReaderEnabled (bool enable) |
EventListeners | subscribedEventListeners () const |
void | subscribeEventListeners (const EventListeners &listeners) const |
Public Member Functions | |
Registry (QObject *parent=nullptr) | |
~Registry () override | |
Public Member Functions inherited from QObject | |
QObject (QObject *parent) | |
QBindable< QString > | bindableObjectName () |
bool | blockSignals (bool block) |
const QObjectList & | children () const const |
QMetaObject::Connection | connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const |
void | deleteLater () |
void | destroyed (QObject *obj) |
bool | disconnect (const char *signal, const QObject *receiver, const char *method) const const |
bool | disconnect (const QObject *receiver, const char *method) const const |
void | dumpObjectInfo () const const |
void | dumpObjectTree () const const |
QList< QByteArray > | dynamicPropertyNames () const const |
virtual bool | event (QEvent *e) |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
T | findChild (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (Qt::FindChildOptions options) const const |
bool | inherits (const char *className) const const |
void | installEventFilter (QObject *filterObj) |
bool | isQuickItemType () const const |
bool | isWidgetType () const const |
bool | isWindowType () const const |
void | killTimer (int id) |
virtual const QMetaObject * | metaObject () const const |
void | moveToThread (QThread *targetThread) |
QString | objectName () const const |
void | objectNameChanged (const QString &objectName) |
QObject * | parent () const const |
QVariant | property (const char *name) const const |
Q_CLASSINFO (Name, Value) | |
Q_EMIT Q_EMIT | |
Q_ENUM (...) | |
Q_ENUM_NS (...) | |
Q_ENUMS (...) | |
Q_FLAG (...) | |
Q_FLAG_NS (...) | |
Q_FLAGS (...) | |
Q_GADGET Q_GADGET | |
Q_GADGET_EXPORT (EXPORT_MACRO) | |
Q_INTERFACES (...) | |
Q_INVOKABLE Q_INVOKABLE | |
Q_MOC_INCLUDE Q_MOC_INCLUDE | |
Q_NAMESPACE Q_NAMESPACE | |
Q_NAMESPACE_EXPORT (EXPORT_MACRO) | |
Q_OBJECT Q_OBJECT | |
Q_PROPERTY (...) | |
Q_REVISION Q_REVISION | |
Q_SET_OBJECT_NAME (Object) | |
Q_SIGNAL Q_SIGNAL | |
Q_SIGNALS Q_SIGNALS | |
Q_SLOT Q_SLOT | |
Q_SLOTS Q_SLOTS | |
T | qobject_cast (const QObject *object) |
T | qobject_cast (QObject *object) |
QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT | |
void | removeEventFilter (QObject *obj) |
void | setObjectName (const QString &name) |
void | setObjectName (QAnyStringView name) |
void | setParent (QObject *parent) |
bool | setProperty (const char *name, const QVariant &value) |
bool | setProperty (const char *name, QVariant &&value) |
bool | signalsBlocked () const const |
int | startTimer (int interval, Qt::TimerType timerType) |
int | startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType) |
QThread * | thread () const const |
Additional Inherited Members | |
Properties inherited from QObject | |
objectName | |
Static Public Member Functions inherited from QObject | |
QMetaObject::Connection | connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, Functor functor) |
bool | disconnect (const QMetaObject::Connection &connection) |
bool | disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method) |
bool | disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method) |
bool | disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method) |
QString | tr (const char *sourceText, const char *disambiguation, int n) |
Protected Member Functions inherited from QObject | |
virtual void | childEvent (QChildEvent *event) |
virtual void | connectNotify (const QMetaMethod &signal) |
virtual void | customEvent (QEvent *event) |
virtual void | disconnectNotify (const QMetaMethod &signal) |
bool | isSignalConnected (const QMetaMethod &signal) const const |
int | receivers (const char *signal) const const |
QObject * | sender () const const |
int | senderSignalIndex () const const |
virtual void | timerEvent (QTimerEvent *event) |
Detailed Description
This class represents the global accessibility registry.
It provides information about running applications. All updates of accessible objects will result in signals emitted by this class.
Definition at line 29 of file registry.h.
Member Typedef Documentation
◆ EventListeners
Definition at line 63 of file registry.h.
Member Enumeration Documentation
◆ EventListener
This enum describes the different types of events that can be observed.
Enumerator | |
---|---|
NoEventListeners | No event listeners registered or wanted |
Window | Window changes, such as new applications being started |
Focus | Focus listener reacts to focus changes - see signal
|
StateChanged | State of the accessible changed - see signal
|
ChildrenChanged | Children changed - see signal
|
VisibleDataChanged | Visibility of the accessible changed - see signal
|
SelectionChanged | Selection changed - see signal
|
ModelChanged | The model changed - see signal
|
TextCaretMoved | The text caret moved its position - see signal
|
TextChanged | The text changed - see signal
|
TextSelectionChanged | The text selection changed - see signal
|
PropertyChanged | A property changed. See signals
|
AllEventListeners | All possible event listeners |
Definition at line 38 of file registry.h.
Constructor & Destructor Documentation
◆ Registry()
|
explicit |
Construct a Registry object with parent as QObject parent.
Definition at line 14 of file registry.cpp.
◆ ~Registry()
|
override |
Destroys this Registry.
Definition at line 20 of file registry.cpp.
Member Function Documentation
◆ accessibleDescriptionChanged
|
signal |
Emitted when an accessible description changes.
When subscribed to the PropertyChanged EventListener, this signal is emitted whenever the accessible-description property changes its value.
◆ accessibleFromUrl
|
slot |
Creates the AccessibleObject for the url.
This can be used to deserialize an AccessibleObject after passing it around as string.
The returned QUrl returns a scheme of "accessibleobject".
Definition at line 60 of file registry.cpp.
◆ accessibleNameChanged
|
signal |
Emitted when an accessible name changes.
When subscribed to the PropertyChanged EventListener, this signal is emitted whenever the accessible-name property changes its value.
◆ added
|
signal |
Emitted if a AccessibleObject is created.
This signal indicates that the AccessibleObject instance was created and is going to be added/attached.
◆ applications
|
slot |
List of all currently running applications that expose an accessibility interface.
Definition at line 55 of file registry.cpp.
◆ childAdded
|
signal |
Notifies about a new AccessibleObject.
The childAdded signal is emitted when a new accessible object is created. This signal depends on the implementation of the server side and is not reliable for all applications. The parameter childIndex is the index of the child that has been added.
- See also
- AccessibleObject::child(), childRemoved()
◆ childRemoved
|
signal |
Notifies that an AccessibleObject has been removed.
The parameter childIndex is the index of the child that has been removed.
- See also
- AccessibleObject::child(), childAdded()
◆ defunct
|
signal |
Emitted if a AccessibleObject is marked defunct.
This signal indicates that the AccessibleObject became invalid and does not point any longer to any valid accessible object.
◆ enabledChanged
|
signal |
Emitted if the isEnabled state changed.
If the accessibility daemon got enabled or disabled either by us or ny someone else then this signal is emitted.
◆ focusChanged
|
signal |
Emitted when the focus changed.
When subscribed to the Focus EventListener then this signal is emitted every time the focus changes. object is the newly focused AccessibleObject.
◆ isEnabled
|
slot |
Returns true if the accessibility stack is enabled.
This means that an atspi registry daemon is running and available as org.a11y.bus at the session dbus. The org.a11y.bus implments the org.a11y.Status dbus interface that offers the IsEnabled property. The isEnabled and setEnabled methods do read/write the boolean value of that org.a11y.Status.IsEnabled dbus property..
Definition at line 25 of file registry.cpp.
◆ isScreenReaderEnabled
|
slot |
Returns true if the screen reader is enabled.
This means that there is potentially a screen reader, if installed, that is enabled or disabled. This allows to enable system wide a screen reader with just one switch.
Definition at line 35 of file registry.cpp.
◆ modelChanged
|
signal |
Notifies that the object's table model changed.
◆ removed
|
signal |
Emitted if a AccessibleObject is destroyed.
This signal indicates that the AccessibleObject instance was destroyed and ended its life-time.
◆ screenReaderEnabledChanged
|
signal |
Emitted if the isScreenReaderEnabled state changed.
If the screen reader enabled property got enabled or disabled either by us or by someone else then this signal is emitted.
◆ selectionChanged
|
signal |
Notifies that the object's selection changed.
◆ setEnabled
|
slot |
Activates accessibility when enabled and tells toolkits to provide updates such as focus changes.
Definition at line 30 of file registry.cpp.
◆ setScreenReaderEnabled
|
slot |
Tells the system that a screen reader is enabled.
Definition at line 40 of file registry.cpp.
◆ stateChanged
|
signal |
Notifies about a state change in an object.
The state of object has change. If the state is now set active is true, otherwise the state was removed.
◆ subscribedEventListeners
|
slot |
Returns the active event listeners.
Definition at line 50 of file registry.cpp.
◆ subscribeEventListeners
|
slot |
In order to get notified of changes in accessible applications it is neccessary to subscribe to the listeners that are relevant.
This will unsubscribe all previously subscribed event listeners.
Definition at line 45 of file registry.cpp.
◆ textCaretMoved
|
signal |
◆ textChanged
|
signal |
Emitted when an object's text was changed.
The new text will be text. The change starts at startOffset and goes to endOffset.
- See also
- textInserted, textRemoved
◆ textInserted
|
signal |
Emitted when text was inserted in an object's text.
The new text will be text. The change starts at startOffset and goes to endOffset.
- See also
- textInserted, textRemoved
◆ textRemoved
|
signal |
Emitted when an object's text was removed.
The removed text will be text, but this string may be emtpy for some implementations. The removal starts at startOffset and goes to endOffset.
- See also
- textInserted, textRemoved
◆ textSelectionChanged
|
signal |
◆ visibleDataChanged
|
signal |
Notifies that the object's visible data changed.
◆ windowActivated
|
signal |
Emitted when a window is activated.
◆ windowClosed
|
signal |
Emitted when a window is closed.
◆ windowCreated
|
signal |
Emitted when a window is created.
◆ windowDeactivated
|
signal |
Emitted when a window is deactivated.
◆ windowDesktopCreated
|
signal |
Emitted when a desktop window is created.
◆ windowDesktopDestroyed
|
signal |
Emitted when a desktop window is destroyed.
◆ windowDestroyed
|
signal |
Emitted when a window is destroyed.
◆ windowLowered
|
signal |
Emitted when a window is lowered.
◆ windowMaximized
|
signal |
Emitted when a window is maximized.
◆ windowMinimized
|
signal |
Emitted when a window is minimized.
◆ windowMoved
|
signal |
Emitted when a window is moved.
◆ windowRaised
|
signal |
Emitted when a window is raised.
◆ windowReparented
|
signal |
Emitted when a window is reparented.
◆ windowResized
|
signal |
Emitted when a window is resized.
◆ windowRestored
|
signal |
Emitted when a window is restored to normal size.
◆ windowShaded
|
signal |
Emitted when a window is shaded.
◆ windowUnshaded
|
signal |
Emitted when a window is unshaded.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Oct 4 2024 11:57:08 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.