Qt 4.8
Public Functions | List of all members
QAccessibleDisplay Class Reference

The QAccessibleDisplay class implements the QAccessibleInterface for widgets that display information. More...

#include <simplewidgets.h>

Inheritance diagram for QAccessibleDisplay:
QAccessibleWidgetEx QAccessibleImageInterface QAccessibleObjectEx QAccessible2Interface QAccessibleInterfaceEx QAccessibleInterface QAccessible QAccessibleProgressBar

Public Functions

QString imageDescription ()
 
QRect imagePosition (QAccessible2::CoordinateType coordType)
 
QSize imageSize ()
 
int navigate (RelationFlag, int entry, QAccessibleInterface **target) const
 Reimplemented Function More...
 
 QAccessibleDisplay (QWidget *w, Role role=StaticText)
 Constructs a QAccessibleDisplay object for w. More...
 
Relation relationTo (int child, const QAccessibleInterface *other, int otherChild) const
 Reimplemented Function More...
 
Role role (int child) const
 Reimplemented Function More...
 
QString text (Text t, int child) const
 Reimplemented Function More...
 
- Public Functions inherited from QAccessibleWidgetEx
QString actionText (int action, Text t, int child) const
 Returns the text property t of the action action supported by the object, or of the object's child if child is not 0. More...
 
int childAt (int x, int y) const
 Returns the 1-based index of the child that contains the screen coordinates (x, y). More...
 
int childCount () const
 Returns the number of children that belong to this object. More...
 
bool doAction (int action, int child, const QVariantList &params)
 Asks the object, or the object's child if child is not 0, to execute action using the parameters, params. More...
 
int indexOfChild (const QAccessibleInterface *child) const
 Returns the 1-based index of the object child in this object's children list, or -1 if child is not a child of this object. More...
 
QVariant invokeMethodEx (Method method, int child, const QVariantList &params)
 
 QAccessibleWidgetEx (QWidget *o, Role r=Client, const QString &name=QString())
 
QRect rect (int child) const
 Returns the geometry of the object, or of the object's child if child is not 0. More...
 
State state (int child) const
 Returns the current state of the object, or of the object's child if child is not 0. More...
 
- Public Functions inherited from QAccessibleObjectEx
bool isValid () const
 Returns true if all the data necessary to use this interface implementation is valid (e. More...
 
QObjectobject () const
 Returns a pointer to the QObject this interface implementation provides information for. More...
 
 QAccessibleObjectEx (QObject *object)
 
void setText (Text t, int child, const QString &text)
 Sets the text property t of the object, or of the object's child if child is not 0, to text. More...
 
int userActionCount (int child) const
 Returns the number of custom actions of the object, or of the object's child if child is not 0. More...
 
- Public Functions inherited from QAccessibleInterfaceEx
virtual QAccessible2Interfaceinterface_cast (QAccessible2::InterfaceType)
 
virtual QVariant virtual_hook (const QVariant &data)
 
- Public Functions inherited from QAccessibleInterface
QAccessibleActionInterfaceactionInterface ()
 
QColor backgroundColor ()
 
QAccessibleEditableTextInterfaceeditableTextInterface ()
 
QColor foregroundColor ()
 
QAccessibleImageInterfaceimageInterface ()
 
QVariant invokeMethod (Method method, int child=0, const QVariantList &params=QVariantList())
 Invokes a method on child with the given parameters params and returns the result of the operation as QVariant. More...
 
QSet< MethodsupportedMethods ()
 Returns a QSet of QAccessible::Method that are supported by this accessible interface. More...
 
QAccessibleTable2Interfacetable2Interface ()
 
QAccessibleTableInterfacetableInterface ()
 
QAccessibleTextInterfacetextInterface ()
 
QAccessibleValueInterfacevalueInterface ()
 
virtual ~QAccessibleInterface ()
 Destroys the object. More...
 
- Public Functions inherited from QAccessibleImageInterface
QAccessible2InterfaceqAccessibleImageCastHelper ()
 
- Public Functions inherited from QAccessible2Interface
virtual ~QAccessible2Interface ()
 

Additional Inherited Members

- Public Types inherited from QAccessible
enum  Action {
  DefaultAction = 0, Press = -1, FirstStandardAction = Press, SetFocus = -2,
  Increase = -3, Decrease = -4, Accept = -5, Cancel = -6,
  Select = -7, ClearSelection = -8, RemoveSelection = -9, ExtendSelection = -10,
  AddToSelection = -11, LastStandardAction = AddToSelection
}
 This enum describes the possible types of action that can occur. More...
 
enum  Event {
  SoundPlayed = 0x0001, Alert = 0x0002, ForegroundChanged = 0x0003, MenuStart = 0x0004,
  MenuEnd = 0x0005, PopupMenuStart = 0x0006, PopupMenuEnd = 0x0007, ContextHelpStart = 0x000C,
  ContextHelpEnd = 0x000D, DragDropStart = 0x000E, DragDropEnd = 0x000F, DialogStart = 0x0010,
  DialogEnd = 0x0011, ScrollingStart = 0x0012, ScrollingEnd = 0x0013, MenuCommand = 0x0018,
  ActionChanged = 0x0101, ActiveDescendantChanged = 0x0102, AttributeChanged = 0x0103, DocumentContentChanged = 0x0104,
  DocumentLoadComplete = 0x0105, DocumentLoadStopped = 0x0106, DocumentReload = 0x0107, HyperlinkEndIndexChanged = 0x0108,
  HyperlinkNumberOfAnchorsChanged = 0x0109, HyperlinkSelectedLinkChanged = 0x010A, HypertextLinkActivated = 0x010B, HypertextLinkSelected = 0x010C,
  HyperlinkStartIndexChanged = 0x010D, HypertextChanged = 0x010E, HypertextNLinksChanged = 0x010F, ObjectAttributeChanged = 0x0110,
  PageChanged = 0x0111, SectionChanged = 0x0112, TableCaptionChanged = 0x0113, TableColumnDescriptionChanged = 0x0114,
  TableColumnHeaderChanged = 0x0115, TableModelChanged = 0x0116, TableRowDescriptionChanged = 0x0117, TableRowHeaderChanged = 0x0118,
  TableSummaryChanged = 0x0119, TextAttributeChanged = 0x011A, TextCaretMoved = 0x011B, TextColumnChanged = 0x011D,
  TextInserted = 0x011E, TextRemoved = 0x011F, TextUpdated = 0x0120, TextSelectionChanged = 0x0121,
  VisibleDataChanged = 0x0122, ObjectCreated = 0x8000, ObjectDestroyed = 0x8001, ObjectShow = 0x8002,
  ObjectHide = 0x8003, ObjectReorder = 0x8004, Focus = 0x8005, Selection = 0x8006,
  SelectionAdd = 0x8007, SelectionRemove = 0x8008, SelectionWithin = 0x8009, StateChanged = 0x800A,
  LocationChanged = 0x800B, NameChanged = 0x800C, DescriptionChanged = 0x800D, ValueChanged = 0x800E,
  ParentChanged = 0x800F, HelpChanged = 0x80A0, DefaultActionChanged = 0x80B0, AcceleratorChanged = 0x80C0
}
 This enum type defines accessible event types. More...
 
typedef QAccessibleInterface *(* InterfaceFactory) (const QString &key, QObject *)
 This is a typedef for a pointer to a function with the following signature: More...
 
enum  Method {
  ListSupportedMethods = 0, SetCursorPosition = 1, GetCursorPosition = 2, ForegroundColor = 3,
  BackgroundColor = 4
}
 This enum describes the possible types of methods that can be invoked on an accessible object. More...
 
enum  RelationFlag {
  Unrelated = 0x00000000, Self = 0x00000001, Ancestor = 0x00000002, Child = 0x00000004,
  Descendent = 0x00000008, Sibling = 0x00000010, HierarchyMask = 0x000000ff, Up = 0x00000100,
  Down = 0x00000200, Left = 0x00000400, Right = 0x00000800, Covers = 0x00001000,
  Covered = 0x00002000, GeometryMask = 0x0000ff00, FocusChild = 0x00010000, Label = 0x00020000,
  Labelled = 0x00040000, Controller = 0x00080000, Controlled = 0x00100000, LogicalMask = 0x00ff0000
}
 This enum type defines bit flags that can be combined to indicate the relationship between two accessible objects. More...
 
enum  Role {
  NoRole = 0x00000000, TitleBar = 0x00000001, MenuBar = 0x00000002, ScrollBar = 0x00000003,
  Grip = 0x00000004, Sound = 0x00000005, Cursor = 0x00000006, Caret = 0x00000007,
  AlertMessage = 0x00000008, Window = 0x00000009, Client = 0x0000000A, PopupMenu = 0x0000000B,
  MenuItem = 0x0000000C, ToolTip = 0x0000000D, Application = 0x0000000E, Document = 0x0000000F,
  Pane = 0x00000010, Chart = 0x00000011, Dialog = 0x00000012, Border = 0x00000013,
  Grouping = 0x00000014, Separator = 0x00000015, ToolBar = 0x00000016, StatusBar = 0x00000017,
  Table = 0x00000018, ColumnHeader = 0x00000019, RowHeader = 0x0000001A, Column = 0x0000001B,
  Row = 0x0000001C, Cell = 0x0000001D, Link = 0x0000001E, HelpBalloon = 0x0000001F,
  Assistant = 0x00000020, List = 0x00000021, ListItem = 0x00000022, Tree = 0x00000023,
  TreeItem = 0x00000024, PageTab = 0x00000025, PropertyPage = 0x00000026, Indicator = 0x00000027,
  Graphic = 0x00000028, StaticText = 0x00000029, EditableText = 0x0000002A, PushButton = 0x0000002B,
  CheckBox = 0x0000002C, RadioButton = 0x0000002D, ComboBox = 0x0000002E, ProgressBar = 0x00000030,
  Dial = 0x00000031, HotkeyField = 0x00000032, Slider = 0x00000033, SpinBox = 0x00000034,
  Canvas = 0x00000035, Animation = 0x00000036, Equation = 0x00000037, ButtonDropDown = 0x00000038,
  ButtonMenu = 0x00000039, ButtonDropGrid = 0x0000003A, Whitespace = 0x0000003B, PageTabList = 0x0000003C,
  Clock = 0x0000003D, Splitter = 0x0000003E, LayeredPane = 0x0000003F, Terminal = 0x00000040,
  Desktop = 0x00000041, UserRole = 0x0000ffff
}
 This enum defines the role of an accessible object. More...
 
typedef void(* RootObjectHandler) (QObject *)
 A function pointer type. More...
 
enum  StateFlag {
  Normal = 0x00000000, Unavailable = 0x00000001, Selected = 0x00000002, Focused = 0x00000004,
  Pressed = 0x00000008, Checked = 0x00000010, Mixed = 0x00000020, ReadOnly = 0x00000040,
  HotTracked = 0x00000080, DefaultButton = 0x00000100, Expanded = 0x00000200, Collapsed = 0x00000400,
  Busy = 0x00000800, Marqueed = 0x00002000, Animated = 0x00004000, Invisible = 0x00008000,
  Offscreen = 0x00010000, Sizeable = 0x00020000, Movable = 0x00040000, SelfVoicing = 0x00080000,
  Focusable = 0x00100000, Selectable = 0x00200000, Linked = 0x00400000, Traversed = 0x00800000,
  MultiSelectable = 0x01000000, ExtSelectable = 0x02000000, Protected = 0x20000000, HasPopup = 0x40000000,
  Modal = 0x80000000, HasInvokeExtension = 0x10000000
}
 This enum type defines bit flags that can be combined to indicate the state of an accessible object. More...
 
enum  Text {
  Name = 0, Description, Value, Help,
  Accelerator, UserText = 0x0000ffff
}
 This enum specifies string information that an accessible object returns. More...
 
typedef void(* UpdateHandler) (QObject *, int who, Event reason)
 A function pointer type. More...
 
- Static Public Functions inherited from QAccessible
static void cleanup ()
 
static void initialize ()
 
static void installFactory (InterfaceFactory)
 Installs the InterfaceFactory factory. More...
 
static RootObjectHandler installRootObjectHandler (RootObjectHandler)
 Installs the given handler as the function to be used by setRootObject(), and returns the previously installed handler. More...
 
static UpdateHandler installUpdateHandler (UpdateHandler)
 Installs the given handler as the function to be used by updateAccessibility(), and returns the previously installed handler. More...
 
static bool isActive ()
 Returns true if an accessibility implementation has been requested during the runtime of the application; otherwise returns false. More...
 
static QAccessibleInterfacequeryAccessibleInterface (QObject *)
 If a QAccessibleInterface implementation exists for the given object, this function returns a pointer to the implementation; otherwise it returns 0. More...
 
static void removeFactory (InterfaceFactory)
 Removes factory from the list of installed InterfaceFactories. More...
 
static void setRootObject (QObject *)
 Sets the root accessible object of this application to object. More...
 
static void updateAccessibility (QObject *, int who, Event reason)
 Notifies accessibility clients about a change in object's accessibility information. More...
 
- Protected Functions inherited from QAccessibleWidgetEx
void addControllingSignal (const QString &signal)
 
QObjectparentObject () const
 
void setAccelerator (const QString &accel)
 
void setDescription (const QString &desc)
 
void setHelp (const QString &help)
 
void setValue (const QString &value)
 
QWidgetwidget () const
 
 ~QAccessibleWidgetEx ()
 
- Protected Functions inherited from QAccessibleObjectEx
virtual ~QAccessibleObjectEx ()
 

Detailed Description

The QAccessibleDisplay class implements the QAccessibleInterface for widgets that display information.

Warning
This function is not part of the public interface.

Definition at line 115 of file simplewidgets.h.

Constructors and Destructors

◆ QAccessibleDisplay()

QAccessibleDisplay::QAccessibleDisplay ( QWidget w,
Role  role = StaticText 
)
explicit

Constructs a QAccessibleDisplay object for w.

role is propagated to the QAccessibleWidgetEx constructor.

Definition at line 529 of file simplewidgets.cpp.

531 {
532 }
Role role(int child) const
Reimplemented Function
QAccessibleWidgetEx(QWidget *o, Role r=Client, const QString &name=QString())

Functions

◆ imageDescription()

QString QAccessibleDisplay::imageDescription ( )
virtual
Warning
This function is not part of the public interface.

Implements QAccessibleImageInterface.

Definition at line 643 of file simplewidgets.cpp.

644 {
645 #ifndef QT_NO_TOOLTIP
646  return widget()->toolTip();
647 #else
648  return QString::null;
649 #endif
650 }
QWidget * widget() const
static const Null null
Definition: qstring.h:502
QString toolTip
the widget&#39;s tooltip
Definition: qwidget.h:204

◆ imagePosition()

QRect QAccessibleDisplay::imagePosition ( QAccessible2::CoordinateType  coordType)
virtual
Warning
This function is not part of the public interface.

Implements QAccessibleImageInterface.

Definition at line 665 of file simplewidgets.cpp.

666 {
667  QLabel *label = qobject_cast<QLabel *>(widget());
668  if (!label)
669  return QRect();
670  const QPixmap *pixmap = label->pixmap();
671  if (!pixmap)
672  return QRect();
673 
674  switch (coordType) {
676  return QRect(label->mapToGlobal(label->pos()), label->size());
678  return label->geometry();
679  }
680 
681  return QRect();
682 }
QPoint pos() const
T qobject_cast(QObject *object)
Definition: qobject.h:375
QSize size() const
QWidget * widget() const
The QRect class defines a rectangle in the plane using integer precision.
Definition: qrect.h:58
The QLabel widget provides a text or image display.
Definition: qlabel.h:55
QPixmap pixmap
the label&#39;s pixmap
Definition: qlabel.h:60
The QPixmap class is an off-screen image representation that can be used as a paint device...
Definition: qpixmap.h:71
const QRect & geometry() const
QPoint mapToGlobal(const QPoint &) const
Translates the widget coordinate pos to global screen coordinates.

◆ imageSize()

QSize QAccessibleDisplay::imageSize ( )
virtual
Warning
This function is not part of the public interface.

Implements QAccessibleImageInterface.

Definition at line 653 of file simplewidgets.cpp.

654 {
655  QLabel *label = qobject_cast<QLabel *>(widget());
656  if (!label)
657  return QSize();
658  const QPixmap *pixmap = label->pixmap();
659  if (!pixmap)
660  return QSize();
661  return pixmap->size();
662 }
T qobject_cast(QObject *object)
Definition: qobject.h:375
QSize size() const
Returns the size of the pixmap.
Definition: qpixmap.cpp:661
QWidget * widget() const
The QLabel widget provides a text or image display.
Definition: qlabel.h:55
QPixmap pixmap
the label&#39;s pixmap
Definition: qlabel.h:60
The QPixmap class is an off-screen image representation that can be used as a paint device...
Definition: qpixmap.h:71
The QSize class defines the size of a two-dimensional object using integer point precision.
Definition: qsize.h:53

◆ navigate()

int QAccessibleDisplay::navigate ( RelationFlag  rel,
int  entry,
QAccessibleInterface **  target 
) const
virtual

Reimplemented Function

Reimplemented from QAccessibleWidgetEx.

Definition at line 623 of file simplewidgets.cpp.

624 {
625  *target = 0;
626  if (rel == Labelled) {
627  QObject *targetObject = 0;
628  QLabel *label = qobject_cast<QLabel*>(object());
629  if (label) {
630 #ifndef QT_NO_SHORTCUT
631  if (entry == 1)
632  targetObject = label->buddy();
633 #endif
634  }
635  *target = QAccessible::queryAccessibleInterface(targetObject);
636  if (*target)
637  return 0;
638  }
639  return QAccessibleWidgetEx::navigate(rel, entry, target);
640 }
T qobject_cast(QObject *object)
Definition: qobject.h:375
QObject * object() const
Returns a pointer to the QObject this interface implementation provides information for...
The QObject class is the base class of all Qt objects.
Definition: qobject.h:111
QWidget * buddy() const
Returns this label&#39;s buddy, or 0 if no buddy is currently set.
Definition: qlabel.cpp:1319
static QAccessibleInterface * queryAccessibleInterface(QObject *)
If a QAccessibleInterface implementation exists for the given object, this function returns a pointer...
The QLabel widget provides a text or image display.
Definition: qlabel.h:55
int navigate(RelationFlag rel, int entry, QAccessibleInterface **target) const
Navigates from this object to an object that has a relationship relation to this object, and returns the respective object in target.

◆ relationTo()

QAccessible::Relation QAccessibleDisplay::relationTo ( int  child,
const QAccessibleInterface other,
int  otherChild 
) const
virtual

Reimplemented Function

Reimplemented from QAccessibleWidgetEx.

Definition at line 604 of file simplewidgets.cpp.

606 {
607  Relation relation = QAccessibleWidgetEx::relationTo(child, other, otherChild);
608  if (child || otherChild)
609  return relation;
610 
611  QObject *o = other->object();
612  QLabel *label = qobject_cast<QLabel*>(object());
613  if (label) {
614 #ifndef QT_NO_SHORTCUT
615  if (o == label->buddy())
616  relation |= Label;
617 #endif
618  }
619  return relation;
620 }
T qobject_cast(QObject *object)
Definition: qobject.h:375
QObject * object() const
Returns a pointer to the QObject this interface implementation provides information for...
virtual QObject * object() const =0
Returns a pointer to the QObject this interface implementation provides information for...
Relation relationTo(int child, const QAccessibleInterface *other, int otherChild) const
Returns the relationship between this object&#39;s \a child and the \a other object&#39;s \a otherChild...
The QObject class is the base class of all Qt objects.
Definition: qobject.h:111
QWidget * buddy() const
Returns this label&#39;s buddy, or 0 if no buddy is currently set.
Definition: qlabel.cpp:1319
The QLabel widget provides a text or image display.
Definition: qlabel.h:55

◆ role()

QAccessible::Role QAccessibleDisplay::role ( int  child) const
virtual

Reimplemented Function

Reimplemented from QAccessibleWidgetEx.

Definition at line 535 of file simplewidgets.cpp.

536 {
538  if (l) {
539  if (l->pixmap())
540  return Graphic;
541 #ifndef QT_NO_PICTURE
542  if (l->picture())
543  return Graphic;
544 #endif
545 #ifndef QT_NO_MOVIE
546  if (l->movie())
547  return Animation;
548 #endif
549 #ifndef QT_NO_PROGRESSBAR
550  } else if (qobject_cast<QProgressBar*>(object())) {
551  return ProgressBar;
552 #endif
553  } else if (qobject_cast<QStatusBar*>(object())) {
554  return StatusBar;
555  }
556  return QAccessibleWidgetEx::role(child);
557 }
T qobject_cast(QObject *object)
Definition: qobject.h:375
Role role(int child) const
Returns the role of the object, or of the object&#39;s child if child is not 0.
QObject * object() const
Returns a pointer to the QObject this interface implementation provides information for...
const QPicture * picture() const
Returns the label&#39;s picture or 0 if the label doesn&#39;t have a picture.
Definition: qlabel.cpp:163
QMovie * movie() const
Returns a pointer to the label&#39;s movie, or 0 if no movie has been set.
Definition: qlabel.cpp:1468
QFactoryLoader * l
The QLabel widget provides a text or image display.
Definition: qlabel.h:55
QPixmap pixmap
the label&#39;s pixmap
Definition: qlabel.h:60
The Animation element is the base of all QML animations.

◆ text()

QString QAccessibleDisplay::text ( Text  t,
int  child 
) const
virtual

Reimplemented Function

Reimplemented from QAccessibleWidgetEx.

Definition at line 560 of file simplewidgets.cpp.

561 {
562  QString str;
563  switch (t) {
564  case Name:
565  str = widget()->accessibleName();
566  if (str.isEmpty()) {
567  if (qobject_cast<QLabel*>(object())) {
568  QLabel *label = qobject_cast<QLabel*>(object());
569  str = label->text();
570  if (label->textFormat() == Qt::RichText
571  || (label->textFormat() == Qt::AutoText && Qt::mightBeRichText(str))) {
572  QTextDocument doc;
573  doc.setHtml(str);
574  str = doc.toPlainText();
575  }
576 #ifndef QT_NO_LCDNUMBER
577  } else if (qobject_cast<QLCDNumber*>(object())) {
579  if (l->digitCount())
580  str = QString::number(l->value());
581  else
582  str = QString::number(l->intValue());
583 #endif
584  } else if (qobject_cast<QStatusBar*>(object())) {
585  return qobject_cast<QStatusBar*>(object())->currentMessage();
586  }
587  }
588  break;
589  case Value:
590 #ifndef QT_NO_PROGRESSBAR
591  if (qobject_cast<QProgressBar*>(object()))
592  str = QString::number(qobject_cast<QProgressBar*>(object())->value());
593 #endif
594  break;
595  default:
596  break;
597  }
598  if (str.isEmpty())
599  str = QAccessibleWidgetEx::text(t, child);;
600  return qt_accStripAmp(str);
601 }
QString accessibleName
the widget&#39;s name as seen by assistive technologies
Definition: qwidget.h:213
static QString number(int, int base=10)
This is an overloaded member function, provided for convenience. It differs from the above function o...
Definition: qstring.cpp:6448
T qobject_cast(QObject *object)
Definition: qobject.h:375
Qt::TextFormat textFormat
the label&#39;s text format
Definition: qlabel.h:59
QObject * object() const
Returns a pointer to the QObject this interface implementation provides information for...
Q_GUI_EXPORT bool mightBeRichText(const QString &)
Returns true if the string text is likely to be rich text; otherwise returns false.
QString text(Text t, int child) const
Returns the value of the text property t of the object, or of the object&#39;s child if child is not 0...
The QString class provides a Unicode character string.
Definition: qstring.h:83
QString toPlainText() const
Returns the plain text contained in the document.
The QStatusBar class provides a horizontal bar suitable for presenting status information.
Definition: qstatusbar.h:57
bool isEmpty() const
Returns true if the string has no characters; otherwise returns false.
Definition: qstring.h:704
int digitCount
the current number of digits displayed
Definition: qlcdnumber.h:63
void setHtml(const QString &html)
Replaces the entire contents of the document with the given HTML-formatted text in the html string...
int intValue
the displayed value rounded to the nearest integer
Definition: qlcdnumber.h:67
QWidget * widget() const
double value
the displayed value
Definition: qlcdnumber.h:66
QFactoryLoader * l
The QLabel widget provides a text or image display.
Definition: qlabel.h:55
The QLCDNumber widget displays a number with LCD-like digits.
Definition: qlcdnumber.h:57
The QTextDocument class holds formatted text that can be viewed and edited using a QTextEdit...
QString text
the label&#39;s text
Definition: qlabel.h:58
QString Q_GUI_EXPORT qt_accStripAmp(const QString &text)

The documentation for this class was generated from the following files: