GnomeEntry

Name

GnomeEntry -- 

Synopsis


#include <libgnomeui/libgnomeui.h>


struct      GnomeEntryPrivate;
struct      GnomeEntry;
GtkWidget*  gnome_entry_new                 (const gchar *history_id);
void        gnome_entry_construct           (GnomeEntry *gentry,
                                             const gchar *history_id);
GtkWidget*  gnome_entry_gtk_entry           (GnomeEntry *gentry);
const gchar* gnome_entry_get_history_id     (GnomeEntry *gentry);
void        gnome_entry_set_history_id      (GnomeEntry *gentry,
                                             const gchar *history_id);
void        gnome_entry_set_max_saved       (GnomeEntry *gentry,
                                             guint max_saved);
guint       gnome_entry_get_max_saved       (GnomeEntry *gentry);
void        gnome_entry_prepend_history     (GnomeEntry *gentry,
                                             gboolean save,
                                             const gchar *text);
void        gnome_entry_append_history      (GnomeEntry *gentry,
                                             gboolean save,
                                             const gchar *text);
void        gnome_entry_clear_history       (GnomeEntry *gentry);

Object Hierarchy


  GObject
   +----GtkObject
         +----GtkWidget
               +----GtkContainer
                     +----GtkBox
                           +----GtkHBox
                                 +----GtkCombo
                                       +----GnomeEntry

Implemented Interfaces

GnomeEntry implements AtkImplementorIface and GtkEditable.

Properties


  "gtk-entry"            GtkEntry             : Read
  "history-id"           gchararray           : Read / Write

Signal Prototypes


"activate"  void        user_function      (GnomeEntry *entry,
                                            gpointer user_data);

Description

Details

struct GnomeEntryPrivate

struct GnomeEntryPrivate;


struct GnomeEntry

struct GnomeEntry;


gnome_entry_new ()

GtkWidget*  gnome_entry_new                 (const gchar *history_id);

Creates a new GnomeEntry widget. If history_id is not NULL, then the history list will be saved and restored between uses under the given id.

history_id :

If not NULL, the text id under which history data is stored

Returns :

Newly-created GnomeEntry widget.


gnome_entry_construct ()

void        gnome_entry_construct           (GnomeEntry *gentry,
                                             const gchar *history_id);

gentry :

history_id :


gnome_entry_gtk_entry ()

GtkWidget*  gnome_entry_gtk_entry           (GnomeEntry *gentry);

Obtain pointer to GnomeEntry's internal text entry

gentry :

Pointer to GnomeEntry object.

Returns :

Pointer to GtkEntry widget.


gnome_entry_get_history_id ()

const gchar* gnome_entry_get_history_id     (GnomeEntry *gentry);

Returns the current history id of the GnomeEntry widget.

gentry :

Pointer to GnomeEntry object.

Returns :

The current history id.


gnome_entry_set_history_id ()

void        gnome_entry_set_history_id      (GnomeEntry *gentry,
                                             const gchar *history_id);

Set the id of the history list. This function cannot be used to change and already existing id.

gentry :

Pointer to GnomeEntry object.

history_id :

the text id under which history data is stored


gnome_entry_set_max_saved ()

void        gnome_entry_set_max_saved       (GnomeEntry *gentry,
                                             guint max_saved);

Set internal limit on number of history items saved to the config file. Zero is an acceptable value for max_saved, but the same thing is accomplished by setting the history id of gentry to NULL.

gentry :

Pointer to GnomeEntry object.

max_saved :

Maximum number of history items to save


gnome_entry_get_max_saved ()

guint       gnome_entry_get_max_saved       (GnomeEntry *gentry);

Get internal limit on number of history items saved to the config file See #gnome_entry_set_max_saved().

gentry :

Pointer to GnomeEntry object.

Returns :

An unsigned integer


gnome_entry_prepend_history ()

void        gnome_entry_prepend_history     (GnomeEntry *gentry,
                                             gboolean save,
                                             const gchar *text);

Adds a history item of the given text to the head of the history list inside gentry. If save is TRUE, the history item will be saved in the config file (assuming that gentry's history id is not NULL). Duplicates are automatically removed from the history list. The history list is automatically saved if needed.

gentry :

Pointer to GnomeEntry object.

save :

If TRUE, history entry will be saved to config file

text :

Text to add


gnome_entry_append_history ()

void        gnome_entry_append_history      (GnomeEntry *gentry,
                                             gboolean save,
                                             const gchar *text);

Adds a history item of the given text to the tail of the history list inside gentry. If save is TRUE, the history item will be saved in the config file (assuming that gentry's history id is not NULL). Duplicates are automatically removed from the history list. The history list is automatically saved if needed.

gentry :

Pointer to GnomeEntry object.

save :

If TRUE, history entry will be saved to config file

text :

Text to add


gnome_entry_clear_history ()

void        gnome_entry_clear_history       (GnomeEntry *gentry);

Clears the history.

gentry :

Pointer to GnomeEntry object.

Properties

"gtk-entry" (GtkEntry : Read)

"history-id" (gchararray : Read / Write)

Signals

The "activate" signal

void        user_function                  (GnomeEntry *entry,
                                            gpointer user_data);

entry :

the object which received the signal.

user_data :

user data set when the signal handler was connected.