MateEntry

## MateEntry MateEntry |

## Synopsis

    #include <libmateui/libmateui.h>

                        MateEntryPrivate;
    struct              MateEntry;
    GtkWidget *         mate_entry_new                     (const gchar *history_id);
    GtkWidget *         mate_entry_gtk_entry               (MateEntry *gentry);
    const gchar *       mate_entry_get_history_id          (MateEntry *gentry);
    void                mate_entry_set_history_id          (MateEntry *gentry,
                                                             const gchar *history_id);
    void                mate_entry_set_max_saved           (MateEntry *gentry,
                                                             guint max_saved);
    guint               mate_entry_get_max_saved           (MateEntry *gentry);
    void                mate_entry_prepend_history         (MateEntry *gentry,
                                                             gboolean save,
                                                             const gchar *text);
    void                mate_entry_append_history          (MateEntry *gentry,
                                                             gboolean save,
                                                             const gchar *text);
    void                mate_entry_clear_history           (MateEntry *gentry);

## Object Hierarchy

      GObject
       +----GInitiallyUnowned
             +----GtkObject
                   +----GtkWidget
                         +----GtkContainer
                               +----GtkBox
                                     +----GtkHBox
                                           +----GtkCombo
                                                 +----MateEntry

## Implemented Interfaces

MateEntry implements AtkImplementorIface, GtkBuildable, GtkOrientable and GtkEditable.

## Properties

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

## Signals

      "activate"                                       : Run Last

## Description

## Details

### MateEntryPrivate

    typedef struct _MateEntryPrivate MateEntryPrivate;

### Warning

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

### struct MateEntry

    struct MateEntry;

### Warning

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

### mate_entry_new ()

    GtkWidget *         mate_entry_new                     (const gchar *history_id);

### Warning

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

Creates a new MateEntry 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 MateEntry widget.

### mate_entry_gtk_entry ()

    GtkWidget *         mate_entry_gtk_entry               (MateEntry *gentry);

### Warning

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

Obtain pointer to MateEntry's internal text entry

`gentry` : | Pointer to MateEntry object.
Returns : | Pointer to GtkEntry widget.

### mate_entry_get_history_id ()

    const gchar *       mate_entry_get_history_id          (MateEntry *gentry);

### Warning

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

Returns the current history id of the MateEntry widget.

`gentry` : | Pointer to MateEntry object.
Returns : | The current history id.

### mate_entry_set_history_id ()

    void                mate_entry_set_history_id          (MateEntry *gentry,
                                                             const gchar *history_id);

### Warning

`mate_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.

`gentry` : | Pointer to MateEntry object.
`history_id` : | the text id under which history data is stored

### mate_entry_set_max_saved ()

    void                mate_entry_set_max_saved           (MateEntry *gentry,
                                                             guint max_saved);

### Warning

`mate_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`.

`gentry` : | Pointer to MateEntry object.
`max_saved` : | Maximum number of history items to save

### mate_entry_get_max_saved ()

    guint               mate_entry_get_max_saved           (MateEntry *gentry);

### Warning

`mate_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 #`mate_entry_set_max_saved()`.

`gentry` : | Pointer to MateEntry object.
Returns : | An unsigned integer

### mate_entry_prepend_history ()

    void                mate_entry_prepend_history         (MateEntry *gentry,
                                                             gboolean save,
                                                             const gchar *text);

### Warning

`mate_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.

`gentry` : | Pointer to MateEntry object.
`save` : | If `TRUE`, history entry will be saved to config file
`text` : | Text to add

### mate_entry_append_history ()

    void                mate_entry_append_history          (MateEntry *gentry,
                                                             gboolean save,
                                                             const gchar *text);

### Warning

`mate_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.

`gentry` : | Pointer to MateEntry object.
`save` : | If `TRUE`, history entry will be saved to config file
`text` : | Text to add

### mate_entry_clear_history ()

    void                mate_entry_clear_history           (MateEntry *gentry);

### Warning

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

Clears the history.

`gentry` : | Pointer to MateEntry object.

## Property Details

### The `"gtk-entry"` property

      "gtk-entry"                GtkEntry*             : Read

The GTK entry.

### The `"history-id"` property

      "history-id"               gchar*                : Read / Write

History ID.

Default value: NULL

## Signal Details

### The `"activate"` signal

    void                user_function                      (MateEntry *entry,
                                                            gpointer    user_data)      : Run Last

`entry` : | the object which received the signal.
`user_data` : | user data set when the signal handler was connected.