X-Git-Url: https://git.stderr.nl/gitweb?a=blobdiff_plain;f=libchimara%2Fchimara-glk.h;h=8001adafbfdb3f40ccc0ce4101bb8fc971e8ba12;hb=6c1f4dbd7b7dc80962990fb6ac176551ca88b21c;hp=32725de98968334294eec85e63fdbb7463e6db2d;hpb=aa81cab268d6b17079c9d04226bdfc47a1b6a289;p=projects%2Fchimara%2Fchimara.git
diff --git a/libchimara/chimara-glk.h b/libchimara/chimara-glk.h
index 32725de..8001ada 100644
--- a/libchimara/chimara-glk.h
+++ b/libchimara/chimara-glk.h
@@ -21,13 +21,13 @@ G_BEGIN_DECLS
*
* This structure contains no public members.
*/
-typedef struct _ChimaraGlk {
+typedef struct {
GtkContainer parent_instance;
/*< public >*/
} ChimaraGlk;
-typedef struct _ChimaraGlkClass {
+typedef struct {
GtkContainerClass parent_class;
/* Signals */
void(* stopped) (ChimaraGlk *self);
@@ -36,25 +36,105 @@ typedef struct _ChimaraGlkClass {
void(* char_input) (ChimaraGlk *self, guint32 window_rock, guint keysym);
void(* line_input) (ChimaraGlk *self, guint32 window_rock, gchar *text);
void(* text_buffer_output) (ChimaraGlk *self, guint32 window_rock, gchar *text);
+ void(* iliad_screen_update) (ChimaraGlk *self, gboolean typing);
} ChimaraGlkClass;
+/**
+ * ChimaraGlkWindowType:
+ * @CHIMARA_GLK_TEXT_BUFFER: The styles for text buffer windows.
+ * @CHIMARA_GLK_TEXT_GRID: The styles for text grid windows.
+ *
+ * Specifies the type of windows for which to retrieve the style tag with
+ * chimara_glk_get_tag().
+ */
+typedef enum {
+ CHIMARA_GLK_TEXT_BUFFER,
+ CHIMARA_GLK_TEXT_GRID
+} ChimaraGlkWindowType;
+
+/**
+ * ChimaraError:
+ * @CHIMARA_LOAD_MODULE_ERROR: There was an error opening the plugin containing
+ * the Glk program. The error message from g_module_error() is appended to the GError message.
+ * @CHIMARA_NO_GLK_MAIN: The plugin containing the Glk program did not export a
+ * glk_main() function.
+ * @CHIMARA_PLUGIN_NOT_FOUND: An appropriate interpreter plugin for the
+ * autodetected game file type could not be found.
+ * @CHIMARA_PLUGIN_ALREADY_RUNNING: A plugin was opened while there was already
+ * another plugin running in the widget.
+ *
+ * Error codes returned by #ChimaraGlk widgets and subclasses.
+ */
+typedef enum _ChimaraError {
+ CHIMARA_LOAD_MODULE_ERROR,
+ CHIMARA_NO_GLK_MAIN,
+ CHIMARA_PLUGIN_NOT_FOUND,
+ CHIMARA_PLUGIN_ALREADY_RUNNING
+} ChimaraError;
+
+/**
+ * ChimaraResourceType:
+ * @CHIMARA_RESOURCE_SOUND: A sound file.
+ * @CHIMARA_RESOURCE_IMAGE: An image file.
+ *
+ * The type of resource that the Glk program is requesting, passed to a
+ * #ChimaraResourceLoadFunc.
+ */
+typedef enum _ChimaraResourceType {
+ CHIMARA_RESOURCE_SOUND,
+ CHIMARA_RESOURCE_IMAGE
+} ChimaraResourceType;
+
+/**
+ * ChimaraResourceLoadFunc:
+ * @usage: A #ChimaraResourceType constant.
+ * @resnum: The resource number to look for.
+ * @user_data: A pointer to provide to the callback.
+ *
+ * The type of function passed to chimara_glk_set_resource_load_callback(). It
+ * takes a #ChimaraResourceType constant, @usage, to indicate what sort of
+ * resource to look for; @resnum is the resource number to look for, and
+ * @user_data is the user data provided along with the callback. The function
+ * must return an allocated string containing the filename where the resource
+ * can be found.
+ */
+typedef gchar * (*ChimaraResourceLoadFunc)(ChimaraResourceType usage, guint32 resnum, gpointer user_data);
+
+/**
+ * CHIMARA_ERROR:
+ *
+ * The domain of errors raised by Chimara widgets.
+ */
+#define CHIMARA_ERROR chimara_error_quark()
+
+GQuark chimara_error_quark(void);
GType chimara_glk_get_type(void) G_GNUC_CONST;
GtkWidget *chimara_glk_new(void);
void chimara_glk_set_interactive(ChimaraGlk *glk, gboolean interactive);
gboolean chimara_glk_get_interactive(ChimaraGlk *glk);
void chimara_glk_set_protect(ChimaraGlk *glk, gboolean protect);
gboolean chimara_glk_get_protect(ChimaraGlk *glk);
-void chimara_glk_set_default_font_description(ChimaraGlk *glk, PangoFontDescription *font);
-void chimara_glk_set_default_font_string(ChimaraGlk *glk, const gchar *font);
-PangoFontDescription *chimara_glk_get_default_font_description(ChimaraGlk *glk);
-void chimara_glk_set_monospace_font_description(ChimaraGlk *glk, PangoFontDescription *font);
-void chimara_glk_set_monospace_font_string(ChimaraGlk *glk, const gchar *font);
-PangoFontDescription *chimara_glk_get_monospace_font_description(ChimaraGlk *glk);
+void chimara_glk_set_css_to_default(ChimaraGlk *glk);
+gboolean chimara_glk_set_css_from_file(ChimaraGlk *glk, const gchar *filename, GError **error);
+void chimara_glk_set_css_from_string(ChimaraGlk *glk, const gchar *css);
void chimara_glk_set_spacing(ChimaraGlk *glk, guint spacing);
guint chimara_glk_get_spacing(ChimaraGlk *glk);
-gboolean chimara_glk_run(ChimaraGlk *glk, gchar *plugin, int argc, char *argv[], GError **error);
+gboolean chimara_glk_run(ChimaraGlk *glk, const gchar *plugin, int argc, char *argv[], GError **error);
+gboolean chimara_glk_run_file(ChimaraGlk *self, GFile *plugin_file, int argc, char *argv[], GError **error);
void chimara_glk_stop(ChimaraGlk *glk);
void chimara_glk_wait(ChimaraGlk *glk);
+void chimara_glk_unload_plugin(ChimaraGlk *glk);
+gboolean chimara_glk_get_running(ChimaraGlk *glk);
+void chimara_glk_feed_char_input(ChimaraGlk *glk, guint32 keyval);
+void chimara_glk_feed_line_input(ChimaraGlk *glk, const gchar *text);
+gboolean chimara_glk_is_char_input_pending(ChimaraGlk *glk);
+gboolean chimara_glk_is_line_input_pending(ChimaraGlk *glk);
+GtkTextTag *chimara_glk_get_tag(ChimaraGlk *glk, ChimaraGlkWindowType window, const gchar *name);
+const gchar **chimara_glk_get_tag_names(ChimaraGlk *glk, unsigned int *num_tags);
+void chimara_glk_update_style(ChimaraGlk *glk);
+void chimara_glk_set_resource_load_callback(ChimaraGlk *glk, ChimaraResourceLoadFunc func, gpointer user_data, GDestroyNotify destroy_user_data);
G_END_DECLS