Modified webpage: now tinymail repository is in gitorious.
[modest] / src / modest-runtime.h
index 53bccbd..0fce328 100644 (file)
 #include <modest-signal-mgr.h>
 #include <tny-platform-factory.h>
 #include "widgets/modest-window-mgr.h"
+#include <modest-protocol-registry.h>
+#include <tny-stream-cache.h>
+#include <modest-plugin-factory.h>
+#include <widgets/modest-toolkit-factory.h>
 
 G_BEGIN_DECLS
 
@@ -63,7 +67,7 @@ typedef enum {
  * environment, instantiates singletons and so on)
  * modest_runtime_init should only be called once, and
  * when done with it, modest_runtime_uninit should be called
- *  
+ *
  * TRUE if this succeeded, FALSE otherwise.
  */
 gboolean modest_runtime_init (void);
@@ -78,10 +82,10 @@ gboolean modest_runtime_init (void);
  * TRUE if this succeeded, FALSE otherwise
  */
 gboolean modest_runtime_uninit (void);
-       
+
 
 /**
- * modest_runtime_get_debug_flags 
+ * modest_runtime_get_debug_flags
  *
  * get the debug flags for modest; they are read from the MODEST_DEBUG
  * environment variable; the flags specified as strings, separated by ':'.
@@ -122,6 +126,15 @@ ModestConf*         modest_runtime_get_conf   (void);
 ModestAccountMgr*         modest_runtime_get_account_mgr   (void);
 
 /**
+ * modest_runtime_get_images_cache:
+ * 
+ * get the images #TnyStreamCache singleton instance
+ * 
+ * Returns: the images #TnyStreamCache singleton. This should NOT be unref'd.
+ **/
+TnyStreamCache*         modest_runtime_get_images_cache   (void);
+
+/**
  * modest_runtime_get_email_clipboard:
  * 
  * get the #ModestEmailClipboard singleton instance
@@ -170,8 +183,14 @@ TnyDevice*                    modest_runtime_get_device     (void);
  **/
 TnyPlatformFactory*           modest_runtime_get_platform_factory     (void);
 
-
-
+/**
+ * modest_runtime_get_toolkit_factory:
+ * 
+ * get the #ModestToolkitFactory singleton instance
+ *
+ * Returns: the #ModestToolkitFactory singleton. This should NOT be unref'd.
+ **/
+ModestToolkitFactory*           modest_runtime_get_toolkit_factory     (void);
 
 /**
  * modest_runtime_get_mail_operation_queue:
@@ -186,13 +205,15 @@ ModestMailOperationQueue* modest_runtime_get_mail_operation_queue (void);
 /**
  * modest_runtime_get_send_queue:
  * @account: a valid TnyTransportAccount
+ * @create: whether or not a new send queue should be created if it does not exist
  * 
  * get the send queue for the given account
  *
  * Returns: the #ModestTnySendQueue singleton instance for this account
  * (ie., one singleton per account). This should NOT be unref'd.
  **/
-ModestTnySendQueue* modest_runtime_get_send_queue        (TnyTransportAccount *account);
+ModestTnySendQueue* modest_runtime_get_send_queue        (TnyTransportAccount *account,
+                                                         gboolean create);
 
 /**
  * modest_runtime_remove_send_queue:
@@ -219,6 +240,41 @@ void modest_runtime_remove_all_send_queues ();
  **/
 ModestWindowMgr* modest_runtime_get_window_mgr (void);
 
+/**
+ * modest_runtime_get_protocol_registry:
+ *
+ * get the #ModestProtocolRegistry singleton instance
+ *
+ * Returns: the #ModestProtocolRegistry singleton. This should NOT be unref'd.
+ **/
+ModestProtocolRegistry* modest_runtime_get_protocol_registry (void);
+
+/**
+ * modest_runtime_get_plugin_factory:
+ *
+ * get the #ModestPluginFactory singleton instance
+ *
+ * Returns: the #ModestPluginFactory singleton. This should NOT be unref'd.
+ **/
+ModestPluginFactory * modest_runtime_get_plugin_factory (void);
+
+/**
+ * modest_runtime_get_allow_shutdown:
+ *
+ * tell if Modest will shutdown when window list and mail op queue are empty
+ *
+ * Returns: %TRUE if modest shutdown is allowed, %FALSE otherwise
+ */
+gboolean modest_runtime_get_allow_shutdown (void);
+
+/**
+ * modest_runtime_get_allow_shutdown:
+ * @allow: a #gboolean
+ *
+ * set if Modest will shutdown when window list and mail op queue are empty
+ *
+ */
+void modest_runtime_set_allow_shutdown (gboolean allow);
 
 G_END_DECLS