MxEntry

## MxEntry MxEntry — Widget for displaying text |

## Synopsis

    struct              MxEntry;
    struct              MxEntryClass;
    ClutterActor *      mx_entry_new                        (void);
    ClutterActor *      mx_entry_new_with_text              (const gchar *text);
    const gchar *       mx_entry_get_text                   (MxEntry *entry);
    void                mx_entry_set_text                   (MxEntry *entry,
                                                             const gchar *text);
    ClutterActor *      mx_entry_get_clutter_text           (MxEntry *entry);
    void                mx_entry_set_hint_text              (MxEntry *entry,
                                                             const gchar *text);
    const gchar *       mx_entry_get_hint_text              (MxEntry *entry);
    void                mx_entry_set_password_char          (MxEntry *entry,
                                                             gunichar password_char);
    gunichar            mx_entry_get_password_char          (MxEntry *entry);
    void                mx_entry_set_primary_icon_from_file (MxEntry *entry,
                                                             const gchar *filename);
    void                mx_entry_set_secondary_icon_from_file
                                                            (MxEntry *entry,
                                                             const gchar *filename);

## Object Hierarchy

      GObject
       +----GInitiallyUnowned
             +----ClutterActor
                   +----MxWidget
                         +----MxEntry

## Implemented Interfaces

MxEntry implements ClutterContainer, ClutterScriptable, ClutterAnimatable, AtkImplementorIface, MxStylable and MxFocusable.

## Properties

      "clutter-text"             ClutterText*          : Read
      "hint-text"                gchar*                : Read / Write
      "icon-highlight-suffix"    gchar*                : Read / Write
      "password-char"            guint                 : Read / Write
      "primary-icon-tooltip-text" gchar*                : Read / Write
      "secondary-icon-tooltip-text" gchar*                : Read / Write
      "text"                     gchar*                : Read / Write

## Signals

      "primary-icon-clicked"                           : Run Last
      "secondary-icon-clicked"                         : Run Last

## Description

MxEntry is a widget for displaying and editing a single line of text. It derives from MxWidget to add extra style and placement functionality over ClutterText. The internal ClutterText is publicly accessibly to allow applications to set further properties.

MxEntry supports the following pseudo style states:

- focus: the widget has focus

- indeterminate: the widget is showing the hint text

## Details

### struct MxEntry

    struct MxEntry;

The contents of this structure is private and should only be accessed using the provided API.

### struct MxEntryClass

    struct MxEntryClass {
      MxWidgetClass parent_class;

      /* signals */
      void (*primary_icon_clicked)   (MxEntry *entry);
      void (*secondary_icon_clicked) (MxEntry *entry);

      /* padding for future expansion */
      void (*_padding_0) (void);
      void (*_padding_1) (void);
      void (*_padding_2) (void);
      void (*_padding_3) (void);
      void (*_padding_4) (void);
    };

### mx_entry_new ()

    ClutterActor *      mx_entry_new                        (void);

Create a new MxEntry

Returns : | a new MxEntry

### mx_entry_new_with_text ()

    ClutterActor *      mx_entry_new_with_text              (const gchar *text);

Create a new MxEntry with the specified entry

`text` : | text to set the entry to
Returns : | a new MxEntry

### mx_entry_get_text ()

    const gchar *       mx_entry_get_text                   (MxEntry *entry);

Get the text displayed on the entry

`entry` : | a MxEntry
Returns : | the text for the entry. This must not be freed by the application

### mx_entry_set_text ()

    void                mx_entry_set_text                   (MxEntry *entry,
                                                             const gchar *text);

Sets the text displayed on the entry

`entry` : | a MxEntry
`text` : | text to set the entry to

### mx_entry_get_clutter_text ()

    ClutterActor *      mx_entry_get_clutter_text           (MxEntry *entry);

Retrieve the internal ClutterText so that extra parameters can be set

`entry` : | a MxEntry
Returns : | the ClutterText used by MxEntry. The entry is owned by the MxEntry and should not be unref'ed by the application. [transfer none]

### mx_entry_set_hint_text ()

    void                mx_entry_set_hint_text              (MxEntry *entry,
                                                             const gchar *text);

Sets the text to display when the entry is empty and unfocused. When the entry is displaying the hint, it has a pseudo class of "indeterminate". A value of NULL unsets the hint.

`entry` : | a MxEntry
`text` : | text to set as the entry hint

### mx_entry_get_hint_text ()

    const gchar *       mx_entry_get_hint_text              (MxEntry *entry);

Gets the text that is displayed when the entry is empty and unfocused

`entry` : | a MxEntry
Returns : | the current value of the hint property. This string is owned by the MxEntry and should not be freed or modified.

### mx_entry_set_password_char ()

    void                mx_entry_set_password_char          (MxEntry *entry,
                                                             gunichar password_char);

Sets the character to display instead of the text. Use 0 to display the actual text.

`entry` : | a MxEntry
`password_char` : | text to set as the entry hint

### mx_entry_get_password_char ()

    gunichar            mx_entry_get_password_char          (MxEntry *entry);

Gets the character to display instead of the text.

`entry` : | a MxEntry
Returns : | a character, or 0 if input should not be hidden.

### mx_entry_set_primary_icon_from_file ()

    void                mx_entry_set_primary_icon_from_file (MxEntry *entry,
                                                             const gchar *filename);

Set the primary icon of the entry to the given filename

`entry` : | a MxEntry
`filename` : | filename of an icon

### mx_entry_set_secondary_icon_from_file ()

    void                mx_entry_set_secondary_icon_from_file
                                                            (MxEntry *entry,
                                                             const gchar *filename);

Set the primary icon of the entry to the given filename

`entry` : | a MxEntry
`filename` : | filename of an icon

## Property Details

### The `"clutter-text"` property

      "clutter-text"             ClutterText*          : Read

Internal ClutterText actor.

### The `"hint-text"` property

      "hint-text"                gchar*                : Read / Write

Text to display when the entry is not focused and the text property is empty.

Default value: NULL

### The `"icon-highlight-suffix"` property

      "icon-highlight-suffix"    gchar*                : Read / Write

The filename suffix for the highligh icon.

Default value: NULL

### The `"password-char"` property

      "password-char"            guint                 : Read / Write

Character to display instead of entered text.

Default value: 0

### The `"primary-icon-tooltip-text"` property

      "primary-icon-tooltip-text" gchar*                : Read / Write

The tooltip text for the primary icon.

Default value: NULL

### The `"secondary-icon-tooltip-text"` property

      "secondary-icon-tooltip-text" gchar*                : Read / Write

The tooltip text for the secondary icon.

Default value: NULL

### The `"text"` property

      "text"                     gchar*                : Read / Write

Text of the entry.

Default value: NULL

## Signal Details

### The `"primary-icon-clicked"` signal

    void                user_function                      (MxEntry *arg0,
                                                            gpointer user_data)      : Run Last

Emitted when the primary icon is clicked

`user_data` : | user data set when the signal handler was connected.

### The `"secondary-icon-clicked"` signal

    void                user_function                      (MxEntry *arg0,
                                                            gpointer user_data)      : Run Last

Emitted when the secondary icon is clicked

`user_data` : | user data set when the signal handler was connected.