AwnOverlayText

AwnOverlayText — Text overlay for use with AwnIcon.

Stability Level

Unstable, unless otherwise indicated

Functions

Properties

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

Types and Values

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── AwnOverlay
            ╰── AwnOverlayText

Includes

#include <libawn/libawn.h>

Description

Text overlay used with AwnIcon.

Functions

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

Types and Values

AwnOverlayText

typedef struct _AwnOverlayText AwnOverlayText;

Text overlay used with AwnIcon.

Property Details

The “font-mode” property

  “font-mode”                gint

Font Mode.

Flags: Read / Write

Allowed values: [0,2]

Default value: 0


The “font-sizing” property

  “font-sizing”              gdouble

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.

Flags: Read / Write / Construct

Allowed values: [1,100]

Default value: 12


The “text” property

  “text”                     gchar *

The text to display as a string.

Flags: Read / Write / Construct

Default value: ""


The “text-color” property

  “text-color”               DesktopAgnosticColor *

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.

Flags: Read / Write


The “text-color-astr” property

  “text-color-astr”          gchar *

Text color as string.

Flags: Read / Write

Default value: ""


The “text-outline-color” property

  “text-outline-color”       DesktopAgnosticColor *

Text Outline Colour.

Flags: Read / Write


The “text-outline-color-astr” property

  “text-outline-color-astr”  gchar *

Text outline color as string.

Flags: Read / Write

Default value: ""


The “text-outline-width” property

  “text-outline-width”       gdouble

Text Outline Width.

Flags: Read / Write

Allowed values: [0,10]

Default value: 2.5

See Also

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