* 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>
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;
GType u_object_exportable_get_type(void);
+/*
+ * 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