X-Git-Url: http://git.maemo.org/git/?p=modest;a=blobdiff_plain;f=src%2Fmodest-runtime.h;h=c07baf2f0febbb8014d51434563d81234c7b3249;hp=785f48e2e7752321312c9ac3abd393083d97764f;hb=6a7986312ee5e30f99a070fdf3f37f8427681034;hpb=31bb0518a45f4ca59a30a650475d3a3f9ff87610 diff --git a/src/modest-runtime.h b/src/modest-runtime.h index 785f48e..c07baf2 100644 --- a/src/modest-runtime.h +++ b/src/modest-runtime.h @@ -35,9 +35,16 @@ #include #include #include +#include #include #include -#include +#include +#include +#include +#include "widgets/modest-window-mgr.h" +#include +#include +#include G_BEGIN_DECLS @@ -46,8 +53,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_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; /** @@ -57,7 +66,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); @@ -75,7 +84,7 @@ 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 ':'. @@ -83,11 +92,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 @@ -102,7 +110,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); @@ -112,16 +120,34 @@ 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); /** + * 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 + * + * Returns: the #ModestEamilClipboard singleton. This should NOT be unref'd. + **/ +ModestEmailClipboard* modest_runtime_get_email_clipboard (void); + +/** * modest_runtime_get_account_store: * * 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); @@ -131,29 +157,99 @@ 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 + * @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, + 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: * - * get the ModestWidgetFactory singleton instance + * Removes all send queues, ready for them to be recreated, for instance + * with a new connection. + **/ +void modest_runtime_remove_all_send_queues (); + +/** + * modest_runtime_get_window_mgr: + * + * get the #ModestWindowMgr singleton instance + * + * Returns: the #ModestWindowMgr singleton. This should NOT be unref'd. + **/ +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 ModestCacheMgr singleton + * Returns: the #ModestPluginFactory singleton. This should NOT be unref'd. **/ -ModestWidgetFactory* modest_runtime_get_widget_factory (void); +ModestPluginFactory * modest_runtime_get_plugin_factory (void); G_END_DECLS