* all:
[modest] / src / modest-runtime.h
index 9097eb4..e4f91e8 100644 (file)
@@ -37,7 +37,8 @@
 #include <modest-cache-mgr.h>
 #include <modest-mail-operation-queue.h>
 #include <modest-tny-account-store.h>
-#include <modest-widget-factory.h>
+#include <modest-tny-send-queue.h>
+#include <tny-platform-factory.h>
 
 G_BEGIN_DECLS
 
@@ -48,7 +49,7 @@ typedef enum {
        MODEST_RUNTIME_DEBUG_LOG_ACTIONS           = 1 << 1, /* not in use atm */
        MODEST_RUNTIME_DEBUG_DEBUG_OBJECTS         = 1 << 2, /* for g_type_init */
        MODEST_RUNTIME_DEBUG_DEBUG_SIGNALS         = 1 << 3, /* for g_type_init */
-       MODEST_RUNTIME_DEBUG_FACTORY_SETTINGS      = 1 << 4, /* reset to factory defaults */
+       MODEST_RUNTIME_DEBUG_FACTORY_SETTINGS      = 1 << 4  /* reset to factory defaults */
 } ModestRuntimeDebugFlags;
 
 /**
@@ -96,11 +97,10 @@ gboolean modest_runtime_uninit (void);
  * - "abort-on-warning": abort the program when a gtk/glib/.. warning occurs.
  * useful when running in debugger
  * - "log-actions": log user actions (not in use atm)
- * - "track-object": track the use of (g)objects in the program. this option influences
+ * - "debug-objects": track the use of (g)objects in the program. this option influences
  *  g_type_init_with_debug_flags
- *  - "track-signals": track the use of (g)signals in the program. this option influences
+ *  - "debug-signals": track the use of (g)signals in the program. this option influences
  *  g_type_init_with_debug_flags
- *  - "disable-cache": disable caching of strings and pixbuf
  * if you would want to track signals and log actions, you could do something like:
  *  MODEST_DEBUG="log-actions:track-signals" ./modest
  * NOTE that the flags will stay the same during the run of the program, even
@@ -115,7 +115,7 @@ ModestRuntimeDebugFlags modest_runtime_get_debug_flags  (void) G_GNUC_CONST;
  * 
  * get the ModestConf singleton instance
  * 
- * Returns: the ModestConf singleton
+ * Returns: the ModestConf singleton. This should NOT be unref'd.
  **/
 ModestConf*         modest_runtime_get_conf   (void);
 
@@ -125,7 +125,7 @@ ModestConf*         modest_runtime_get_conf   (void);
  * 
  * get the ModestAccountMgr singleton instance
  * 
- * Returns: the ModestAccountMgr singleton
+ * Returns: the ModestAccountMgr singleton. This should NOT be unref'd.
  **/
 ModestAccountMgr*         modest_runtime_get_account_mgr   (void);
 
@@ -134,7 +134,7 @@ ModestAccountMgr*         modest_runtime_get_account_mgr   (void);
  * 
  * get the ModestTnyAccountStore singleton instance
  *
- * Returns: the ModestTnyAccountStore singleton
+ * Returns: the ModestTnyAccountStore singleton. This should NOT be unref'd.
  **/
 ModestTnyAccountStore*    modest_runtime_get_account_store (void);
 
@@ -144,29 +144,54 @@ ModestTnyAccountStore*    modest_runtime_get_account_store (void);
  * 
  * get the ModestCacheMgr singleton instance
  *
- * Returns: the ModestCacheMgr singleton
+ * Returns: the #ModestCacheMgr singleton. This should NOT be unref'd.
  **/
 ModestCacheMgr*           modest_runtime_get_cache_mgr     (void);
 
 
+
+/**
+ * modest_runtime_get_device:
+ * 
+ * get the #TnyDevice singleton instance
+ *
+ * Returns: the #TnyDevice singleton. This should NOT be unref'd.
+ **/
+TnyDevice*                    modest_runtime_get_device     (void);
+
+
+/**
+ * modest_runtime_get_platform_factory:
+ * 
+ * get the #TnyPlatformFactory singleton instance
+ *
+ * Returns: the #TnyPlatformFactory singleton. This should NOT be unref'd.
+ **/
+TnyPlatformFactory*           modest_runtime_get_platform_factory     (void);
+
+
+
+
 /**
  * modest_runtime_get_mail_operation_queue:
  * 
- * get the ModestMailOperationQueue singleton instance
+ * get the #ModestMailOperationQueue singleton instance
  *
- * Returns: the ModestMailOperationQueue singleton
+ * Returns: the #ModestMailOperationQueue singleton. This should NOT be unref'd.
  **/
 ModestMailOperationQueue* modest_runtime_get_mail_operation_queue (void);
 
 
 /**
- * modest_runtime_get_widget_factory
+ * modest_runtime_get_send_queue:
+ * @account: a valid TnyTransportAccount
  * 
- * get the ModestWidgetFactory singleton instance
+ * get the send queue for the given account
  *
- * Returns: the ModestCacheMgr singleton
+ * Returns: the #ModestTnySendQueue singleton instance for this account
+ * (ie., one singleton per account). This should NOT be unref'd.
  **/
-ModestWidgetFactory*      modest_runtime_get_widget_factory     (void);
+ModestTnySendQueue* modest_runtime_get_send_queue        (TnyTransportAccount *account);
 
 
 G_END_DECLS