GimpContainer

GimpContainer

Synopsis

                    GimpContainer;
                    GimpContainerPriv;
GType               gimp_container_get_type             (void);
GType               gimp_container_get_children_type    (const GimpContainer *container);
GimpContainerPolicy gimp_container_get_policy           (const GimpContainer *container);
gint                gimp_container_get_n_children       (const GimpContainer *container);
gboolean            gimp_container_is_empty             (const GimpContainer *container);
gboolean            gimp_container_add                  (GimpContainer *container,
                                                         GimpObject *object);
gboolean            gimp_container_remove               (GimpContainer *container,
                                                         GimpObject *object);
gboolean            gimp_container_insert               (GimpContainer *container,
                                                         GimpObject *object,
                                                         gint new_index);
gboolean            gimp_container_reorder              (GimpContainer *container,
                                                         GimpObject *object,
                                                         gint new_index);
void                gimp_container_clear                (GimpContainer *container);
void                gimp_container_freeze               (GimpContainer *container);
void                gimp_container_thaw                 (GimpContainer *container);
gboolean            gimp_container_frozen               (GimpContainer *container);
gboolean            gimp_container_have                 (const GimpContainer *container,
                                                         GimpObject *object);
void                gimp_container_foreach              (const GimpContainer *container,
                                                         GFunc func,
                                                         gpointer user_data);
GimpObject *        gimp_container_get_child_by_name    (const GimpContainer *container,
                                                         const gchar *name);
GimpObject *        gimp_container_get_child_by_index   (const GimpContainer *container,
                                                         gint index);
GimpObject *        gimp_container_get_first_child      (const GimpContainer *container);
GimpObject *        gimp_container_get_last_child       (const GimpContainer *container);
gint                gimp_container_get_child_index      (const GimpContainer *container,
                                                         const GimpObject *object);
GQuark              gimp_container_add_handler          (GimpContainer *container,
                                                         const gchar *signame,
                                                         GCallback callback,
                                                         gpointer callback_data);
void                gimp_container_remove_handler       (GimpContainer *container,
                                                         GQuark id);
GimpObject *        gimp_container_get_neighbor_of      (const GimpContainer *container,
                                                         const GimpObject *object);
gchar **            gimp_container_get_name_array       (const GimpContainer *container,
                                                         gint *length);

Object Hierarchy

  GObject
   +----GimpObject
         +----GimpContainer
               +----GimpList

Implemented Interfaces

GimpContainer implements GimpConfigInterface.

Properties

  "children-type"            GType*                : Read / Write / Construct Only
  "policy"                   GimpContainerPolicy   : Read / Write / Construct Only

Signals

  "add"                                            : Run First
  "freeze"                                         : Run Last
  "remove"                                         : Run First
  "reorder"                                        : Run First
  "thaw"                                           : Run Last

Description

Details

GimpContainer

typedef struct _GimpContainer GimpContainer;


GimpContainerPriv

typedef struct _GimpContainerPriv GimpContainerPriv;


gimp_container_get_type ()

GType               gimp_container_get_type             (void);


gimp_container_get_children_type ()

GType               gimp_container_get_children_type    (const GimpContainer *container);


gimp_container_get_policy ()

GimpContainerPolicy gimp_container_get_policy           (const GimpContainer *container);


gimp_container_get_n_children ()

gint                gimp_container_get_n_children       (const GimpContainer *container);


gimp_container_is_empty ()

gboolean            gimp_container_is_empty             (const GimpContainer *container);


gimp_container_add ()

gboolean            gimp_container_add                  (GimpContainer *container,
                                                         GimpObject *object);


gimp_container_remove ()

gboolean            gimp_container_remove               (GimpContainer *container,
                                                         GimpObject *object);


gimp_container_insert ()

gboolean            gimp_container_insert               (GimpContainer *container,
                                                         GimpObject *object,
                                                         gint new_index);


gimp_container_reorder ()

gboolean            gimp_container_reorder              (GimpContainer *container,
                                                         GimpObject *object,
                                                         gint new_index);


gimp_container_clear ()

void                gimp_container_clear                (GimpContainer *container);


gimp_container_freeze ()

void                gimp_container_freeze               (GimpContainer *container);


gimp_container_thaw ()

void                gimp_container_thaw                 (GimpContainer *container);


gimp_container_frozen ()

gboolean            gimp_container_frozen               (GimpContainer *container);


gimp_container_have ()

gboolean            gimp_container_have                 (const GimpContainer *container,
                                                         GimpObject *object);


gimp_container_foreach ()

void                gimp_container_foreach              (const GimpContainer *container,
                                                         GFunc func,
                                                         gpointer user_data);


gimp_container_get_child_by_name ()

GimpObject *        gimp_container_get_child_by_name    (const GimpContainer *container,
                                                         const gchar *name);


gimp_container_get_child_by_index ()

GimpObject *        gimp_container_get_child_by_index   (const GimpContainer *container,
                                                         gint index);


gimp_container_get_first_child ()

GimpObject *        gimp_container_get_first_child      (const GimpContainer *container);

container :

a GimpContainer

Returns :

the first child object stored in container or NULL if the container is empty

gimp_container_get_last_child ()

GimpObject *        gimp_container_get_last_child       (const GimpContainer *container);

container :

a GimpContainer

Returns :

the last child object stored in container or NULL if the container is empty

gimp_container_get_child_index ()

gint                gimp_container_get_child_index      (const GimpContainer *container,
                                                         const GimpObject *object);


gimp_container_add_handler ()

GQuark              gimp_container_add_handler          (GimpContainer *container,
                                                         const gchar *signame,
                                                         GCallback callback,
                                                         gpointer callback_data);


gimp_container_remove_handler ()

void                gimp_container_remove_handler       (GimpContainer *container,
                                                         GQuark id);


gimp_container_get_neighbor_of ()

GimpObject *        gimp_container_get_neighbor_of      (const GimpContainer *container,
                                                         const GimpObject *object);


gimp_container_get_name_array ()

gchar **            gimp_container_get_name_array       (const GimpContainer *container,
                                                         gint *length);

Property Details

The "children-type" property

  "children-type"            GType*                : Read / Write / Construct Only

Allowed values: GimpObject


The "policy" property

  "policy"                   GimpContainerPolicy   : Read / Write / Construct Only

Default value: GIMP_CONTAINER_POLICY_STRONG

Signal Details

The "add" signal

void                user_function                      (GimpContainer *gimpcontainer,
                                                        GimpObject    *arg1,
                                                        gpointer       user_data)          : Run First

gimpcontainer :

the object which received the signal.

user_data :

user data set when the signal handler was connected.

The "freeze" signal

void                user_function                      (GimpContainer *gimpcontainer,
                                                        gpointer       user_data)          : Run Last

gimpcontainer :

the object which received the signal.

user_data :

user data set when the signal handler was connected.

The "remove" signal

void                user_function                      (GimpContainer *gimpcontainer,
                                                        GimpObject    *arg1,
                                                        gpointer       user_data)          : Run First

gimpcontainer :

the object which received the signal.

user_data :

user data set when the signal handler was connected.

The "reorder" signal

void                user_function                      (GimpContainer *gimpcontainer,
                                                        GimpObject    *arg1,
                                                        gint           arg2,
                                                        gpointer       user_data)          : Run First

gimpcontainer :

the object which received the signal.

user_data :

user data set when the signal handler was connected.

The "thaw" signal

void                user_function                      (GimpContainer *gimpcontainer,
                                                        gpointer       user_data)          : Run Last

gimpcontainer :

the object which received the signal.

user_data :

user data set when the signal handler was connected.