AwnOverlayText

## AwnOverlayText AwnOverlayText — Text overlay for use with AwnIcon. |

## Stability Level

Unstable, unless otherwise indicated

## Synopsis

    #include <libawn/libawn.h>

                        AwnOverlayText;
    AwnOverlayText*     awn_overlay_text_new                (void);
    void                awn_overlay_text_get_size           (AwnOverlayText *overlay,
                                                             GtkWidget *widget,
                                                             gchar *text,
                                                             gint size,
                                                             gint *width,
                                                             gint *height);

## Object Hierarchy

      GObject
       +----GInitiallyUnowned
             +----AwnOverlay
                   +----AwnOverlayText

## Properties

      "font-mode"                gint                  : Read / Write
      "font-sizing"              gdouble               : Read / Write / Construct
      "text"                     gchar*                : Read / Write / Construct
      "text-color"               DesktopAgnosticColor*  : Read / Write
      "text-color-astr"          gchar*                : Read / Write
      "text-outline-color"       DesktopAgnosticColor*  : Read / Write
      "text-outline-color-astr"  gchar*                : Read / Write
      "text-outline-width"       gdouble               : Read / Write

## Description

Text overlay used with AwnIcon.

## Details

### AwnOverlayText

    typedef struct _AwnOverlayText AwnOverlayText;

Text overlay used with AwnIcon.

### awn_overlay_text_new ()

    AwnOverlayText*     awn_overlay_text_new                (void);

Creates a new instance of AwnOverlayText.

Returns : | an instance of AwnOverlayText.

### awn_overlay_text_get_size ()

    void                awn_overlay_text_get_size           (AwnOverlayText *overlay,
                                                             GtkWidget *widget,
                                                             gchar *text,
                                                             gint size,
                                                             gint *width,
                                                             gint *height);

`overlay` : |
`widget` : |
`text` : |
`size` : |
`width` : |
`height` : |

## Property Details

### The `"font-mode"` property

      "font-mode"                gint                  : Read / Write

Font Mode.

Allowed values: [0,2]

Default value: 0

### The `"font-sizing"` property

      "font-sizing"              gdouble               : Read / Write / Construct

The Absolute font size as defined for use with PangoFontDescription at `PANGO_SCALE` at an AwnIcon height of 48 pixels. The following standard awn font sizes are predefined: `AWN_FONT_SIZE_EXTRA_SMALL`, `AWN_FONT_SIZE_SMALL`, `AWN_FONT_SIZE_MEDIUM`, `AWN_FONT_SIZE_LARGE`, `AWN_FONT_SIZE_EXTRA_LARGE`. The default size is `AWN_FONT_SIZE_MEDIUM`. Standard doubles can be used but all attempts should be made to use one of the standard awn font sizes.

Allowed values: [1,100]

Default value: 12

### The `"text"` property

      "text"                     gchar*                : Read / Write / Construct

The text to display as a string.

Default value: ""

### The `"text-color"` property

      "text-color"               DesktopAgnosticColor*  : Read / Write

Text color to use as a DesktopAgnosticColor. The default value is `NULL`. If NULL then the current GTK+ Themes foreground GTK_ACTIVE_STATE color will be used.

### The `"text-color-astr"` property

      "text-color-astr"          gchar*                : Read / Write

Text color as string.

Default value: ""

### The `"text-outline-color"` property

      "text-outline-color"       DesktopAgnosticColor*  : Read / Write

Text Outline Colour.

### The `"text-outline-color-astr"` property

      "text-outline-color-astr"  gchar*                : Read / Write

Text outline color as string.

Default value: ""

### The `"text-outline-width"` property

      "text-outline-width"       gdouble               : Read / Write

Text Outline Width.

Allowed values: [0,10]

Default value: 2.5

## See Also

#AwnEffects, AwnOverlay, AwnOverlayThemedIcon, AwnOverlayThrobber, AwnOverlayPixbuf, AwnOverlayPixbufFile, AwnIcon