Modified webpage: now tinymail repository is in gitorious.
[modest] / src / modest-runtime.h
index dbe2460..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
 
@@ -50,9 +54,10 @@ G_BEGIN_DECLS
 typedef enum {
        MODEST_RUNTIME_DEBUG_ABORT_ON_WARNING      = 1 << 0,
        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_OBJECTS               = 1 << 2, /* for g_type_init */
+       MODEST_RUNTIME_DEBUG_SIGNALS               = 1 << 3, /* for g_type_init */
+       MODEST_RUNTIME_DEBUG_FACTORY_SETTINGS      = 1 << 4, /* reset to factory defaults */
+       MODEST_RUNTIME_DEBUG_CODE                  = 1 << 5  /* print various debugging messages */
 } ModestRuntimeDebugFlags;
 
 /**
@@ -62,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);
@@ -77,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 ':'.
@@ -121,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
@@ -169,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:
@@ -185,13 +205,23 @@ 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:
+ * @account: a #TnyTransportAccount
+ * 
+ * Removes the send queue associated with the given transport account
+ **/
+void modest_runtime_remove_send_queue (TnyTransportAccount *account);
 
 /**
  * modest_runtime_remove_all_send_queues:
@@ -211,50 +241,40 @@ void modest_runtime_remove_all_send_queues ();
 ModestWindowMgr* modest_runtime_get_window_mgr (void);
 
 /**
- * modest_runtime_verify_object_last_ref
- * @OBJ: some (GObject) ptr
- * @NAME: name of @OBJ
- * 
- * macro to check whether @obj holds only one more ref (ie. after the
- * next unref it will die)
- * 
- * not, a g_warning will be issued on stderr. NOTE: this is only active
- * when MODEST_DEBUG contains "debug-objects".
+ * modest_runtime_get_protocol_registry:
  *
- ***/
-#define modest_runtime_verify_object_last_ref(OBJ,name)                                                       \
-       do {                                                                                           \
-               if (modest_runtime_get_debug_flags() & MODEST_RUNTIME_DEBUG_DEBUG_OBJECTS)             \
-                       if (G_IS_OBJECT(OBJ) && G_OBJECT(OBJ)->ref_count != 1)                         \
-                               g_warning ("%s:%d: %s ("                                               \
-                                          #OBJ ") still holds a ref count of %d",                     \
-                                          __FILE__,__LINE__,name, G_OBJECT(OBJ)->ref_count);          \
-       } while (0)
-
+ * 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_not_implemented
- * @WIN: the parent GtkWindow, or NULL
+ * modest_runtime_get_allow_shutdown:
  *
- * give a not-implemented-yet warning popup or g_warning
+ * tell if Modest will shutdown when window list and mail op queue are empty
  *
- ***/
-#define modest_runtime_not_implemented(WIN)    \
-       do {                                   \
-               if (gtk_main_level() > 0) {    \
-                       GtkWidget *popup;      \
-                       popup = gtk_message_dialog_new (WIN,\
-                                                       GTK_DIALOG_MODAL|GTK_DIALOG_DESTROY_WITH_PARENT,\
-                                                       GTK_MESSAGE_WARNING, \
-                                                       GTK_BUTTONS_OK, \
-                                                       "Not yet implemented");\
-                       gtk_dialog_run (GTK_DIALOG(popup));             \
-                       gtk_widget_destroy (popup);                     \
-               } else                                                  \
-                       g_warning ("%s:%d: Not yet implemented",__FILE__,__LINE__); \
-       } while (0)                                                     \
+ * 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