accessible/qaccessible.cpp

qAccessibleFactories()->clear();

never executed: }

458 -

459 static void qAccessibleCleanup() -

460 { -

461

executed (the execution status of this line is deduced): qAccessibleFactories()->clear();

462

executed: }

Execution Count:1

463 -

464 /*! -

465 \typedef QAccessible::InterfaceFactory -

466 -

467 This is a typedef for a pointer to a function with the following -

468 signature: -

469 -

470 \snippet code/src_gui_accessible_qaccessible.cpp 1 -

471 -

472 The function receives a QString and a QObject pointer, where the -

473 QString is the key identifying the interface. The QObject is used -

474 to pass on to the QAccessibleInterface so that it can hold a reference -

475 to it. -

476 -

477 If the key and the QObject does not have a corresponding -

478 QAccessibleInterface, a null-pointer will be returned. -

479 -

480 Installed factories are called by queryAccessibilityInterface() until -

481 one provides an interface. -

482 */ -

483 -

484 /*! -

485 \typedef QAccessible::UpdateHandler -

486 -

487 \internal -

488 -

489 A function pointer type. Use a function with this prototype to install -

490 your own update function. -

491 -

492 The function is called by updateAccessibility(). -

493 */ -

494 -

495 /*! -

496 \typedef QAccessible::RootObjectHandler -

497 -

498 \internal -

499 -

500 A function pointer type. Use a function with this prototype to install -

501 your own root object handler. -

502 -

503 The function is called by setRootObject(). -

504 */ -

505 -

506 -

507 /*! -

508 Installs the InterfaceFactory \a factory. The last factory added -

509 is the first one used by queryAccessibleInterface(). -

510 */ -

511 void QAccessible::installFactory(InterfaceFactory factory) -

512 { -

513

if (!factory)

partially evaluated: !factory

TRUE	FALSE
no Evaluation Count:0	yes Evaluation Count:1

0-1

514

qAddPostRoutine(qAccessibleCleanup);

never executed: return;

515 -

516

if (!cleanupAdded) {

partially evaluated: !cleanupAdded

TRUE	FALSE
yes Evaluation Count:1	no Evaluation Count:0

0-1

517

executed (the execution status of this line is deduced): qAddPostRoutine(qAccessibleCleanup);

518

cleanupAdded = true;

executed (the execution status of this line is deduced): cleanupAdded = true;

519

if (qAccessibleFactories()->contains(factory))

executed: }

Execution Count:1

520

partially evaluated: qAccessibleFactories()->contains(factory)

TRUE	FALSE
no Evaluation Count:0	yes Evaluation Count:1

0-1

521

qAccessibleFactories()->append(factory);

never executed: return;

522

executed (the execution status of this line is deduced): qAccessibleFactories()->append(factory);

523

qAccessibleFactories()->removeAll(factory);

executed: }

Execution Count:1

524 -

525 /*! -

526 Removes \a factory from the list of installed InterfaceFactories. -

527 */ -

528 void QAccessible::removeFactory(InterfaceFactory factory) -

529 { -

530

never executed (the execution status of this line is deduced): qAccessibleFactories()->removeAll(factory);

531

UpdateHandler old = updateHandler;

never executed: }

532 -

533 /*! -

534 \internal -

535 -

536 Installs the given \a handler as the function to be used by -

537 updateAccessibility(), and returns the previously installed -

538 handler. -

539 */ -

540 QAccessible::UpdateHandler QAccessible::installUpdateHandler(UpdateHandler handler) -

541 { -

542

executed (the execution status of this line is deduced): UpdateHandler old = updateHandler;

543

updateHandler = handler;

executed (the execution status of this line is deduced): updateHandler = handler;

544

return old;

executed: return old;

Execution Count:2

545 } -

546 -

547 /*! -

548 Installs the given \a handler as the function to be used by setRootObject(), -

549 and returns the previously installed handler. -

550 */ -

551 QAccessible::RootObjectHandler QAccessible::installRootObjectHandler(RootObjectHandler handler) -

552 { -

553

RootObjectHandler old = rootObjectHandler;

executed (the execution status of this line is deduced): RootObjectHandler old = rootObjectHandler;

554

rootObjectHandler = handler;

executed (the execution status of this line is deduced): rootObjectHandler = handler;

555

return old;

executed: return old;

Execution Count:2

556 } -

557 -

558 /*! -

559 If a QAccessibleInterface implementation exists for the given \a object, -

560 this function returns a pointer to the implementation; otherwise it -

561 returns 0. -

562 -

563 The function calls all installed factory functions (from most -

564 recently installed to least recently installed) until one is found -

565 that provides an interface for the class of \a object. If no -

566 factory can provide an accessibility implementation for the class -

567 the function loads installed accessibility plugins, and tests if -

568 any of the plugins can provide the implementation. -

569 -

570 If no implementation for the object's class is available, the -

571 function tries to find an implementation for the object's parent -

572 class, using the above strategy. -

573 -

574 \warning The caller is responsible for deleting the returned -

575 interface after use. -

576 */ -

577 QAccessibleInterface *QAccessible::queryAccessibleInterface(QObject *object) -

578 { -

579

accessibility_active = true;

executed (the execution status of this line is deduced): accessibility_active = true;

580

if (!object)

partially evaluated: !object

TRUE	FALSE
no Evaluation Count:0	yes Evaluation Count:223

0-223

581

const QMetaObject *mo = object->metaObject();

never executed: return 0;

582 -

583

executed (the execution status of this line is deduced): const QMetaObject *mo = object->metaObject();

584

while (mo) {

evaluated: mo

TRUE	FALSE
yes Evaluation Count:280	yes Evaluation Count:2

2-280

585

const QString cn = QLatin1String(mo->className());

executed (the execution status of this line is deduced): const QString cn = QLatin1String(mo->className());

586

for (int i = qAccessibleFactories()->count(); i > 0; --i) {

evaluated: i > 0

TRUE	FALSE
yes Evaluation Count:280	yes Evaluation Count:278

278-280

587

InterfaceFactory factory = qAccessibleFactories()->at(i - 1);

executed (the execution status of this line is deduced): InterfaceFactory factory = qAccessibleFactories()->at(i - 1);

588

if (QAccessibleInterface *iface = factory(cn, object))

evaluated: QAccessibleInterface *iface = factory(cn, object)

TRUE	FALSE
yes Evaluation Count:2	yes Evaluation Count:278

2-278

589

return iface;

executed: return iface;

Execution Count:2

590

if (QAccessibleInterface * iface = qLoadPlugin1<QAccessibleInterface, QAccessiblePlugin>(loader(), cn, object))

executed: }

Execution Count:278

278

591 #ifndef QT_NO_ACCESSIBILITY -

592 #ifndef QT_NO_LIBRARY -

593

evaluated: QAccessibleInterface * iface = qLoadPlugin1<QAccessibleInterface, QAccessiblePlugin>(loader(), cn, object)

TRUE	FALSE
yes Evaluation Count:219	yes Evaluation Count:59

59-219

594

return iface;

executed: return iface;

Execution Count:219

219

595 #endif -

596 #endif -

597

mo = mo->superClass();

executed (the execution status of this line is deduced): mo = mo->superClass();

598

return new QAccessibleApplication;

executed: }

Execution Count:59

599 -

600 #ifndef QT_NO_ACCESSIBILITY -

601

if (object == qApp)

partially evaluated: object == (static_cast<QGuiApplication *>(QCoreApplication::instance()))

TRUE	FALSE
yes Evaluation Count:2	no Evaluation Count:0

0-2

602

executed: return new QAccessibleApplication;

Execution Count:2

603 #endif -

604 -

605

return accessibility_active;

never executed: return 0;

606 } -

607 -

608 /*! -

609 Returns true if an accessibility implementation has been requested -

610 during the runtime of the application; otherwise returns false. -

611 -

612 Use this function to prevent potentially expensive notifications via -

613 updateAccessibility(). -

614 */ -

615 bool QAccessible::isActive() -

616 { -

617

executed: return accessibility_active;

Execution Count:360373

360373

618 } -

619 -

620 -

621 -

622 /*! -

623 Sets the root object of the accessible objects of this application -

624 to \a object. All other accessible objects are reachable using object -

625 navigation from the root object. -

626 -

627 Normally, it isn't necessary to call this function, because Qt sets -

628 the QApplication object as the root object immediately before the -

629 event loop is entered in QApplication::exec(). -

630 -

631 Use QAccessible::installRootObjectHandler() to redirect the function -

632 call to a customized handler function. -

633 -

634 \sa queryAccessibleInterface() -

635 */ -

636 void QAccessible::setRootObject(QObject *object) -

637 { -

638

if (rootObjectHandler) {

partially evaluated: rootObjectHandler

TRUE	FALSE
no Evaluation Count:0	yes Evaluation Count:43

0-43

639

rootObjectHandler(object);

never executed (the execution status of this line is deduced): rootObjectHandler(object);

640

if (QPlatformAccessibility *pfAccessibility = platformAccessibility())

never executed: return;

641 } -

642 -

643 #ifndef QT_NO_ACCESSIBILITY -

644

partially evaluated: QPlatformAccessibility *pfAccessibility = platformAccessibility()

TRUE	FALSE
yes Evaluation Count:43	no Evaluation Count:0

0-43

645

pfAccessibility->setRootObject(object);

executed: pfAccessibility->setRootObject(object);

Execution Count:43

646 #endif -

647

executed: }

Execution Count:43

648 -

649 /*! -

650 Notifies about a change that might be relevant for accessibility clients. -

651 -

652 \a event provides details about the change. These include the source -

653 of the change and the nature of the change. The \a event should -

654 contain enough information give meaningful notifications. -

655 -

656 For example, the type \c ValueChange indicates that the position of -

657 a slider has been changed. -

658 -

659 Call this function whenever the state of your accessible object or -

660 one of its sub-elements has been changed either programmatically -

661 (e.g. by calling QLabel::setText()) or by user interaction. -

662 -

663 If there are no accessibility tools listening to this event, the -

664 performance penalty for calling this function is small, but if -

665 determining the parameters of the call is expensive you can test -

666 QAccessible::isActive() to avoid unnecessary computation. -

667 */ -

668 void QAccessible::updateAccessibility(QAccessibleEvent *event) -

669 { -

670

if (updateHandler) {

evaluated: updateHandler

TRUE	FALSE
yes Evaluation Count:857	yes Evaluation Count:85163

857-85163

671

updateHandler(event);

executed (the execution status of this line is deduced): updateHandler(event);

672

executed: return;

Execution Count:857

857

673 } -

674 -

675

if (!isActive())

partially evaluated: !isActive()

TRUE	FALSE
yes Evaluation Count:85163	no Evaluation Count:0

0-85163

676

if (QPlatformAccessibility *pfAccessibility = platformAccessibility())

executed: return;

Execution Count:85163

85163

677 -

678 #ifndef QT_NO_ACCESSIBILITY -

679

never evaluated: QPlatformAccessibility *pfAccessibility = platformAccessibility()

680

pfAccessibility->notifyAccessibilityUpdate(event);

never executed: pfAccessibility->notifyAccessibilityUpdate(event);

681 #endif -

682

return QVector<QPair<QAccessibleInterface*, QAccessible::Relation> >();

never executed: }

683 -

684 #if QT_DEPRECATED_SINCE(5, 0) -

685 /*! -

686 \obsolete -

687 \fn void QAccessible::updateAccessibility(QObject *object, int child, Event reason); -

688 -

689 \brief Use QAccessible::updateAccessibility(QAccessibleEvent*) instead. -

690 */ -

691 #endif -

692 -

693 /*! -

694 \class QAccessibleInterface -

695 \brief The QAccessibleInterface class defines an interface that exposes information -

696 about accessible objects. -

697 \internal -

698 -

699 \ingroup accessibility -

700 \inmodule QtGui -

701 -

702 This class is part of \l {Accessibility for QWidget Applications}. -

703 -

704 Accessibility tools (also called AT Clients), such as screen readers -

705 or braille displays, require high-level information about -

706 accessible objects in an application. Accessible objects provide -

707 specialized input and output methods, making it possible for users -

708 to use accessibility tools with enabled applications (AT Servers). -

709 -

710 Every element that the user needs to interact with or react to is -

711 an accessible object, and should provide this information. These -

712 are mainly visual objects, such as widgets and widget elements, but -

713 can also be content, such as sounds. -

714 -

715 The AT client uses three basic concepts to acquire information -

716 about any accessible object in an application: -

717 \list -

718 \li \e Properties The client can read information about -

719 accessible objects. In some cases the client can also modify these -

720 properties; such as text in a line edit. -

721 \li \e Actions The client can invoke actions like pressing a button -

722 or . -

723 \li \e{Relationships and Navigation} The client can traverse from one -

724 accessible object to another, using the relationships between objects. -

725 \endlist -

726 -

727 The QAccessibleInterface defines the API for these three concepts. -

728 -

729 \section1 Relationships and Navigation -

730 -

731 The functions childCount() and indexOfChild() return the number of -

732 children of an accessible object and the index a child object has -

733 in its parent. The childAt() function returns a child QAccessibleInterface -

734 that is found at a position. The child does not have to be a direct -

735 child. This allows bypassing intermediate layers when the parent already knows the -

736 top-most child. childAt() is used for hit testing (finding the object -

737 under the mouse). -

738 -

739 The relations() function provides information about the relations an -

740 object has to other objects, and parent() and child() allows -

741 traversing from one object to another object. -

742 -

743 \section1 Properties -

744 -

745 The central property of an accessible objects is what role() it -

746 has. Different objects can have the same role, e.g. both the "Add -

747 line" element in a scroll bar and the \c OK button in a dialog have -

748 the same role, "button". The role implies what kind of -

749 interaction the user can perform with the user interface element. -

750 -

751 An object's state() property is a combination of different state -

752 flags and can describe both how the object's state differs from a -

753 "normal" state, e.g. it might be unavailable, and also how it -

754 behaves, e.g. it might be selectable. -

755 -

756 The text() property provides textual information about the object. -

757 An object usually has a name, but can provide extended information -

758 such as a description, help text, or information about any -

759 keyboard accelerators it provides. Some objects allow changing the -

760 text() property through the setText() function, but this -

761 information is in most cases read-only. -

762 -

763 The rect() property provides information about the geometry of an -

764 accessible object. This information is usually only available for -

765 visual objects. -

766 -

767 \section1 Interfaces -

768 -

769 To enable the user to interact with an accessible object the -

770 object must implement QAccessibleActionInterface in addition to -

771 QAccessibleInterface. -

772 Objects that support selections can define actions to change the selection. -

773 -

774 There are several other interfaces that should be implemented as required. -

775 QAccessibleTextInterface should be used for bigger texts edits such as document views. -

776 This interface should not be implemented for labels/single line edits. -

777 The complementary QAccessibleEditableTextInterface should be added when the -

778 Text is editable. -

779 -

780 For sliders, scrollbars and other numerical value selectors QAccessibleValueInterface -

781 should be implemented. -

782 -

783 Lists, tables and trees should implement QAccessibleTableInterface. -

784 -

785 \sa QAccessible, QAccessibleActionInterface, QAccessibleTextInterface, QAccessibleEditableTextInterface, QAccessibleValueInterface, QAccessibleTableInterface -

786 */ -

787 -

788 /*! -

789 \fn bool QAccessibleInterface::isValid() const -

790 -

791 Returns true if all the data necessary to use this interface -

792 implementation is valid (e.g. all pointers are non-null); -

793 otherwise returns false. -

794 -

795 \sa object() -

796 */ -

797 -

798 /*! -

799 \fn QObject *QAccessibleInterface::object() const -

800 -

801 Returns a pointer to the QObject this interface implementation provides -

802 information for. -

803 -

804 \sa isValid() -

805 */ -

806 -

807 /*! -

808 \fn int QAccessibleInterface::childCount() const -

809 -

810 Returns the number of children that belong to this object. A child -

811 can provide accessibility information on its own (e.g. a child -

812 widget), or be a sub-element of this accessible object. -

813 -

814 All objects provide this information. -

815 -

816 \sa indexOfChild() -

817 */ -

818 -

819 /*! -

820 \fn int QAccessibleInterface::indexOfChild(const QAccessibleInterface *child) const -

821 -

822 Returns the 0-based index of the object \a child in this object's -

823 children list, or -1 if \a child is not a child of this object. -

824 -

825 All objects provide this information about their children. -

826 -

827 \sa childCount() -

828 */ -

829 -

830 /*! -

831 Returns the meaningful relations to other widgets. Usually this will not return parent/child -

832 relations, unless they are handled in a specific way such as in tree views. -

833 It will typically return the labelled-by and label relations. -

834 -

835 It is possible to filter the relations by using \a match. -

836 It should never return itself. -

837 -

838 \sa parent(), child() -

839 */ -

840 QVector<QPair<QAccessibleInterface*, QAccessible::Relation> > -

841 QAccessibleInterface::relations(QAccessible::Relation /*match = QAccessible::AllRelations*/) const -

842 { -

843

never executed: return QVector<QPair<QAccessibleInterface*, QAccessible::Relation> >();

844 } -

845 -

846 /*! -

847 Returns the object that has the keyboard focus. -

848 -

849 The object returned can be any descendant, including itself. -

850 */ -

851 QAccessibleInterface *QAccessibleInterface::focusChild() const -

852 { -

853

QAccessibleInterface *iface = QAccessible::queryAccessibleInterface(m_object);

never executed: return 0;

854 } -

855 -

856 /*! -

857 \fn QAccessibleInterface *QAccessibleInterface::childAt(int x, int y) const -

858 -

859 Returns the QAccessibleInterface of a child that contains the screen coordinates (\a x, \a y). -

860 If there are no children at this position this function returns 0. -

861 The returned accessible must be a child, but not necessarily a direct child. -

862 -

863 This function is only relyable for visible objects (invisible -

864 object might not be laid out correctly). -

865 -

866 All visual objects provide this information. -

867 -

868 A default implementation is provided for objects inheriting QAccessibleObject. This will iterate -

869 over all children. If the widget manages its children (e.g. a table) it will be more efficient -

870 to write a specialized implementation. -

871 -

872 \sa rect() -

873 */ -

874 -

875 /*! -

876 \fn QAccessibleInterface* QAccessibleInterface::parent() const -

877 -

878 Returns the QAccessibleInterface of the parent in the accessible object hierarchy. -

879 -

880 Returns 0 if no parent exists (e.g. for the top level application object). -

881 -

882 \sa child() -

883 */ -

884 -

885 /*! -

886 \fn QAccessibleInterface* QAccessibleInterface::child(int index) const -

887 -

888 Returns the accessible child with index \a index. -

889 0-based index. The number of children of an object can be checked with childCount. -

890 -

891 Returns 0 when asking for an invalid child (e.g. when the child became invalid in the meantime). -

892 -

893 \sa childCount(), parent() -

894 */ -

895 -

896 /*! -

897 \fn QString QAccessibleInterface::text(QAccessible::Text t) const -

898 -

899 Returns the value of the text property \a t of the object. -

900 -

901 The \l QAccessible::Name is a string used by clients to identify, find, or -

902 announce an accessible object for the user. All objects must have -

903 a name that is unique within their container. The name can be -

904 used differently by clients, so the name should both give a -

905 short description of the object and be unique. -

906 -

907 An accessible object's \l QAccessible::Description provides textual information -

908 about an object's visual appearance. The description is primarily -

909 used to provide greater context for vision-impaired users, but is -

910 also used for context searching or other applications. Not all -

911 objects have a description. An "OK" button would not need a -

912 description, but a tool button that shows a picture of a smiley -

913 would. -

914 -

915 The \l QAccessible::Value of an accessible object represents visual information -

916 contained by the object, e.g. the text in a line edit. Usually, -

917 the value can be modified by the user. Not all objects have a -

918 value, e.g. static text labels don't, and some objects have a -

919 state that already is the value, e.g. toggle buttons. -

920 -

921 The \l QAccessible::Help text provides information about the function and -

922 usage of an accessible object. Not all objects provide this -

923 information. -

924 -

925 The \l QAccessible::Accelerator is a keyboard shortcut that activates the -

926 object's default action. A keyboard shortcut is the underlined -

927 character in the text of a menu, menu item or widget, and is -

928 either the character itself, or a combination of this character -

929 and a modifier key like Alt, Ctrl or Shift. Command controls like -

930 tool buttons also have shortcut keys and usually display them in -

931 their tooltip. -

932 -

933 All objects provide a string for \l QAccessible::Name. -

934 -

935 \sa role(), state() -

936 */ -

937 -

938 /*! -

939 \fn void QAccessibleInterface::setText(QAccessible::Text t, const QString &text) -

940 -

941 Sets the text property \a t of the object to \a text. -

942 -

943 Note that the text properties of most objects are read-only -

944 so calling this function might have no effect. -

945 -

946 \sa text() -

947 */ -

948 -

949 /*! -

950 \fn QRect QAccessibleInterface::rect() const -

951 -

952 Returns the geometry of the object. The geometry is in screen coordinates. -

953 -

954 This function is only reliable for visible objects (invisible -

955 objects might not be laid out correctly). -

956 -

957 All visual objects provide this information. -

958 -

959 \sa childAt() -

960 */ -

961 -

962 /*! -

963 \fn QAccessible::Role QAccessibleInterface::role() const -

964 -

965 Returns the role of the object. -

966 The role of an object is usually static. -

967 -

968 All accessible objects have a role. -

969 -

970 \sa text(), state() -

971 */ -

972 -

973 /*! -

974 \fn QAccessible::State QAccessibleInterface::state() const -

975 -

976 Returns the current state of the object. -

977 The returned value is a combination of the flags in -

978 the QAccessible::StateFlag enumeration. -

979 -

980 All accessible objects have a state. -

981 -

982 \sa text(), role() -

983 */ -

984 -

985 -

986 /*! -

987 \fn QAccessibleEditableTextInterface *QAccessibleInterface::editableTextInterface() -

988 \internal -

989 */ -

990 -

991 /*! -

992 Returns the accessible's foreground color if applicable or an invalid QColor. -

993 -

994 \sa backgroundColor() -

995 */ -

996 QColor QAccessibleInterface::foregroundColor() const -

997 { -

998

return QColor();

never executed: return QColor();

999 } -

1000 -

1001 /*! -

1002 Returns the accessible's background color if applicable or an invalid QColor. -

1003 -

1004 \sa foregroundColor() -

1005 */ -

1006 QColor QAccessibleInterface::backgroundColor() const -

1007 { -

1008

return QColor();

never executed: return QColor();

1009 } -

1010 -

1011 /*! -

1012 \fn QAccessibleTextInterface *QAccessibleInterface::textInterface() -

1013 \internal -

1014 */ -

1015 -

1016 /*! -

1017 \fn QAccessibleValueInterface *QAccessibleInterface::valueInterface() -

1018 \internal -

1019 */ -

1020 -

1021 /*! -

1022 \fn QAccessibleTableInterface *QAccessibleInterface::tableInterface() -

1023 \internal -

1024 */ -

1025 -

1026 /*! -

1027 \fn QAccessibleTableCellInterface *QAccessibleInterface::tableCellInterface() -

1028 \internal -

1029 */ -

1030 -

1031 /*! -

1032 \fn QAccessibleActionInterface *QAccessibleInterface::actionInterface() -

1033 \internal -

1034 */ -

1035 -

1036 /*! -

1037 \fn QAccessibleImageInterface *QAccessibleInterface::imageInterface() -

1038 \internal -

1039 */ -

1040 -

1041 /*! -

1042 \class QAccessibleEvent -

1043 \internal -

1044 \ingroup accessibility -

1045 \inmodule QtGui -

1046 -

1047 \brief The QAccessibleEvent class contains parameters that describe updates in the -

1048 accessibility framework. -

1049 -

1050 This class is used with \l QAccessible::updateAccessibility(). -

1051 -

1052 The event type is one of the values of \l QAccessible::Event, which -

1053 determines the subclass of QAccessibleEvent that applies. -

1054 -

1055 To enable in process screen readers, all events must be sent after the change has happened. -

1056 */ -

1057 -

1058 /*! \fn QAccessibleEvent::QAccessibleEvent(QObject *object, QAccessible::Event type) -

1059 -

1060 Constructs a QAccessibleEvent to notify that \a object has changed. -

1061 The event \a type explains what changed. -

1062 */ -

1063 -

1064 /*! \fn QAccessibleEvent::~QAccessibleEvent() -

1065 Destroys the event. -

1066 */ -

1067 -

1068 /*! \fn QAccessible::Event QAccessibleEvent::type() const -

1069 Returns the event type. -

1070 */ -

1071 -

1072 /*! \fn QObject* QAccessibleEvent::object() const -

1073 Returns the event object. -

1074 */ -

1075 -

1076 /*! \fn void QAccessibleEvent::setChild(int child) -

1077 Sets the child index to \a child. -

1078 */ -

1079 -

1080 /*! \fn int QAccessibleEvent::child() const -

1081 Returns the child index. -

1082 */ -

1083 -

1084 -

1085 /*! -

1086 \class QAccessibleValueChangeEvent -

1087 \internal -

1088 \ingroup accessibility -

1089 \inmodule QtGui -

1090 -

1091 \brief The QAccessibleValueChangeEvent describes a change in value for an accessible object. -

1092 -

1093 It contains the new value. -

1094 -

1095 This class is used with \l QAccessible::updateAccessibility(). -

1096 */ -

1097 -

1098 /*! \fn QAccessibleValueChangeEvent::QAccessibleValueChangeEvent(QObject *object, const QVariant &value) -

1099 Constructs a new QAccessibleValueChangeEvent for \a object. -

1100 The event contains the new \a value. -

1101 */ -

1102 /*! \fn void QAccessibleValueChangeEvent::setValue(const QVariant & value) -

1103 Sets the new \a value for this event. -

1104 */ -

1105 /*! -

1106 \fn QVariant QAccessibleValueChangeEvent::value() const -

1107 -

1108 Returns the new value of the accessible object of this event. -

1109 */ -

1110 -

1111 /*! -

1112 \class QAccessibleStateChangeEvent -

1113 \internal -

1114 \ingroup accessibility -

1115 \inmodule QtGui -

1116 -

1117 \brief The QAccessibleStateChangeEvent notfies the accessibility framework -

1118 that the state of an object has changed. -

1119 -

1120 This class is used with \l QAccessible::updateAccessibility(). -

1121 -

1122 \sa QAccessibleInterface::state() -

1123 */ -

1124 /*! \fn QAccessibleStateChangeEvent::QAccessibleStateChangeEvent(QObject *object, QAccessible::State state) -

1125 Constructs a new QAccessibleStateChangeEvent for \a object. -

1126 The difference to the object's previous state is in \a state. -

1127 */ -

1128 /*! -

1129 \fn QAccessible::State QAccessibleStateChangeEvent::changedStates() const -

1130 \internal -

1131 -

1132 \brief Returns the states that have been changed. -

1133 -

1134 Be aware that the returned states are the ones that have changed, -

1135 to find out about the state of an object, use QAccessibleInterface::state(). -

1136 -

1137 For example, if an object used to have the focus but loses it, -

1138 the object's state will have focused set to \c false. This event on the -

1139 other hand tells about the change and has focused set to \c true since -

1140 the focus state is changed from \c true to \c false. -

1141 */ -

1142 -

1143 -

1144 /*! -

1145 \class QAccessibleTableModelChangeEvent -

1146 \internal -

1147 \ingroup accessibility -

1148 \inmodule QtGui -

1149 -

1150 \brief The QAccessibleTableModelChangeEvent signifies a change in a table, list, or tree where cells -

1151 are added or removed. -

1152 If the change affected a number of rows, firstColumn and lastColumn will return \c -1. -

1153 Likewise for columns, the row functions may return \c -1. -

1154 -

1155 This class is used with \l QAccessible::updateAccessibility(). -

1156 */ -

1157 -

1158 /*! \enum QAccessibleTableModelChangeEvent::ModelChangeType -

1159 This enum describes different types of changes in the table model. -

1160 \value ModelReset The model has been reset, all previous knowledge about the model is now invalid. -

1161 \value DataChanged No cells have been added or removed, but the data of the specified cell range is invalid. -

1162 \value RowsInserted New rows have been inserted. -

1163 \value ColumnsInserted New columns have been inserted. -

1164 \value RowsRemoved Rows have been removed. -

1165 \value ColumnsRemoved Columns have been removed. -

1166 */ -

1167 /*! \fn QAccessibleTableModelChangeEvent::QAccessibleTableModelChangeEvent(QObject *object, ModelChangeType changeType) -

1168 Constructs a new QAccessibleTableModelChangeEvent for \a object of with \a changeType. -

1169 */ -

1170 /*! \fn int QAccessibleTableModelChangeEvent::firstColumn() const -

1171 Returns the first changed column. -

1172 */ -

1173 /*! \fn int QAccessibleTableModelChangeEvent::firstRow() const -

1174 Returns the first changed row. -

1175 */ -

1176 /*! \fn int QAccessibleTableModelChangeEvent::lastColumn() const -

1177 Returns the last changed column. -

1178 */ -

1179 /*! \fn int QAccessibleTableModelChangeEvent::lastRow() const -

1180 Returns the last changed row. -

1181 */ -

1182 /*! \fn QAccessibleTableModelChangeEvent::ModelChangeType QAccessibleTableModelChangeEvent::modelChangeType() const -

1183 Returns the type of change. -

1184 */ -

1185 /*! \fn void QAccessibleTableModelChangeEvent::setFirstColumn(int column) -

1186 Sets the first changed \a column. -

1187 */ -

1188 /*! \fn void QAccessibleTableModelChangeEvent::setFirstRow(int row) -

1189 Sets the first changed \a row. -

1190 */ -

1191 /*! \fn void QAccessibleTableModelChangeEvent::setLastColumn(int column) -

1192 Sets the last changed \a column. -

1193 */ -

1194 /*! \fn void QAccessibleTableModelChangeEvent::setLastRow(int row) -

1195 Sets the last changed \a row. -

1196 */ -

1197 /*! \fn void QAccessibleTableModelChangeEvent::setModelChangeType(ModelChangeType changeType) -

1198 Sets the type of change to \a changeType. -

1199 */ -

1200 -

1201 -

1202 /*! -

1203 \class QAccessibleTextCursorEvent -

1204 \internal -

1205 \ingroup accessibility -

1206 \inmodule QtGui -

1207 -

1208 \brief The QAccessibleEvent class -

1209 -

1210 This class is used with \l QAccessible::updateAccessibility(). -

1211 */ -

1212 /*! \fn QAccessibleTextCursorEvent::QAccessibleTextCursorEvent(QObject *object, int cursorPosition) -

1213 Create a new QAccessibleTextCursorEvent for \a object. -

1214 The \a cursorPosition is the new cursor position. -

1215 */ -

1216 /*! \fn int QAccessibleTextCursorEvent::cursorPosition() const -

1217 Returns the cursor position. -

1218 */ -

1219 /*! \fn void QAccessibleTextCursorEvent::setCursorPosition(int position) -

1220 Sets the cursor \a position for this event. -

1221 */ -

1222 -

1223 /*! -

1224 \class QAccessibleTextInsertEvent -

1225 \internal -

1226 \ingroup accessibility -

1227 \inmodule QtGui -

1228 -

1229 \brief The QAccessibleEvent class -

1230 -

1231 This class is used with \l QAccessible::updateAccessibility(). -

1232 */ -

1233 /*! \fn QAccessibleTextInsertEvent::QAccessibleTextInsertEvent(QObject *object, int position, const QString &text) -

1234 Constructs a new QAccessibleTextInsertEvent event for \a object. -

1235 The \a text has been inserted at \a position. -

1236 By default, it is assumed that the cursor has moved to the end -

1237 of the selection. If that is not the case, one needs to manually -

1238 set it with \l QAccessibleTextCursorEvent::setCursorPosition for this event. -

1239 */ -

1240 /*! \fn int QAccessibleTextInsertEvent::changePosition() const -

1241 Returns the position where the text was inserted. -

1242 */ -

1243 /*! \fn QString QAccessibleTextInsertEvent::textInserted() const -

1244 Returns the text that has been inserted. -

1245 */ -

1246 -

1247 /*! -

1248 \class QAccessibleTextRemoveEvent -

1249 \internal -

1250 \ingroup accessibility -

1251 \inmodule QtGui -

1252 -

1253 \brief The QAccessibleEvent class -

1254 -

1255 This class is used with \l QAccessible::updateAccessibility(). -

1256 */ -

1257 /*! \fn QAccessibleTextRemoveEvent::QAccessibleTextRemoveEvent(QObject *object, int position, const QString &text) -

1258 Constructs a new QAccessibleTextRemoveEvent event for \a object. -

1259 The \a text has been removed at \a position. -

1260 By default it is assumed that the cursor has moved to \a position. -

1261 If that is not the case, one needs to manually -

1262 set it with \l QAccessibleTextCursorEvent::setCursorPosition for this event. -

1263 */ -

1264 -

1265 /*! \fn int QAccessibleTextRemoveEvent::changePosition() const -

1266 Returns the position where the text was removed. -

1267 */ -

1268 /*! \fn QString QAccessibleTextRemoveEvent::textRemoved() const -

1269 Returns the text that has been removed. -

1270 */ -

1271 -

1272 /*! -

1273 \class QAccessibleTextUpdateEvent -

1274 \internal -

1275 \ingroup accessibility -

1276 \inmodule QtGui -

1277 -

1278 \brief The QAccessibleEvent class notifies about text changes. -

1279 This is for accessibles that support editable text such as line edits. -

1280 This event occurs for example when a portion of selected text -

1281 gets replaced by pasting a new text or in override mode of editors. -

1282 -

1283 This class is used with \l QAccessible::updateAccessibility(). -

1284 */ -

1285 /*! \fn QAccessibleTextUpdateEvent::QAccessibleTextUpdateEvent(QObject *object, int position, const QString &oldText, const QString &text) -

1286 Constructs a new QAccessibleTextUpdateEvent for \a object. -

1287 The text change takes place at \a position where the \a oldText was removed and \a text inserted instead. -

1288 */ -

1289 /*! \fn int QAccessibleTextUpdateEvent::changePosition() const -

1290 Returns where the change took place. -

1291 */ -

1292 /*! \fn QString QAccessibleTextUpdateEvent::textInserted() const -

1293 Returns the inserted text. -

1294 */ -

1295 /*! \fn QString QAccessibleTextUpdateEvent::textRemoved() const -

1296 Returns the removed text. -

1297 */ -

1298 -

1299 /*! -

1300 \class QAccessibleTextSelectionEvent -

1301 \internal -

1302 \ingroup accessibility -

1303 \inmodule QtGui -

1304 -

1305 \brief The QAccessibleEvent class -

1306 -

1307 This class is used with \l QAccessible::updateAccessibility(). -

1308 */ -

1309 /*! \fn QAccessibleTextSelectionEvent::QAccessibleTextSelectionEvent(QObject *object, int start, int end) -

1310 Constructs a new QAccessibleTextSelectionEvent for \a object. -

1311 The new selection this event notifies about is from position \a start to \a end. -

1312 */ -

1313 /*! \fn int QAccessibleTextSelectionEvent::selectionEnd() const -

1314 Returns the position of the last selected character. -

1315 */ -

1316 /*! \fn int QAccessibleTextSelectionEvent::selectionStart() const -

1317 Returns the position of the first selected character. -

1318 */ -

1319 /*! \fn void QAccessibleTextSelectionEvent::setSelection(int start, int end) -

1320 Sets the selection for this event from position \a start to \a end. -

1321 */ -

1322 -

1323 -

1324 -

1325 /*! -

1326 Returns the QAccessibleInterface associated with the event. -

1327 The caller of this function takes ownership of the returned interface. -

1328 */ -

1329 QAccessibleInterface *QAccessibleEvent::accessibleInterface() const -

1330 { -

1331

never executed (the execution status of this line is deduced): QAccessibleInterface *iface = QAccessible::queryAccessibleInterface(m_object);

1332

if (!iface) {

never evaluated: !iface

1333

qWarning() << "Cannot create accessible interface for object: " << m_object;

never executed (the execution status of this line is deduced):

 QMessageLogger("accessible/qaccessible.cpp", 1333, __PRETTY_FUNCTION__).warning() << "Cannot create accessible interface for object: " << m_object;

1334

QAccessibleInterface *child = iface->child(m_child);

never executed: return 0;

1335 } -

1336 -

1337

if (m_child >= 0) {

never evaluated: m_child >= 0

1338

never executed (the execution status of this line is deduced): QAccessibleInterface *child = iface->child(m_child);

1339

if (child) {

never evaluated: child

1340

delete iface;

never executed (the execution status of this line is deduced): delete iface;

1341

iface = child;

never executed (the execution status of this line is deduced): iface = child;

1342

} else {

never executed: }

1343

qWarning() << "Cannot creat accessible child interface for object: " << m_object << " index: " << m_child;

never executed (the execution status of this line is deduced):

 QMessageLogger("accessible/qaccessible.cpp", 1343, __PRETTY_FUNCTION__).warning() << "Cannot creat accessible child interface for object: " << m_object << " index: " << m_child;

1344

never executed: }

1345 } -

1346

return iface;

never executed: return iface;

1347 } -

1348 -

1349 /*! -

1350 Returns the window associated with the underlying object. -

1351 For instance, QAccessibleWidget reimplements this and returns -

1352 the windowHandle() of the QWidget. -

1353 -

1354 It is used on some platforms to be able to notify the AT client about -

1355 state changes. -

1356 The backend will traverse up all ancestors until it finds a window. -

1357 (This means that at least one interface among the ancestors should -

1358 return a valid QWindow pointer). -

1359 -

1360 The default implementation of this returns 0. -

1361 \internal -

1362 */ -

1363 QWindow *QAccessibleInterface::window() const -

1364 { -

1365

role = QAccessible::UserRole;

never executed: return 0;

1366 } -

1367 -

1368 /*! -

1369 \internal -

1370 Method to allow extending this class without breaking binary compatibility. -

1371 The actual behavior and format of \a data depends on \a id argument -

1372 which must be defined if the class is to be extended with another virtual -

1373 function. -

1374 Currently, this is unused. -

1375 */ -

1376 void QAccessibleInterface::virtual_hook(int /*id*/, void * /*data*/) -

1377 { -

1378 } -

1379 -

1380 /*! -

1381 \fn void *QAccessibleInterface::interface_cast(QAccessible::InterfaceType type) -

1382 -

1383 Returns a specialized accessibility interface \a type from the -

1384 generic QAccessibleInterface. -

1385 -

1386 This function must be reimplemented when providing more -

1387 information about a widget or object through the specialized -

1388 interfaces. For example a line edit should implement the -

1389 QAccessibleTextInterface and QAccessibleEditableTextInterface. -

1390 -

1391 Qt's QLineEdit for example has its accessibility support -

1392 implemented in QAccessibleLineEdit. -

1393 -

1394 \code -

1395 void *QAccessibleLineEdit::interface_cast(QAccessible::InterfaceType t) -

1396 { -

1397 if (t == QAccessible::TextInterface) -

1398 return static_cast<QAccessibleTextInterface*>(this); -

1399 else if (t == QAccessible::EditableTextInterface) -

1400 return static_cast<QAccessibleEditableTextInterface*>(this); -

1401 return QAccessibleWidget::interface_cast(t); -

1402 } -

1403 \endcode -

1404 -

1405 \sa QAccessible::InterfaceType, QAccessibleTextInterface, -

1406 QAccessibleEditableTextInterface, QAccessibleValueInterface, -

1407 QAccessibleActionInterface, QAccessibleTableInterface, -

1408 QAccessibleTableCellInterface -

1409 */ -

1410 -

1411 /*! \internal */ -

1412 const char *qAccessibleRoleString(QAccessible::Role role) -

1413 { -

1414

if (role >=0x40)

never evaluated: role >=0x40

1415

never executed: role = QAccessible::UserRole;

1416 static int roleEnum = QAccessible::staticMetaObject.indexOfEnumerator("Role"); -

1417

return QAccessible::staticMetaObject.enumerator(roleEnum).valueToKey(role);

never executed: return QAccessible::staticMetaObject.enumerator(roleEnum).valueToKey(role);

1418 } -

1419 -

1420 /*! \internal */ -

1421 const char *qAccessibleEventString(QAccessible::Event event) -

1422 { -

1423 static int eventEnum = QAccessible::staticMetaObject.indexOfEnumerator("Event"); -

1424

return QAccessible::staticMetaObject.enumerator(eventEnum).valueToKey(event);

executed: return QAccessible::staticMetaObject.enumerator(eventEnum).valueToKey(event);

Execution Count:2

1425 } -

1426 -

1427 /*! \internal */ -

1428 bool operator==(const QAccessible::State &first, const QAccessible::State &second) -

1429 { -

1430

return memcmp(&first, &second, sizeof(QAccessible::State)) == 0;

executed: return memcmp(&first, &second, sizeof(QAccessible::State)) == 0;

Execution Count:16

1431 } -

1432 -

1433 #ifndef QT_NO_DEBUG_STREAM -

1434 Q_GUI_EXPORT QDebug operator<<(QDebug d, const QAccessibleInterface *iface) -

1435 { -

1436

if (!iface) {

never evaluated: !iface

1437

d << "QAccessibleInterface(null)";

never executed (the execution status of this line is deduced): d << "QAccessibleInterface(null)";

1438

return d;

never executed: return d;

1439 } -

1440

d.nospace();

never executed (the execution status of this line is deduced): d.nospace();

1441

d << "QAccessibleInterface(" << hex << (void *) iface << dec;

never executed (the execution status of this line is deduced): d << "QAccessibleInterface(" << hex << (void *) iface << dec;

1442

if (iface->isValid()) {

never evaluated: iface->isValid()

1443

d << " name=" << iface->text(QAccessible::Name) << " ";

never executed (the execution status of this line is deduced): d << " name=" << iface->text(QAccessible::Name) << " ";

1444

d << "role=" << qAccessibleRoleString(iface->role()) << " ";

never executed (the execution status of this line is deduced): d << "role=" << qAccessibleRoleString(iface->role()) << " ";

1445

if (iface->childCount())

never evaluated: iface->childCount()

1446

d << "childc=" << iface->childCount() << " ";

never executed: d << "childc=" << iface->childCount() << " ";

1447

if (iface->object()) {

never evaluated: iface->object()

1448

d << "obj=" << iface->object();

never executed (the execution status of this line is deduced): d << "obj=" << iface->object();

1449