libchimara/chimara-glk.h

   1 /* Copyright / licensing information here. */
   2
   3 #ifndef __CHIMARA_GLK_H__
   4 #define __CHIMARA_GLK_H__
   5
   6 #include <glib.h>
   7 #include <gtk/gtk.h>
   8 #include <pango/pango.h>
   9
  10 G_BEGIN_DECLS
  11
  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))
  18
  19 /**
  20  * ChimaraGlk:
  21  *
  22  * This structure contains no public members.
  23  */
  24 typedef struct _ChimaraGlk {
  25         GtkContainer parent_instance;
  26
  27         /*< public >*/
  28 } ChimaraGlk;
  29
  30 typedef struct _ChimaraGlkClass {
  31         GtkContainerClass parent_class;
  32         /* Signals */
  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 } ChimaraGlkClass;
  40
  41 /**
  42  * ChimaraError:
  43  *
  44  * Error codes returned by #ChimaraGlk widgets and subclasses.
  45  * <variablelist>
  46  * <varlistentry>
  47  *   <term>CHIMARA_LOAD_MODULE_ERROR</term>
  48  *   <listitem><para>There was an error opening the plugin containing the Glk
  49  *   program. The error message from <link
  50  *   linkend="g-module-error">g_module_error()</link> is appended to the <link
  51  *   linkend="GError">GError</link> message.</para></listitem>
  52  * </varlistentry>
  53  * <varlistentry>
  54  *   <term>CHIMARA_NO_GLK_MAIN</term>
  55  *   <listitem><para>The plugin containing the Glk program did not export a
  56  *   glk_main() function.</para></listitem>
  57  * </varlistentry>
  58  * <varlistentry>
  59  *   <term>CHIMARA_PLUGIN_NOT_FOUND</term>
  60  *   <listitem><para>An appropriate interpreter plugin for the autodetected
  61  *   game file type could not be found.</para></listitem>
  62  * </varlistentry>
  63  * <varlistentry>
  64  *   <term>CHIMARA_PLUGIN_ALREADY_RUNNING</term>
  65  *   <listitem><para>A plugin was opened while there was already another plugin
  66  *   running in the widget.</para></listitem>
  67  * </variablelist>
  68  */
  69 typedef enum _ChimaraError {
  70         CHIMARA_LOAD_MODULE_ERROR,
  71         CHIMARA_NO_GLK_MAIN,
  72         CHIMARA_PLUGIN_NOT_FOUND,
  73         CHIMARA_PLUGIN_ALREADY_RUNNING
  74 } ChimaraError;
  75
  76 /**
  77  * CHIMARA_ERROR:
  78  *
  79  * The domain of errors raised by Chimara widgets.
  80  */
  81 #define CHIMARA_ERROR chimara_error_quark()
  82
  83 GQuark chimara_error_quark(void);
  84 GType chimara_glk_get_type(void) G_GNUC_CONST;
  85 GtkWidget *chimara_glk_new(void);
  86 void chimara_glk_set_interactive(ChimaraGlk *glk, gboolean interactive);
  87 gboolean chimara_glk_get_interactive(ChimaraGlk *glk);
  88 void chimara_glk_set_protect(ChimaraGlk *glk, gboolean protect);
  89 gboolean chimara_glk_get_protect(ChimaraGlk *glk);
  90 void chimara_glk_set_default_font_description(ChimaraGlk *glk, PangoFontDescription *font);
  91 void chimara_glk_set_default_font_string(ChimaraGlk *glk, const gchar *font);
  92 PangoFontDescription *chimara_glk_get_default_font_description(ChimaraGlk *glk);
  93 void chimara_glk_set_monospace_font_description(ChimaraGlk *glk, PangoFontDescription *font);
  94 void chimara_glk_set_monospace_font_string(ChimaraGlk *glk, const gchar *font);
  95 PangoFontDescription *chimara_glk_get_monospace_font_description(ChimaraGlk *glk);
  96 void chimara_glk_set_spacing(ChimaraGlk *glk, guint spacing);
  97 guint chimara_glk_get_spacing(ChimaraGlk *glk);
  98 gboolean chimara_glk_run(ChimaraGlk *glk, const gchar *plugin, int argc, char *argv[], GError **error);
  99 void chimara_glk_stop(ChimaraGlk *glk);
 100 void chimara_glk_wait(ChimaraGlk *glk);
 101 gboolean chimara_glk_get_running(ChimaraGlk *glk);
 102 void chimara_glk_feed_char_input(ChimaraGlk *glk, guint32 keycode);
 103 void chimara_glk_feed_line_input(ChimaraGlk *glk, const gchar *text);
 104
 105 G_END_DECLS
 106
 107 #endif /* __CHIMARA_GLK_H__ */