* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
- * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef __GTK_ENTRY_COMPLETION_H__
#define __GTK_ENTRY_COMPLETION_H__
-#include <glib-object.h>
+#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
+#error "Only <gtk/gtk.h> can be included directly."
+#endif
#include <gtk/gtktreemodel.h>
#include <gtk/gtkliststore.h>
+#include <gtk/gtkcellarea.h>
#include <gtk/gtktreeviewcolumn.h>
#include <gtk/gtktreemodelfilter.h>
#define GTK_IS_ENTRY_COMPLETION(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_ENTRY_COMPLETION))
#define GTK_IS_ENTRY_COMPLETION_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_ENTRY_COMPLETION))
#define GTK_ENTRY_COMPLETION_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_ENTRY_COMPLETION, GtkEntryCompletionClass))
-#define GTK_ENTRY_COMPLETION_GET_PRIVATE(obj)(G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_ENTRY_COMPLETION, GtkEntryCompletionPrivate))
typedef struct _GtkEntryCompletion GtkEntryCompletion;
typedef struct _GtkEntryCompletionClass GtkEntryCompletionClass;
typedef struct _GtkEntryCompletionPrivate GtkEntryCompletionPrivate;
+/**
+ * GtkEntryCompletionMatchFunc:
+ * @completion: the #GtkEntryCompletion
+ * @key: the string to match, normalized and case-folded
+ * @iter: a #GtkTreeIter indicating the row to match
+ * @user_data: user data given to gtk_entry_completion_set_match_func()
+ *
+ * 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 g_utf8_normalize()
+ * and g_utf8_casefold()). If this is not appropriate, match functions
+ * have access to the unmodified key via
+ * <literal>gtk_entry_get_text (GTK_ENTRY (gtk_entry_completion_get_entry (<!-- -->)))</literal>.
+ *
+ * Returns: %TRUE if @iter should be displayed as a possible completion
+ * for @key
+ */
typedef gboolean (* GtkEntryCompletionMatchFunc) (GtkEntryCompletion *completion,
const gchar *key,
GtkTreeIter *iter,
GtkTreeModel *model,
GtkTreeIter *iter);
void (* action_activated) (GtkEntryCompletion *completion,
- gint index);
+ gint index_);
+ gboolean (* insert_prefix) (GtkEntryCompletion *completion,
+ const gchar *prefix);
+ gboolean (* cursor_on_match) (GtkEntryCompletion *completion,
+ GtkTreeModel *model,
+ GtkTreeIter *iter);
+
+ /* Padding for future expansion */
+ void (*_gtk_reserved0) (void);
+ void (*_gtk_reserved1) (void);
+ void (*_gtk_reserved2) (void);
+ void (*_gtk_reserved3) (void);
};
/* core */
-GType gtk_entry_completion_get_type (void);
+GType gtk_entry_completion_get_type (void) G_GNUC_CONST;
GtkEntryCompletion *gtk_entry_completion_new (void);
+GtkEntryCompletion *gtk_entry_completion_new_with_area (GtkCellArea *area);
-GtkWidget *gtk_entry_completion_get_entry (GtkEntryCompletion *entry);
+GtkWidget *gtk_entry_completion_get_entry (GtkEntryCompletion *completion);
void gtk_entry_completion_set_model (GtkEntryCompletion *completion,
GtkTreeModel *model);
void gtk_entry_completion_set_minimum_key_length (GtkEntryCompletion *completion,
gint length);
gint gtk_entry_completion_get_minimum_key_length (GtkEntryCompletion *completion);
+GDK_AVAILABLE_IN_3_4
+gchar * gtk_entry_completion_compute_prefix (GtkEntryCompletion *completion,
+ const char *key);
void gtk_entry_completion_complete (GtkEntryCompletion *completion);
+void gtk_entry_completion_insert_prefix (GtkEntryCompletion *completion);
void gtk_entry_completion_insert_action_text (GtkEntryCompletion *completion,
- gint index,
- gchar *text);
+ gint index_,
+ const gchar *text);
void gtk_entry_completion_insert_action_markup (GtkEntryCompletion *completion,
- gint index,
- gchar *markup);
+ gint index_,
+ const gchar *markup);
void gtk_entry_completion_delete_action (GtkEntryCompletion *completion,
- gint index);
-
+ gint index_);
+
+void gtk_entry_completion_set_inline_completion (GtkEntryCompletion *completion,
+ gboolean inline_completion);
+gboolean gtk_entry_completion_get_inline_completion (GtkEntryCompletion *completion);
+void gtk_entry_completion_set_inline_selection (GtkEntryCompletion *completion,
+ gboolean inline_selection);
+gboolean gtk_entry_completion_get_inline_selection (GtkEntryCompletion *completion);
+void gtk_entry_completion_set_popup_completion (GtkEntryCompletion *completion,
+ gboolean popup_completion);
+gboolean gtk_entry_completion_get_popup_completion (GtkEntryCompletion *completion);
+void gtk_entry_completion_set_popup_set_width (GtkEntryCompletion *completion,
+ gboolean popup_set_width);
+gboolean gtk_entry_completion_get_popup_set_width (GtkEntryCompletion *completion);
+void gtk_entry_completion_set_popup_single_match (GtkEntryCompletion *completion,
+ gboolean popup_single_match);
+gboolean gtk_entry_completion_get_popup_single_match (GtkEntryCompletion *completion);
+
+const gchar *gtk_entry_completion_get_completion_prefix (GtkEntryCompletion *completion);
/* convenience */
void gtk_entry_completion_set_text_column (GtkEntryCompletion *completion,
gint column);
+gint gtk_entry_completion_get_text_column (GtkEntryCompletion *completion);
G_END_DECLS
projects / ~andy / gtk / blobdiff