X-Git-Url: https://git.stderr.nl/gitweb?a=blobdiff_plain;f=src%2Ffileref.h;h=cfbdcca034b46396c9eb3bd119548a0c9ed8464f;hb=91214934fbcdfd363202a65c142194506604ff7b;hp=fb52ee53245e331e3df51e706ecc989458c61a4d;hpb=08b46abcb806c15a053b238e0eaee87a442c940c;p=projects%2Fchimara%2Fchimara.git

diff --git a/src/fileref.h b/src/fileref.h
index fb52ee5..cfbdcca 100644
--- a/src/fileref.h
+++ b/src/fileref.h
@@ -4,15 +4,24 @@
 #include <gtk/gtk.h>
 #include "glk.h"
 
+/**
+ * glk_fileref_struct:
+ *
+ * This is an opaque structure (see <link linkend="chimara-Opaque-Structures">
+ * Opaque Structures</link> and should not be accessed directly.
+ */
 struct glk_fileref_struct
 {
-	glui32 rock;
+	/*< private >*/
+	glui32 magic, rock;
 	/* Pointer to the list node in the global fileref list that contains this
 	fileref */
 	GList* fileref_list;
 	/* Fileref parameters */
-	gchar *filename;
-	glui32 filemode;
+	gchar *filename; /* Always stored in the default filename encoding, not
+		UTF8 or Latin-1 */
+	glui32 orig_filemode; /* Used to check if the user gets a fileref in read
+		mode and then tries to open it in write mode */
 	glui32 usage;
 };