gio/giotypes.h

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2006-2007 Red Hat, Inc.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General
  16  * Public License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  *
  20  * Author: Alexander Larsson <alexl@redhat.com>
  21  */
  22
  23 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  24 #error "Only <gio/gio.h> can be included directly."
  25 #endif
  26
  27 #ifndef __GIO_TYPES_H__
  28 #define __GIO_TYPES_H__
  29
  30 #include <glib-object.h>
  31 #include <gio/gioenums.h>
  32
  33 G_BEGIN_DECLS
  34
  35 typedef struct _GAppLaunchContext             GAppLaunchContext;
  36 typedef struct _GAppInfo                      GAppInfo; /* Dummy typedef */
  37 typedef struct _GAsyncResult                  GAsyncResult; /* Dummy typedef */
  38 typedef struct _GBufferedInputStream          GBufferedInputStream;
  39 typedef struct _GBufferedOutputStream         GBufferedOutputStream;
  40 typedef struct _GCancellable                  GCancellable;
  41 typedef struct _GDataInputStream              GDataInputStream;
  42
  43 /**
  44  * GDrive:
  45  *
  46  * Opaque drive object.
  47  **/
  48 typedef struct _GDrive                        GDrive; /* Dummy typedef */
  49 typedef struct _GFileEnumerator               GFileEnumerator;
  50 typedef struct _GFileMonitor                  GFileMonitor;
  51 typedef struct _GFilterInputStream            GFilterInputStream;
  52 typedef struct _GFilterOutputStream           GFilterOutputStream;
  53
  54 /**
  55  * GFile:
  56  *
  57  * A handle to an object implementing the #GFileIface interface.
  58  * Generally stores a location within the file system. Handles do not
  59  * necessarily represent files or directories that currently exist.
  60  **/
  61 typedef struct _GFile                         GFile; /* Dummy typedef */
  62 typedef struct _GFileInfo                     GFileInfo;
  63
  64 /**
  65  * GFileAttributeMatcher:
  66  *
  67  * Determines if a string matches a file attribute.
  68  **/
  69 typedef struct _GFileAttributeMatcher         GFileAttributeMatcher;
  70 typedef struct _GFileAttributeInfo            GFileAttributeInfo;
  71 typedef struct _GFileAttributeInfoList        GFileAttributeInfoList;
  72 typedef struct _GFileInputStream              GFileInputStream;
  73 typedef struct _GFileOutputStream             GFileOutputStream;
  74 typedef struct _GFileIcon                     GFileIcon;
  75 typedef struct _GFilenameCompleter            GFilenameCompleter;
  76
  77
  78 typedef struct _GIcon                         GIcon; /* Dummy typedef */
  79 typedef struct _GInputStream                  GInputStream;
  80 typedef struct _GIOModule                     GIOModule;
  81 typedef struct _GIOExtensionPoint             GIOExtensionPoint;
  82 typedef struct _GIOExtension                  GIOExtension;
  83
  84 /**
  85  * GIOSchedulerJob:
  86  *
  87  * Opaque class for definining and scheduling IO jobs.
  88  **/
  89 typedef struct _GIOSchedulerJob               GIOSchedulerJob;
  90 typedef struct _GLoadableIcon                 GLoadableIcon; /* Dummy typedef */
  91 typedef struct _GMemoryInputStream            GMemoryInputStream;
  92 typedef struct _GMemoryOutputStream           GMemoryOutputStream;
  93
  94 /**
  95  * GMount:
  96  *
  97  * A handle to an object implementing the #GMountIface interface.
  98  **/
  99 typedef struct _GMount                        GMount; /* Dummy typedef */
 100 typedef struct _GMountOperation               GMountOperation;
 101 typedef struct _GOutputStream                 GOutputStream;
 102 typedef struct _GSeekable                     GSeekable;
 103 typedef struct _GSimpleAsyncResult            GSimpleAsyncResult;
 104 typedef struct _GThemedIcon                   GThemedIcon;
 105 typedef struct _GVfs                          GVfs; /* Dummy typedef */
 106
 107 /**
 108  * GVolume:
 109  *
 110  * Opaque mountable volume object.
 111  **/
 112 typedef struct _GVolume                       GVolume; /* Dummy typedef */
 113 typedef struct _GVolumeMonitor                GVolumeMonitor;
 114
 115 /**
 116  * GAsyncReadyCallback:
 117  * @source_object: the object the asynchronous operation was started with.
 118  * @res: a #GAsyncResult.
 119  * @user_data: user data passed to the callback.
 120  *
 121  * Type definition for a function that will be called back when an asynchronous
 122  * operation within GIO has been completed.
 123  **/
 124 typedef void (*GAsyncReadyCallback) (GObject *source_object,
 125                                      GAsyncResult *res,
 126                                      gpointer user_data);
 127
 128 /**
 129  * GFileProgressCallback:
 130  * @current_num_bytes: the current number of bytes in the operation.
 131  * @total_num_bytes: the total number of bytes in the operation.
 132  * @user_data: user data passed to the callback.
 133  *
 134  * When doing file operations that may take a while, such as moving
 135  * a file or copying a file, a progress callback is used to pass how
 136  * far along that operation is to the application.
 137  **/
 138 typedef void (*GFileProgressCallback) (goffset current_num_bytes,
 139                                        goffset total_num_bytes,
 140                                        gpointer user_data);
 141
 142 /**
 143  * GFileReadMoreCallback:
 144  * @file_contents: the data as currently read.
 145  * @file_size: the size of the data currently read.
 146  * @callback_data: data passed to the callback.
 147  *
 148  * When loading the partial contents of a file with g_file_read_partial_contents(),
 149  * it may become necessary to determine if any more data from the file should be loaded.
 150  * A #GFileReadMoreCallback function facilitates this by returning %TRUE if more data
 151  * should be read, or %FALSE otherwise.
 152  *
 153  * Returns: %TRUE if more data should be read back. %FALSE otherwise.
 154  **/
 155 typedef gboolean (* GFileReadMoreCallback) (const char *file_contents,
 156                                             goffset file_size,
 157                                             gpointer callback_data);
 158
 159
 160 /**
 161  * GIOSchedulerJobFunc:
 162  * @job: a #GIOSchedulerJob.
 163  * @cancellable: optional #GCancellable object, %NULL to ignore.
 164  * @user_data: the data to pass to callback function
 165  *
 166  * I/O Job function.
 167  *
 168  * Note that depending on whether threads are available, the
 169  * #GIOScheduler may run jobs in separate threads or in an idle
 170  * in the mainloop.
 171  *
 172  * Long-running jobs should periodically check the @cancellable
 173  * to see if they have been cancelled.
 174  *
 175  * Returns: %TRUE if this function should be called again to
 176  *    complete the job, %FALSE if the job is complete (or cancelled)
 177  **/
 178 typedef gboolean (*GIOSchedulerJobFunc) (GIOSchedulerJob *job,
 179                                          GCancellable    *cancellable,
 180                                          gpointer         user_data);
 181
 182 /**
 183  * GSimpleAsyncThreadFunc:
 184  * @res: a #GSimpleAsyncResult.
 185  * @object: a #GObject.
 186  * @cancellable: optional #GCancellable object, %NULL to ignore.
 187  *
 188  * Simple thread function that runs an asynchronous operation and
 189  * checks for cancellation.
 190  **/
 191 typedef void (*GSimpleAsyncThreadFunc) (GSimpleAsyncResult *res,
 192                                         GObject *object,
 193                                         GCancellable *cancellable);
 194
 195 G_END_DECLS
 196
 197 #endif /* __GIO_TYPES_H__ */