MxListView

MxListView — a box layout driven by a model.

Synopsis

                    MxListView;
ClutterActor *      mx_list_view_new                    (void);
void                mx_list_view_set_model              (MxListView *list_view,
                                                         ClutterModel *model);
ClutterModel *      mx_list_view_get_model              (MxListView *list_view);
void                mx_list_view_set_item_type          (MxListView *list_view,
                                                         GType item_type);
GType               mx_list_view_get_item_type          (MxListView *list_view);
void                mx_list_view_add_attribute          (MxListView *list_view,
                                                         const gchar *attribute,
                                                         gint column);
void                mx_list_view_freeze                 (MxListView *list_view);
void                mx_list_view_thaw                   (MxListView *list_view);
void                mx_list_view_set_factory            (MxListView *list_view,
                                                         MxItemFactory *factory);
MxItemFactory *     mx_list_view_get_factory            (MxListView *list_view);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----ClutterActor
               +----MxWidget
                     +----MxBoxLayout
                           +----MxListView

Implemented Interfaces

MxListView implements ClutterScriptable, ClutterAnimatable, AtkImplementorIface, MxStylable, ClutterContainer, MxScrollable and MxFocusable.

Properties

  "factory"                  GObject*              : Read / Write
  "item-type"                GType*                : Read / Write
  "model"                    ClutterModel*         : Read / Write

Description

MxListView is a box layout container driven by a ClutterModel. Children are created for each row in the model, either by creating actors from the supplied ClutterActor derived type, or from a MxItemFactory.

Data is set on the children by mapping columns in the model to object properties on the children.

Details

MxListView

typedef struct _MxListView MxListView;

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


mx_list_view_new ()

ClutterActor *      mx_list_view_new                    (void);

Create a new MxListView

Returns :

a newly allocated MxListView

mx_list_view_set_model ()

void                mx_list_view_set_model              (MxListView *list_view,
                                                         ClutterModel *model);

Set the model used by the MxListView

list_view :

An MxListView

model :

A ClutterModel

mx_list_view_get_model ()

ClutterModel *      mx_list_view_get_model              (MxListView *list_view);

Get the model currently used by the MxListView

list_view :

An MxListView

Returns :

the current ClutterModel

mx_list_view_set_item_type ()

void                mx_list_view_set_item_type          (MxListView *list_view,
                                                         GType item_type);

Set the item type used to create items representing each row in the model

list_view :

An MxListView

item_type :

A GType

mx_list_view_get_item_type ()

GType               mx_list_view_get_item_type          (MxListView *list_view);

Get the item type currently being used to create items

list_view :

An MxListView

Returns :

a GType

mx_list_view_add_attribute ()

void                mx_list_view_add_attribute          (MxListView *list_view,
                                                         const gchar *attribute,
                                                         gint column);

Adds an attribute mapping between the current model and the objects from the cell renderer.

list_view :

An MxListView

attribute :

Name of the attribute

column :

Column number

mx_list_view_freeze ()

void                mx_list_view_freeze                 (MxListView *list_view);

Freeze the view. This means that the view will not act on changes to the model until it is thawed. Call mx_list_view_thaw() to thaw the view

list_view :

An MxListView

mx_list_view_thaw ()

void                mx_list_view_thaw                   (MxListView *list_view);

Thaw the view. This means that the view will now act on changes to the model.

list_view :

An MxListView

mx_list_view_set_factory ()

void                mx_list_view_set_factory            (MxListView *list_view,
                                                         MxItemFactory *factory);

Sets factory to be the factory used for creating new list items

list_view :

A MxListView

factory :

A MxItemFactory. [allow-none]

mx_list_view_get_factory ()

MxItemFactory *     mx_list_view_get_factory            (MxListView *list_view);

Gets the MxItemFactory used for creating new list items.

list_view :

A MxListView

Returns :

A MxItemFactory.

Property Details

The "factory" property

  "factory"                  GObject*              : Read / Write

The MxItemFactory used for creating new items.


The "item-type" property

  "item-type"                GType*                : Read / Write

The GType to use as the items in the view. Must be a subclass of ClutterActor.

Allowed values: ClutterActor


The "model" property

  "model"                    ClutterModel*         : Read / Write

The model for the item view.