MxEntry

MxEntry — Widget for displaying text

Synopsis

                    MxEntry;
ClutterActor *      mx_entry_new                        (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_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 ClutterScriptable and MxStylable.

Properties

  "hint-text"                gchar*                : Read / Write
  "text"                     gchar*                : Read / Write

Signals

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

Description

MxEntry is a simple widget for displaying 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

MxEntry

typedef struct _MxEntry MxEntry;

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

mx_entry_new ()

ClutterActor *      mx_entry_new                        (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.

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_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 "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 "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.
Generated by GTK-Doc V1.11