MplContentPane

MplContentPane — Content pane with a header.

Synopsis

                    MplContentPane;
                    MplContentPaneClass;
ClutterActor *      mpl_content_pane_new                (char const *title);
char const *        mpl_content_pane_get_title          (MplContentPane *self);
void                mpl_content_pane_set_title          (MplContentPane *self,
                                                         char const *title);
ClutterActor *      mpl_content_pane_get_header_actor   (MplContentPane *self);
void                mpl_content_pane_set_header_actor   (MplContentPane *self,
                                                         ClutterActor *actor);
ClutterActor *      mpl_content_pane_get_child          (MplContentPane *self);
void                mpl_content_pane_set_child          (MplContentPane *self,
                                                         ClutterActor *child);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----ClutterActor
               +----MxWidget
                     +----MxBoxLayout
                           +----MplContentPane

Implemented Interfaces

MplContentPane implements ClutterScriptable, MxStylable, ClutterContainer, MxScrollable and MxFocusable.

Properties

  "child"                    ClutterActor*         : Read / Write
  "header-actor"             ClutterActor*         : Read / Write
  "title"                    gchar*                : Read / Write

Description

MplContentPane provides a styled content pane widget, which consists of a header with a title, an optional header actor packed at the right edge of the header, and a content area.

Details

MplContentPane

typedef struct _MplContentPane MplContentPane;

A styled widget implementing a content pane with a header.


MplContentPaneClass

typedef struct {
} MplContentPaneClass;

Class struct for MplContentPane


mpl_content_pane_new ()

ClutterActor *      mpl_content_pane_new                (char const *title);

Constructs a new MplContentPane with the given title.

title :

the panel title

Returns :

ClutterActor

mpl_content_pane_get_title ()

char const *        mpl_content_pane_get_title          (MplContentPane *self);

Returns the current title of the pane.

self :

MplContentPane

Returns :

pane title

mpl_content_pane_set_title ()

void                mpl_content_pane_set_title          (MplContentPane *self,
                                                         char const *title);

Sets the title of the pane to the given string.

self :

MplContentPane

title :

title

mpl_content_pane_get_header_actor ()

ClutterActor *      mpl_content_pane_get_header_actor   (MplContentPane *self);

Returns the pane header actor, if set or NULL.

self :

MplContentPane

Returns :

ClutterActor

mpl_content_pane_set_header_actor ()

void                mpl_content_pane_set_header_actor   (MplContentPane *self,
                                                         ClutterActor *actor);

Sets the pane header actor. The header actor is an optional actor inserted into the header and packed from its right edge. It can be used, for example, to add a close button to the pane.

self :

MplContentPane

actor :

ClutterActor or NULL

mpl_content_pane_get_child ()

ClutterActor *      mpl_content_pane_get_child          (MplContentPane *self);

Returns the content child of the pane.

self :

MplContentPane

Returns :

ClutterActor

mpl_content_pane_set_child ()

void                mpl_content_pane_set_child          (MplContentPane *self,
                                                         ClutterActor *child);

Sets the content child of the pane to the provided actor.

self :

MplContentPane

child :

ClutterActor

Property Details

The "child" property

  "child"                    ClutterActor*         : Read / Write

Contained actor.


The "header-actor" property

  "header-actor"             ClutterActor*         : Read / Write

Right-hand header actor.


The "title" property

  "title"                    gchar*                : Read / Write

Title text.

Default value: ""