MxPathBar

MxPathBar

Synopsis

struct              MxPathBar;
ClutterActor *      mx_path_bar_new                     (void);
gint                mx_path_bar_push                    (MxPathBar *bar,
                                                         const gchar *name);
gint                mx_path_bar_pop                     (MxPathBar *bar);
gint                mx_path_bar_get_level               (MxPathBar *bar);
void                mx_path_bar_clear                   (MxPathBar *bar);
gboolean            mx_path_bar_get_editable            (MxPathBar *bar);
void                mx_path_bar_set_editable            (MxPathBar *bar,
                                                         gboolean editable);
gboolean            mx_path_bar_get_clear_on_change     (MxPathBar *bar);
void                mx_path_bar_set_clear_on_change     (MxPathBar *bar,
                                                         gboolean clear_on_change);
const gchar *       mx_path_bar_get_label               (MxPathBar *bar,
                                                         gint level);
void                mx_path_bar_set_label               (MxPathBar *bar,
                                                         gint level,
                                                         const gchar *label);
const gchar *       mx_path_bar_get_text                (MxPathBar *bar);
void                mx_path_bar_set_text                (MxPathBar *bar,
                                                         const gchar *text);
MxEntry *           mx_path_bar_get_entry               (MxPathBar *bar);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----ClutterActor
               +----MxWidget
                     +----MxPathBar

Implemented Interfaces

MxPathBar implements ClutterScriptable, ClutterAnimatable, AtkImplementorIface, MxStylable and MxFocusable.

Properties

  "clear-on-change"          gboolean              : Read / Write
  "editable"                 gboolean              : Read / Write
  "entry"                    MxEntry*              : Read
  "level"                    gint                  : Read

Description

Details

struct MxPathBar

struct MxPathBar;

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


mx_path_bar_new ()

ClutterActor *      mx_path_bar_new                     (void);


mx_path_bar_push ()

gint                mx_path_bar_push                    (MxPathBar *bar,
                                                         const gchar *name);


mx_path_bar_pop ()

gint                mx_path_bar_pop                     (MxPathBar *bar);


mx_path_bar_get_level ()

gint                mx_path_bar_get_level               (MxPathBar *bar);


mx_path_bar_clear ()

void                mx_path_bar_clear                   (MxPathBar *bar);

Remove all the current buttons

bar :

An MxPathBar

mx_path_bar_get_editable ()

gboolean            mx_path_bar_get_editable            (MxPathBar *bar);

Get the value of the "editable" property.

bar :

A MxPathBar

Returns :

the current value of the "editable" property.

mx_path_bar_set_editable ()

void                mx_path_bar_set_editable            (MxPathBar *bar,
                                                         gboolean editable);

Set the value of the "editable" property.

bar :

A MxPathBar

editable :

TRUE if the path bar should be editable

mx_path_bar_get_clear_on_change ()

gboolean            mx_path_bar_get_clear_on_change     (MxPathBar *bar);

Get the value of the "clear-on-change" property

bar :

A MxPathBar

Returns :

the value of the "clear-on-change" property

mx_path_bar_set_clear_on_change ()

void                mx_path_bar_set_clear_on_change     (MxPathBar *bar,
                                                         gboolean clear_on_change);

Set theh value of the "clear-on-change" property

bar :

A MxPathBar

clear_on_change :

the new value of the property

mx_path_bar_get_label ()

const gchar *       mx_path_bar_get_label               (MxPathBar *bar,
                                                         gint level);


mx_path_bar_set_label ()

void                mx_path_bar_set_label               (MxPathBar *bar,
                                                         gint level,
                                                         const gchar *label);

Set the text on the button specified by level

bar :

A MxPathBar

level :

A gint

label :

A gchar

mx_path_bar_get_text ()

const gchar *       mx_path_bar_get_text                (MxPathBar *bar);


mx_path_bar_set_text ()

void                mx_path_bar_set_text                (MxPathBar *bar,
                                                         const gchar *text);

Set the text in the editable area of the MxPathBar

bar :

A MxPathBar

text :

string to set the editable text to.

mx_path_bar_get_entry ()

MxEntry *           mx_path_bar_get_entry               (MxPathBar *bar);

Get the MxEntry used as the editable area in the MxPathBar.

bar :

A MxPathBar

Returns :

MxEntry *

Property Details

The "clear-on-change" property

  "clear-on-change"          gboolean              : Read / Write

Whether to clear the entry when changing levels.

Default value: FALSE


The "editable" property

  "editable"                 gboolean              : Read / Write

Enable or disable editing.

Default value: FALSE


The "entry" property

  "entry"                    MxEntry*              : Read

The MxEntry inside the path bar.


The "level" property

  "level"                    gint                  : Read

Depth of the path bar.

Allowed values: >= -1

Default value: 0