Mercurial > pidgin
view finch/libgnt/gntentry.h @ 29812:1e8dc177415e
propagate from branch 'im.pidgin.pidgin' (head 267f28808ab6eeda6b5d68f6433f2b3fcf230d4f)
to branch 'im.pidgin.cpw.malu.ft_thumbnails' (head e638c5bb96c2400620511beaf38c52bedb56db4b)
author | Marcus Lundblad <ml@update.uu.se> |
---|---|
date | Thu, 18 Feb 2010 21:59:26 +0000 |
parents | 1f59065c606a |
children | 69decc147e5b |
line wrap: on
line source
/** * @file gntentry.h Entry API * @ingroup gnt */ /* * GNT - The GLib Ncurses Toolkit * * GNT is the legal property of its developers, whose names are too numerous * to list here. Please refer to the COPYRIGHT file distributed with this * source distribution. * * This library is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA */ #ifndef GNT_ENTRY_H #define GNT_ENTRY_H #include "gntwidget.h" #include "gnt.h" #include "gntcolors.h" #include "gntkeys.h" #define GNT_TYPE_ENTRY (gnt_entry_get_gtype()) #define GNT_ENTRY(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), GNT_TYPE_ENTRY, GntEntry)) #define GNT_ENTRY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), GNT_TYPE_ENTRY, GntEntryClass)) #define GNT_IS_ENTRY(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), GNT_TYPE_ENTRY)) #define GNT_IS_ENTRY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), GNT_TYPE_ENTRY)) #define GNT_ENTRY_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), GNT_TYPE_ENTRY, GntEntryClass)) #define GNT_ENTRY_FLAGS(obj) (GNT_ENTRY(obj)->priv.flags) #define GNT_ENTRY_SET_FLAGS(obj, flags) (GNT_ENTRY_FLAGS(obj) |= flags) #define GNT_ENTRY_UNSET_FLAGS(obj, flags) (GNT_ENTRY_FLAGS(obj) &= ~(flags)) #define ENTRY_CHAR '_' /* The character to use to fill in the blank places */ typedef struct _GntEntry GntEntry; typedef struct _GntEntryPriv GntEntryPriv; typedef struct _GntEntryClass GntEntryClass; typedef struct _GntEntryKillRing GntEntryKillRing; typedef enum { GNT_ENTRY_FLAG_ALPHA = 1 << 0, /* Only alpha */ GNT_ENTRY_FLAG_INT = 1 << 1, /* Only integer */ GNT_ENTRY_FLAG_NO_SPACE = 1 << 2, /* No blank space is allowed */ GNT_ENTRY_FLAG_NO_PUNCT = 1 << 3, /* No punctuations */ GNT_ENTRY_FLAG_MASK = 1 << 4, /* Mask the inputs */ } GntEntryFlag; #define GNT_ENTRY_FLAG_ALL (GNT_ENTRY_FLAG_ALPHA | GNT_ENTRY_FLAG_INT) struct _GntEntry { GntWidget parent; GntEntryFlag flag; char *start; char *end; char *scroll; /* Current scrolling position */ char *cursor; /* Cursor location */ /* 0 <= cursor - scroll < widget-width */ size_t buffer; /* Size of the buffer */ int max; /* 0 means infinite */ gboolean masked; GList *history; /* History of the strings. User can use this by pressing ctrl+up/down */ int histlength; /* How long can the history be? */ GList *suggests; /* List of suggestions */ gboolean word; /* Are the suggestions for only a word, or for the whole thing? */ gboolean always; /* Should the list of suggestions show at all times, or only on tab-press? */ GntWidget *ddown; /* The dropdown with the suggested list */ GntEntryKillRing *killring; /**< @since 2.3.0 */ }; struct _GntEntryClass { GntWidgetClass parent; void (*text_changed)(GntEntry *entry); void (*gnt_reserved1)(void); void (*gnt_reserved2)(void); void (*gnt_reserved3)(void); void (*gnt_reserved4)(void); }; G_BEGIN_DECLS /** * @return GType for GntEntry. */ GType gnt_entry_get_gtype(void); /** * Create a new GntEntry. * * @param text The text in the new entry box. * * @return The newly created entry box. */ GntWidget * gnt_entry_new(const char *text); /** * Set the maximum length of the text in the entry box. * * @param entry The entry box. * @param max The maximum length for text. A value of 0 means infinite length. */ void gnt_entry_set_max(GntEntry *entry, int max); /** * Set the text in an entry box. * * @param entry The entry box. * @param text The text to set in the box. */ void gnt_entry_set_text(GntEntry *entry, const char *text); /** * Set flags an entry box. * * @param entry The entry box. * @param flag The flags to set for the entry box. */ void gnt_entry_set_flag(GntEntry *entry, GntEntryFlag flag); /** * Get the text in an entry box. * * @param entry The entry box. * * @return The current text in the entry box. */ const char *gnt_entry_get_text(GntEntry *entry); /** * Clear the text in the entry box. * * @param entry The entry box. */ void gnt_entry_clear(GntEntry *entry); /** * Set whether the text in the entry box should be masked for display. * * @param entry The entry box. * @param set @c TRUE if the text should be masked, @c FALSE otherwise. */ void gnt_entry_set_masked(GntEntry *entry, gboolean set); /** * Add a text to the history list for the text. The history length for the * entry box needs to be set first by gnt_entry_set_history_length. * * @param entry The entry box. * @param text A new entry for the history list. */ void gnt_entry_add_to_history(GntEntry *entry, const char *text); /** * Set the length of history for the entry box. * * @param entry The entry box. * @param num The maximum length of the history. */ void gnt_entry_set_history_length(GntEntry *entry, int num); /** * Set whether the suggestions are for the entire entry box, or for each * individual word in the entry box. * * @param entry The entry box. * @param word @c TRUE if the suggestions are for individual words, @c FALSE otherwise. */ void gnt_entry_set_word_suggest(GntEntry *entry, gboolean word); /** * Set whether to always display the suggestions list, or only when the * tab-completion key is pressed (the TAB key, by default). * * @param entry The entry box. * @param always @c TRUE if the suggestion list should always be displayed. */ void gnt_entry_set_always_suggest(GntEntry *entry, gboolean always); /** * Add an item to the suggestion list. * * @param entry The entry box. * @param text An item to add to the suggestion list. */ void gnt_entry_add_suggest(GntEntry *entry, const char *text); /** * Remove an entry from the suggestion list. * * @param entry The entry box. * @param text The item to remove from the suggestion list. */ void gnt_entry_remove_suggest(GntEntry *entry, const char *text); G_END_DECLS #endif /* GNT_ENTRY_H */