![]() | ![]() | ![]() | GTK+ Reference Manual | ![]() |
---|
GtkEntryCompletion —
#include <gtk/gtk.h> struct GtkEntryCompletion; gboolean (*GtkEntryCompletionMatchFunc) (GtkEntryCompletion *completion, const gchar *key, GtkTreeIter *iter, gpointer user_data); GtkEntryCompletion* gtk_entry_completion_new (void); GtkWidget* gtk_entry_completion_get_entry (GtkEntryCompletion *entry); void gtk_entry_completion_set_model (GtkEntryCompletion *completion, GtkTreeModel *model); GtkTreeModel* gtk_entry_completion_get_model (GtkEntryCompletion *completion); void gtk_entry_completion_set_match_func (GtkEntryCompletion *completion, GtkEntryCompletionMatchFunc func, gpointer func_data, GDestroyNotify func_notify); void gtk_entry_completion_set_minimum_key_length (GtkEntryCompletion *completion, gint length); gint gtk_entry_completion_get_minimum_key_length (GtkEntryCompletion *completion); void gtk_entry_completion_complete (GtkEntryCompletion *completion); void gtk_entry_completion_insert_action_text (GtkEntryCompletion *completion, gint index, const gchar *text); void gtk_entry_completion_insert_action_markup (GtkEntryCompletion *completion, gint index, const gchar *markup); void gtk_entry_completion_delete_action (GtkEntryCompletion *completion, gint index); void gtk_entry_completion_set_text_column (GtkEntryCompletion *completion, gint column);
GObject +----GtkEntryCompletion
GtkEntryCompletion implements GtkCellLayout.
"minimum-key-length" gint : Read / Write "model" GtkTreeModel : Read / Write
"action-activated" void user_function (GtkEntryCompletion *entrycompletion, gint arg1, gpointer user_data); "match-selected" gboolean user_function (GtkEntryCompletion *entrycompletion, GtkTreeModel *arg1, GtkTreeIter *arg2, gpointer user_data);
gboolean (*GtkEntryCompletionMatchFunc) (GtkEntryCompletion *completion, const gchar *key, GtkTreeIter *iter, gpointer user_data);
completion : | |
key : | |
iter : | |
user_data : | |
Returns : |
GtkEntryCompletion* gtk_entry_completion_new (void);
Creates a new GtkEntryCompletion object.
Returns : | A newly created GtkEntryCompletion object. |
Since 2.4
GtkWidget* gtk_entry_completion_get_entry (GtkEntryCompletion *entry);
Gets the entry completion has been attached to.
entry : | |
Returns : | The entry completion has been attached to. |
Since 2.4
void gtk_entry_completion_set_model (GtkEntryCompletion *completion, GtkTreeModel *model);
Sets the model for a GtkEntryCompletion. If completion already has a model set, it will remove it before setting the new model.
completion : | A GtkEntryCompletion. |
model : | The GtkTreeModel. |
Since 2.4
GtkTreeModel* gtk_entry_completion_get_model (GtkEntryCompletion *completion);
Returns the model the GtkEntryCompletion is using as data source. Returns NULL if the model is unset.
completion : | A GtkEntryCompletion. |
Returns : | A GtkTreeModel, or NULL if none is currently being used. |
Since 2.4
void gtk_entry_completion_set_match_func (GtkEntryCompletion *completion, GtkEntryCompletionMatchFunc func, gpointer func_data, GDestroyNotify func_notify);
Sets the match function for completion to be func. The match function is used to determine if a row should or should not be in the completion list.
completion : | A GtkEntryCompletion. |
func : | The GtkEntryCompletionMatchFunc to use. |
func_data : | The user data for func. |
func_notify : | Destroy notifier for func_data. |
Since 2.4.
void gtk_entry_completion_set_minimum_key_length (GtkEntryCompletion *completion, gint length);
Requires the length of the search key for completion to be at least length. This is useful for long lists, where completing using a small key takes a lot of time and will come up with meaningless results anyway (ie, a too large dataset).
completion : | A GtkEntryCompletion. |
length : | The minimum length of the key in order to start completing. |
Since 2.4
gint gtk_entry_completion_get_minimum_key_length (GtkEntryCompletion *completion);
Returns the minimum key length as set for completion.
completion : | A GtkEntryCompletion. |
Returns : | The currently used minimum key length. |
Since 2.4
void gtk_entry_completion_complete (GtkEntryCompletion *completion);
Requests a completion operation, or in other words a refiltering of the current list with completions, using the current key. The completion list view will be updated accordingly.
completion : | A GtkEntryCompletion. |
Since 2.4
void gtk_entry_completion_insert_action_text (GtkEntryCompletion *completion, gint index, const gchar *text);
Inserts an action in completion's action item list at position index with text text. If you want the action item to have markup, use gtk_entry_completion_insert_action_markup().
completion : | A GtkEntryCompletion. |
index : | The index of the item to insert. |
text : | Text of the item to insert. |
Since 2.4
void gtk_entry_completion_insert_action_markup (GtkEntryCompletion *completion, gint index, const gchar *markup);
Inserts an action in completion's action item list at position index with markup markup.
completion : | A GtkEntryCompletion. |
index : | The index of the item to insert. |
markup : | Markup of the item to insert. |
Since 2.4
void gtk_entry_completion_delete_action (GtkEntryCompletion *completion, gint index);
Deletes the action at index from completion's action list.
completion : | A GtkEntryCompletion. |
index : | The index of the item to Delete. |
Since 2.4
void gtk_entry_completion_set_text_column (GtkEntryCompletion *completion, gint column);
Conviencefunction for setting up the most used case of this code: a completion list with just strings. This function will set up completion to have a list displaying all (and just) strings in the completion list, and to get those strings from column in the model of completion.
completion : | A GtkEntryCompletion. |
column : | The column in the model of completion to get strings from. |
Since 2.4
"minimum-key-length" (gint : Read / Write) | Minimum length of the search key in order to look up matches. |
"model" (GtkTreeModel : Read / Write) | The model to find matches in. |
void user_function (GtkEntryCompletion *entrycompletion, gint arg1, gpointer user_data);
entrycompletion : | the object which received the signal. |
arg1 : | |
user_data : | user data set when the signal handler was connected. |
gboolean user_function (GtkEntryCompletion *entrycompletion, GtkTreeModel *arg1, GtkTreeIter *arg2, gpointer user_data);
entrycompletion : | the object which received the signal. |
arg1 : | |
arg2 : | |
user_data : | user data set when the signal handler was connected. |
Returns : |
<< GtkEntry | GtkHScale >> |