gio/gmountoperation.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 __G_MOUNT_OPERATION_H__
  28 #define __G_MOUNT_OPERATION_H__
  29
  30 #include <sys/stat.h>
  31
  32 #include <glib-object.h>
  33
  34 G_BEGIN_DECLS
  35
  36 #define G_TYPE_MOUNT_OPERATION         (g_mount_operation_get_type ())
  37 #define G_MOUNT_OPERATION(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_MOUNT_OPERATION, GMountOperation))
  38 #define G_MOUNT_OPERATION_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_MOUNT_OPERATION, GMountOperationClass))
  39 #define G_IS_MOUNT_OPERATION(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_MOUNT_OPERATION))
  40 #define G_IS_MOUNT_OPERATION_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_MOUNT_OPERATION))
  41 #define G_MOUNT_OPERATION_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_MOUNT_OPERATION, GMountOperationClass))
  42
  43 /**
  44  * GMountOperation:
  45  *
  46  * Class for providing authentication methods for mounting operations,
  47  * such as mounting a file locally, or authenticating with a server.
  48  **/
  49 typedef struct _GMountOperation        GMountOperation;
  50 typedef struct _GMountOperationClass   GMountOperationClass;
  51 typedef struct _GMountOperationPrivate GMountOperationPrivate;
  52
  53 struct _GMountOperation
  54 {
  55   GObject parent_instance;
  56
  57   GMountOperationPrivate *priv;
  58 };
  59
  60 /**
  61  * GPasswordFlags:
  62  * @G_PASSWORD_FLAGS_NEED_PASSWORD: operation requires a password.
  63  * @G_PASSWORD_FLAGS_NEED_USERNAME: operation requires a username.
  64  * @G_PASSWORD_FLAGS_NEED_DOMAIN: operation requires a domain.
  65  * @G_PASSWORD_FLAGS_SAVING_SUPPORTED: operation supports saving settings.
  66  * @G_PASSWORD_FLAGS_ANONYMOUS_SUPPORTED: operation supports anonymous users.
  67  *
  68  * #GPasswordFlags are used to request specific information from the
  69  * user, or to notify the user of their choices in an authentication
  70  * situation.
  71  *
  72  **/
  73 typedef enum {
  74   G_PASSWORD_FLAGS_NEED_PASSWORD       = 1<<0,
  75   G_PASSWORD_FLAGS_NEED_USERNAME       = 1<<1,
  76   G_PASSWORD_FLAGS_NEED_DOMAIN         = 1<<2,
  77   G_PASSWORD_FLAGS_SAVING_SUPPORTED    = 1<<3,
  78   G_PASSWORD_FLAGS_ANONYMOUS_SUPPORTED = 1<<4
  79 } GPasswordFlags;
  80
  81 /**
  82  * GPasswordSave:
  83  * @G_PASSWORD_SAVE_NEVER: never save a password.
  84  * @G_PASSWORD_SAVE_FOR_SESSION: save a password for the session.
  85  * @G_PASSWORD_SAVE_PERMANENTLY: save a password permanently.
  86  *
  87  * #GPasswordSave is used to indicate the lifespan of a saved password.
  88  **/
  89 typedef enum {
  90   G_PASSWORD_SAVE_NEVER,
  91   G_PASSWORD_SAVE_FOR_SESSION,
  92   G_PASSWORD_SAVE_PERMANENTLY
  93 } GPasswordSave;
  94
  95 struct _GMountOperationClass
  96 {
  97   GObjectClass parent_class;
  98
  99   /* signals: */
 100
 101   gboolean (* ask_password) (GMountOperation *op,
 102                              const char      *message,
 103                              const char      *default_user,
 104                              const char      *default_domain,
 105                              GPasswordFlags   flags);
 106
 107   gboolean (* ask_question) (GMountOperation *op,
 108                              const char      *message,
 109                              const char      *choices[]);
 110
 111   void     (* reply)        (GMountOperation *op,
 112                              gboolean         abort);
 113
 114   /*< private >*/
 115   /* Padding for future expansion */
 116   void (*_g_reserved1) (void);
 117   void (*_g_reserved2) (void);
 118   void (*_g_reserved3) (void);
 119   void (*_g_reserved4) (void);
 120   void (*_g_reserved5) (void);
 121   void (*_g_reserved6) (void);
 122   void (*_g_reserved7) (void);
 123   void (*_g_reserved8) (void);
 124   void (*_g_reserved9) (void);
 125   void (*_g_reserved10) (void);
 126   void (*_g_reserved11) (void);
 127   void (*_g_reserved12) (void);
 128 };
 129
 130 GType g_mount_operation_get_type (void) G_GNUC_CONST;
 131
 132 GMountOperation *  g_mount_operation_new (void);
 133
 134 const char *  g_mount_operation_get_username      (GMountOperation *op);
 135 void          g_mount_operation_set_username      (GMountOperation *op,
 136                                                    const char      *username);
 137 const char *  g_mount_operation_get_password      (GMountOperation *op);
 138 void          g_mount_operation_set_password      (GMountOperation *op,
 139                                                    const char      *password);
 140 gboolean      g_mount_operation_get_anonymous     (GMountOperation *op);
 141 void          g_mount_operation_set_anonymous     (GMountOperation *op,
 142                                                    gboolean         anonymous);
 143 const char *  g_mount_operation_get_domain        (GMountOperation *op);
 144 void          g_mount_operation_set_domain        (GMountOperation *op,
 145                                                    const char      *domain);
 146 GPasswordSave g_mount_operation_get_password_save (GMountOperation *op);
 147 void          g_mount_operation_set_password_save (GMountOperation *op,
 148                                                    GPasswordSave    save);
 149 int           g_mount_operation_get_choice        (GMountOperation *op);
 150 void          g_mount_operation_set_choice        (GMountOperation *op,
 151                                                    int              choice);
 152 void          g_mount_operation_reply             (GMountOperation *op,
 153                                                    gboolean         abort);
 154
 155 G_END_DECLS
 156
 157 #endif /* __G_MOUNT_OPERATION_H__ */