Some documenting thingies.
[irreco.git] / irreco / trunk / src / core / irreco_dlg.h
blob2395b52369feb8c103a2dfebf6ffe29abfb28e15
1 /*
2 * irreco - Ir Remote Control
3 * Copyright (C) 2007 Arto Karppinen (arto.karppinen@iki.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 IrrecoDlg
22 * @{ @file
27 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-*/
28 /* Typedef */
29 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-*/
31 * Make sure that typedefs are available before we include anything elese.
33 * This makes sure that whatever other structures that depend on structures
34 * defined in this file will compile OK recardles of header inclusion order.
36 #ifndef __IRRECO_DLG_H_TYPEDEF__
37 #define __IRRECO_DLG_H_TYPEDEF__
39 #define IRRECO_TYPE_DLG irreco_dlg_get_type()
40 #define IRRECO_DLG(obj) \
41 (G_TYPE_CHECK_INSTANCE_CAST ((obj), \
42 IRRECO_TYPE_DLG, IrrecoDlg))
43 #define IRRECO_DLG_CLASS(klass) \
44 (G_TYPE_CHECK_CLASS_CAST ((klass), \
45 IRRECO_TYPE_DLG, IrrecoDlgClass))
46 #define IRRECO_IS_DLG(obj) \
47 (G_TYPE_CHECK_INSTANCE_TYPE ((obj), \
48 IRRECO_TYPE_DLG))
49 #define IRRECO_IS_DLG_CLASS(klass) \
50 (G_TYPE_CHECK_CLASS_TYPE ((klass), \
51 IRRECO_TYPE_DLG))
52 #define IRRECO_DLG_GET_CLASS(obj) \
53 (G_TYPE_INSTANCE_GET_CLASS ((obj), \
54 IRRECO_TYPE_DLG, IrrecoDlgClass))
56 /**
57 * @addtogroup IrrecoDlg
58 * @{
61 typedef struct _IrrecoDlg IrrecoDlg;
62 typedef struct _IrrecoDlgClass IrrecoDlgClass;
64 /** @} */
66 #endif /* __IRRECO_DLG_H_TYPEDEF__ */
70 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-*/
71 /* Include */
72 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-*/
73 #ifndef __IRRECO_DLG_H__
74 #define __IRRECO_DLG_H__
75 #include "irreco.h"
79 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-*/
80 /* Datatypes */
81 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-*/
83 /**
84 * @addtogroup IrrecoDlg
85 * @{
88 struct _IrrecoDlg {
89 GtkDialog parent;
92 struct _IrrecoDlgClass {
93 GtkDialogClass parent_class;
96 /** @} */
99 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-*/
100 /* Macro */
101 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-*/
105 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-*/
106 /* Prototypes */
107 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-*/
108 GType irreco_dlg_get_type(void);
109 GtkWidget *irreco_dlg_new(void);
110 void irreco_dlg_set_parent(IrrecoDlg *self, GtkWindow *parent);
113 #endif /* __IRRECO_DLG_H__ */
115 /** @} */