uobject: Namespace changes.

[upkg.git] / src / uobject / exportable.h

diff --git a/src/uobject/exportable.h b/src/uobject/exportable.h
index 931d5b94a4010895b8d870d3090419837d7be0ef..e241f1ec63c2b43c44f60c34bd3ca46a580ed2ce 100644 (file)
--- a/src/uobject/exportable.h
+++ b/src/uobject/exportable.h
@@ -17,22 +17,26 @@
  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 
-#ifndef UOBJECT_EXPORTABLE_H_
-#define UOBJECT_EXPORTABLE_H_
+#ifndef U_OBJECT_EXPORTABLE_H_
+#define U_OBJECT_EXPORTABLE_H_
 
 #include <stdio.h>
 #include <glib-object.h>
 
-#define UOBJECT_TYPE_EXPORTABLE (uobject_exportable_get_type())
-#define UOBJECT_EXPORTABLE(obj) G_TYPE_CHECK_INSTANCE_CAST(obj, \
-       UOBJECT_TYPE_EXPORTABLE, UObjectExportable)
-#define UOBJECT_IS_EXPORTABLE(obj) G_TYPE_CHECK_INSTANCE_TYPE(obj, \
-       UOBJECT_TYPE_EXPORTABLE)
-#define UOBJECT_EXPORTABLE_GET_INTERFACE(inst) G_TYPE_INSTANCE_GET_INTERFACE \
-       (inst, UOBJECT_TYPE_EXPORTABLE, UObjectExportable)
+#define U_OBJECT_TYPE_EXPORTABLE (u_object_exportable_get_type())
+#define U_OBJECT_EXPORTABLE(obj) G_TYPE_CHECK_INSTANCE_CAST(obj, \
+       U_OBJECT_TYPE_EXPORTABLE, UObjectExportable)
+#define U_OBJECT_IS_EXPORTABLE(obj) G_TYPE_CHECK_INSTANCE_TYPE(obj, \
+       U_OBJECT_TYPE_EXPORTABLE)
+#define U_OBJECT_EXPORTABLE_GET_INTERFACE(inst) G_TYPE_INSTANCE_GET_INTERFACE \
+       (inst, U_OBJECT_TYPE_EXPORTABLE, UObjectExportable)
 
 typedef struct UObjectExportable UObjectExportable;
 
+/*
+ * Interface for UObjects that support exporting to a file.  For example, a
+ * texture might be saved to disk as a PNG image for editing.
+ */
 struct UObjectExportable {
        GTypeInterface parent;
 
@@ -40,9 +44,21 @@ struct UObjectExportable {
        int (*export_name)(GObject *obj, char *buf, size_t n);
 };
 
-GType uobject_exportable_get_type(void);
+GType u_object_exportable_get_type(void);
 
-int uobject_export(GObject *obj, FILE *f);
-int uobject_export_name(GObject *obj, char *buf, size_t n);
+/*
+ * Export the object by writing it to the given FILE handle, which must have
+ * been opened for writing in binary mode.
+ */
+int u_object_export(GObject *obj, FILE *f);
+
+/*
+ * Get the suggested output filename.  Not more than n-1 characters of the
+ * filename will be written to buf, and the result is always null terminated.
+ * Returns the number of characters that would be written if the buffer was
+ * not bounded.  It is valid to call this function with a NULL buffer and a 0
+ * size in order to determine how large the buffer needs to be.
+ */
+int u_object_export_name(GObject *obj, char *buf, size_t n);
 
 #endif