GimpTagEntry

GimpTagEntry

Synopsis

                    GimpTagEntry;
GtkWidget *         gimp_tag_entry_new                  (GimpTaggedContainer *container,
                                                         GimpTagEntryMode mode);
void                gimp_tag_entry_set_selected_items   (GimpTagEntry *entry,
                                                         GList *items);
gchar **            gimp_tag_entry_parse_tags           (GimpTagEntry *entry);
void                gimp_tag_entry_set_tag_string       (GimpTagEntry *entry,
                                                         const gchar *tag_string);
const gchar *       gimp_tag_entry_get_separator        (void);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkEntry
                           +----GimpTagEntry
                                 +----GimpComboTagEntry

Implemented Interfaces

GimpTagEntry implements AtkImplementorIface, GtkBuildable, GtkEditable and GtkCellEditable.

Properties

  "container"                GimpTaggedContainer*  : Read / Write / Construct Only
  "mode"                     GimpTagEntryMode      : Read / Write / Construct Only

Description

Details

GimpTagEntry

typedef struct _GimpTagEntry GimpTagEntry;


gimp_tag_entry_new ()

GtkWidget *         gimp_tag_entry_new                  (GimpTaggedContainer *container,
                                                         GimpTagEntryMode mode);

GimpTagEntry is a widget which can query and assign tags to tagged objects. When operating in query mode, container is kept up to date with tags selected. When operating in assignment mode, tags are assigned to objects selected and visible in container.

container :

a GimpTaggedContainer object

mode :

GimpTagEntryMode to work in.

Returns :

a new GimpTagEntry widget.

gimp_tag_entry_set_selected_items ()

void                gimp_tag_entry_set_selected_items   (GimpTagEntry *entry,
                                                         GList *items);

Set list of currently selected GimpTagged objects. Only selected and visible (not filtered out) GimpTagged objects are assigned tags when operating in tag assignment mode.

items :

a list of GimpTagged objects.

gimp_tag_entry_parse_tags ()

gchar **            gimp_tag_entry_parse_tags           (GimpTagEntry *entry);

Parses currently entered tags from entry. Tags do not need to be valid as they are fixed when necessary. Only valid tags are returned.

entry :

a GimpTagEntry widget.

Returns :

a newly allocated NULL terminated list of strings. It should be freed using g_strfreev().

gimp_tag_entry_set_tag_string ()

void                gimp_tag_entry_set_tag_string       (GimpTagEntry *entry,
                                                         const gchar *tag_string);

Sets tags from tag_string to tag_entry. Given tags do not need to be valid as they can be fixed or dropped automatically. Depending on selected GimpTagEntryMode, appropriate action is peformed.

entry :

a GimpTagEntry object.

tag_string :

string of tags, separated by any terminal punctuation character.

gimp_tag_entry_get_separator ()

const gchar *       gimp_tag_entry_get_separator        (void);

Tag separator is a single Unicode terminal punctuation character.

Returns :

returns locale dependent tag separator.

Property Details

The "container" property

  "container"                GimpTaggedContainer*  : Read / Write / Construct Only

The Tagged container.


The "mode" property

  "mode"                     GimpTagEntryMode      : Read / Write / Construct Only

Mode in which to work.

Default value: GIMP_TAG_ENTRY_MODE_QUERY