diff options
| author | Timothy Pearson <kb9vqf@pearsoncomputing.net> | 2011-11-08 12:31:36 -0600 |
|---|---|---|
| committer | Timothy Pearson <kb9vqf@pearsoncomputing.net> | 2011-11-08 12:31:36 -0600 |
| commit | d796c9dd933ab96ec83b9a634feedd5d32e1ba3f (patch) | |
| tree | 6e3dcca4f77e20ec8966c666aac7c35bd4704053 /doc/html/qaccessible.html | |
| download | tqt3-d796c9dd933ab96ec83b9a634feedd5d32e1ba3f.tar.gz tqt3-d796c9dd933ab96ec83b9a634feedd5d32e1ba3f.zip | |
Test conversion to TQt3 from Qt3 8c6fc1f8e35fd264dd01c582ca5e7549b32ab731
Diffstat (limited to 'doc/html/qaccessible.html')
| -rw-r--r-- | doc/html/qaccessible.html | 291 |
1 files changed, 291 insertions, 0 deletions
diff --git a/doc/html/qaccessible.html b/doc/html/qaccessible.html new file mode 100644 index 000000000..b54702f99 --- /dev/null +++ b/doc/html/qaccessible.html @@ -0,0 +1,291 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/kernel/qaccessible.cpp:46 --> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>TQAccessible Class</title> +<style type="text/css"><!-- +fn { margin-left: 1cm; text-indent: -1cm; } +a:link { color: #004faf; text-decoration: none } +a:visited { color: #672967; text-decoration: none } +body { background: #ffffff; color: black; } +--></style> +</head> +<body> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> +<tr bgcolor="#E5E5E5"> +<td valign=center> + <a href="index.html"> +<font color="#004faf">Home</font></a> + | <a href="classes.html"> +<font color="#004faf">All Classes</font></a> + | <a href="mainclasses.html"> +<font color="#004faf">Main Classes</font></a> + | <a href="annotated.html"> +<font color="#004faf">Annotated</font></a> + | <a href="groups.html"> +<font color="#004faf">Grouped Classes</font></a> + | <a href="functions.html"> +<font color="#004faf">Functions</font></a> +</td> +<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>TQAccessible Class Reference</h1> + +<p>The TQAccessible class provides enums and static functions +relating to accessibility. +<a href="#details">More...</a> +<p><tt>#include <<a href="qaccessible-h.html">qaccessible.h</a>></tt> +<p>Inherited by <a href="qaccessibleinterface.html">TQAccessibleInterface</a>. +<p><a href="qaccessible-members.html">List of all member functions.</a> +<h2>Public Members</h2> +<ul> +<li class=fn>enum <a href="#Event-enum"><b>Event</b></a> { 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, 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 }</li> +<li class=fn>enum <a href="#State-enum"><b>State</b></a> { Normal = 0x00000000, Unavailable = 0x00000001, Selected = 0x00000002, Focused = 0x00000004, Pressed = 0x00000008, Checked = 0x00000010, Mixed = 0x00000020, ReadOnly = 0x00000040, HotTracked = 0x00000080, Default = 0x00000100, Expanded = 0x00000200, Collapsed = 0x00000400, Busy = 0x00000800, Floating = 0x00001000, Marqueed = 0x00002000, Animated = 0x00004000, Invisible = 0x00008000, Offscreen = 0x00010000, Sizeable = 0x00020000, Moveable = 0x00040000, SelfVoicing = 0x00080000, Focusable = 0x00100000, Selectable = 0x00200000, Linked = 0x00400000, Traversed = 0x00800000, MultiSelectable = 0x01000000, ExtSelectable = 0x02000000, AlertLow = 0x04000000, AlertMedium = 0x08000000, AlertHigh = 0x10000000, Protected = 0x20000000, Valid = 0x3fffffff }</li> +<li class=fn>enum <a href="#Role-enum"><b>Role</b></a> { 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, Character = 0x00000020, List = 0x00000021, ListItem = 0x00000022, Outline = 0x00000023, OutlineItem = 0x00000024, PageTab = 0x00000025, PropertyPage = 0x00000026, Indicator = 0x00000027, Graphic = 0x00000028, StaticText = 0x00000029, EditableText = 0x0000002A, PushButton = 0x0000002B, CheckBox = 0x0000002C, RadioButton = 0x0000002D, ComboBox = 0x0000002E, DropLest = 0x0000002F, ProgressBar = 0x00000030, Dial = 0x00000031, HotkeyField = 0x00000032, Slider = 0x00000033, SpinBox = 0x00000034, Diagram = 0x00000035, Animation = 0x00000036, Equation = 0x00000037, ButtonDropDown = 0x00000038, ButtonMenu = 0x00000039, ButtonDropGrid = 0x0000003A, Whitespace = 0x0000003B, PageTabList = 0x0000003C, Clock = 0x0000003D }</li> +<li class=fn>enum <a href="#NavDirection-enum"><b>NavDirection</b></a> { NavUp = 0x00000001, NavDown = 0x00000002, NavLeft = 0x00000003, NavRight = 0x00000004, NavNext = 0x00000005, NavPrevious = 0x00000006, NavFirstChild = 0x00000007, NavLastChild = 0x00000008, NavFocusChild = 0x00000009 }</li> +<li class=fn>enum <a href="#Text-enum"><b>Text</b></a> { Name = 0, Description, Value, Help, Accelerator, DefaultAction }</li> +</ul> +<h2>Static Public Members</h2> +<ul> +<li class=fn>TQRESULT <a href="#queryAccessibleInterface"><b>queryAccessibleInterface</b></a> ( TQObject * object, TQAccessibleInterface ** iface )</li> +<li class=fn>void <a href="#updateAccessibility"><b>updateAccessibility</b></a> ( TQObject * object, int control, Event reason )</li> +<li class=fn>bool <a href="#isActive"><b>isActive</b></a> ()</li> +</ul> +<hr><a name="details"></a><h2>Detailed Description</h2> + + +The TQAccessible class provides enums and static functions +relating to accessibility. +<p> +<p> Accessibility clients use implementations of the +<a href="qaccessibleinterface.html">TQAccessibleInterface</a> to read the information an accessible object +exposes, or to call functions to manipulate the accessible object. +<p> +<p> See the <a href="plugins-howto.html">plugin documentation</a> for +more details about how to redistribute TQt plugins. +<p>See also <a href="misc.html">Miscellaneous Classes</a>. + +<hr><h2>Member Type Documentation</h2> +<h3 class=fn><a name="Event-enum"></a>TQAccessible::Event</h3> + +<p> This enum type defines event types when the state of the +accessible object has changed. The event types are: +<ul> +<li><tt>TQAccessible::SoundPlayed</tt> +<li><tt>TQAccessible::Alert</tt> +<li><tt>TQAccessible::ForegroundChanged</tt> +<li><tt>TQAccessible::MenuStart</tt> +<li><tt>TQAccessible::MenuEnd</tt> +<li><tt>TQAccessible::PopupMenuStart</tt> +<li><tt>TQAccessible::PopupMenuEnd</tt> +<li><tt>TQAccessible::ContextHelpStart</tt> +<li><tt>TQAccessible::ContextHelpEnd</tt> +<li><tt>TQAccessible::DragDropStart</tt> +<li><tt>TQAccessible::DragDropEnd</tt> +<li><tt>TQAccessible::DialogStart</tt> +<li><tt>TQAccessible::DialogEnd</tt> +<li><tt>TQAccessible::ScrollingStart</tt> +<li><tt>TQAccessible::ScrollingEnd</tt> +<li><tt>TQAccessible::ObjectCreated</tt> +<li><tt>TQAccessible::ObjectDestroyed</tt> +<li><tt>TQAccessible::ObjectShow</tt> +<li><tt>TQAccessible::ObjectHide</tt> +<li><tt>TQAccessible::ObjectReorder</tt> +<li><tt>TQAccessible::Focus</tt> +<li><tt>TQAccessible::Selection</tt> +<li><tt>TQAccessible::SelectionAdd</tt> +<li><tt>TQAccessible::SelectionRemove</tt> +<li><tt>TQAccessible::SelectionWithin</tt> +<li><tt>TQAccessible::StateChanged</tt> +<li><tt>TQAccessible::LocationChanged</tt> +<li><tt>TQAccessible::NameChanged</tt> +<li><tt>TQAccessible::DescriptionChanged</tt> +<li><tt>TQAccessible::ValueChanged</tt> +<li><tt>TQAccessible::ParentChanged</tt> +<li><tt>TQAccessible::HelpChanged</tt> +<li><tt>TQAccessible::DefaultActionChanged</tt> +<li><tt>TQAccessible::AcceleratorChanged</tt> +<li><tt>TQAccessible::MenuCommand</tt> +</ul> +<h3 class=fn><a name="NavDirection-enum"></a>TQAccessible::NavDirection</h3> + +<p> This enum specifies which item to move to when navigating. +<ul> +<li><tt>TQAccessible::NavUp</tt> - sibling above +<li><tt>TQAccessible::NavDown</tt> - sibling below +<li><tt>TQAccessible::NavLeft</tt> - left sibling +<li><tt>TQAccessible::NavRight</tt> - right sibling +<li><tt>TQAccessible::NavNext</tt> - next sibling +<li><tt>TQAccessible::NavPrevious</tt> - previous sibling +<li><tt>TQAccessible::NavFirstChild</tt> - first child +<li><tt>TQAccessible::NavLastChild</tt> - last child +<li><tt>TQAccessible::NavFocusChild</tt> - child with focus +</ul> +<h3 class=fn><a name="Role-enum"></a>TQAccessible::Role</h3> + +<p> This enum defines a number of roles an accessible object can have. +The roles are: +<ul> +<li><tt>TQAccessible::NoRole</tt> +<li><tt>TQAccessible::TitleBar</tt> +<li><tt>TQAccessible::MenuBar</tt> +<li><tt>TQAccessible::ScrollBar</tt> +<li><tt>TQAccessible::Grip</tt> +<li><tt>TQAccessible::Sound</tt> +<li><tt>TQAccessible::Cursor</tt> +<li><tt>TQAccessible::Caret</tt> +<li><tt>TQAccessible::AlertMessage</tt> +<li><tt>TQAccessible::Window</tt> +<li><tt>TQAccessible::Client</tt> +<li><tt>TQAccessible::PopupMenu</tt> +<li><tt>TQAccessible::MenuItem</tt> +<li><tt>TQAccessible::ToolTip</tt> +<li><tt>TQAccessible::Application</tt> +<li><tt>TQAccessible::Document</tt> +<li><tt>TQAccessible::Pane</tt> +<li><tt>TQAccessible::Chart</tt> +<li><tt>TQAccessible::Dialog</tt> +<li><tt>TQAccessible::Border</tt> +<li><tt>TQAccessible::Grouping</tt> +<li><tt>TQAccessible::Separator</tt> +<li><tt>TQAccessible::ToolBar</tt> +<li><tt>TQAccessible::StatusBar</tt> +<li><tt>TQAccessible::Table</tt> +<li><tt>TQAccessible::ColumnHeader</tt> +<li><tt>TQAccessible::RowHeader</tt> +<li><tt>TQAccessible::Column</tt> +<li><tt>TQAccessible::Row</tt> +<li><tt>TQAccessible::Cell</tt> +<li><tt>TQAccessible::Link</tt> +<li><tt>TQAccessible::HelpBalloon</tt> +<li><tt>TQAccessible::Character</tt> +<li><tt>TQAccessible::List</tt> +<li><tt>TQAccessible::ListItem</tt> +<li><tt>TQAccessible::Outline</tt> +<li><tt>TQAccessible::OutlineItem</tt> +<li><tt>TQAccessible::PageTab</tt> +<li><tt>TQAccessible::PropertyPage</tt> +<li><tt>TQAccessible::Indicator</tt> +<li><tt>TQAccessible::Graphic</tt> +<li><tt>TQAccessible::StaticText</tt> +<li><tt>TQAccessible::EditableText</tt> +<li><tt>TQAccessible::PushButton</tt> +<li><tt>TQAccessible::CheckBox</tt> +<li><tt>TQAccessible::RadioButton</tt> +<li><tt>TQAccessible::ComboBox</tt> +<li><tt>TQAccessible::DropLest</tt> +<li><tt>TQAccessible::ProgressBar</tt> +<li><tt>TQAccessible::Dial</tt> +<li><tt>TQAccessible::HotkeyField</tt> +<li><tt>TQAccessible::Slider</tt> +<li><tt>TQAccessible::SpinBox</tt> +<li><tt>TQAccessible::Diagram</tt> +<li><tt>TQAccessible::Animation</tt> +<li><tt>TQAccessible::Equation</tt> +<li><tt>TQAccessible::ButtonDropDown</tt> +<li><tt>TQAccessible::ButtonMenu</tt> +<li><tt>TQAccessible::ButtonDropGrid</tt> +<li><tt>TQAccessible::Whitespace</tt> +<li><tt>TQAccessible::PageTabList</tt> +<li><tt>TQAccessible::Clock</tt> +</ul> +<h3 class=fn><a name="State-enum"></a>TQAccessible::State</h3> + +<p> This enum type defines bitflags that can be combined to indicate +the state of the accessible object. The values are: +<ul> +<li><tt>TQAccessible::Normal</tt> +<li><tt>TQAccessible::Unavailable</tt> +<li><tt>TQAccessible::Selected</tt> +<li><tt>TQAccessible::Focused</tt> +<li><tt>TQAccessible::Pressed</tt> +<li><tt>TQAccessible::Checked</tt> +<li><tt>TQAccessible::Mixed</tt> +<li><tt>TQAccessible::ReadOnly</tt> +<li><tt>TQAccessible::HotTracked</tt> +<li><tt>TQAccessible::Default</tt> +<li><tt>TQAccessible::Expanded</tt> +<li><tt>TQAccessible::Collapsed</tt> +<li><tt>TQAccessible::Busy</tt> +<li><tt>TQAccessible::Floating</tt> +<li><tt>TQAccessible::Marqueed</tt> +<li><tt>TQAccessible::Animated</tt> +<li><tt>TQAccessible::Invisible</tt> +<li><tt>TQAccessible::Offscreen</tt> +<li><tt>TQAccessible::Sizeable</tt> +<li><tt>TQAccessible::Moveable</tt> +<li><tt>TQAccessible::SelfVoicing</tt> +<li><tt>TQAccessible::Focusable</tt> +<li><tt>TQAccessible::Selectable</tt> +<li><tt>TQAccessible::Linked</tt> +<li><tt>TQAccessible::Traversed</tt> +<li><tt>TQAccessible::MultiSelectable</tt> +<li><tt>TQAccessible::ExtSelectable</tt> +<li><tt>TQAccessible::AlertLow</tt> +<li><tt>TQAccessible::AlertMedium</tt> +<li><tt>TQAccessible::AlertHigh</tt> +<li><tt>TQAccessible::Protected</tt> +<li><tt>TQAccessible::Valid</tt> +</ul> +<h3 class=fn><a name="Text-enum"></a>TQAccessible::Text</h3> + +<p> This enum specifies string information that an accessible object +returns. +<ul> +<li><tt>TQAccessible::Name</tt> - The name of the object +<li><tt>TQAccessible::Description</tt> - A short text describing the object +<li><tt>TQAccessible::Value</tt> - The value of the object +<li><tt>TQAccessible::Help</tt> - A longer text giving information about how +to use the object +<li><tt>TQAccessible::DefaultAction</tt> - The default method to interact with the object +<li><tt>TQAccessible::Accelerator</tt> - The keyboard shortcut that executes the +default action +</ul> +<hr><h2>Member Function Documentation</h2> +<h3 class=fn>bool <a name="isActive"></a>TQAccessible::isActive ()<tt> [static]</tt> +</h3> +Returns TRUE if an accessibility implementation has been requested, +during the runtime of the application, otherwise returns FALSE. +<p> Use this function to prevent potentially expensive notifications via +<a href="#updateAccessibility">updateAccessibility</a>(). +<p> + +<h3 class=fn>TQRESULT <a name="queryAccessibleInterface"></a>TQAccessible::queryAccessibleInterface ( <a href="qobject.html">TQObject</a> * object, <a href="qaccessibleinterface.html">TQAccessibleInterface</a> ** iface )<tt> [static]</tt> +</h3> +Sets <em>iface</em> to point to the implementation of the +<a href="qaccessibleinterface.html">TQAccessibleInterface</a> for <em>object</em>, and returns <tt>TQS_OK</tt> if +successfull, or sets <em>iface</em> to 0 and returns <tt>TQE_NOCOMPONENT</tt> if +no accessibility implementation for <em>object</em> exists. +<p> The function uses the <a href="qobject.html#className">classname</a> of <em>object</em> to find a suitable implementation. If no +implementation for the object's class is available the function +tries to find an implementation for the object's parent class. +<p> This function is called to answer an accessibility client's +request for object information. You should never need to call this +function yourself. + +<h3 class=fn>void <a name="updateAccessibility"></a>TQAccessible::updateAccessibility ( <a href="qobject.html">TQObject</a> * object, int control, <a href="qaccessible.html#Event-enum">Event</a> reason )<tt> [static]</tt> +</h3> + +<p> Notifies accessibility clients about a change in <em>object</em>'s +accessibility information. +<p> <em>reason</em> specifies the cause of the change, for example, +ValueChange when the position of a slider has been changed. <em>control</em> is the ID of the child element that has changed. When <em>control</em> is 0, the object itself has changed. +<p> Call this function whenever the state of your accessible object or +one of it's sub-elements has been changed either programmatically +(e.g. by calling <a href="qlabel.html#setText">TQLabel::setText</a>()) or by user interaction. +<p> If there are no accessibility tools listening to this event, the +performance penalty for calling this function is minor, but if determining +the parameters of the call is expensive you can use <a href="#isActive">isActive</a>() to +avoid unnecessary performance penalties if no client is listening. + +<!-- eof --> +<hr><p> +This file is part of the <a href="index.html">TQt toolkit</a>. +Copyright © 1995-2007 +<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center> +<table width=100% cellspacing=0 border=0><tr> +<td>Copyright © 2007 +<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a> +<td align=right><div align=right>TQt 3.3.8</div> +</table></div></address></body> +</html> |