PgmRenderTextIFace

PgmRenderTextIFace — An interface for drawing text.

Synopsis




enum                PgmRenderTextWeight;
enum                PgmRenderTextSlant;
                    PgmRenderTextIFace;
PgmRenderError      pgm_render_text_set_label           (PgmRenderTextIFace *text,
                                                         const gchar *label);
PgmRenderError      pgm_render_text_get_label           (PgmRenderTextIFace *text,
                                                         gchar *label);
PgmRenderError      pgm_render_text_set_font            (PgmRenderTextIFace *text,
                                                         const gchar *name,
                                                         PgmRenderTextWeight weight,
                                                         PgmRenderTextSlant slant,
                                                         gint size);
PgmRenderError      pgm_render_text_get_font            (PgmRenderTextIFace *text,
                                                         PgmRenderTextWeight *weight,
                                                         PgmRenderTextSlant *slant,
                                                         gint *size);
PgmRenderError      pgm_render_text_get_size            (PgmRenderTextIFace *text,
                                                         gint *text_width,
                                                         gint *text_height);


Description

PgmRenderTextIFace is an interface to add text drawing capabilities to an object.

Details

enum PgmRenderTextWeight

typedef enum {
  PGM_RENDER_TEXT_WEIGHT_NORMAL,
  PGM_RENDER_TEXT_WEIGHT_BOLD
} PgmRenderTextWeight;

The different text weight types.

PGM_RENDER_TEXT_WEIGHT_NORMAL Normal text weight.
PGM_RENDER_TEXT_WEIGHT_BOLD Bold text weight.

enum PgmRenderTextSlant

typedef enum {
  PGM_RENDER_TEXT_SLANT_NORMAL,
  PGM_RENDER_TEXT_SLANT_ITALIC
} PgmRenderTextSlant;

The different text slant types.

PGM_RENDER_TEXT_SLANT_NORMAL Normal text slant.
PGM_RENDER_TEXT_SLANT_ITALIC Italic text slant.

PgmRenderTextIFace

typedef struct _PgmRenderTextIFace PgmRenderTextIFace;


pgm_render_text_set_label ()

PgmRenderError      pgm_render_text_set_label           (PgmRenderTextIFace *text,
                                                         const gchar *label);

Sets the label of text.

text : A PgmRenderTextIFace object.
label : The label of the text.
Returns : An error status.

pgm_render_text_get_label ()

PgmRenderError      pgm_render_text_get_label           (PgmRenderTextIFace *text,
                                                         gchar *label);

Retrieves the label of text.

text : A PgmRenderTextIFace object.
label : The label of the text to fill.
Returns : An error status.

pgm_render_text_set_font ()

PgmRenderError      pgm_render_text_set_font            (PgmRenderTextIFace *text,
                                                         const gchar *name,
                                                         PgmRenderTextWeight weight,
                                                         PgmRenderTextSlant slant,
                                                         gint size);

Set the font of text.

text : A PgmRenderTextIFace object.
name : The name of the font.
weight : The weight type of the font.
slant : The slant type of the font.
size : The size of the font in [10, 100].
Returns : An error status.

pgm_render_text_get_font ()

PgmRenderError      pgm_render_text_get_font            (PgmRenderTextIFace *text,
                                                         PgmRenderTextWeight *weight,
                                                         PgmRenderTextSlant *slant,
                                                         gint *size);

Retrieves the font of text.

text : A PgmRenderTextIFace object.
weight : The weight type of the font to fill.
slant : The slant type of the font to fill.
size : The size of the font to fill.
Returns : An error status.

pgm_render_text_get_size ()

PgmRenderError      pgm_render_text_get_size            (PgmRenderTextIFace *text,
                                                         gint *text_width,
                                                         gint *text_height);

Retrieves the real size (text_width, text_height) of the generated text.

text : A PgmRenderTextIFace object.
text_width : The real width of the font to fill.
text_height : The real height of the font to fill.
Returns : An error status.