diff options
Diffstat (limited to 'docs/reference/pygtk-atk-constants.xml')
| -rw-r--r-- | docs/reference/pygtk-atk-constants.xml | 1464 |
1 files changed, 0 insertions, 1464 deletions
diff --git a/docs/reference/pygtk-atk-constants.xml b/docs/reference/pygtk-atk-constants.xml deleted file mode 100644 index 4ef98642..00000000 --- a/docs/reference/pygtk-atk-constants.xml +++ /dev/null @@ -1,1464 +0,0 @@ -<?xml version="1.0" standalone="no"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" - "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> - -<refentry id="atk-constants"> - <refnamediv> - <refname>atk Constants</refname> - <refpurpose>the built-in constants of the atk module</refpurpose> - </refnamediv> - - <refsect1> - <title>Synopsis</title> - - <programlisting> -<xref linkend="atk-coord-type-constants" endterm="atk-coord-type-constants-title"></xref> -<xref linkend="atk-layer-constants" endterm="atk-layer-constants-title"></xref> -<xref linkend="atk-relation-type-constants" endterm="atk-relation-type-constants-title"></xref> -<xref linkend="atk-role-constants" endterm="atk-role-constants-title"></xref> -<xref linkend="atk-state-type-constants" endterm="atk-state-type-constants-title"></xref> -<xref linkend="atk-text-attr-constants" endterm="atk-text-attr-constants-title"></xref> -<xref linkend="atk-text-boundary-constants" endterm="atk-text-boundary-constants-title"></xref> -<xref linkend="atk-text-clip-type-constants" endterm="atk-text-clip-type-constants-title"></xref> -</programlisting> - - </refsect1> - - <refsect1 id="atk-constants-description"> - <title>Description</title> - - <refsect2 id="atk-coord-type-constants"> - <title id="atk-coord-type-constants-title">Atk Coord Type Constants</title> - - <para>The Atk Coord Type constants specify how xy coordinates are to - be interpreted. Used by methods such as <link - linkend="method-atkcomponent--get-position"><methodname>atk.Component.get_position</methodname>()</link> - and <link - linkend="method-atktext--get-character-extents"><methodname>atk.Text.get_character_extents</methodname>()</link></para> - - <variablelist> - <varlistentry> - <term><literal>atk.XY_SCREEN</literal></term> - <listitem> - <simpara>specifies xy coordinates relative to the - screen</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.XY_WINDOW</literal></term> - <listitem> - <simpara>specifies xy coordinates relative to the widget's - top-level window</simpara> - </listitem> - </varlistentry> - </variablelist> - - </refsect2> - - <refsect2 id="atk-layer-constants"> - <title id="atk-layer-constants-title">Atk Layer Constants</title> - - <para>The Atk Layer constants specify the layer of a component. These - enumerated "layer values" are used when determining which UI rendering - layer a component is drawn into, which can help in making - determinations of when components occlude one another.</para> - - <variablelist> - <varlistentry> - <term><literal>atk.LAYER_INVALID</literal></term> - <listitem> - <simpara>The object does not have a layer</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.LAYER_BACKGROUND</literal></term> - <listitem> - <simpara>This layer is reserved for the desktop - background</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.LAYER_CANVAS</literal></term> - <listitem> - <simpara>This layer is used for Canvas components</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.LAYER_WIDGET</literal></term> - <listitem> - <simpara>This layer is normally used for components</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.LAYER_MDI</literal></term> - <listitem> - <simpara>This layer is used for layered components</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.LAYER_POPUP</literal></term> - <listitem> - <simpara>This layer is used for popup components, such as - menus</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.LAYER_OVERLAY</literal></term> - <listitem> - <simpara>This layer is reserved for future use.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.LAYER_WINDOW</literal></term> - <listitem> - <simpara>This layer is used for toplevel windows.</simpara> - </listitem> - </varlistentry> - </variablelist> - - </refsect2> - - <refsect2 id="atk-relation-type-constants"> - <title id="atk-relation-type-constants-title">Atk Relation Type Constants</title> - - <para>The Atk Relation Type constants specify the type of the - relation.</para> - - <variablelist> - <varlistentry> - <term><literal>atk.RELATION_NULL</literal></term> - <listitem> - <simpara> Not used, represents "no relationship" or an error - condition. </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.RELATION_CONTROLLED_BY</literal></term> - <listitem> - <simpara> Indicates an object controlled by one or more target - objects. </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.RELATION_CONTROLLER_FOR</literal></term> - <listitem> - <simpara> Indicates an object is an controller for one or more - target objects. </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.RELATION_LABEL_FOR</literal></term> - <listitem> - <simpara> Indicates an object is a label for one or more target - objects. </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.RELATION_LABELLED_BY</literal></term> - <listitem> - <simpara> Indicates an object is labelled by one or more target - objects. </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.RELATION_MEMBER_OF</literal></term> - <listitem> - <simpara> Indicates an object is a member of a group of one or - more target objects. </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.RELATION_NODE_CHILD_OF</literal></term> - <listitem> - <simpara> Indicates an object is a cell in a treetable which is - displayed because a cell in the same column is expanded and - identifies that cell. </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.RELATION_FLOWS_TO</literal></term> - <listitem> - <simpara> Indicates that the object has content that flows - logically to another <link - linkend="class-atkobject"><classname>atk.Object</classname></link> - in a sequential way, (for instance text-flow). </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.RELATION_FLOWS_FROM</literal></term> - <listitem> - <simpara> Indicates that the object has content that flows - logically from another <link - linkend="class-atkobject"><classname>atk.Object</classname></link> - in a sequential way, (for instance text-flow). </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.RELATION_SUBWINDOW_OF</literal></term> - <listitem> - <simpara> Indicates a subwindow attached to a component but - otherwise has no connection in the UI hierarchy to that - component. </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.RELATION_EMBEDS</literal></term> - <listitem> - <simpara> Indicates that the object visually embeds another - object's content, i.e. this object's content flows around - another's content. </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.RELATION_EMBEDDED_BY</literal></term> - <listitem> - <simpara> Inverse of <literal>atk.RELATION_EMBEDS</literal>, - indicates that this object's content is visualy embedded in - another object. </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.RELATION_POPUP_FOR</literal></term> - <listitem> - <simpara>Indicates that an object is a popup for another - object.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.RELATION_PARENT_WINDOW_OF</literal></term> - <listitem> - <simpara> Indicates that an object is a parent window of another - object. </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.RELATION_LAST_DEFINED</literal></term> - <listitem> - <simpara> Not used, this value indicates the end of the - enumeration. </simpara> - </listitem> - </varlistentry> - </variablelist> - - </refsect2> - - <refsect2 id="atk-role-constants"> - <title id="atk-role-constants-title">Atk Role Constants</title> - - <para>The Atk Role constants describes the role of an object. These - are the built-in enumerated roles that UI components can have in - ATK. Other roles may be added at runtime, so an AtkRole >= - <literal>atk.ROLE_LAST_DEFINED</literal> is not necessarily an - error.</para> - - <variablelist> - <varlistentry> - <term><literal>atk.ROLE_INVALID</literal></term> - <listitem> - <simpara>Invalid role</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_ACCEL_LABEL</literal></term> - <listitem> - <simpara>A label which represents an accelerator</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_ALERT</literal></term> - <listitem> - <simpara>An object which is an alert to the user</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_ANIMATION</literal></term> - <listitem> - <simpara>An object which is an animated image</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_ARROW</literal></term> - <listitem> - <simpara>An arrow in one of the four cardinal directions</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_CALENDAR</literal></term> - <listitem> - <simpara> An object that displays a calendar and allows the user - to select a date </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_CANVAS</literal></term> - <listitem> - <simpara> An object that can be drawn into and is used to trap - events </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_CHECK_BOX</literal></term> - <listitem> - <simpara> A choice that can be checked or unchecked and provides - a separate indicator for the current state </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_CHECK_MENU_ITEM</literal></term> - <listitem> - <simpara>A menu item with a check box</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_COLOR_CHOOSER</literal></term> - <listitem> - <simpara>A specialized dialog that lets the user choose a - color</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_COLUMN_HEADER</literal></term> - <listitem> - <simpara>The header for a column of data</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_COMBO_BOX</literal></term> - <listitem> - <simpara>A list of choices the user can select from</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_DATE_EDITOR</literal></term> - <listitem> - <simpara>An object whose purpose is to allow a user to edit a - date</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_DESKTOP_ICON</literal></term> - <listitem> - <simpara>An inconifed internal frame within a - DESKTOP_PANE</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_DESKTOP_FRAME</literal></term> - <listitem> - <simpara> A pane that supports internal frames and iconified - versions of those internal frames </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_DIAL</literal></term> - <listitem> - <simpara>An object whose purpose is to allow a user to set a - value</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_DIALOG</literal></term> - <listitem> - <simpara>A top level window with title bar and a border</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_DIRECTORY_PANE</literal></term> - <listitem> - <simpara> A pane that allows the user to navigate through and - select the contents of a directory </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_DRAWING_AREA</literal></term> - <listitem> - <simpara> An object used for drawing custom user interface - elements </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_FILE_CHOOSER</literal></term> - <listitem> - <simpara>A specialized dialog that lets the user choose a - file</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_FILLER</literal></term> - <listitem> - <simpara>A object that fills up space in a user - interface</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_FONT_CHOOSER</literal></term> - <listitem> - <simpara>A specialized dialog that lets the user choose a - font</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_FRAME</literal></term> - <listitem> - <simpara> A top level window with a title bar, border, menubar, - etc. </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_GLASS_PANE</literal></term> - <listitem> - <simpara> A pane that is guaranteed to be painted on top of all - panes beneath it </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_HTML_CONTAINER</literal></term> - <listitem> - <simpara> A document container for HTML, whose children - represent the document content </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_ICON</literal></term> - <listitem> - <simpara> A small fixed size picture, typically used to decorate - components </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_IMAGE</literal></term> - <listitem> - <simpara> An object whose primary purpose is to display an image - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_INTERNAL_FRAME</literal></term> - <listitem> - <simpara>A frame-like object that is clipped by a desktop - pane</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_LABEL</literal></term> - <listitem> - <simpara> An object used to present an icon or short string in - an interface </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_LAYERED_PANE</literal></term> - <listitem> - <simpara> A specialized pane that allows its children to be - drawn in layers, providing a form of stacking order </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_LIST</literal></term> - <listitem> - <simpara> An object that presents a list of objects to the user - and allows the user to select one or more of them </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_LIST_ITEM</literal></term> - <listitem> - <simpara>An object that represents an element of a - list</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_MENU</literal></term> - <listitem> - <simpara> An object usually found inside a menu bar that - contains a list of actions the user can choose from </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_MENU_BAR</literal></term> - <listitem> - <simpara> An object usually drawn at the top of the primary - dialog box of an application that contains a list of menus the - user can choose from </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_MENU_ITEM</literal></term> - <listitem> - <simpara> An object usually contained in a menu that presents an - action the user can choose </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_OPTION_PANE</literal></term> - <listitem> - <simpara> A specialized pane whose primary use is inside a - DIALOG </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_PAGE_TAB</literal></term> - <listitem> - <simpara> An object that is a child of a page tab list - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_PAGE_TAB_LIST</literal></term> - <listitem> - <simpara> An object that presents a series of panels (or page - tabs), one at a time, through some mechanism provided by the - object </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_PANEL</literal></term> - <listitem> - <simpara>A generic container that is often used to group - objects</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_PASSWORD_TEXT</literal></term> - <listitem> - <simpara> A text object uses for passwords, or other places - where the text content is not shown visibly to the user - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_POPUP_MENU</literal></term> - <listitem> - <simpara> A temporary window that is usually used to offer the - user a list of choices, and then hides when the user selects one - of those choices </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_PROGRESS_BAR</literal></term> - <listitem> - <simpara> An object used to indicate how much of a task has been - completed </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_PUSH_BUTTON</literal></term> - <listitem> - <simpara> An object the user can manipulate to tell the - application to do something </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_RADIO_BUTTON</literal></term> - <listitem> - <simpara> A specialized check box that will cause other radio - buttons in the same group to become unchecked when this one is - checked </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_RADIO_MENU_ITEM</literal></term> - <listitem> - <simpara> A check menu item which belongs to a group. At each - instant exactly one of the radio menu items from a group is - selected</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_ROOT_PANE</literal></term> - <listitem> - <simpara> A specialized pane that has a glass pane and a layered - pane as its children </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_ROW_HEADER</literal></term> - <listitem> - <simpara>The header for a row of data</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_SCROLL_BAR</literal></term> - <listitem> - <simpara> An object usually used to allow a user to - incrementally view a large amount of data. </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_SCROLL_PANE</literal></term> - <listitem> - <simpara> An object that allows a user to incrementally view a - large amount of information </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_SEPARATOR</literal></term> - <listitem> - <simpara> An object usually contained in a menu to provide a - visible and logical separation of the contents in a menu - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_SLIDER</literal></term> - <listitem> - <simpara> An object that allows the user to select from a - bounded range </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_SPLIT_PANE</literal></term> - <listitem> - <simpara> A specialized panel that presents two other panels at - the same time </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_SPIN_BUTTON</literal></term> - <listitem> - <simpara> An object used to get an integer or floating point - number from the user </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_STATUSBAR</literal></term> - <listitem> - <simpara> An object which reports messages of minor importance - to the user </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_TABLE</literal></term> - <listitem> - <simpara> An object used to represent information in terms of - rows and columns </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_TABLE_CELL</literal></term> - <listitem> - <simpara>A cell in a table</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_TABLE_COLUMN_HEADER</literal></term> - <listitem> - <simpara>The header for a column of a table</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_TABLE_ROW_HEADER</literal></term> - <listitem> - <simpara>The header for a row of a table</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_TEAR_OFF_MENU_ITEM</literal></term> - <listitem> - <simpara>A menu item used to tear off and reattach its - menu</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_TERMINAL</literal></term> - <listitem> - <simpara>An object that represents an accessible - terminal</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_TEXT</literal></term> - <listitem> - <simpara>An object that presents text to the user</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_TOGGLE_BUTTON</literal></term> - <listitem> - <simpara> A specialized push button that can be checked or - unchecked, but does not provide a separate indicator for the - current state </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_TOOL_BAR</literal></term> - <listitem> - <simpara> A bar or palette usually composed of push buttons or - toggle buttons </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_TOOL_TIP</literal></term> - <listitem> - <simpara>An object that provides information about another - object</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_TREE</literal></term> - <listitem> - <simpara> An object used to represent hierarchical information - to the user </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_TREE_TABLE</literal></term> - <listitem> - <simpara> An object capable of expanding and collapsing rows as - well as showing multiple columns of data </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_UNKNOWN</literal></term> - <listitem> - <simpara> The object contains some Accessible information, but - its role is not known </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_VIEWPORT</literal></term> - <listitem> - <simpara>An object usually used in a scroll pane</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_WINDOW</literal></term> - <listitem> - <simpara>A top level window with no title or border.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_HEADER</literal></term> - <listitem> - <simpara>An object that serves as a document header.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_FOOTER</literal></term> - <listitem> - <simpara>An object that serves as a document footer.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_PARAGRAPH</literal></term> - <listitem> - <simpara>An object which is contains a paragraph of text - content.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_RULER</literal></term> - <listitem> - <simpara> An object which describes margins and tab stops, - etc. for text objects which it controls (should have - CONTROLLER_FOR relation to such). </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_APPLICATION</literal></term> - <listitem> - <simpara> The object is an application object, which may contain - atk.ROLE_FRAME objects or other types of accessibles. </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_AUTOCOMPLETE</literal></term> - <listitem> - <simpara> The object is a dialog or list containing items for - insertion into an entry widget, for instance a list of words for - completion of a text entry. </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_EDITBAR</literal></term> - <listitem> - <simpara>The object is an editable text object in a - toolbar</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_EMBEDDED</literal></term> - <listitem> - <simpara> The object is an embedded container within a document - or panel. This role is a grouping "hint" indicating that the - contained objects share a context. </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_ENTRY</literal></term> - <listitem> - <simpara> The object is a component whose textual content may be - entered or modified by the user, provided atk.STATE_EDITABLE is - present. </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_CHART</literal></term> - <listitem> - <simpara> The object is a graphical depiction of quantitative - data. It may contain multiple subelements whose attributes - and/or description may be queried to obtain both the - quantitative data and information about how the data is being - presented. The LABELLED_BY relation is particularly important in - interpreting objects of this type, as is the - accessible-description property. </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_CAPTION</literal></term> - <listitem> - <simpara> The object contains descriptive information, usually - textual, about another user interface element such as a table, - chart, or image. </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_DOCUMENT_FRAME</literal></term> - <listitem> - <simpara> The object is a visual frame or container which - contains a view of document content. Document frames may occur - within another Document instance, in which case the second - document may be said to be embedded in the containing - instance. HTML frames are often ROLE_DOCUMENT_FRAME. Either this - object, or a singleton descendant, should implement the Document - interface. </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_HEADING</literal></term> - <listitem> - <simpara> The object serves as a heading for content which - follows it in a document. The 'heading level' of the heading, if - availabe, may be obtained by querying the object's - attributes. </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_PAGE</literal></term> - <listitem> - <simpara> The object is a containing instance which encapsulates - a page of information. atk.ROLE_PAGE is used in documents and - content which support a paginated navigation model. </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_SECTION</literal></term> - <listitem> - <simpara> The object is a containing instance of document - content which constitutes a particular 'logical' section of the - document. The type of content within a section, and the nature - of the section division itself, may be obtained by querying the - object's attributes. Sections may be nested. </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_REDUNDANT_OBJECT</literal></term> - <listitem> - <simpara> The object is redundant with another object in the - hierarchy, and is exposed for purely technical reasons. Objects - of this role should normally be ignored by clients. </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.ROLE_LAST_DEFINED</literal></term> - <listitem> - <simpara>not a valid role, used for finding end of the - enumeration</simpara> - </listitem> - </varlistentry> - </variablelist> - - </refsect2> - - <refsect2 id="atk-state-type-constants"> - <title id="atk-state-type-constants-title">Atk State Type Constants</title> - - <para>The Atk State Type constants specify a particular state of a - component. The actual state of an component is described by its <link - linkend="class-atkstateset"><classname>atk.StateSet</classname></link>, - which is a set of states.</para> - - <variablelist> - <varlistentry> - <term><literal>atk.STATE_INVALID</literal></term> - <listitem> - <simpara>Indicates an invalid state</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.STATE_ACTIVE</literal></term> - <listitem> - <simpara>Indicates a window is currently the active - window</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.STATE_ARMED</literal></term> - <listitem> - <simpara>Indicates that the object is armed.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.STATE_BUSY</literal></term> - <listitem> - <simpara> Indicates the current object is busy. This state may - be used by implementors of Document to indicate that content - loading is in process. </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.STATE_CHECKED</literal></term> - <listitem> - <simpara>Indicates this object is currently checked</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.STATE_DEFUNCT</literal></term> - <listitem> - <simpara> Indicates the user interface object corresponding to - this object no longer exists </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.STATE_EDITABLE</literal></term> - <listitem> - <simpara> Indicates the user can change the contents of this - object </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.STATE_ENABLED</literal></term> - <listitem> - <simpara> Indicates that this object is enabled. An inconsistent - <link - linkend="class-gtktogglebutton"><classname>gtk.ToggleButton</classname></link> - is an example of an object which is sensitive but not - enabled. </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.STATE_EXPANDABLE</literal></term> - <listitem> - <simpara> Indicates this object allows progressive disclosure of - its children </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.STATE_EXPANDED</literal></term> - <listitem> - <simpara>Indicates this object its expanded</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.STATE_FOCUSABLE</literal></term> - <listitem> - <simpara> Indicates this object can accept keyboard focus, which - means all events resulting from typing on the keyboard will - normally be passed to it when it has focus </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.STATE_FOCUSED</literal></term> - <listitem> - <simpara>Indicates this object currently has the keyboard - focus</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.STATE_HORIZONTAL</literal></term> - <listitem> - <simpara>Indicates the orientation of this object is - horizontal</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.STATE_ICONIFIED</literal></term> - <listitem> - <simpara> Indicates this object is minimized and is represented - only by an icon </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.STATE_MODAL</literal></term> - <listitem> - <simpara> Indicates something must be done with this object - before the user can interact with an object in a different - window </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.STATE_MULTI_LINE</literal></term> - <listitem> - <simpara> Indicates this (text) object can contain multiple lines of text </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.STATE_MULTISELECTABLE</literal></term> - <listitem> - <simpara> Indicates this object allows more than one of its - children to be selected at the same time </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.STATE_OPAQUE</literal></term> - <listitem> - <simpara> Indicates this object paints every pixel within its - rectangular region. </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.STATE_PRESSED</literal></term> - <listitem> - <simpara>Indicates this object is currently pressed</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.STATE_RESIZABLE</literal></term> - <listitem> - <simpara>Indicates the size of this object is not fixed</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.STATE_SELECTABLE</literal></term> - <listitem> - <simpara> Indicates this object is the child of an object that - allows its children to be selected and that this child is one of - those children that can be selected </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.STATE_SELECTED</literal></term> - <listitem> - <simpara> Indicates this object is the child of an object that - allows its children to be selected and that this child is one of - those children that has been selected </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.STATE_SENSITIVE</literal></term> - <listitem> - <simpara>Indicates this object is sensitive</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.STATE_SHOWING</literal></term> - <listitem> - <simpara> Indicates this object, the object's parent, the - object's parent's parent, and so on, are all visible </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.STATE_SINGLE_LINE</literal></term> - <listitem> - <simpara> Indicates this (text) object can contain only a single - line of text </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.STATE_STALE</literal></term> - <listitem> - <simpara> Indicates that the index associated with this object - has changed since the user accessed the object. </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.STATE_TRANSIENT</literal></term> - <listitem> - <simpara>Indicates this object is transient</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.STATE_VERTICAL</literal></term> - <listitem> - <simpara>Indicates the orientation of this object is - vertical</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.STATE_VISIBLE</literal></term> - <listitem> - <simpara>Indicates this object is visible</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.STATE_MANAGES_DESCENDANTS</literal></term> - <listitem> - <simpara> Indicates that "active-descendant-changed" event is - sent when children become 'active' (i.e. are selected or - navigated to onscreen). Used to prevent need to enumerate all - children in very large containers, like tables. </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.STATE_INDETERMINATE</literal></term> - <listitem> - <simpara> Indicates that a check box is in a state other than - checked or not checked. </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.STATE_TRUNCATED</literal></term> - <listitem> - <simpara> Indicates that an object is truncated, e.g. a text - value in a speradsheet cell. </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.STATE_REQUIRED</literal></term> - <listitem> - <simpara> Indicates that explicit user interaction with an - object is required by the user interface, e.g. a required field - in a "web-form" interface. </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.STATE_INVALID_ENTRY</literal></term> - <listitem> - <simpara> Indicates that the object has encountered an error - condition due to failure of input validation. For instance, a - form control may acquire this state in response to invalid or - malformed user input. </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.STATE_SUPPORTS_AUTOCOMPLETION</literal></term> - <listitem> - <simpara> Indicates that the object may exhibit "typeahead" - behavior in response to user keystrokes, e.g. one keystroke may - result in the insertion of several characters into an entry, or - result in the auto-selection of an item in a list. This state - supplants <literal>atk.ROLE_AUTOCOMPLETE</literal>. </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.STATE_SELECTABLE_TEXT</literal></term> - <listitem> - <simpara>Indicates that the object in question supports text - selection. It should only be exposed on objects which implement - the Text interface, in order to distinguish this state from - <literal>atk.STATE_SELECTABLE</literal>, which infers that the - object in question is a selectable child of an object which - implements Selection. While similar, text selection and - subelement selection are distinct operations. </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.STATE_LAST_DEFINED</literal></term> - <listitem> - <simpara>Not a valid state, used for finding end of - enumeration</simpara> - </listitem> - </varlistentry> - </variablelist> - - </refsect2> - - <refsect2 id="atk-text-attr-constants"> - <title id="atk-text-attr-constants-title">Atk Text Attribute Constants</title> - - <para>The Atk Text Attribute constants specify the built-in text - attributes supported. Other text attributes may be set by an - application using the <link - linkend="function-atk--text-attribute-register"><function>atk.text_attribute_register</function>()</link> - function.</para> - - <variablelist> - <varlistentry> - <term><literal>atk.TEXT_ATTR_INVALID</literal></term> - <listitem> - <simpara>nvalid attribute</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.TEXT_ATTR_LEFT_MARGIN</literal></term> - <listitem> - <simpara>The pixel width of the left margin</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.TEXT_ATTR_RIGHT_MARGIN</literal></term> - <listitem> - <simpara>The pixel width of the right margin</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.TEXT_ATTR_INDENT</literal></term> - <listitem> - <simpara>The number of pixels that the text is indented</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.TEXT_ATTR_INVISIBLE</literal></term> - <listitem> - <simpara>Either "true" or "false" indicating whether text is - visible or not</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.TEXT_ATTR_PIXELS_ABOVE_LINES</literal></term> - <listitem> - <simpara>Pixels of blank space to leave above each - newline-terminated line.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.TEXT_ATTR_PIXELS_BELOW_LINES</literal></term> - <listitem> - <simpara>Pixels of blank space to leave below each - newline-terminated line.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.TEXT_ATTR_PIXELS_INSIDE_WRAP</literal></term> - <listitem> - <simpara>Pixels of blank space to leave between wrapped lines - inside the same newline-terminated line (paragraph).</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.TEXT_ATTR_BG_FULL_HEIGHT</literal></term> - <listitem> - <simpara>"true" or "false" whether to make the background color - for each character the height of the highest font used on the - current line, or the height of the font used for the current - character.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.TEXT_ATTR_RISE</literal></term> - <listitem> - <simpara>Number of pixels that the characters are risen above - the baseline</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.TEXT_ATTR_UNDERLINE</literal></term> - <listitem> - <simpara>"none", "single", "double" or "low"</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.TEXT_ATTR_STRIKETHROUGH</literal></term> - <listitem> - <simpara>"true" or "false" whether the text is - strikethrough</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.TEXT_ATTR_SIZE</literal></term> - <listitem> - <simpara>The size of the characters.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.TEXT_ATTR_SCALE</literal></term> - <listitem> - <simpara>The scale of the characters. The value is a string - representation of a double</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.TEXT_ATTR_WEIGHT</literal></term> - <listitem> - <simpara>The weight of the characters.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.TEXT_ATTR_LANGUAGE</literal></term> - <listitem> - <simpara>The language used</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.TEXT_ATTR_FAMILY_NAME</literal></term> - <listitem> - <simpara>The font family name</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.TEXT_ATTR_BG_COLOR</literal></term> - <listitem> - <simpara>The background color. The value is an RGB value of the - format "u,u,u"</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.TEXT_ATTR_FG_COLOR</literal></term> - <listitem> - <simpara>The foreground color. The value is an RGB value of the - format "u,u,u"</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.TEXT_ATTR_BG_STIPPLE</literal></term> - <listitem> - <simpara>"true" if a <link - linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> - is set for stippling the background color.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.TEXT_ATTR_FG_STIPPLE</literal></term> - <listitem> - <simpara>"true" if a <link - linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> - is set for stippling the foreground color.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.TEXT_ATTR_WRAP_MODE</literal></term> - <listitem> - <simpara>The wrap mode of the text, if any. Values are "none", - "char" or "word"</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.TEXT_ATTR_DIRECTION</literal></term> - <listitem> - <simpara>The direction of the text, if set. Values are "none", - "ltr" or "rtl"</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.TEXT_ATTR_JUSTIFICATION</literal></term> - <listitem> - <simpara> The justification of the text, if set. Values are - "left", "right", "center" or "fill" </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.TEXT_ATTR_STRETCH</literal></term> - <listitem> - <simpara> The stretch of the text, if set. Values are - "ultra_condensed", "extra_condensed", "condensed", - "semi_condensed", "normal", "semi_expanded", "expanded", - "extra_expanded" or "ultra_expanded" </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.TEXT_ATTR_VARIANT</literal></term> - <listitem> - <simpara> The capitalization variant of the text, if set. Values - are "normal" or "small_caps" </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.TEXT_ATTR_STYLE</literal></term> - <listitem> - <simpara> The slant style of the text, if set. Values are - "normal", "oblique" or "italic" </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.TEXT_ATTR_LAST_DEFINED</literal></term> - <listitem> - <simpara> not a valid text attribute, used for finding end of - enumeration </simpara> - </listitem> - </varlistentry> - </variablelist> - - </refsect2> - - <refsect2 id="atk-text-boundary-constants"> - <title id="atk-text-boundary-constants-title">Atk Text Boundary Constants</title> - - <para>The Atk Text Boundary constants specify oundaries for regions of - text.</para> - - <variablelist> - <varlistentry> - <term><literal>atk.TEXT_BOUNDARY_CHAR</literal></term> - <listitem> - <simpara> Boundary is the boundary between characters (including - non-printing characters) </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.TEXT_BOUNDARY_WORD_START</literal></term> - <listitem> - <simpara>Boundary is the start (i.e. first character) of a - word.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.TEXT_BOUNDARY_WORD_END</literal></term> - <listitem> - <simpara>Boundary is the end (i.e. last character) of a - word.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.TEXT_BOUNDARY_SENTENCE_START</literal></term> - <listitem> - <simpara>Boundary is the first character in a - sentence.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.TEXT_BOUNDARY_SENTENCE_END</literal></term> - <listitem> - <simpara> Boundary is the last (terminal) character in a - sentence; in languages which use "sentence stop" punctuation - such as English, the boundary is thus the '.', '?', or similar - terminal punctuation character. </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.TEXT_BOUNDARY_LINE_START</literal></term> - <listitem> - <simpara> Boundary is the initial character of the content or a - character immediately following a newline, linefeed, or return - character. </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.TEXT_BOUNDARY_LINE_END</literal></term> - <listitem> - <simpara>Boundary is the linefeed, or return - character.</simpara> - </listitem> - </varlistentry> - </variablelist> - - </refsect2> - - <refsect2 id="atk-text-clip-type-constants"> - <title id="atk-text-clip-type-constants-title">Atk Text Clip Type Constants</title> - - <para>The Atk Text Clip Type constants specify the type of clipping - required.</para> - - <variablelist> - <varlistentry> - <term><literal>atk.TEXT_CLIP_NONE</literal></term> - <listitem> - <simpara>No clipping to be done</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.TEXT_CLIP_MIN</literal></term> - <listitem> - <simpara>Text clipped by min coordinate is omitted</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.TEXT_CLIP_MAX</literal></term> - <listitem> - <simpara>Text clipped by max coordinate is omitted</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>atk.TEXT_CLIP_BOTH</literal></term> - <listitem> - <simpara>Only text fully within mix/max bound is - retained</simpara> - </listitem> - </varlistentry> - </variablelist> - - </refsect2> - - </refsect1> - -</refentry> |