GwyPixmapLayer

GwyPixmapLayer — Base class for GwyDataView pixmap layers

Synopsis




            GwyPixmapLayer;
            GwyPixmapLayerClass;
gboolean    gwy_pixmap_layer_wants_repaint  (GwyPixmapLayer *pixmap_layer);
GdkPixbuf*  gwy_pixmap_layer_paint          (GwyPixmapLayer *pixmap_layer);
void        gwy_pixmap_layer_set_data_key   (GwyPixmapLayer *pixmap_layer,
                                             const gchar *key);
const gchar* gwy_pixmap_layer_get_data_key  (GwyPixmapLayer *pixmap_layer);
void        gwy_pixmap_layer_make_pixbuf    (GwyPixmapLayer *pixmap_layer,
                                             gboolean has_alpha);

Object Hierarchy


  GObject
   +----GtkObject
         +----GwyDataViewLayer
               +----GwyPixmapLayer
                     +----GwyLayerBasic
                     +----GwyLayerMask

Properties


  "data-key"             gchararray            : Read / Write

Description

Details

GwyPixmapLayer

typedef struct _GwyPixmapLayer GwyPixmapLayer;


GwyPixmapLayerClass

typedef struct {
    GwyDataViewLayerClass parent_class;

    GdkPixbuf* (*paint)(GwyPixmapLayer *layer);

    gpointer reserved1;
    gpointer reserved2;
} GwyPixmapLayerClass;


gwy_pixmap_layer_wants_repaint ()

gboolean    gwy_pixmap_layer_wants_repaint  (GwyPixmapLayer *pixmap_layer);

pixmap_layer :
Returns :

gwy_pixmap_layer_paint ()

GdkPixbuf*  gwy_pixmap_layer_paint          (GwyPixmapLayer *pixmap_layer);

Returns a pixbuf with painted pixmap layer.

This method does not enforce repaint. If the layer doesn't think it needs to repaint the pixbuf, it simply returns the current one. To enforce update, emit "data-changed" signal on corresponding data field.

pixmap_layer : A pixmap data view layer.
Returns : The pixbuf. It should not be modified or freed.

gwy_pixmap_layer_set_data_key ()

void        gwy_pixmap_layer_set_data_key   (GwyPixmapLayer *pixmap_layer,
                                             const gchar *key);

Sets the data field to display by a pixmap layer.

pixmap_layer : A pixmap layer.
key : Container string key identifying the data field to display.

gwy_pixmap_layer_get_data_key ()

const gchar* gwy_pixmap_layer_get_data_key  (GwyPixmapLayer *pixmap_layer);

Gets the key identifying data field this pixmap layer displays.

pixmap_layer : A pixmap layer.
Returns : The string key, or NULL if it isn't set.

gwy_pixmap_layer_make_pixbuf ()

void        gwy_pixmap_layer_make_pixbuf    (GwyPixmapLayer *pixmap_layer,
                                             gboolean has_alpha);

Creates or resizes pixmap layer GdkPixbuf to match its data field.

This method is intended for pixmap layer implementation.

pixmap_layer : A pixmap layer.
has_alpha : Whether pixbuf should have alpha channel.

Properties

The "data-key" property

  "data-key"             gchararray            : Read / Write

The :data-key property is the container key used to identify displayed GwyDataField in container.

Default value: NULL