1 /* Copyright / licensing information here. */
3 #ifndef __CHIMARA_GLK_H__
4 #define __CHIMARA_GLK_H__
8 #include <pango/pango.h>
12 #define CHIMARA_TYPE_GLK (chimara_glk_get_type())
13 #define CHIMARA_GLK(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), CHIMARA_TYPE_GLK, ChimaraGlk))
14 #define CHIMARA_GLK_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), CHIMARA_TYPE_GLK, ChimaraGlkClass))
15 #define CHIMARA_IS_GLK(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), CHIMARA_TYPE_GLK))
16 #define CHIMARA_IS_GLK_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), CHIMARA_TYPE_GLK))
17 #define CHIMARA_GLK_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), CHIMARA_TYPE_GLK, ChimaraGlkClass))
22 * This structure contains no public members.
24 typedef struct _ChimaraGlk {
25 GtkContainer parent_instance;
30 typedef struct _ChimaraGlkClass {
31 GtkContainerClass parent_class;
33 void(* stopped) (ChimaraGlk *self);
34 void(* started) (ChimaraGlk *self);
35 void(* waiting) (ChimaraGlk *self);
36 void(* char_input) (ChimaraGlk *self, guint32 window_rock, guint keysym);
37 void(* line_input) (ChimaraGlk *self, guint32 window_rock, gchar *text);
38 void(* text_buffer_output) (ChimaraGlk *self, guint32 window_rock, gchar *text);
39 void(* iliad_screen_update) (ChimaraGlk *self, gboolean typing);
43 CHIMARA_GLK_TEXT_BUFFER,
45 } ChimaraGlkWindowType;
49 * @CHIMARA_LOAD_MODULE_ERROR: There was an error opening the plugin containing
50 * the Glk program. The error message from <link
51 * linkend="g-module-error">g_module_error()</link> is appended to the <link
52 * linkend="GError">GError</link> message.
53 * @CHIMARA_NO_GLK_MAIN: The plugin containing the Glk program did not export a
54 * glk_main() function.
55 * @CHIMARA_PLUGIN_NOT_FOUND: An appropriate interpreter plugin for the
56 * autodetected game file type could not be found.
57 * @CHIMARA_PLUGIN_ALREADY_RUNNING: A plugin was opened while there was already
58 * another plugin running in the widget.
60 * Error codes returned by #ChimaraGlk widgets and subclasses.
62 typedef enum _ChimaraError {
63 CHIMARA_LOAD_MODULE_ERROR,
65 CHIMARA_PLUGIN_NOT_FOUND,
66 CHIMARA_PLUGIN_ALREADY_RUNNING
70 * ChimaraResourceType:
71 * @CHIMARA_RESOURCE_SOUND: A sound file.
72 * @CHIMARA_RESOURCE_IMAGE: An image file.
74 * The type of resource that the Glk program is requesting, passed to a
75 * #ChimaraResourceLoadFunc.
77 typedef enum _ChimaraResourceType {
78 CHIMARA_RESOURCE_SOUND,
79 CHIMARA_RESOURCE_IMAGE
80 } ChimaraResourceType;
83 * ChimaraResourceLoadFunc:
85 * The type of function passed to chimara_glk_set_resource_load_callback(). It
86 * takes a #ChimaraResourceType constant, @usage, to indicate what sort of
87 * resource to look for; @resnum is the resource number to look for, and
88 * @user_data is the user data provided along with the callback. The function
89 * must return an allocated string containing the filename where the resource
92 typedef gchar * (*ChimaraResourceLoadFunc)(ChimaraResourceType usage, guint32 resnum, gpointer user_data);
97 * The domain of errors raised by Chimara widgets.
99 #define CHIMARA_ERROR chimara_error_quark()
101 GQuark chimara_error_quark(void);
102 GType chimara_glk_get_type(void) G_GNUC_CONST;
103 GtkWidget *chimara_glk_new(void);
104 void chimara_glk_set_interactive(ChimaraGlk *glk, gboolean interactive);
105 gboolean chimara_glk_get_interactive(ChimaraGlk *glk);
106 void chimara_glk_set_protect(ChimaraGlk *glk, gboolean protect);
107 gboolean chimara_glk_get_protect(ChimaraGlk *glk);
108 void chimara_glk_set_css_to_default(ChimaraGlk *glk);
109 gboolean chimara_glk_set_css_from_file(ChimaraGlk *glk, const gchar *filename, GError **error);
110 void chimara_glk_set_css_from_string(ChimaraGlk *glk, const gchar *css);
111 void chimara_glk_set_spacing(ChimaraGlk *glk, guint spacing);
112 guint chimara_glk_get_spacing(ChimaraGlk *glk);
113 gboolean chimara_glk_run(ChimaraGlk *glk, const gchar *plugin, int argc, char *argv[], GError **error);
114 void chimara_glk_stop(ChimaraGlk *glk);
115 void chimara_glk_wait(ChimaraGlk *glk);
116 gboolean chimara_glk_get_running(ChimaraGlk *glk);
117 void chimara_glk_feed_char_input(ChimaraGlk *glk, guint32 keyval);
118 void chimara_glk_feed_line_input(ChimaraGlk *glk, const gchar *text);
119 gboolean chimara_glk_is_char_input_pending(ChimaraGlk *glk);
120 gboolean chimara_glk_is_line_input_pending(ChimaraGlk *glk);
121 GtkTextTag *chimara_glk_get_tag(ChimaraGlk *glk, ChimaraGlkWindowType window, const gchar *name);
122 const gchar **chimara_glk_get_tag_names(ChimaraGlk *glk);
123 gint chimara_glk_get_num_tag_names(ChimaraGlk *glk);
124 void chimara_glk_update_style(ChimaraGlk *glk);
125 void chimara_glk_set_resource_load_callback(ChimaraGlk *glk, ChimaraResourceLoadFunc func, gpointer user_data);
129 #endif /* __CHIMARA_GLK_H__ */