grim/guifications3

fix a documentation goof up

2009-12-27, Gary Kramlich
9a882cfb0ec1
fix a documentation goof up
/*
* Guifications - The end-all, be-all notification framework
* Copyright (C) 2003-2009 Gary Kramlich <grim@reaperworld.com>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef GF_FONT_H
#define GF_FONT_H
#include <gflib/gf_enum.h>
#include <glib-object.h>
#define GF_TYPE_FONT (gf_font_get_gtype())
typedef struct _GfFont GfFont;
#define GF_TYPE_FONT_STYLE (gf_font_style_get_gtype())
typedef enum _GfFontStyle {
GF_FONT_STYLE_NORMAL,
GF_FONT_STYLE_OBLIQUE,
GF_FONT_STYLE_ITALIC
} GfFontStyle;
#define GF_TYPE_FONT_VARIANT (gf_font_variant_get_gtype())
typedef enum _GfFontVariant{
GF_FONT_VARIANT_NORMAL,
GF_FONT_VARIANT_SMALL_CAPS
} GfFontVariant;
#define GF_TYPE_FONT_WEIGHT (gf_font_weight_get_gtype())
typedef enum _GfFontWeight {
GF_FONT_WEIGHT_ULTRA_LIGHT = 200,
GF_FONT_WEIGHT_LIGHT = 300,
GF_FONT_WEIGHT_NORMAL = 400,
GF_FONT_WEIGHT_SEMIBOLD = 600,
GF_FONT_WEIGHT_BOLD = 700,
GF_FONT_WEIGHT_ULTRABOLD = 800,
GF_FONT_WEIGHT_HEAVY = 900
} GfFontWeight;
#define GF_TYPE_FONT_STRETCH (gf_font_stretch_get_gtype())
typedef enum _GfFontStretch {
GF_FONT_STRETCH_ULTRA_CONDENSED,
GF_FONT_STRETCH_EXTRA_CONDENSED,
GF_FONT_STRETCH_CONDENSED,
GF_FONT_STRETCH_SEMI_CONDENSED,
GF_FONT_STRETCH_NORMAL,
GF_FONT_STRETCH_SEMI_EXPANDED,
GF_FONT_STRETCH_EXPANDED,
GF_FONT_STRETCH_EXTRA_EXPANDED,
GF_FONT_STRETCH_ULTRA_EXPANDED
} GfFontStretch;
#define GF_TYPE_FONT_MASK (gf_font_mask_get_gtype())
typedef enum _GfFontMask {
GF_FONT_MASK_FAMILY = 1 << 0,
GF_FONT_MASK_STYLE = 1 << 1,
GF_FONT_MASK_VARIANT = 1 << 2,
GF_FONT_MASK_WEIGHT = 1 << 3,
GF_FONT_MASK_STRETCH = 1 << 4,
GF_FONT_MASK_SIZE = 1 << 5
} GfFontMask;
G_BEGIN_DECLS
GType gf_font_get_gtype(void);
GfFont *gf_font_new();
GfFont *gf_font_copy(const GfFont *font);
void gf_font_free(GfFont *font);
void gf_font_set_family(GfFont *font, const gchar *family);
const gchar *gf_font_get_family(const GfFont *font);
void gf_font_set_style(GfFont *font, GfFontStyle style);
GfFontStyle gf_font_get_style(const GfFont *font);
void gf_font_set_variant(GfFont *font, GfFontVariant variant);
GfFontVariant gf_font_get_variant(const GfFont *font);
void gf_font_set_weight(GfFont *font, GfFontWeight weight);
GfFontWeight gf_font_get_weight(const GfFont *font);
void gf_font_set_stretch(GfFont *font, GfFontStretch stretch);
GfFontStretch gf_font_get_stretch(const GfFont *font);
void gf_font_set_size(GfFont *font, gint size);
gint gf_font_get_size(const GfFont *font);
void gf_font_set_absolute_size(GfFont *font, double size);
gboolean gf_font_get_size_is_absolute(const GfFont *font);
void gf_font_set_mask(GfFont *font, GfFontMask mask);
GfFontMask gf_font_get_mask(const GfFont *font);
gboolean gf_font_equal(const GfFont *f1, const GfFont *f2);
GType gf_font_style_get_gtype(void);
#define gf_font_style_from_string(str) \
gf_enum_from_string(GF_TYPE_FONT_STYLE, (str))
#define gf_font_style_to_string(style, i18n) \
gf_enum_to_string(GF_TYPE_FONT_STYLE, (style), (i18n))
GType gf_font_variant_get_gtype(void);
#define gf_font_variant_from_string(str) \
gf_enum_from_string(GF_TYPE_FONT_VARIANT, (str))
#define gf_font_variant_to_string(variant, i18n) \
gf_enum_to_string(GF_TYPE_FONT_VARIANT, (variant), (i18n))
GType gf_font_weight_get_gtype(void);
#define gf_font_weight_from_string(str) \
gf_enum_from_string(GF_TYPE_FONT_WEIGHT, (str))
#define gf_font_weight_to_string(weight, i18n) \
gf_enum_to_string(GF_TYPE_FONT_WEIGHT, (weight), (i18n))
GType gf_font_stretch_get_gtype(void);
#define gf_font_stretch_from_string(str) \
gf_enum_from_string(GF_TYPE_FONT_STRETCH, (str))
#define gf_font_stretch_to_string(stretch, i18n) \
gf_enum_to_string(GF_TYPE_FONT_STRETCH, (stretch), (i18n))
GType gf_font_mask_get_gtype(void);
#define gf_font_mask_from_string(str) \
gf_enum_from_string(GF_TYPE_FONT_MASK, (str))
#define gf_font_mask_to_string(mask, i18n) \
gf_enum_to_string(GF_TYPE_FONT_MASK, (mask), (i18n))
G_END_DECLS
#endif /* GF_FONT_H */