d9/d62/atspiadaptor__p_8h_source.html

// Copyright (C) 2016 The Qt Company Ltd.

// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only


#ifndef ATSPIADAPTOR_H

#define ATSPIADAPTOR_H


//

//  W A R N I N G

//  -------------

//

// This file is not part of the Qt API. It exists purely as an

// implementation detail. This header file may change from version to

// version without notice, or even be removed.

//

// We mean it.

//


#include <atspi/atspi.h>


#include <QtGui/private/qtguiglobal_p.h>

#include <QtDBus/qdbusvirtualobject.h>

#include <QtGui/qaccessible.h>


#include "dbusconnection_p.h"

#include "qspi_struct_marshallers_p.h"


QT_REQUIRE_CONFIG(accessibility);


QT_BEGIN_NAMESPACE


class QAccessibleInterface;

class QSpiApplicationAdaptor;


class AtSpiAdaptor :public QDBusVirtualObject

{

    Q_OBJECT


public:

    explicit AtSpiAdaptor(DBusConnection *connection, QObject *parent = nullptr);

    ~AtSpiAdaptor();


    void registerApplication();

    QString introspect(const QString &path) const override;

    bool handleMessage(const QDBusMessage &message, const QDBusConnection &connection) override;

    void notify(QAccessibleEvent *event);


public Q_SLOTS:

    void eventListenerRegistered(const QString &bus, const QString &path);

    void eventListenerDeregistered(const QString &bus, const QString &path);

    void windowActivated(QObject* window, bool active);


private:

    void updateEventListeners();

    void setBitFlag(const QString &flag);


    // sending messages

    QVariantList packDBusSignalArguments(const QString &type, int data1, int data2, const QVariant &variantData) const;

    bool sendDBusSignal(const QString &path, const QString &interface, const QString &name, const QVariantList &arguments) const;

    QVariant variantForPath(const QString &path) const;


    void sendFocusChanged(QAccessibleInterface *interface) const;

    void notifyAboutCreation(QAccessibleInterface *interface) const;

    void notifyAboutDestruction(QAccessibleInterface *interface) const;

    void childrenChanged(QAccessibleInterface *interface) const;


    // handlers for the different accessible interfaces

    bool applicationInterface(QAccessibleInterface *interface, const QString &function, const QDBusMessage &message, const QDBusConnection &connection);

    bool accessibleInterface(QAccessibleInterface *interface, const QString &function, const QDBusMessage &message, const QDBusConnection &connection);

    bool componentInterface(QAccessibleInterface *interface, const QString &function, const QDBusMessage &message, const QDBusConnection &connection);

    bool actionInterface(QAccessibleInterface *interface, const QString &function, const QDBusMessage &message, const QDBusConnection &connection);

    bool textInterface(QAccessibleInterface *interface, const QString &function, const QDBusMessage &message, const QDBusConnection &connection);

    bool editableTextInterface(QAccessibleInterface *interface, const QString &function, const QDBusMessage &message, const QDBusConnection &connection);

    bool valueInterface(QAccessibleInterface *interface, const QString &function, const QDBusMessage &message, const QDBusConnection &connection);

    bool selectionInterface(QAccessibleInterface *interface, const QString &function, const QDBusMessage &message, const QDBusConnection &connection);

    bool tableInterface(QAccessibleInterface *interface, const QString &function, const QDBusMessage &message, const QDBusConnection &connection);

    bool tableCellInterface(QAccessibleInterface *interface, const QString &function, const QDBusMessage &message, const QDBusConnection &connection);


    void sendReply(const QDBusConnection &connection, const QDBusMessage &message, const QVariant &argument) const;


    QAccessibleInterface *interfaceFromPath(const QString& dbusPath) const;

    QString pathForInterface(QAccessibleInterface *interface) const;

    QString pathForObject(QObject *object) const;


    void notifyStateChange(QAccessibleInterface *interface, const QString& state, int value);


    void sendAnnouncement(QAccessibleAnnouncementEvent *event);


    // accessible helper functions

    AtspiRole getRole(QAccessibleInterface *interface) const;

    QSpiAttributeSet getAttributes(QAccessibleInterface *) const;

    QSpiRelationArray relationSet(QAccessibleInterface *interface, const QDBusConnection &connection) const;

    QStringList accessibleInterfaces(QAccessibleInterface *interface) const;


    // component helper functions

    static QRect getExtents(QAccessibleInterface *interface, uint coordType);

    static bool isValidCoordType(uint coordType);

    static QRect translateFromScreenCoordinates(QAccessibleInterface *interface, const QRect &rect, uint targetCoordType);

    static QPoint translateToScreenCoordinates(QAccessibleInterface *interface, const QPoint &pos, uint fromCoordType);


    // action helper functions

    QSpiActionArray getActions(QAccessibleInterface *interface) const;


    // text helper functions

    QVariantList getAttributes(QAccessibleInterface *, int offset, bool includeDefaults) const;

    QString getAttributeValue(QAccessibleInterface *, int offset, const QString &attributeName) const;

    QList<QVariant> getCharacterExtents(QAccessibleInterface *, int offset, uint coordType) const;

    QList<QVariant> getRangeExtents(QAccessibleInterface *, int startOffset, int endOffset, uint coordType) const;

    static QAccessible::TextBoundaryType qAccessibleBoundaryTypeFromAtspiBoundaryType(int atspiTextBoundaryType);

    static bool isValidAtspiTextGranularity(uint coordType);

    static QAccessible::TextBoundaryType qAccessibleBoundaryTypeFromAtspiTextGranularity(uint atspiTextGranularity);

    static bool inheritsQAction(QObject *object);


    // private vars

    QSpiObjectReference accessibilityRegistry;

    DBusConnection *m_dbus;

    QSpiApplicationAdaptor *m_applicationAdaptor;


    int m_applicationId;


    // Bit fields - which updates to send


    // AT-SPI has some events that we do not care about:

    // document

    // document-load-complete

    // document-load-stopped

    // document-reload

    uint sendFocus : 1;

    // mouse abs/rel/button


    // all of object

    uint sendObject : 1;

    uint sendObject_active_descendant_changed : 1;

    uint sendObject_announcement : 1;

    uint sendObject_attributes_changed : 1;

    uint sendObject_bounds_changed : 1;

    uint sendObject_children_changed : 1;

//    uint sendObject_children_changed_add : 1;

//    uint sendObject_children_changed_remove : 1;

    uint sendObject_column_deleted : 1;

    uint sendObject_column_inserted : 1;

    uint sendObject_column_reordered : 1;

    uint sendObject_link_selected : 1;

    uint sendObject_model_changed : 1;

    uint sendObject_property_change : 1;

    uint sendObject_property_change_accessible_description : 1;

    uint sendObject_property_change_accessible_name : 1;

    uint sendObject_property_change_accessible_parent : 1;

    uint sendObject_property_change_accessible_role : 1;

    uint sendObject_property_change_accessible_table_caption : 1;

    uint sendObject_property_change_accessible_table_column_description : 1;

    uint sendObject_property_change_accessible_table_column_header : 1;

    uint sendObject_property_change_accessible_table_row_description : 1;

    uint sendObject_property_change_accessible_table_row_header : 1;

    uint sendObject_property_change_accessible_table_summary : 1;

    uint sendObject_property_change_accessible_value : 1;

    uint sendObject_row_deleted : 1;

    uint sendObject_row_inserted : 1;

    uint sendObject_row_reordered : 1;

    uint sendObject_selection_changed : 1;

    uint sendObject_state_changed : 1;

    uint sendObject_text_attributes_changed : 1;

    uint sendObject_text_bounds_changed : 1;

    uint sendObject_text_caret_moved : 1;

    uint sendObject_text_changed : 1;

//    uint sendObject_text_changed_delete : 1;

//    uint sendObject_text_changed_insert : 1;

    uint sendObject_text_selection_changed : 1;

    uint sendObject_value_changed : 1;

    uint sendObject_visible_data_changed : 1;


    // we don't implement terminal

    // terminal-application_changed/charwidth_changed/columncount_changed/line_changed/linecount_changed

    uint sendWindow : 1;

    uint sendWindow_activate : 1;

    uint sendWindow_close: 1;

    uint sendWindow_create : 1;

    uint sendWindow_deactivate : 1;

//    uint sendWindow_desktop_create : 1;

//    uint sendWindow_desktop_destroy : 1;

    uint sendWindow_lower : 1;

    uint sendWindow_maximize : 1;

    uint sendWindow_minimize : 1;

    uint sendWindow_move : 1;

    uint sendWindow_raise : 1;

    uint sendWindow_reparent : 1;

    uint sendWindow_resize : 1;

    uint sendWindow_restore : 1;

    uint sendWindow_restyle : 1;

    uint sendWindow_shade : 1;

    uint sendWindow_unshade : 1;

};


QT_END_NAMESPACE


#endif

AtSpiAdaptor
Definition atspiadaptor_p.h:37

AtSpiAdaptor::introspect
QString introspect(const QString &path) const override

AtSpiAdaptor::~AtSpiAdaptor
~AtSpiAdaptor()

AtSpiAdaptor::notify
void notify(QAccessibleEvent *event)

AtSpiAdaptor::windowActivated
void windowActivated(QObject *window, bool active)

AtSpiAdaptor::registerApplication
void registerApplication()

AtSpiAdaptor::eventListenerDeregistered
void eventListenerDeregistered(const QString &bus, const QString &path)

AtSpiAdaptor::AtSpiAdaptor
AtSpiAdaptor(DBusConnection *connection, QObject *parent=nullptr)

AtSpiAdaptor::handleMessage
bool handleMessage(const QDBusMessage &message, const QDBusConnection &connection) override
This function needs to handle all messages to the path of the virtual object, when the SubPath option...

AtSpiAdaptor::eventListenerRegistered
void eventListenerRegistered(const QString &bus, const QString &path)

DBusConnection
Connects to the accessibility dbus.
Definition dbusconnection_p.h:31

QDBusConnection
\inmodule QtDBus
Definition qdbusconnection.h:42

QDBusMessage
\inmodule QtDBus
Definition qdbusmessage.h:22

QDBusVirtualObject
\inmodule QtDBus
Definition qdbusvirtualobject.h:20

QList< QVariant >

QMap< QString, QString >

QObject
\inmodule QtCore
Definition qobject.h:103

QObject::parent
QObject * parent() const
Returns a pointer to the parent object.
Definition qobject.h:346

QPoint
\inmodule QtCore\reentrant
Definition qpoint.h:25

QRect
\inmodule QtCore\reentrant
Definition qrect.h:30

QSpiApplicationAdaptor
Definition qspiapplicationadaptor_p.h:35

QStringList
\inmodule QtCore

QString
\macro QT_RESTRICTED_CAST_FROM_ASCII
Definition qstring.h:129

QVariant
\inmodule QtCore
Definition qvariant.h:65

dbusconnection_p.h

arguments
QList< QVariant > arguments
Definition doc_src_qsignalspy.cpp:12

rect
rect
[4]
Definition doc_src_styles.cpp:43

state
else opt state
[0]
Definition doc_src_styles.cpp:11

QT_BEGIN_NAMESPACE
Combined button and popup list for selecting options.
Definition qstandardpaths_haiku.cpp:21

QT_END_NAMESPACE
Definition qsharedpointer.cpp:1590

interface
DBusConnection const char DBusError DBusBusType DBusError return DBusConnection DBusHandleMessageFunction void DBusFreeFunction return DBusConnection return DBusConnection return const char DBusError return DBusConnection DBusMessage dbus_uint32_t return DBusConnection dbus_bool_t DBusConnection DBusAddWatchFunction DBusRemoveWatchFunction DBusWatchToggledFunction void DBusFreeFunction return DBusConnection DBusDispatchStatusFunction void DBusFreeFunction DBusTimeout return DBusTimeout return DBusWatch return DBusWatch unsigned int return DBusError const DBusError return const DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessageIter int const void return DBusMessageIter DBusMessageIter return DBusMessageIter void DBusMessageIter void int return DBusMessage DBusMessageIter return DBusMessageIter return DBusMessageIter DBusMessageIter const char const char const char * interface
Definition qdbus_symbols_p.h:355

connection
DBusConnection * connection
Definition qdbus_symbols_p.h:163

value
EGLOutputLayerEXT EGLint EGLAttrib value
[5]
Definition qeglstreamconvenience_p.h:46

type
GLenum type
Definition qopengles2ext.h:150

message
GLuint GLsizei const GLchar * message
Definition qopengles2ext.h:154

offset
GLenum GLuint GLintptr offset
Definition qopengles2ext.h:660

coordType
GLsizei const GLubyte GLsizei GLenum coordType
Definition qopengles2ext.h:3164

name
GLuint name
Definition qopengles2ext.h:156

event
struct _cl_event * event
Definition qopenglext.h:2998

path
GLsizei const GLchar *const  * path
Definition qopenglext.h:4283

qspi_struct_marshallers_p.h

QSpiRelationArray
QList< QSpiRelationArrayEntry > QSpiRelationArray
Definition qspi_struct_marshallers_p.h:96

QSpiActionArray
QList< QSpiAction > QSpiActionArray
Definition qspi_struct_marshallers_p.h:78

QT_REQUIRE_CONFIG
#define QT_REQUIRE_CONFIG(feature)
Definition qtconfigmacros.h:68

Q_OBJECT
#define Q_OBJECT
Definition qtmetamacros.h:119

Q_SLOTS
#define Q_SLOTS
Definition qtmetamacros.h:44

uint
unsigned int uint
Definition qtypes.h:34

pos
pos
[7]
Definition src_corelib_io_qsettings.cpp:57

window
aWidget window() -> setWindowTitle("New Window Title")
[2]

argument
QDBusArgument argument
Definition src_qdbus_qdbusargument.cpp:16

QSpiObjectReference
Definition qspi_struct_marshallers_p.h:35