AtkText                package:RGtk2                R Documentation

_A_t_k_T_e_x_t

_D_e_s_c_r_i_p_t_i_o_n:

     The ATK interface implemented by components with text content.

_M_e_t_h_o_d_s _a_n_d _F_u_n_c_t_i_o_n_s:

     'atkTextGetText(object, start.offset, end.offset)'
      'atkTextGetCharacterAtOffset(object, offset)'
      'atkTextGetTextAfterOffset(object, offset, boundary.type)'
      'atkTextGetTextAtOffset(object, offset, boundary.type)'
      'atkTextGetTextBeforeOffset(object, offset, boundary.type)'
      'atkTextGetCaretOffset(object)'
      'atkTextGetCharacterExtents(object, offset, coords)'
      'atkTextGetRunAttributes(object, offset)'
      'atkTextGetDefaultAttributes(object)'
      'atkTextGetCharacterCount(object)'
      'atkTextGetOffsetAtPoint(object, x, y, coords)'
      'atkTextGetBoundedRanges(object, rect, coord.type, x.clip.type,
     y.clip.type)'
      'atkTextGetRangeExtents(object, start.offset, end.offset,
     coord.type)'
      'atkTextGetNSelections(object)'
      'atkTextGetSelection(object, selection.num)'
      'atkTextAddSelection(object, start.offset, end.offset)'
      'atkTextRemoveSelection(object, selection.num)'
      'atkTextSetSelection(object, selection.num, start.offset,
     end.offset)'
      'atkTextSetCaretOffset(object, offset)'
      'atkTextAttributeRegister(name)'
      'atkTextAttributeGetName(attr)'
      'atkTextAttributeForName(name)'
      'atkTextAttributeGetValue(attr, index)'

_H_i_e_r_a_r_c_h_y:

     GInterface
        +----AtkText 

_I_m_p_l_e_m_e_n_t_a_t_i_o_n_s:

     AtkText is implemented by 'AtkNoOpObject'.

_D_e_t_a_i_l_e_d _D_e_s_c_r_i_p_t_i_o_n:

     'AtkText' should be implemented by 'AtkObjects' on behalf of
     widgets that have text content which is either attributed or
     otherwise non-trivial. 'AtkObjects' whose text content is simple,
     unattributed, and very brief may expose that content via
     'atkObjectGetName' instead; however if the text is editable,
     multi-line, typically longer than three or four words, attributed,
     selectable, or if the object already uses the 'name' ATK property
     for other information, the 'AtkText' interface should be used to
     expose the text content.  In the case of editable text content,
     'AtkEditableText' (a subtype of the 'AtkText' interface) should be
     implemented instead. 'AtkText' provides not only traversal
     facilities and change notification for text content, but also
     caret tracking and glyph bounding box calculations.  Note that the
     text strings are exposed as UTF-8, and are therefore potentially
     multi-byte, and caret-to-byte offset mapping makes no assumptions
     about the character length; also bounding box glyph-to-offset
     mapping may be complex for languages which use ligatures.

_S_t_r_u_c_t_u_r_e_s:


     '_A_t_k_T_e_x_t' The AtkText structure does not contain any fields.


     '_A_t_k_T_e_x_t_R_a_n_g_e' A structure used to describe a text range.  
          *'AtkTextRange' is a transparent-type.*

          '_b_o_u_n_d_s' ['AtkTextRectangle']  A rectangle giving the bounds
               of the text range

          '_s_t_a_r_t_O_f_f_s_e_t' [integer]  The start offset of a AtkTextRange

          '_e_n_d_O_f_f_s_e_t' [integer]  The end offset of a AtkTextRange

          '_c_o_n_t_e_n_t' [character]  The text in the text range


     '_A_t_k_T_e_x_t_R_e_c_t_a_n_g_l_e' A structure used to store a rectangle used by
          AtkText.   *'AtkTextRectangle' is a transparent-type.*

          '_x' [integer]  The horizontal coordinate of a rectangle

          '_y' [integer]  The vertical coordinate of a rectangle

          '_w_i_d_t_h' [integer]  The width of a rectangle

          '_h_e_i_g_h_t' [integer]  The height of a rectangle


     '_A_t_k_A_t_t_r_i_b_u_t_e' A string name/value pair representing a text
          attribute.   *'AtkAttribute' is a transparent-type.*

          '_n_a_m_e' [character]  The attribute name. Call
               'atkTextAttrGetName()'

          '_v_a_l_u_e' [character]  the value of the attribute, represented
               as a string.  Call 'atkTextAttrGetValue()' for those
               which are strings. For values which are numbers, the
               string representation of the number  is in value.


_E_n_u_m_s _a_n_d _F_l_a_g_s:


     '_A_t_k_T_e_x_t_B_o_u_n_d_a_r_y' Text boundary types used for specifying
          boundaries for regions of text  

          '_c_h_a_r' Boundary is the boundary between characters 
               (including non-printing characters)

          '_w_o_r_d-_s_t_a_r_t' Boundary is the start (i.e. first character) of
               a word. 

          '_w_o_r_d-_e_n_d' Boundary is the end (i.e. last character) of a
               word.

          '_s_e_n_t_e_n_c_e-_s_t_a_r_t' Boundary is the first character in a
               sentence.

          '_s_e_n_t_e_n_c_e-_e_n_d' 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.

          '_l_i_n_e-_s_t_a_r_t' Boundary is the initial character of the content
               or a  character immediately following a newline,
               linefeed, or return character.

          '_l_i_n_e-_e_n_d' Boundary is the linefeed, or return character.


     '_A_t_k_T_e_x_t_C_l_i_p_T_y_p_e' Describes the type of clipping required.  

          '_n_o_n_e' No clipping to be done

          '_m_i_n' Text clipped by min coordinate is omitted

          '_m_a_x' Text clipped by max coordinate is omitted

          '_b_o_t_h' Only text fully within mix/max bound is retained


     '_A_t_k_T_e_x_t_A_t_t_r_i_b_u_t_e' Describes the text attributes supported  

          '_i_n_v_a_l_i_d' Invalid attribute

          '_l_e_f_t-_m_a_r_g_i_n' The pixel width of the left margin

          '_r_i_g_h_t-_m_a_r_g_i_n' The pixel width of the right margin

          '_i_n_d_e_n_t' The number of pixels that the text is indented

          '_i_n_v_i_s_i_b_l_e' Either "true" or "false" indicating whether text
               is visible or not

          '_e_d_i_t_a_b_l_e' Either "true" or "false" indicating whether text
               is editable or not

          '_p_i_x_e_l_s-_a_b_o_v_e-_l_i_n_e_s' Pixels of blank space to leave above
               each line. 

          '_p_i_x_e_l_s-_b_e_l_o_w-_l_i_n_e_s' Pixels of blank space to leave below
               each line.

          '_p_i_x_e_l_s-_i_n_s_i_d_e-_w_r_a_p' Pixels of blank space to leave between
               wrapped lines inside the same line (paragraph).

          '_b_g-_f_u_l_l-_h_e_i_g_h_t' "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.

          '_r_i_s_e' Number of pixels that the characters are risen above
               the baseline

          '_u_n_d_e_r_l_i_n_e' "none", "single", "double" or "low"

          '_s_t_r_i_k_e_t_h_r_o_u_g_h' "true" or "false" whether the text is
               strikethrough 

          '_s_i_z_e' The size of the characters. 

          '_s_c_a_l_e' The scale of the characters. The value is a string
               representation of a double 

          '_w_e_i_g_h_t' The weight of the characters.

          '_l_a_n_g_u_a_g_e' The language used

          '_f_a_m_i_l_y-_n_a_m_e' The font family name

          '_b_g-_c_o_l_o_r' The background color. The value is an RGB value of
               the format "'u','u','u'"

          '_f_g-_c_o_l_o_r' The foreground color. The value is an RGB value of
               the format "'u','u','u'"

          '_b_g-_s_t_i_p_p_l_e' "true" if a 'GdkBitmap' is set for stippling the
               background color.

          '_f_g-_s_t_i_p_p_l_e' "true" if a 'GdkBitmap' is set for stippling the
               foreground color.

          '_w_r_a_p-_m_o_d_e' The wrap mode of the text, if any. Values are
               "none", "char" or "word" 

          '_d_i_r_e_c_t_i_o_n' The direction of the text, if set. Values are
               "none", "ltr" or "rtl" 

          '_j_u_s_t_i_f_i_c_a_t_i_o_n' The justification of the text, if set. Values
               are "left", "right", "center" or "fill" 

          '_s_t_r_e_t_c_h' 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"

          '_v_a_r_i_a_n_t' The capitalization variant of the text, if set.
               Values are "normal" or "small_caps"

          '_s_t_y_l_e' The slant style of the text, if set. Values are
               "normal", "oblique" or "italic"

          '_l_a_s_t-_d_e_f_i_n_e_d' not a valid text attribute, used for finding
               end of enumeration


_S_i_g_n_a_l_s:


     '_t_e_x_t-_a_t_t_r_i_b_u_t_e_s-_c_h_a_n_g_e_d(_a_t_k_t_e_x_t, _u_s_e_r._d_a_t_a)' The
          "text-attributes-changed" signal is emitted when the text
          attributes of  the text of an object which implements AtkText
          changes.

          '_a_t_k_t_e_x_t' ['AtkText'] the object which received the signal.

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_t_e_x_t-_c_a_r_e_t-_m_o_v_e_d(_a_t_k_t_e_x_t, _a_r_g_1, _u_s_e_r._d_a_t_a)' The
          "text-caret-moved" signal is emitted when the caret position
          of  the text of an object which implements AtkText changes.

          '_a_t_k_t_e_x_t' ['AtkText'] the object which received the signal.

          '_a_r_g_1' [integer] The new position of the text caret.

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_t_e_x_t-_c_h_a_n_g_e_d(_a_t_k_t_e_x_t, _a_r_g_1, _a_r_g_2, _u_s_e_r._d_a_t_a)' The "text-changed"
          signal is emitted when the text of the object which 
          implements the AtkText interface changes, This signal will
          have a detail  which is either "insert" or "delete" which
          identifies whether the text  change was an insertion or a
          deletion

          '_a_t_k_t_e_x_t' ['AtkText'] the object which received the signal.

          '_a_r_g_1' [integer] The position (character offset) of the
               insertion or deletion.

          '_a_r_g_2' [integer] The length (in characters) of text inserted
               or deleted.

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_t_e_x_t-_s_e_l_e_c_t_i_o_n-_c_h_a_n_g_e_d(_a_t_k_t_e_x_t, _u_s_e_r._d_a_t_a)' The
          "text-selection-changed" signal is emitted when the selected
          text of  an object which implements AtkText changes.

          '_a_t_k_t_e_x_t' ['AtkText'] the object which received the signal.

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


_A_u_t_h_o_r(_s):

     Derived by RGtkGen from GTK+ documentation

_R_e_f_e_r_e_n_c_e_s:

     <URL: http://developer.gnome.org/doc/API/2.0/atk/AtkText.html>

