Got Gtk-Doc working. Now all the fancy /** comments before the functions
[rodin/chimara.git] / src / chimara-glk.h
1 /* Copyright / licensing information here. */
2
3 #ifndef __CHIMARA_GLK_H__
4 #define __CHIMARA_GLK_H__
5
6 #include <glib-object.h>
7 #include <gtk/gtk.h>
8
9 G_BEGIN_DECLS
10
11 #define CHIMARA_TYPE_GLK            (chimara_glk_get_type())
12 #define CHIMARA_GLK(obj)            (G_TYPE_CHECK_INSTANCE_CAST((obj), \
13                                      CHIMARA_TYPE_GLK, ChimaraGlk))
14 #define CHIMARA_GLK_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST((klass), \
15                                      CHIMARA_TYPE_GLK, ChimaraGlkClass))
16 #define CHIMARA_IS_GLK(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
17                                      CHIMARA_TYPE_GLK))
18 #define CHIMARA_IS_GLK_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), \
19                                      CHIMARA_TYPE_GLK))
20 #define CHIMARA_GLK_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj), \
21                                      CHIMARA_TYPE_GLK, ChimaraGlkClass))
22
23 /**
24  * ChimaraGlk:
25  * 
26  * This structure contains no public members.
27  */
28 typedef struct _ChimaraGlk {
29         GtkContainer parent_instance;
30     
31         /*< public >*/
32 } ChimaraGlk;
33
34 typedef struct _ChimaraGlkClass {
35         GtkContainerClass parent_class;
36         /* Signals */
37         void(* stopped) (ChimaraGlk *self);
38         void(* started) (ChimaraGlk *self);
39 } ChimaraGlkClass;
40
41 GType chimara_glk_get_type(void) G_GNUC_CONST;
42 GtkWidget *chimara_glk_new(void);
43 void chimara_glk_set_interactive(ChimaraGlk *glk, gboolean interactive);
44 gboolean chimara_glk_get_interactive(ChimaraGlk *glk);
45 void chimara_glk_set_protect(ChimaraGlk *glk, gboolean protect);
46 gboolean chimara_glk_get_protect(ChimaraGlk *glk);
47 gboolean chimara_glk_run(ChimaraGlk *glk, gchar *plugin, GError **error);
48 void chimara_glk_stop(ChimaraGlk *glk);
49 void chimara_glk_wait(ChimaraGlk *glk);
50
51 G_END_DECLS
52
53 #endif /* __CHIMARA_GLK_H__ */