GimpIntStore

GimpIntStore — A model for integer based name-value pairs (e.g. enums)

Synopsis

                    GimpIntStore;
enum                GimpIntStoreColumns;
GtkListStore *      gimp_int_store_new                  (void);
gboolean            gimp_int_store_lookup_by_value      (GtkTreeModel *model,
                                                         gint value,
                                                         GtkTreeIter *iter);

Object Hierarchy

  GObject
   +----GtkListStore
         +----GimpIntStore
               +----GimpEnumStore

Implemented Interfaces

GimpIntStore implements GtkTreeModel, GtkTreeDragSource, GtkTreeDragDest, GtkTreeSortable and GtkBuildable.

Properties

  "user-data-type"           GType*                : Read / Write / Construct Only

Description

A model for integer based name-value pairs (e.g. enums)

Details

GimpIntStore

typedef struct _GimpIntStore GimpIntStore;

enum GimpIntStoreColumns

typedef enum {
  GIMP_INT_STORE_VALUE,
  GIMP_INT_STORE_LABEL,
  GIMP_INT_STORE_STOCK_ID,
  GIMP_INT_STORE_PIXBUF,
  GIMP_INT_STORE_USER_DATA,
  GIMP_INT_STORE_NUM_COLUMNS
} GimpIntStoreColumns;

The column types of GimpIntStore.

GIMP_INT_STORE_VALUE

 the integer value

GIMP_INT_STORE_LABEL

 a human-readable label

GIMP_INT_STORE_STOCK_ID

 a stock ID

GIMP_INT_STORE_PIXBUF

 a GdkPixbuf

GIMP_INT_STORE_USER_DATA

 arbitrary user data

GIMP_INT_STORE_NUM_COLUMNS

 the number of columns

gimp_int_store_new ()

GtkListStore *      gimp_int_store_new                  (void);

Creates a GtkListStore with a number of useful columns. GimpIntStore is especially useful if the items you want to store are identified using an integer value.

Returns :

 a new GimpIntStore.

Since GIMP 2.2

gimp_int_store_lookup_by_value ()

gboolean            gimp_int_store_lookup_by_value      (GtkTreeModel *model,
                                                         gint value,
                                                         GtkTreeIter *iter);

Iterate over the model looking for value.

model :

 a GimpIntStore

value :

 an integer value to lookup in the model

iter :

 return location for the iter of the given value

Returns :

 TRUE if the value has been located and iter is valid, FALSE otherwise.

Since GIMP 2.2

Property Details

The "user-data-type" property

  "user-data-type"           GType*                : Read / Write / Construct Only

Allows to set the GType for the GIMP_INT_STORE_USER_DATA column.

You need to set this property when constructing the store if you want to use the GIMP_INT_STORE_USER_DATA column and want to have the store handle ref-counting of your user data.

Allowed values: void

Since GIMP 2.4

Generated by GTK-Doc V1.18