MxDialog

MxDialog — a modal, single-widget container

Synopsis

struct              MxDialog;
struct              MxDialogClass;
ClutterActor *      mx_dialog_new                       (void);
void                mx_dialog_set_transient_parent      (MxDialog *dialog,
                                                         ClutterActor *actor);
void                mx_dialog_add_action                (MxDialog *dialog,
                                                         MxAction *action);
void                mx_dialog_remove_action             (MxDialog *dialog,
                                                         MxAction *action);
GList *             mx_dialog_get_actions               (MxDialog *dialog);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----ClutterActor
               +----MxWidget
                     +----MxBin
                           +----MxDialog

Implemented Interfaces

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

Description

MxDialog is a single-widget container. When presented, it performs a suitable transition animation and blocks input to the actors beneath it until it is hidden again.

It also allows actions to be added to it, which will be represented as buttons, using MxButton.

Details

struct MxDialog

struct MxDialog;

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


struct MxDialogClass

struct MxDialogClass {
  MxBinClass parent_class;
};

mx_dialog_new ()

ClutterActor *      mx_dialog_new                       (void);

Creates a new MxDialog.

Returns :

A newly allocated MxDialog

Since 1.2


mx_dialog_set_transient_parent ()

void                mx_dialog_set_transient_parent      (MxDialog *dialog,
                                                         ClutterActor *actor);

Sets the parent of the MxDialog. This is the actor over which the modal frame will appear when clutter_actor_show() is called.

dialog :

A MxDialog

actor :

A ClutterActor

Since 1.2


mx_dialog_add_action ()

void                mx_dialog_add_action                (MxDialog *dialog,
                                                         MxAction *action);

Adds an MxButton that represents action to the button area of dialog

dialog :

A MxDialog

action :

A MxAction

Since 1.2


mx_dialog_remove_action ()

void                mx_dialog_remove_action             (MxDialog *dialog,
                                                         MxAction *action);

Removes the button associated with action from the button area of dialog

dialog :

A MxDialog

action :

A MxAction

Since 1.2


mx_dialog_get_actions ()

GList *             mx_dialog_get_actions               (MxDialog *dialog);

Retrieves a list of actions added to dialog.

dialog :

A MxDialog

Returns :

A newly allocated GList of MxAction objects. The actions in the list are owned by the dialog. [transfer container][element-type Mx.Action]

Since 1.2