manpagez: man pages & more
html files: libgimpwidgets
Home | html | info | man

GimpEnumStore

GimpEnumStore — A GimpIntStore subclass that keeps enum values.

Properties

GType * enum-type Read / Write / Construct Only

Types and Values

Object Hierarchy

    GObject
    ╰── GtkListStore
        ╰── GimpIntStore
            ╰── GimpEnumStore

Implemented Interfaces

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

Description

A GimpIntStore subclass that keeps enum values.

Functions

gimp_enum_store_new ()

GtkListStore *
gimp_enum_store_new (GType enum_type);

Creates a new GimpEnumStore, derived from GtkListStore and fills it with enum values. The enum needs to be registered to the type system and should have translatable value names.

Parameters

enum_type

the GType of an enum.

 

Returns

a new GimpEnumStore.

Since: GIMP 2.4


gimp_enum_store_new_with_range ()

GtkListStore *
gimp_enum_store_new_with_range (GType enum_type,
                                gint minimum,
                                gint maximum);

Creates a new GimpEnumStore like gimp_enum_store_new() but allows to limit the enum values to a certain range. Values smaller than minimum or larger than maximum are not added to the store.

Parameters

enum_type

the GType of an enum.

 

minimum

the minimum value to include

 

maximum

the maximum value to include

 

Returns

a new GimpEnumStore.

Since: GIMP 2.4


gimp_enum_store_new_with_values ()

GtkListStore *
gimp_enum_store_new_with_values (GType enum_type,
                                 gint n_values,
                                 ...);

Creates a new GimpEnumStore like gimp_enum_store_new() but allows to expliticely list the enum values that should be added to the store.

Parameters

enum_type

the GType of an enum.

 

n_values

the number of enum values to include

 

...

a list of enum values (exactly n_values )

 

Returns

a new GimpEnumStore.

Since: GIMP 2.4


gimp_enum_store_new_with_values_valist ()

GtkListStore *
gimp_enum_store_new_with_values_valist
                               (GType enum_type,
                                gint n_values,
                                va_list args);

See gimp_enum_store_new_with_values().

Parameters

enum_type

the GType of an enum.

 

n_values

the number of enum values to include

 

args

a va_list of enum values (exactly n_values )

 

Returns

a new GimpEnumStore.

Since: GIMP 2.4


gimp_enum_store_set_stock_prefix ()

void
gimp_enum_store_set_stock_prefix (GimpEnumStore *store,
                                  const gchar *stock_prefix);

Creates a stock ID for each enum value in the store by appending the value's nick to the given stock_prefix , separated by a hyphen.

See also: gimp_enum_combo_box_set_stock_prefix().

Parameters

store

a GimpEnumStore

 

stock_prefix

a prefix to create icon stock ID from enum values

 

Since: GIMP 2.4

Types and Values

GimpEnumStore

typedef struct _GimpEnumStore GimpEnumStore;

Property Details

The “enum-type” property

  “enum-type”                GType *

Sets the GType of the enum to be used in the store.

Flags: Read / Write / Construct Only

Allowed values: gint

Since: GIMP 2.4

© manpagez.com 2000-2017
Individual documents may contain additional copyright information.