gtkTextIterForwardSearch        package:RGtk2        R Documentation

_g_t_k_T_e_x_t_I_t_e_r_F_o_r_w_a_r_d_S_e_a_r_c_h

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

     Searches forward for 'str'. Any match is returned by setting 
     'match.start' to the first character of the match and 'match.end'
     to the  first character after the match. The search will not
     continue past 'limit'. Note that a search is a linear or O(n)
     operation, so you may wish to use 'limit' to avoid locking up your
     UI on large buffers.

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

     gtkTextIterForwardSearch(object, str, flags, limit = NULL)

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

'object': ['GtkTextIter']  start of search

   'str': [character]  a search string

 'flags': ['GtkTextSearchFlags']  flags affecting how the search is
          done

 'limit': ['GtkTextIter']  bound for the search, or 'NULL' for the end
          of the buffer

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

     If the 'GTK_TEXT_SEARCH_VISIBLE_ONLY' flag is present, the match
     may have invisible text interspersed in 'str'. i.e. 'str' will be
     a possibly-noncontiguous subsequence of the matched range.
     similarly, if you specify 'GTK_TEXT_SEARCH_TEXT_ONLY', the match
     may have pixbufs or child widgets mixed inside the matched range.
     If these flags are not given, the match must be exact; the special
     0xFFFC character in 'str' will match embedded pixbufs or child
     widgets.

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

     A list containing the following elements: 

  retval: [logical]  whether a match was found

'match.start': ['GtkTextIter']  return location for start of match, or
          'NULL'

'match.end': ['GtkTextIter']  return location for end of match, or
          'NULL'

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

     Derived by RGtkGen from GTK+ documentation

