GLib 2.42.0
[platform/upstream/glib.git] / gio / gmountoperation.h
index 3b730b5..f3155a5 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_MOUNT_OPERATION_H__
 #define __G_MOUNT_OPERATION_H__
 
-#include <sys/stat.h>
+#if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
+#error "Only <gio/gio.h> can be included directly."
+#endif
 
-#include <glib-object.h>
+#include <gio/giotypes.h>
 
 G_BEGIN_DECLS
 
@@ -36,7 +36,12 @@ G_BEGIN_DECLS
 #define G_IS_MOUNT_OPERATION_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_MOUNT_OPERATION))
 #define G_MOUNT_OPERATION_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_MOUNT_OPERATION, GMountOperationClass))
 
-typedef struct _GMountOperation        GMountOperation;
+/**
+ * GMountOperation:
+ *
+ * Class for providing authentication methods for mounting operations,
+ * such as mounting a file locally, or authenticating with a server.
+ **/
 typedef struct _GMountOperationClass   GMountOperationClass;
 typedef struct _GMountOperationPrivate GMountOperationPrivate;
 
@@ -47,40 +52,38 @@ struct _GMountOperation
   GMountOperationPrivate *priv;
 };
 
-typedef enum {
-  G_PASSWORD_FLAGS_NEED_PASSWORD    = 1<<0,
-  G_PASSWORD_FLAGS_NEED_USERNAME    = 1<<1,
-  G_PASSWORD_FLAGS_NEED_DOMAIN      = 1<<2,
-  G_PASSWORD_FLAGS_SAVING_SUPPORTED = 1<<4,
-  G_PASSWORD_FLAGS_ANON_SUPPORTED   = 1<<5
-} GPasswordFlags;
-
-typedef enum {
-  G_PASSWORD_SAVE_NEVER,
-  G_PASSWORD_SAVE_FOR_SESSION,
-  G_PASSWORD_SAVE_PERMANENTLY
-} GPasswordSave;
-
 struct _GMountOperationClass
 {
   GObjectClass parent_class;
 
   /* signals: */
 
-  gboolean (* ask_password) (GMountOperation *op,
-                            const char      *message,
-                            const char      *default_user,
-                            const char      *default_domain,
-                            GPasswordFlags   flags);
-  
-  gboolean (* ask_question) (GMountOperation *op,
-                            const char      *message,
-                            const char      *choices[]);
-
-  void     (* reply)        (GMountOperation *op,
-                            gboolean         abort);
-  
-  
+  void (* ask_password) (GMountOperation       *op,
+                        const char            *message,
+                        const char            *default_user,
+                        const char            *default_domain,
+                        GAskPasswordFlags      flags);
+
+  void (* ask_question) (GMountOperation       *op,
+                        const char            *message,
+                        const char            *choices[]);
+
+  void (* reply)        (GMountOperation       *op,
+                        GMountOperationResult  result);
+
+  void (* aborted)      (GMountOperation       *op);
+
+  void (* show_processes) (GMountOperation      *op,
+                           const gchar          *message,
+                           GArray               *processes,
+                           const gchar          *choices[]);
+
+  void (* show_unmount_progress) (GMountOperation *op,
+                                  const gchar     *message,
+                                  gint64           time_left,
+                                  gint64           bytes_left);
+
+  /*< private >*/
   /* Padding for future expansion */
   void (*_g_reserved1) (void);
   void (*_g_reserved2) (void);
@@ -91,35 +94,46 @@ struct _GMountOperationClass
   void (*_g_reserved7) (void);
   void (*_g_reserved8) (void);
   void (*_g_reserved9) (void);
-  void (*_g_reserved10) (void);
-  void (*_g_reserved11) (void);
-  void (*_g_reserved12) (void);
 };
 
-GType g_mount_operation_get_type (void) G_GNUC_CONST;
-  
-GMountOperation *  g_mount_operation_new (void);
+GLIB_AVAILABLE_IN_ALL
+GType             g_mount_operation_get_type      (void) G_GNUC_CONST;
+GLIB_AVAILABLE_IN_ALL
+GMountOperation * g_mount_operation_new           (void);
 
+GLIB_AVAILABLE_IN_ALL
 const char *  g_mount_operation_get_username      (GMountOperation *op);
+GLIB_AVAILABLE_IN_ALL
 void          g_mount_operation_set_username      (GMountOperation *op,
                                                   const char      *username);
+GLIB_AVAILABLE_IN_ALL
 const char *  g_mount_operation_get_password      (GMountOperation *op);
+GLIB_AVAILABLE_IN_ALL
 void          g_mount_operation_set_password      (GMountOperation *op,
                                                   const char      *password);
+GLIB_AVAILABLE_IN_ALL
 gboolean      g_mount_operation_get_anonymous     (GMountOperation *op);
+GLIB_AVAILABLE_IN_ALL
 void          g_mount_operation_set_anonymous     (GMountOperation *op,
                                                   gboolean         anonymous);
+GLIB_AVAILABLE_IN_ALL
 const char *  g_mount_operation_get_domain        (GMountOperation *op);
+GLIB_AVAILABLE_IN_ALL
 void          g_mount_operation_set_domain        (GMountOperation *op,
                                                   const char      *domain);
+GLIB_AVAILABLE_IN_ALL
 GPasswordSave g_mount_operation_get_password_save (GMountOperation *op);
+GLIB_AVAILABLE_IN_ALL
 void          g_mount_operation_set_password_save (GMountOperation *op,
                                                   GPasswordSave    save);
+GLIB_AVAILABLE_IN_ALL
 int           g_mount_operation_get_choice        (GMountOperation *op);
+GLIB_AVAILABLE_IN_ALL
 void          g_mount_operation_set_choice        (GMountOperation *op,
                                                   int              choice);
+GLIB_AVAILABLE_IN_ALL
 void          g_mount_operation_reply             (GMountOperation *op,
-                                                  gboolean         abort);
+                                                  GMountOperationResult result);
 
 G_END_DECLS