atkTextGetTextBeforeOffset       package:RGtk2       R Documentation

_a_t_k_T_e_x_t_G_e_t_T_e_x_t_B_e_f_o_r_e_O_f_f_s_e_t

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

     Gets the specified text.

_U_s_a_g_e:

     atkTextGetTextBeforeOffset(object, offset, boundary.type)

_A_r_g_u_m_e_n_t_s:

'object': ['AtkText']  an 'AtkText'

'offset': [integer]  position

'boundary.type': ['AtkTextBoundary']  An 'AtkTextBoundary'

_D_e_t_a_i_l_s:

     If the boundary_type if ATK_TEXT_BOUNDARY_CHAR the character
     before the offset is returned.

     If the boundary_type is ATK_TEXT_BOUNDARY_WORD_START the returned
     string is from the word start before the word start before the
     offset to  the word start before the offset.

     The returned string will contain the word before the offset if the
     offset is inside a word and will contain the word before the word
     before the  offset if the offset is not inside a word.

     If the boundary_type is ATK_TEXT_BOUNDARY_WORD_END the returned
     string is from the word end before the word end at or before the
     offset to the  word end at or before the offset.

     The returned string will contain the word before the offset if the
     offset is inside a word or if the offset is not inside a word.

     If the boundary type is ATK_TEXT_BOUNDARY_SENTENCE_START the
     returned string is from the sentence start before the sentence
     start before  the offset to the sentence start before the offset.

     The returned string will contain the sentence before the offset if
     the  offset is inside a sentence and will contain the sentence
     before the  sentence before the offset if the offset is not inside
     a sentence.

     If the boundary_type is ATK_TEXT_BOUNDARY_SENTENCE_END the
     returned string is from the sentence end before the sentence end
     at or before the offset to  the sentence end at or before the
     offset.

     The returned string will contain the sentence before the offset if
     the  offset is inside a sentence or if the offset is not inside a
     sentence.

     If the boundary type is ATK_TEXT_BOUNDARY_LINE_START the returned
     string is from the line start before the line start ar or before
     the offset  to the line start ar or before the offset.

     If the boundary_type is ATK_TEXT_BOUNDARY_LINE_END the returned
     string is from the line end before the line end before the offset
     to the  line end before the offset.

_V_a_l_u_e:

     A list containing the following elements: 

  retval: [character]  the text before 'offset' bounded by the
          specified 'boundary.type'.

'start.offset': [integer]  the start offset of the returned string

'end.offset': [integer]  the offset of the first character after the 
          returned substring

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

     Derived by RGtkGen from GTK+ documentation

