Improved commentary.
[irreco.git] / irreco / src / core / irreco_theme_button.h
blob3375563bed73bc558524d08653d27150a7e386fa
1 /*
2 * irreco - Ir Remote Control
3 * Copyright (C) 2008 Joni Kokko (t5kojo01@students.oamk.fi)
4 *
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License
7 * as published by the Free Software Foundation; either version 2
8 * of the License, or (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20 /**
21 * @addtogroup IrrecoThemeButton
22 * @{
25 /**
26 * @file
27 * Header file of @ref IrrecoThemeButton.
30 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-*/
31 /* Typedef */
32 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-*/
34 * Make sure that typedefs are available before we include anything elese.
36 * This makes sure that whatever other structures that depend on structures
37 * defined in this file will compile OK recardles of header inclusion order.
39 #ifndef __IRRECO_THEME_BUTTON_H_TYPEDEF__
40 #define __IRRECO_THEME_BUTTON_H_TYPEDEF__
41 typedef struct _IrrecoThemeButton IrrecoThemeButton;
42 #endif /* __IRRECO_THEME_BUTTON_H_TYPEDEF__ */
46 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-*/
47 /* Include */
48 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-*/
49 #ifndef __IRRECO_THEME_BUTTON_H__
50 #define __IRRECO_THEME_BUTTON_H__
51 #include "irreco.h"
55 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-*/
56 /* Datatypes */
57 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-*/
59 struct _IrrecoThemeButton
61 GString *style_name;
62 GString *name;
63 gboolean allow_text;
64 GString *image_up;
65 GString *image_down;
66 GString *text_format_up;
67 GString *text_format_down;
68 gint text_padding;
69 gfloat text_h_align;
70 gfloat text_v_align;
73 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-*/
74 /* Macro */
75 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-*/
79 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-*/
80 /* Prototypes */
81 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-*/
83 IrrecoThemeButton *irreco_theme_button_new();
84 void irreco_theme_button_free(IrrecoThemeButton *self);
86 void irreco_theme_button_set(IrrecoThemeButton *self,
87 const char *style_name,
88 const char *name,
89 gboolean allow_text,
90 const char *image_up,
91 const char *image_down,
92 const char *text_format_up,
93 const char *text_format_down,
94 gint text_padding,
95 gfloat text_h_align,
96 gfloat text_v_align);
98 void irreco_theme_button_print(IrrecoThemeButton *self);
99 #endif /* __IRRECO_THEME_BUTTON_H__ */
101 /** @} */