GtkEntryCompletion           package:RGtk2           R Documentation

_G_t_k_E_n_t_r_y_C_o_m_p_l_e_t_i_o_n

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

     Completion functionality for GtkEntry

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

     'gtkEntryCompletionNew()'
      'gtkEntryCompletionGetEntry(object)'
      'gtkEntryCompletionSetModel(object, model = NULL)'
      'gtkEntryCompletionGetModel(object)'
      'gtkEntryCompletionSetMatchFunc(object, func, func.data = NULL)'
      'gtkEntryCompletionSetMinimumKeyLength(object, length)'
      'gtkEntryCompletionGetMinimumKeyLength(object)'
      'gtkEntryCompletionComplete(object)'
      'gtkEntryCompletionGetCompletionPrefix(object)'
      'gtkEntryCompletionInsertPrefix(object)'
      'gtkEntryCompletionInsertActionText(object, index, text)'
      'gtkEntryCompletionInsertActionMarkup(object, index, markup)'
      'gtkEntryCompletionDeleteAction(object, index)'
      'gtkEntryCompletionSetTextColumn(object, column)'
      'gtkEntryCompletionGetTextColumn(object)'
      'gtkEntryCompletionSetInlineCompletion(object,
     inline.completion)'
      'gtkEntryCompletionGetInlineCompletion(object)'
      'gtkEntryCompletionSetInlineSelection(object, inline.selection)'
      'gtkEntryCompletionGetInlineSelection(object)'
      'gtkEntryCompletionSetPopupCompletion(object, popup.completion)'
      'gtkEntryCompletionGetPopupCompletion(object)'
      'gtkEntryCompletionSetPopupSetWidth(object, popup.set.width)'
      'gtkEntryCompletionGetPopupSetWidth(object)'
      'gtkEntryCompletionSetPopupSingleMatch(object,
     popup.single.match)'
      'gtkEntryCompletionGetPopupSingleMatch(object)'
      'gtkEntryCompletion()'

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

     GObject
        +----GtkEntryCompletion 

_I_n_t_e_r_f_a_c_e_s:

     GtkEntryCompletion implements 'GtkBuildable' and  'GtkCellLayout'.

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

     'GtkEntryCompletion' is an auxiliary object to be used in
     conjunction with 'GtkEntry' to provide the completion
     functionality. It implements the 'GtkCellLayout' interface, to
     allow the user to add extra cells to the  'GtkTreeView' with
     completion matches. 

     "Completion functionality" means that when the user modifies the
     text  in the entry, 'GtkEntryCompletion' checks which rows in the
     model match  the current content of the entry, and displays a list
     of matches. By default, the matching is done by comparing the
     entry text  case-insensitively against the text column of the
     model (see  'gtkEntryCompletionSetTextColumn'), but this can be
     overridden with  a custom match function (see
     'gtkEntryCompletionSetMatchFunc').

     When the user selects a completion, the content of the entry is
     updated.  By default, the content of the entry is replaced by the
     text column of the  model, but this can be overridden by
     connecting to the ::match-selected signal and updating the entry
     in the signal handler. Note that you should return  'TRUE' from
     the signal handler to suppress the default behaviour.

     To add completion functionality to an entry, use
     'gtkEntrySetCompletion'.

     In addition to regular completion matches, which will be inserted
     into the entry when they are selected, 'GtkEntryCompletion' also
     allows to display  "actions" in the popup window. Their appearance
     is similar to menuitems,  to differentiate them clearly from
     completion strings. When an action is  selected, the
     ::action-activated signal is emitted.

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


     '_G_t_k_E_n_t_r_y_C_o_m_p_l_e_t_i_o_n' The GtkEntryCompletion struct contains only
          private data.


_C_o_n_v_e_n_i_e_n_t _C_o_n_s_t_r_u_c_t_i_o_n:

     'gtkEntryCompletion' is the equivalent of 'gtkEntryCompletionNew'.

_U_s_e_r _F_u_n_c_t_i_o_n_s:


     '_G_t_k_E_n_t_r_y_C_o_m_p_l_e_t_i_o_n_M_a_t_c_h_F_u_n_c(_c_o_m_p_l_e_t_i_o_n, _k_e_y, _i_t_e_r, _u_s_e_r._d_a_t_a)' A
          function which decides whether the row indicated by 'iter'
          matches a given  'key', and should be displayed as a possible
          completion for 'key'. Note that 'key' is normalized and
          case-folded (see 'gUtf8Normalize()' and  'gUtf8Casefold()').
          If this is not appropriate, match functions have access to
          the unmodified key via 'gtk_entry_get_text (GTK_ENTRY
          (gtk_entry_completion_get_entry ('.

          '_c_o_m_p_l_e_t_i_o_n' ['GtkEntryCompletion'] the 'GtkEntryCompletion'

          '_k_e_y' [character] the string to match, normalized and
               case-folded

          '_i_t_e_r' ['GtkTreeIter'] a 'GtkTreeIter' indicating the row to
               match

          '_u_s_e_r._d_a_t_a' [R object] user data given to
               'gtkEntryCompletionSetMatchFunc'

          _Returns:_ [logical] 'TRUE' if 'iter' should be displayed as
          a possible completion for 'key'


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


     '_a_c_t_i_o_n-_a_c_t_i_v_a_t_e_d(_w_i_d_g_e_t, _i_n_d_e_x, _u_s_e_r._d_a_t_a)' Gets emitted when an
          action is activated.  

          Since  2.4

          '_w_i_d_g_e_t' ['GtkEntryCompletion']  the object which received
               the signal

          '_i_n_d_e_x' [integer]  the index of the activated action

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


     '_c_u_r_s_o_r-_o_n-_m_a_t_c_h(_w_i_d_g_e_t, _m_o_d_e_l, _i_t_e_r, _u_s_e_r._d_a_t_a)' Gets emitted
          when a match from the cursor is on a match of the list.The
          default behaviour is to replace the contents of the entry
          with the contents of the text column in the row  pointed to
          by 'iter'.  

          Since  2.12

          '_w_i_d_g_e_t' ['GtkEntryCompletion']  the object which received
               the signal

          '_m_o_d_e_l' ['GtkTreeModel']  the 'GtkTreeModel' containing the
               matches

          '_i_t_e_r' ['GtkTreeIter']  a 'GtkTreeIter' positioned at the
               selected match

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

          _Returns:_ [logical] 'TRUE' if the signal has been handled


     '_i_n_s_e_r_t-_p_r_e_f_i_x(_w_i_d_g_e_t, _p_r_e_f_i_x, _u_s_e_r._d_a_t_a)' Gets emitted when the
          inline autocompletion is triggered.  The default behaviour is
          to make the entry display the  whole prefix and select the
          newly inserted part.

          Applications may connect to this signal in order to insert
          only a smaller part of the 'prefix' into the entry - e.g. the
          entry used in the 'GtkFileChooser' inserts only the part of
          the prefix up to the  next '/'.  

          Since  2.6

          '_w_i_d_g_e_t' ['GtkEntryCompletion']  the object which received
               the signal

          '_p_r_e_f_i_x' [character]  the common prefix of all possible
               completions

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

          _Returns:_ [logical] 'TRUE' if the signal has been handled


     '_m_a_t_c_h-_s_e_l_e_c_t_e_d(_w_i_d_g_e_t, _m_o_d_e_l, _i_t_e_r, _u_s_e_r._d_a_t_a)' Gets emitted when
          a match from the list is selected.  The default behaviour is
          to replace the contents of the  entry with the contents of
          the text column in the row  pointed to by 'iter'.  

          Since  2.4

          '_w_i_d_g_e_t' ['GtkEntryCompletion']  the object which received
               the signal

          '_m_o_d_e_l' ['GtkTreeModel']  the 'GtkTreeModel' containing the
               matches

          '_i_t_e_r' ['GtkTreeIter']  a 'GtkTreeIter' positioned at the
               selected match

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

          _Returns:_ [logical] 'TRUE' if the signal has been handled


_P_r_o_p_e_r_t_i_e_s:


     '_i_n_l_i_n_e-_c_o_m_p_l_e_t_i_o_n' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Determines whether
          the common prefix of the possible completions  should be
          inserted automatically in the entry. Note that this requires
          text-column to be set, even if you are using a custom match
          function.  

          Default value: FALSE  Since  2.6


     '_i_n_l_i_n_e-_s_e_l_e_c_t_i_o_n' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Determines whether the
          possible completions on the popup will appear in the entry as
          you navigate through them.  

          Default value: FALSE  Since  2.12


     '_m_i_n_i_m_u_m-_k_e_y-_l_e_n_g_t_h' [_i_n_t_e_g_e_r : _R_e_a_d / _W_r_i_t_e] Minimum length of
          the search key in order to look up matches.  Allowed values:
          >= 0  Default value: 1


     '_m_o_d_e_l' ['_G_t_k_T_r_e_e_M_o_d_e_l' : _R_e_a_d / _W_r_i_t_e] The model to find matches
          in.


     '_p_o_p_u_p-_c_o_m_p_l_e_t_i_o_n' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Determines whether the
          possible completions should be  shown in a popup window.  

          Default value: TRUE  Since  2.6


     '_p_o_p_u_p-_s_e_t-_w_i_d_t_h' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Determines whether the
          completions popup window will be resized to the width of the
          entry.  

          Default value: TRUE  Since  2.8


     '_p_o_p_u_p-_s_i_n_g_l_e-_m_a_t_c_h' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Determines whether
          the completions popup window will shown for a single possible
          completion. You probably want to set this to 'FALSE' if you
          are using  inline  completion.  

          Default value: TRUE  Since  2.8


     '_t_e_x_t-_c_o_l_u_m_n' [_i_n_t_e_g_e_r : _R_e_a_d / _W_r_i_t_e] The column of the model
          containing the strings. Note that the strings must be UTF-8.  

          Allowed values: >= -1  Default value: -1  Since  2.6


_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/gtk/GtkEntryCompletion.html>

