* coding style fixes
[modest] / src / modest-tny-account-store.h
index c7d461e..a92d81e 100644 (file)
@@ -1,5 +1,34 @@
+/* Copyright (c) 2006, Nokia Corporation
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ * * Redistributions of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ *   notice, this list of conditions and the following disclaimer in the
+ *   documentation and/or other materials provided with the distribution.
+ * * Neither the name of the Nokia Corporation nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+ * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+ * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+ * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
+ * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+
 /* modest-tny-account-store.h */
-/* insert (c)/licensing information) */
 
 #ifndef __MODEST_TNY_ACCOUNT_STORE_H__
 #define __MODEST_TNY_ACCOUNT_STORE_H__
@@ -7,6 +36,7 @@
 #include <glib-object.h>
 #include <tny-account-store.h>
 #include <tny-session-camel.h>
+#include <tny-shared.h>
 
 /* other include files */
 
@@ -22,32 +52,66 @@ G_BEGIN_DECLS
 
 typedef struct _ModestTnyAccountStore      ModestTnyAccountStore;
 typedef struct _ModestTnyAccountStoreClass ModestTnyAccountStoreClass;
+typedef TnyGetPassFunc ModestTnyGetPassFunc;
 
 struct _ModestTnyAccountStore {
-       //TnyAccountStore parent;
        GObject parent;
 };
 
 struct _ModestTnyAccountStoreClass {
-       //TnyAccountStoreClass parent_class;
        GObjectClass parent_class;
-       
+
        void (*password_requested) (ModestTnyAccountStore *self,
                                    const gchar *account_name,
                                    gpointer user_data);
+       void (*update_accounts)    (ModestTnyAccountStore *self,
+                                   const gchar *account_name,
+                                   gpointer user_data);
 };
 
 /* member functions */
+
+/**
+ * modest_tny_account_store_get_type:
+ *
+ * Returns: GType of account store
+ */
 GType        modest_tny_account_store_get_type    (void) G_GNUC_CONST;
 
-/* typical parameter-less _new function */
-/* if this is a kind of GtkWidget, it should probably return at GtkWidget*, */
-/*    otherwise probably a GObject*. */
+/**
+ * modest_tny_account_store_new:
+ * @modest_acc_mgr: account manager to use for new account store
+ *
+ * creates new (tinymail) account store for account manager modest_acc_mgr
+ *
+ * Returns: GObject of newly created account store
+ */
 GObject*    modest_tny_account_store_new         (ModestAccountMgr *modest_acc_mgr);
 
 
 
-TnySessionCamel* tny_account_store_get_session (TnyAccountStore *self);
+/**
+ * tny_account_store_set_get_pass_func:
+ * @self: a TnyAccountStore instance
+ * key: a key
+ * func: a function
+ *
+ * set the password function to function
+ */
+void
+modest_tny_account_store_set_get_pass_func (ModestTnyAccountStore *, ModestTnyGetPassFunc);
+
+
+/**
+ * tny_account_store_get_session
+ * @self: a TnyAccountStore instance
+ * 
+ * get the tny-camel-session for this account store. Note that this function
+ * does NOT have the modest_ prefix, as tinymail requires the symbol to be like this...
+ *
+ * Returns: a tny-camel-session
+ */
+TnySessionCamel*    tny_account_store_get_session    (TnyAccountStore *self);
 
 
 G_END_DECLS