GnomeEntry

GnomeEntry

Functions

Properties

GtkEntry * gtk-entry Read
gchar * history-id Read / Write

Signals

Types and Values

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkObject
            ╰── GtkWidget
                ╰── GtkContainer
                    ╰── GtkBox
                        ╰── GtkHBox
                            ╰── GtkCombo
                                ╰── GnomeEntry

Implemented Interfaces

GnomeEntry implements AtkImplementorIface, GtkBuildable, GtkOrientable and GtkEditable.

Includes

#include <libgnomeui/libgnomeui.h>

Description

Functions

gnome_entry_new ()

GtkWidget *
gnome_entry_new (const gchar *history_id);

gnome_entry_new is deprecated and should not be used in newly-written code.

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.

Parameters

history_id

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

 

Returns

Newly-created GnomeEntry widget.


gnome_entry_gtk_entry ()

GtkWidget *
gnome_entry_gtk_entry (GnomeEntry *gentry);

gnome_entry_gtk_entry is deprecated and should not be used in newly-written code.

Obtain pointer to GnomeEntry's internal text entry

Parameters

gentry

Pointer to GnomeEntry object.

 

Returns

Pointer to GtkEntry widget.


gnome_entry_get_history_id ()

const gchar *
gnome_entry_get_history_id (GnomeEntry *gentry);

gnome_entry_get_history_id is deprecated and should not be used in newly-written code.

Returns the current history id of the GnomeEntry widget.

Parameters

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);

gnome_entry_set_history_id is deprecated and should not be used in newly-written code.

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

Parameters

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);

gnome_entry_set_max_saved is deprecated and should not be used in newly-written code.

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.

Parameters

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);

gnome_entry_get_max_saved is deprecated and should not be used in newly-written code.

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

Parameters

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);

gnome_entry_prepend_history is deprecated and should not be used in newly-written code.

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.

Parameters

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);

gnome_entry_append_history is deprecated and should not be used in newly-written code.

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.

Parameters

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);

gnome_entry_clear_history is deprecated and should not be used in newly-written code.

Clears the history.

Parameters

gentry

Pointer to GnomeEntry object.

 

Types and Values

GnomeEntryPrivate

typedef struct _GnomeEntryPrivate GnomeEntryPrivate;

GnomeEntryPrivate is deprecated and should not be used in newly-written code.


struct GnomeEntry

struct GnomeEntry;

GnomeEntry is deprecated and should not be used in newly-written code.

Property Details

The “gtk-entry” property

  “gtk-entry”                GtkEntry *

The GTK entry.

Flags: Read


The “history-id” property

  “history-id”               gchar *

History ID.

Flags: Read / Write

Default value: NULL

Signal Details

The “activate” signal

void
user_function (GnomeEntry *entry,
               gpointer    user_data)

Flags: Run Last