git.maemo.org Git - modest/blob - src/modest-tny-account-store.h

   1 /* Copyright (c) 2006, Nokia Corporation
   2  * All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  * * Redistributions of source code must retain the above copyright
   9  *   notice, this list of conditions and the following disclaimer.
  10  * * Redistributions in binary form must reproduce the above copyright
  11  *   notice, this list of conditions and the following disclaimer in the
  12  *   documentation and/or other materials provided with the distribution.
  13  * * Neither the name of the Nokia Corporation nor the names of its
  14  *   contributors may be used to endorse or promote products derived from
  15  *   this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
  18  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  19  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  20  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
  21  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  23  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  24  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  25  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  26  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  27  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30
  31 /* modest-tny-account-store.h */
  32
  33 #ifndef __MODEST_TNY_ACCOUNT_STORE_H__
  34 #define __MODEST_TNY_ACCOUNT_STORE_H__
  35
  36 #include <glib-object.h>
  37 #include <tny-account-store.h>
  38 #include <tny-session-camel.h>
  39 #include <tny-shared.h>
  40
  41 /* other include files */
  42
  43 G_BEGIN_DECLS
  44
  45 /* convenience macros */
  46 #define MODEST_TYPE_TNY_ACCOUNT_STORE             (modest_tny_account_store_get_type())
  47 #define MODEST_TNY_ACCOUNT_STORE(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_TNY_ACCOUNT_STORE,ModestTnyAccountStore))
  48 #define MODEST_TNY_ACCOUNT_STORE_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_TNY_ACCOUNT_STORE,ModestTnyAccountStoreClass))
  49 #define MODEST_IS_TNY_ACCOUNT_STORE(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_TNY_ACCOUNT_STORE))
  50 #define MODEST_IS_TNY_ACCOUNT_STORE_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_TNY_ACCOUNT_STORE))
  51 #define MODEST_TNY_ACCOUNT_STORE_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_TNY_ACCOUNT_STORE,ModestTnyAccountStoreClass))
  52
  53 typedef struct _ModestTnyAccountStore      ModestTnyAccountStore;
  54 typedef struct _ModestTnyAccountStoreClass ModestTnyAccountStoreClass;
  55 typedef TnyGetPassFunc ModestTnyGetPassFunc;
  56
  57 struct _ModestTnyAccountStore {
  58         GObject parent;
  59 };
  60
  61 struct _ModestTnyAccountStoreClass {
  62         GObjectClass parent_class;
  63
  64         void (*password_requested) (ModestTnyAccountStore *self,
  65                                     const gchar *account_name,
  66                                     gpointer user_data);
  67 };
  68
  69 /* member functions */
  70
  71 /**
  72  * modest_tny_account_store_get_type:
  73  *
  74  * Returns: GType of account store
  75  */
  76 GType        modest_tny_account_store_get_type    (void) G_GNUC_CONST;
  77
  78 /**
  79  * modest_tny_account_store_new:
  80  * @modest_acc_mgr: account manager to use for new account store
  81  *
  82  * creates new (tinymail) account store for account manager modest_acc_mgr
  83  *
  84  * Returns: GObject of newly created account store
  85  */
  86 GObject*    modest_tny_account_store_new         (ModestAccountMgr *modest_acc_mgr);
  87
  88 /**
  89  * modest_tny_account_store_get_account_mgr:
  90  * @self: a TnyAccountStore instance
  91  *
  92  * retrieve the account manager associated with this account store.
  93  *
  94  * Returns: the account manager for @self.
  95  */
  96 ModestAccountMgr *modest_tny_account_store_get_accout_mgr(ModestTnyAccountStore *self);
  97
  98 /**
  99  * tny_account_store_get_session:
 100  * @self: a TnyAccountStore instance
 101  *
 102  * retrieve current tinymail camel session
 103  *
 104  * Returns: current tinymail camel session
 105  */
 106 TnySessionCamel* tny_account_store_get_session (TnyAccountStore *self);
 107
 108 /**
 109  * tny_account_store_set_get_pass_func:
 110  * @self: a TnyAccountStore instance
 111  * key: a key
 112  * func: a function
 113  *
 114  * set the password function to function
 115  */
 116 void
 117 modest_tny_account_store_set_get_pass_func (ModestTnyAccountStore *, ModestTnyGetPassFunc);
 118
 119 G_END_DECLS
 120
 121 #endif /* __MODEST_TNY_ACCOUNT_STORE_H__ */
 122