source: trunk/src/gui/accessible/qaccessiblebridge.cpp@ 711

Last change on this file since 711 was 651, checked in by Dmitry A. Kuminov, 16 years ago

trunk: Merged in qt 4.6.2 sources.

File size: 4.9 KB
Line 
1/****************************************************************************
2**
3** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
4** All rights reserved.
5** Contact: Nokia Corporation ([email protected])
6**
7** This file is part of the QtGui module of the Qt Toolkit.
8**
9** $QT_BEGIN_LICENSE:LGPL$
10** Commercial Usage
11** Licensees holding valid Qt Commercial licenses may use this file in
12** accordance with the Qt Commercial License Agreement provided with the
13** Software or, alternatively, in accordance with the terms contained in
14** a written agreement between you and Nokia.
15**
16** GNU Lesser General Public License Usage
17** Alternatively, this file may be used under the terms of the GNU Lesser
18** General Public License version 2.1 as published by the Free Software
19** Foundation and appearing in the file LICENSE.LGPL included in the
20** packaging of this file. Please review the following information to
21** ensure the GNU Lesser General Public License version 2.1 requirements
22** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
23**
24** In addition, as a special exception, Nokia gives you certain additional
25** rights. These rights are described in the Nokia Qt LGPL Exception
26** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
27**
28** GNU General Public License Usage
29** Alternatively, this file may be used under the terms of the GNU
30** General Public License version 3.0 as published by the Free Software
31** Foundation and appearing in the file LICENSE.GPL included in the
32** packaging of this file. Please review the following information to
33** ensure the GNU General Public License version 3.0 requirements will be
34** met: http://www.gnu.org/copyleft/gpl.html.
35**
36** If you have questions regarding the use of this file, please contact
37** Nokia at [email protected].
38** $QT_END_LICENSE$
39**
40****************************************************************************/
41
42#include "qaccessiblebridge.h"
43
44#ifndef QT_NO_ACCESSIBILITY
45
46QT_BEGIN_NAMESPACE
47
48/*!
49 \class QAccessibleBridge
50 \brief The QAccessibleBridge class is the base class for
51 accessibility back-ends.
52
53 \ingroup accessibility
54
55 Qt supports Microsoft Active Accessibility (MSAA), Mac OS X
56 Accessibility, and the Unix/X11 AT-SPI standard. By subclassing
57 QAccessibleBridge, you can support other backends than the
58 predefined ones.
59
60 Currently, custom bridges are only supported on Unix and OS/2. We might
61 add support for them on other platforms as well if there is
62 enough demand.
63
64 \sa QAccessible, QAccessibleBridgePlugin
65*/
66
67/*!
68 \fn QAccessibleBridge::~QAccessibleBridge()
69
70 Destroys the accessibility bridge object.
71*/
72
73/*!
74 \fn void QAccessibleBridge::setRootObject(QAccessibleInterface *object)
75
76 This function is called by Qt at application startup to set the
77 root accessible object of the application to \a object. All other
78 accessible objects in the application can be reached by the
79 client using object navigation.
80*/
81
82/*!
83 \fn void QAccessibleBridge::notifyAccessibilityUpdate(int reason, QAccessibleInterface *interface, int child)
84
85 This function is called by Qt to notify the bridge about a change
86 in the accessibility information for object wrapped by the given
87 \a interface.
88
89 \a reason specifies the cause of the change. It can take values
90 of type QAccessible::Event.
91
92 \a child is the (1-based) index of the child element that has
93 changed. When \a child is 0, the object itself has changed.
94
95 \sa QAccessible::updateAccessibility()
96*/
97
98/*!