[kdbus] KDBUS_ITEM_PAYLOAD_OFF items are (once again) relative to msg header
[platform/upstream/glib.git] / gio / gloadableicon.h
index ef203d7..d164ca0 100644 (file)
@@ -1,5 +1,5 @@
 /* GIO - GLib Input, Output and Streaming Library
- * 
+ *
  * Copyright (C) 2006-2007 Red Hat, Inc.
  *
  * This library is free software; you can redistribute it and/or
@@ -13,9 +13,7 @@
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General
- * Public License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
- * Boston, MA 02111-1307, USA.
+ * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
  *
  * Author: Alexander Larsson <alexl@redhat.com>
  */
 #ifndef __G_LOADABLE_ICON_H__
 #define __G_LOADABLE_ICON_H__
 
-#include <glib-object.h>
-#include <gio/gicon.h>
-#include <gio/ginputstream.h>
+#if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
+#error "Only <gio/gio.h> can be included directly."
+#endif
+
+#include <gio/giotypes.h>
 
 G_BEGIN_DECLS
 
@@ -34,45 +34,61 @@ G_BEGIN_DECLS
 #define G_IS_LOADABLE_ICON(obj)                (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_LOADABLE_ICON))
 #define G_LOADABLE_ICON_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_LOADABLE_ICON, GLoadableIconIface))
 
-typedef struct _GLoadableIcon                  GLoadableIcon; /* Dummy typedef */
+/**
+ * GLoadableIcon:
+ *
+ * Generic type for all kinds of icons that can be loaded
+ * as a stream.
+ **/
 typedef struct _GLoadableIconIface             GLoadableIconIface;
 
-
+/**
+ * GLoadableIconIface:
+ * @g_iface: The parent interface.
+ * @load: Loads an icon.
+ * @load_async: Loads an icon asynchronously.
+ * @load_finish: Finishes an asynchronous icon load.
+ *
+ * Interface for icons that can be loaded as a stream.
+ **/
 struct _GLoadableIconIface
 {
   GTypeInterface g_iface;
 
   /* Virtual Table */
 
-  GInputStream * (*load)        (GLoadableIcon      *icon,
-                                int                 size,
-                                char              **type,
-                                GCancellable       *cancellable,
-                                GError            **error);
-  void           (*load_async)  (GLoadableIcon      *icon,
-                                int                 size,
-                                GCancellable       *cancellable,
-                                GAsyncReadyCallback callback,
-                                gpointer            user_data);
-  GInputStream * (*load_finish) (GLoadableIcon      *icon,
-                                 GAsyncResult      *res,
-                                 char             **type,
-                                 GError           **error);
+  GInputStream * (* load)        (GLoadableIcon       *icon,
+                                  int                  size,
+                                  char               **type,
+                                  GCancellable        *cancellable,
+                                  GError             **error);
+  void           (* load_async)  (GLoadableIcon       *icon,
+                                  int                  size,
+                                  GCancellable        *cancellable,
+                                  GAsyncReadyCallback  callback,
+                                  gpointer             user_data);
+  GInputStream * (* load_finish) (GLoadableIcon       *icon,
+                                  GAsyncResult        *res,
+                                  char               **type,
+                                  GError             **error);
 };
 
-GType g_loadable_icon_get_type (void) G_GNUC_CONST;
-
+GLIB_AVAILABLE_IN_ALL
+GType         g_loadable_icon_get_type    (void) G_GNUC_CONST;
 
+GLIB_AVAILABLE_IN_ALL
 GInputStream *g_loadable_icon_load        (GLoadableIcon        *icon,
                                           int                   size,
                                           char                **type,
                                           GCancellable         *cancellable,
                                           GError              **error);
+GLIB_AVAILABLE_IN_ALL
 void          g_loadable_icon_load_async  (GLoadableIcon        *icon,
                                           int                   size,
                                           GCancellable         *cancellable,
                                           GAsyncReadyCallback   callback,
                                           gpointer              user_data);
+GLIB_AVAILABLE_IN_ALL
 GInputStream *g_loadable_icon_load_finish (GLoadableIcon        *icon,
                                           GAsyncResult         *res,
                                           char                **type,