## GnomeDbSelectorPart

GnomeDbSelectorPart —

##

# Synopsis

    struct      GnomeDbSelectorPart;
    void        gnome_db_selector_part_set_name (GnomeDbSelectorPart *part,
                                                 const gchar *name);
    const gchar* gnome_db_selector_part_get_name
                                                (GnomeDbSelectorPart *part);
    void        gnome_db_selector_part_set_parent_part
                                                (GnomeDbSelectorPart *part,
                                                 GnomeDbSelectorPart *parent_part);
    GnomeDbSelectorPart* gnome_db_selector_part_get_parent_part
                                                (GnomeDbSelectorPart *part);
    GdkPixbuf*  gnome_db_selector_part_get_pixbuf
                                                (GnomeDbSelectorPart *part);
    void        gnome_db_selector_part_fill_tree_store
                                                (GnomeDbSelectorPart *part,
                                                 GtkTreeStore *store,
                                                 GtkTreeIter *parent);
    GdaSet*     gnome_db_selector_part_get_params
                                                (GnomeDbSelectorPart *part,
                                                 GtkTreeStore *store,
                                                 GtkTreeIter *at_iter);
    GdaSet*     gnome_db_selector_part_get_data (GnomeDbSelectorPart *part,
                                                 GtkTreeStore *store,
                                                 GtkTreeIter *at_iter);
    const GValue* gnome_db_selector_part_get_value
                                                (GnomeDbSelectorPart *part,
                                                 const gchar *id,
                                                 GtkTreeStore *store,
                                                 GtkTreeIter *at_iter);

    enum        GnomeDbSelectorPartFillMode;
    void        gnome_db_selector_part_obtain_new_store_row
                                                (GnomeDbSelectorPart *part,
                                                 GnomeDbSelectorPartFillMode *in_out_mode,
                                                 GtkTreeStore *store,
                                                 GtkTreeIter *iter,
                                                 GtkTreeIter *parent_iter);

## Object Hierarchy

      GInterface
       +----GnomeDbSelectorPart

## Prerequisites

GnomeDbSelectorPart requires GObject.

## Known Implementations

GnomeDbSelectorPart is implemented by GnomeDbSelectorSchema, GnomeDbSelectorView, GnomeDbSelectorMeta and GnomeDbSelectorTable.

## Description

## Details

### struct GnomeDbSelectorPart

    struct GnomeDbSelectorPart;

### gnome_db_selector_part_set_name ()

    void        gnome_db_selector_part_set_name (GnomeDbSelectorPart *part,
                                                 const gchar *name);

Set `part`'s name to make it easy to identify

`part` : | a GnomeDbSelectorPart object
`name` : | a name for `part`

### gnome_db_selector_part_get_name ()

    const gchar* gnome_db_selector_part_get_name
                                                (GnomeDbSelectorPart *part);

Retreive `part`'s name.

`part` : | a GnomeDbSelectorPart object
Returns : | `part`'s name

### gnome_db_selector_part_set_parent_part ()

    void        gnome_db_selector_part_set_parent_part
                                                (GnomeDbSelectorPart *part,
                                                 GnomeDbSelectorPart *parent_part);

Declares to `part` that its part parent is `parent_part`

`part` : | a GnomeDbSelectorPart object
`parent_part` : | a GnomeDbSelectorPart object, or `NULL`

### gnome_db_selector_part_get_parent_part ()

    GnomeDbSelectorPart* gnome_db_selector_part_get_parent_part
                                                (GnomeDbSelectorPart *part);

Get the parent of `part`.

`part` : | GnomeDbSelectorPart object
Returns : | the parent part, or `NULL` if there is none

### gnome_db_selector_part_get_pixbuf ()

    GdkPixbuf*  gnome_db_selector_part_get_pixbuf
                                                (GnomeDbSelectorPart *part);

Get the preferred pixbug to be used when representing `part`

`part` : | GnomeDbSelectorPart object
Returns : | a new GdkPixbuf (or `NULL`). The caller must call `g_object_unref()` on it when finished

### gnome_db_selector_part_fill_tree_store ()

    void        gnome_db_selector_part_fill_tree_store
                                                (GnomeDbSelectorPart *part,
                                                 GtkTreeStore *store,
                                                 GtkTreeIter *parent);

Make `part` populate (or refresh) the contents of `store`, under the `parent` node

`part` : | a GnomeDbSelectorPart object.
`store` : | a GtkTreeStore
`parent` : |

### gnome_db_selector_part_get_params ()

    GdaSet*     gnome_db_selector_part_get_params
                                                (GnomeDbSelectorPart *part,
                                                 GtkTreeStore *store,
                                                 GtkTreeIter *at_iter);

The caller does not own the returned GdaSet.

`part` : | a GnomeDbSelectorPart object
`store` : | a GtkTreeStore, or `NULL`
`at_iter` : | a GtkTreeIter, or `NULL`
Returns : |

### gnome_db_selector_part_get_data ()

    GdaSet*     gnome_db_selector_part_get_data (GnomeDbSelectorPart *part,
                                                 GtkTreeStore *store,
                                                 GtkTreeIter *at_iter);

The caller does not own the returned GdaSet.

`part` : | a GnomeDbSelectorPart object
`store` : | a GtkTreeStore, or `NULL`
`at_iter` : | a GtkTreeIter, or `NULL`
Returns : |

### gnome_db_selector_part_get_value ()

    const GValue* gnome_db_selector_part_get_value
                                                (GnomeDbSelectorPart *part,
                                                 const gchar *id,
                                                 GtkTreeStore *store,
                                                 GtkTreeIter *at_iter);

Looks for a value which id is `id` in `part` (also looks in its parent hierarchy)

`part` : | a GnomeDbSelectorPart object
`id` : | the ID of the requested value
`store` : | a GtkTreeStore, or `NULL`
`at_iter` : | a GtkTreeIter, or `NULL`
Returns : | the (non modifiable) GValue, or `NULL` if not found

### enum GnomeDbSelectorPartFillMode

    typedef enum {
    	GNOME_DB_SELECTOR_PART_FILL_MODE_FIRST_FILL,
    	GNOME_DB_SELECTOR_PART_FILL_MODE_OVW_FIRST,
    	GNOME_DB_SELECTOR_PART_FILL_MODE_OVW_NEXT
    } GnomeDbSelectorPartFillMode;

### gnome_db_selector_part_obtain_new_store_row ()

    void        gnome_db_selector_part_obtain_new_store_row
                                                (GnomeDbSelectorPart *part,
                                                 GnomeDbSelectorPartFillMode *in_out_mode,
                                                 GtkTreeStore *store,
                                                 GtkTreeIter *iter,
                                                 GtkTreeIter *parent_iter);

Reserved for GnomeDbSelectorPart implementations

`part` : |
`in_out_mode` : |
`store` : |
`iter` : |
`parent_iter` : |