awn-overlay

awn-overlay — Base object for overlays used with AwnOverlayable.

Stability Level

Unstable, unless otherwise indicated

Synopsis

#include <libawn/libawn.h>

                    AwnOverlay;
void                (*render)                           (AwnOverlay *overlay,
                                                         GtkWidget *widget,
                                                         cairo_t *cr,
                                                         gint width,
                                                         gint height);
enum                AwnOverlayAlign;
AwnOverlay *        awn_overlay_new                     (void);
void                awn_overlay_render                  (AwnOverlay *overlay,
                                                         GtkWidget *widget,
                                                         cairo_t *cr,
                                                         gint width,
                                                         gint height);
void                awn_overlay_move_to                 (AwnOverlay *overlay,
                                                         cairo_t *cr,
                                                         gint icon_width,
                                                         gint icon_height,
                                                         gint overlay_width,
                                                         gint overlay_height,
                                                         AwnOverlayCoord *coord_req);
gboolean            awn_overlay_get_apply_effects       (AwnOverlay *overlay);
void                awn_overlay_set_apply_effects       (AwnOverlay *overlay,
                                                         gboolean value);
gboolean            awn_overlay_get_use_source_op       (AwnOverlay *overlay);
void                awn_overlay_set_use_source_op       (AwnOverlay *overlay,
                                                         gboolean value);

Description

Base object for overlays used with AwnOverlayable. This object is only useful as a base class from which other classes are derived.

Details

AwnOverlay

typedef struct {
  GInitiallyUnowned parent;
} AwnOverlay;

Base object for overlays used with AwnOverlayable. This object is only useful as a base class from which other classes are derived.


render ()

void                (*render)                           (AwnOverlay *overlay,
                                                         GtkWidget *widget,
                                                         cairo_t *cr,
                                                         gint width,
                                                         gint height);


enum AwnOverlayAlign

typedef enum {
  AWN_OVERLAY_ALIGN_CENTRE,
  AWN_OVERLAY_ALIGN_LEFT,
  AWN_OVERLAY_ALIGN_RIGHT
} AwnOverlayAlign;

An enum for horizontal alignment relative to the GdkGravity specified for an AwnOverlay. Possible values are AWN_OVERLAY_ALIGN_CENTRE, AWN_OVERLAY_ALIGN_LEFT and AWN_OVERLAY_ALIGN_RIGHT

AWN_OVERLAY_ALIGN_CENTRE

Centre alignment.

AWN_OVERLAY_ALIGN_LEFT

Left alignment.

AWN_OVERLAY_ALIGN_RIGHT

Right alignment.

awn_overlay_new ()

AwnOverlay *        awn_overlay_new                     (void);

Creates a new instance of AwnOverlay.

Returns :

an instance of AwnOverlay.

awn_overlay_render ()

void                awn_overlay_render                  (AwnOverlay *overlay,
                                                         GtkWidget *widget,
                                                         cairo_t *cr,
                                                         gint width,
                                                         gint height);

A virtual function invoked by AwnOverlaidIcon for each overlay it contains, on "expose". This should be implemented by subclasses of AwnOverlay.

overlay :

An pointer to an AwnOverlay (or subclass) object.

widget :

The GtkWidget that is being overlaid.

cr :

Pointer to cairo context ( cairo_t ) for the surface being overlaid.

width :

The width of the AwnThemedIcon as gint.

height :

The height of the AwnThemedIcon as gint.

awn_overlay_move_to ()

void                awn_overlay_move_to                 (AwnOverlay *overlay,
                                                         cairo_t *cr,
                                                         gint icon_width,
                                                         gint icon_height,
                                                         gint overlay_width,
                                                         gint overlay_height,
                                                         AwnOverlayCoord *coord_req);

A convenience function for subclasses of AwnOverlay. For most cases will provide correct placement of the overlay within the surface. Only of interest for those implementing AwnOverlay subclass.

overlay :

An pointer to an AwnOverlay (or subclass) object.

cr :

Pointer to Cairo context ( cairo_t) for the surface being overlaid. Poi

icon_width :

The width of the AwnIcon as gint.

icon_height :

The height of the AwnIcon as gint.

overlay_width :

The width of the AwnOverlay as gint.

overlay_height :

The height of the AwnOverlay as gint.

coord_req :

Address of a AwnOverlayCoord structure or NULL. The x,y coords will be returned in the structure if one is provided so they can be used a later time if needed.

awn_overlay_get_apply_effects ()

gboolean            awn_overlay_get_apply_effects       (AwnOverlay *overlay);


awn_overlay_set_apply_effects ()

void                awn_overlay_set_apply_effects       (AwnOverlay *overlay,
                                                         gboolean value);


awn_overlay_get_use_source_op ()

gboolean            awn_overlay_get_use_source_op       (AwnOverlay *overlay);


awn_overlay_set_use_source_op ()

void                awn_overlay_set_use_source_op       (AwnOverlay *overlay,
                                                         gboolean value);

See Also

AwnOverlayable, AwnEffects, AwnIcon, AwnOverlayText, AwnOverlayThemedIcon, AwnOverlayThrobber