[AdgDress] Added missing documentation
[adg.git] / adg / adg-dress.h
blob8bd103223890fcd4c548d1597463bfa84e09d580
1 /* ADG - Automatic Drawing Generation
2 * Copyright (C) 2007,2008,2009 Nicola Fontana <ntd at entidi.it>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17 * Boston, MA 02110-1301, USA.
21 #ifndef __ADG_DRESS_H__
22 #define __ADG_DRESS_H__
24 #include <adg/adg-style.h>
27 G_BEGIN_DECLS
29 #define ADG_TYPE_DRESS (adg_dress_get_type())
30 #define ADG_VALUE_HOLDS_DRESS(value) (G_TYPE_CHECK_VALUE_TYPE((value), ADG_TYPE_DRESS))
32 #define ADG_TYPE_PARAM_SPEC_DRESS (_adg_param_spec_dress_get_type())
33 #define ADG_IS_PARAM_SPEC_DRESS(spec) (G_TYPE_CHECK_INSTANCE_TYPE((spec), ADG_TYPE_PARAM_SPEC_DRESS))
35 #define ADG_DRESS_UNDEFINED 0
36 #define ADG_DRESS_COLOR_REGULAR (_adg_dress_color_regular())
37 #define ADG_DRESS_COLOR_DIMENSION (_adg_dress_color_dimension())
38 #define ADG_DRESS_LINE_REGULAR (_adg_dress_line_regular())
39 #define ADG_DRESS_LINE_DIMENSION (_adg_dress_line_dimension())
40 #define ADG_DRESS_TEXT_REGULAR (_adg_dress_text_regular())
41 #define ADG_DRESS_TEXT_VALUE (_adg_dress_text_value())
42 #define ADG_DRESS_TEXT_LIMIT (_adg_dress_text_limit())
43 #define ADG_DRESS_DIMENSION_REGULAR (_adg_dress_dimension_regular())
46 typedef gint AdgDress;
49 GType adg_dress_get_type (void) G_GNUC_CONST;
50 AdgDress adg_dress_new (const gchar *name,
51 AdgStyle *style);
52 AdgDress adg_dress_new_full (const gchar *name,
53 AdgStyle *style,
54 GType ancestor_type);
55 gboolean adg_dress_set (AdgDress *dress,
56 AdgDress src);
57 gboolean adg_dress_are_related (AdgDress dress1,
58 AdgDress dress2);
59 const gchar * adg_dress_name (AdgDress dress);
60 AdgDress adg_dress_from_name (const gchar *name);
61 GType adg_dress_get_ancestor_type (AdgDress dress);
62 AdgStyle * adg_dress_get_style (AdgDress dress);
63 void adg_dress_set_style (AdgDress dress,
64 AdgStyle *style);
65 gboolean adg_dress_accept_style (AdgDress dress,
66 AdgStyle *style);
68 GType _adg_param_spec_dress_get_type (void) G_GNUC_CONST;
69 GParamSpec * adg_param_spec_dress (const gchar *name,
70 const gchar *nick,
71 const gchar *blurb,
72 AdgDress dress,
73 GParamFlags flags);
75 AdgDress _adg_dress_color_regular (void) G_GNUC_CONST;
76 AdgDress _adg_dress_color_dimension (void) G_GNUC_CONST;
77 AdgDress _adg_dress_line_regular (void) G_GNUC_CONST;
78 AdgDress _adg_dress_line_dimension (void) G_GNUC_CONST;
79 AdgDress _adg_dress_text_regular (void) G_GNUC_CONST;
80 AdgDress _adg_dress_text_value (void) G_GNUC_CONST;
81 AdgDress _adg_dress_text_limit (void) G_GNUC_CONST;
82 AdgDress _adg_dress_dimension_regular (void) G_GNUC_CONST;
84 G_END_DECLS
87 #endif /* __ADG_DRESS_H__ */