GimpTaggedContainer

GimpTaggedContainer

Synopsis

                    GimpTaggedContainer;
struct              GimpTaggedContainerClass;
const GList *       gimp_tagged_container_get_filter    (GimpTaggedContainer *tagged_container);
gint                gimp_tagged_container_get_tag_count (GimpTaggedContainer *container);
GimpContainer *     gimp_tagged_container_new           (GimpContainer *src_container);
void                gimp_tagged_container_set_filter    (GimpTaggedContainer *tagged_container,
                                                         GList *tags);

Object Hierarchy

  GObject
   +----GimpObject
         +----GimpContainer
               +----GimpList
                     +----GimpFilteredContainer
                           +----GimpTaggedContainer

Implemented Interfaces

GimpTaggedContainer implements GimpConfigInterface.

Description

Details

GimpTaggedContainer

typedef struct _GimpTaggedContainer GimpTaggedContainer;


struct GimpTaggedContainerClass

struct GimpTaggedContainerClass {
  GimpFilteredContainerClass  parent_class;

  void (* tag_count_changed) (GimpTaggedContainer *container,
                              gint                 count);
};


gimp_tagged_container_get_filter ()

const GList *       gimp_tagged_container_get_filter    (GimpTaggedContainer *tagged_container);

Returns current tag filter. Tag filter is a list of GimpTag objects, which must be contained by each object matching filter criteria.

tagged_container :

a GimpTaggedContainer object.

Returns :

a list of GimpTag objects used as filter. This value should not be modified or freed.

gimp_tagged_container_get_tag_count ()

gint                gimp_tagged_container_get_tag_count (GimpTaggedContainer *container);

Get number of distinct tags that are currently assigned to all objects in the container. The count is independent of currently used filter, it is provided for all available objects (ie. empty filter).

container :

a GimpTaggedContainer object.

Returns :

number of distinct tags assigned to all objects in the container.

gimp_tagged_container_new ()

GimpContainer *     gimp_tagged_container_new           (GimpContainer *src_container);

Creates a new GimpTaggedContainer object which creates filtered data view of GimpTagged objects. It filters src_container for objects containing all of the filtering tags. Syncronization with src_container data is performed automatically.

src_container :

container to be filtered.

Returns :

a new GimpTaggedContainer object.

gimp_tagged_container_set_filter ()

void                gimp_tagged_container_set_filter    (GimpTaggedContainer *tagged_container,
                                                         GList *tags);

Sets list of tags to be used for filtering. Only objects which have all of the tags assigned match filtering criteria.

tagged_container :

a GimpTaggedContainer object.

tags :

list of GimpTag objects.