MxSpinner

MxSpinner — a processing indicator widget

Synopsis

                    MxSpinner;
ClutterActor *      mx_spinner_new                      (void);
gboolean            mx_spinner_get_animating            (MxSpinner *spinner);
void                mx_spinner_set_animating            (MxSpinner *spinner,
                                                         gboolean animating);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----ClutterActor
               +----MxWidget
                     +----MxSpinner

Implemented Interfaces

MxSpinner implements ClutterScriptable, ClutterAnimatable, AtkImplementorIface and MxStylable.

Properties

  "animating"                gboolean              : Read / Write

Description

The MxSpinner is a widget to use to indicate that something is being processed, usually a task of indeterminate length.

Details

MxSpinner

typedef struct _MxSpinner MxSpinner;

The contents of this structure are private and should only be accessed through the public API.

mx_spinner_new ()

ClutterActor *      mx_spinner_new                      (void);

Create a new MxSpinner widget.

Returns :

 a newly allocated MxSpinner

mx_spinner_get_animating ()

gboolean            mx_spinner_get_animating            (MxSpinner *spinner);

Determines whether the spinner is animating.

spinner :

 A MxSpinner widget

Returns :

 TRUE if the spinner is animating, FALSE otherwise

mx_spinner_set_animating ()

void                mx_spinner_set_animating            (MxSpinner *spinner,
                                                         gboolean animating);

Sets whether the spinner is animating. A spinner can be stopped if the task it represents has finished, or to save energy.

spinner :

 A MxSpinner widget

animating :

 TRUE to enable animation, FALSE to disable

Property Details

The "animating" property

  "animating"                gboolean              : Read / Write

Whether the spinner is animating.

Default value: TRUE

Generated by GTK-Doc V1.15