AwnOverlay

AwnOverlay

Synopsis

                    AwnOverlay;
                    AwnOverlayClass;
                    AwnOverlayCoord;
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);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----AwnOverlay
               +----AwnOverlayPixbuf
               +----AwnOverlayProgress
               +----AwnOverlayText
               +----AwnOverlayThemedIcon
               +----AwnOverlayThrobber

Properties

  "active"                   gboolean              : Read / Write / Construct
  "align"                    gint                  : Read / Write / Construct
  "apply-effects"            gboolean              : Read / Write
  "gravity"                  GdkGravity            : Read / Write / Construct
  "use-source-op"            gboolean              : Read / Write
  "x-adj"                    gdouble               : Read / Write / Construct
  "x-override"               gdouble               : Read / Write / Construct
  "y-adj"                    gdouble               : Read / Write / Construct
  "y-override"               gdouble               : Read / Write / Construct

Description

Details

AwnOverlay

typedef struct _AwnOverlay AwnOverlay;


AwnOverlayClass

typedef struct {
    GInitiallyUnownedClass parent_class;

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

Of interest to implementors of AwnOverlay subclasses.

GInitiallyUnownedClass parent_class;

render ()

Virtual function of the form void render (AwnOverlay* overlay, GtkWidget *widget, cairo_t * cr, gint width, gint height)

AwnOverlayCoord

typedef struct {
    gdouble x;
    gdouble y;
} AwnOverlayCoord;

Structure contains x,y coordinates.

gdouble x;

Horizontal position as a gdouble.

gdouble y;


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);


awn_overlay_render ()

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


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);


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);

Property Details

The "active" property

  "active"                   gboolean              : Read / Write / Construct

Active.

Default value: TRUE


The "align" property

  "align"                    gint                  : Read / Write / Construct

Align.

Allowed values: [0,2]

Default value: 0


The "apply-effects" property

  "apply-effects"            gboolean              : Read / Write

Apply Effects.

Default value: TRUE


The "gravity" property

  "gravity"                  GdkGravity            : Read / Write / Construct

Gravity.

Default value: GDK_GRAVITY_CENTER


The "use-source-op" property

  "use-source-op"            gboolean              : Read / Write

Replaces previous content beneath the overlay.

Default value: FALSE


The "x-adj" property

  "x-adj"                    gdouble               : Read / Write / Construct

X adjust.

Allowed values: [-1,1]

Default value: 0


The "x-override" property

  "x-override"               gdouble               : Read / Write / Construct

X Override.

Allowed values: [-10000,1000]

Default value: -10000


The "y-adj" property

  "y-adj"                    gdouble               : Read / Write / Construct

Y adjust.

Allowed values: [-1,1]

Default value: 0


The "y-override" property

  "y-override"               gdouble               : Read / Write / Construct

Y Override.

Allowed values: [-10000,1000]

Default value: -10000