From 82e0101e9955cfeea5c7434a2f5bab244f955025 Mon Sep 17 00:00:00 2001 From: Sergio Villar Senin Date: Tue, 26 Dec 2006 17:43:32 +0000 Subject: [PATCH] * Splitted the main documentation file in some smaller ones * Updated documentation * Migrated the transfer_msgs function to the async version pmo-trunk-r581 --- docs/reference/Makefile.am | 42 +- docs/reference/modest-architecture.sgml | 28 + docs/reference/modest-coding-guidelines.sgml | 76 +++ docs/reference/modest-design.sgml | 175 ++++++ docs/reference/modest-docs.sgml | 335 +----------- docs/reference/modest-preface.sgml | 47 ++ docs/reference/modest-sections.txt | 575 ++++++++++---------- docs/reference/tmpl/modest-account-assistant.sgml | 2 +- docs/reference/tmpl/modest-account-keys.sgml | 7 + docs/reference/tmpl/modest-account-mgr.sgml | 33 +- .../reference/tmpl/modest-account-view-window.sgml | 2 +- docs/reference/tmpl/modest-account-view.sgml | 2 +- docs/reference/tmpl/modest-combo-box.sgml | 2 +- docs/reference/tmpl/modest-conf.sgml | 15 +- docs/reference/tmpl/modest-edit-msg-window.sgml | 11 +- docs/reference/tmpl/modest-error.sgml | 2 +- docs/reference/tmpl/modest-folder-view.sgml | 2 +- docs/reference/tmpl/modest-formatter.sgml | 2 +- docs/reference/tmpl/modest-header-view.sgml | 2 +- docs/reference/tmpl/modest-icon-factory.sgml | 2 +- docs/reference/tmpl/modest-icon-names.sgml | 2 +- .../tmpl/modest-mail-operation-queue.sgml | 2 +- docs/reference/tmpl/modest-mail-operation.sgml | 4 +- docs/reference/tmpl/modest-msg-view.sgml | 14 +- docs/reference/tmpl/modest-pair.sgml | 2 +- docs/reference/tmpl/modest-presets.sgml | 2 +- docs/reference/tmpl/modest-protocol-mgr.sgml | 2 +- docs/reference/tmpl/modest-store-widget.sgml | 16 +- docs/reference/tmpl/modest-text-utils.sgml | 2 +- docs/reference/tmpl/modest-tny-account-store.sgml | 29 +- .../tmpl/modest-tny-platform-factory.sgml | 2 +- docs/reference/tmpl/modest-tny-stream-gtkhtml.sgml | 2 +- docs/reference/tmpl/modest-toolbar.sgml | 2 +- docs/reference/tmpl/modest-transport-widget.sgml | 2 +- docs/reference/tmpl/modest-widget-factory.sgml | 2 +- docs/reference/tmpl/modest-widget-memory.sgml | 2 +- src/modest-account-mgr.h | 3 +- src/modest-formatter.h | 18 +- src/modest-mail-operation.c | 48 +- src/modest-mail-operation.h | 73 ++- 40 files changed, 822 insertions(+), 769 deletions(-) create mode 100644 docs/reference/modest-architecture.sgml create mode 100644 docs/reference/modest-coding-guidelines.sgml create mode 100644 docs/reference/modest-design.sgml create mode 100644 docs/reference/modest-preface.sgml diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am index 14fbb5f..eee2972 100644 --- a/docs/reference/Makefile.am +++ b/docs/reference/Makefile.am @@ -22,10 +22,10 @@ SCANGOBJ_OPTIONS= # Extra options to supply to gtkdoc-scan. # e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" -SCAN_OPTIONS=\ - --source-dir=$(top_srcdir)/src \ +SCAN_OPTIONS= \ + --source-dir=$(top_srcdir)/src/widgets \ --source-dir=$(top_srcdir)/src/gtk \ - --source-dir=$(top_srcdir)/src/widgets + --source-dir=$(top_srcdir)/src # Extra options to supply to gtkdoc-mkdb. # e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml @@ -42,8 +42,8 @@ FIXXREF_OPTIONS= # Used for dependencies. The docs will be rebuilt if any of these change. # e.g. HFILE_GLOB=$(top_srcdir)/*.h # e.g. CFILE_GLOB=$(top_srcdir)/*.c -HFILE_GLOB=$(top_srcdir)/src/*.h -CFILE_GLOB=$(top_srcdir)/src/*.c +HFILE_GLOB=$(top_srcdir)/src/*.h $(top_srcdir)/src/widgets/*.h $(top_srcdir)/src/gtk/*.h +CFILE_GLOB=$(top_srcdir)/src/*.c $(top_srcdir)/src/widgets/*.c $(top_srcdir)/src/gtk/*.c # Header files to ignore when scanning. # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h @@ -55,7 +55,12 @@ HTML_IMAGES= # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). # e.g. content_files=running.sgml building.sgml changes-2.0.sgml -content_files=xml/tree_index.sgml +content_files= \ + xml/tree_index.sgml \ + modest-preface.sgml \ + modest-architecture.sgml \ + modest-design.sgml \ + modest-coding-guidelines.sgml # SGML files where gtk-doc abbrevations (#GtkWidget) are expanded # These files must be listed here *and* in content_files @@ -74,30 +79,31 @@ INCLUDES= \ -I$(top_srcdir)/src/widgets -GTKDOC_LIBS=\ +GTKDOC_LIBS= \ $(MODEST_LIBTINYMAIL_GNOME_DESKTOP_LIBS) \ $(MODEST_LIBTINYMAIL_MAEMO_LIBS) \ $(MODEST_GSTUFF_LIBS) \ $(top_builddir)/src/gtk/libmodest-ui.la \ $(top_builddir)/src/widgets/libmodest-widgets.la\ - ${top_builddir}/src/modest-conf.o \ ${top_builddir}/src/modest-account-mgr.o \ - ${top_builddir}/src/modest-tny-platform-factory.o \ + ${top_builddir}/src/modest-conf.o \ + ${top_builddir}/src/modest-formatter.o \ + ${top_builddir}/src/modest-icon-factory.o \ + ${top_builddir}/src/modest-mail-operation.o \ + ${top_builddir}/src/modest-mail-operation-queue.o \ + ${top_builddir}/src/modest-marshal.o \ + ${top_builddir}/src/modest-pair.o \ + ${top_builddir}/src/modest-presets.o \ ${top_builddir}/src/modest-protocol-mgr.o \ ${top_builddir}/src/modest-proto.o \ - ${top_builddir}/src/modest-pair.o \ - ${top_builddir}/src/modest-marshal.o \ + ${top_builddir}/src/modest-text-utils.o \ ${top_builddir}/src/modest-tny-account-store.o \ - ${top_builddir}/src/modest-mail-operation.o \ - ${top_builddir}/src/modest-mail-operation-queue.o \ - ${top_builddir}/src/modest-tny-msg-actions.o \ ${top_builddir}/src/modest-tny-attachment.o \ + ${top_builddir}/src/modest-tny-msg-actions.o \ + ${top_builddir}/src/modest-tny-platform-factory.o \ ${top_builddir}/src/modest-tny-stream-gtkhtml.o \ ${top_builddir}/src/modest-widget-factory.o \ - ${top_builddir}/src/modest-widget-memory.o \ - ${top_builddir}/src/modest-icon-factory.o \ - ${top_builddir}/src/modest-formatter.o \ - ${top_builddir}/src/modest-text-utils.o + ${top_builddir}/src/modest-widget-memory.o # This includes the standard gtk-doc make rules, copied by gtkdocize. include $(top_srcdir)/gtk-doc.make diff --git a/docs/reference/modest-architecture.sgml b/docs/reference/modest-architecture.sgml new file mode 100644 index 0000000..94927e7 --- /dev/null +++ b/docs/reference/modest-architecture.sgml @@ -0,0 +1,28 @@ + + Architecture + + modest tries to be quite flexible in its + design. However, it's always important not to make things too + generic. Both for reasons of time limitations and keeping the software + understandable and 'modest', it's important to limit the scope. + + + + For modest, the following: + + modest is a e-mail program + using the tinymail and camel + libraries; + modest targets gtk and + gconf-based user-interfaces, including the Hildon + environment; + modest main use-case is in + small, mobile device such as the Nokia 770 Internet + Tablet; + However, effort is made also to + make modest usable as a general-purpose + e-mail client on normal desktop computer. + + + + diff --git a/docs/reference/modest-coding-guidelines.sgml b/docs/reference/modest-coding-guidelines.sgml new file mode 100644 index 0000000..f78d943 --- /dev/null +++ b/docs/reference/modest-coding-guidelines.sgml @@ -0,0 +1,76 @@ + + Coding guidelines + + When hacking on modest, please honour these time-tested coding guidelines. + First, please follow the Linux CodingStyle guidelines + (/usr/src/linux/Documentation/CodingStyle). + + + + Here are only some additional notes. + + + + Your editor may help you with this, for example for emacs: + + (c-set-style "K&R") + (setq tab-width 8) + (setq indent-tabs-mode t) + (setq c-basic-offset 8) + + + Or the equivalent in your favourite editor. + + + + Lines must not exceed 100 characters. + + + + Functions should do one thing, and do it well. In general, functions + should not be much longer than 20-30 lines (except for, say, handling + many different cases in a 'switch'-statement). Files should not get to + big either; if there are more than, say, 800 lines, it's a sign that + some refactoring should take place. + + + + Code should compile cleanly + with gcc's -Wall compile option. Of + course this might not always be possible due to problems in dependent + libraries and/or compiler version. Therefore, do not + include -Werror in the standard compile options; but + do use it when building / testing things yourself. + + + + Code should also run cleanly. GTK+/GLib warnings and errors must be + taken very seriously. If you run modest with + the -d-flag, it will abort whenever + there is such a warning. This can be useful when running inside the + debugger. + + + Global functions (the ones in .h-files) must + be commented using gtk-doc. This way, we + generate nice documentation. After installing + (under /usr/local), we can browse the results + with DevHelp. Just + add /usr/local/share/gtk-doc/html to the + DEVHELP_SEARCH_PATH-environment variable. + + + Furthermore, please follow 'conventional wisdom' for programming with + GLib/GTK+/GObject. Some things to remember: + + g_new, g_malloc and + friends never return NULL. They terminate + the application if it happens (normally). No need to check + for NULL returns; + g_return_if_fail and friends may be + 'turned off', ie. they are to be used for error checking, + but not for your programming logic + + + + \ No newline at end of file diff --git a/docs/reference/modest-design.sgml b/docs/reference/modest-design.sgml new file mode 100644 index 0000000..ac7dff5 --- /dev/null +++ b/docs/reference/modest-design.sgml @@ -0,0 +1,175 @@ + + Design + + In this part, we'll discuss the design of various parts of + modest. We'll not go into the details of + various APIs in this chapter. Please consult the documentation generated + from the source code (gtk-doc) for that. + + + + + Configuration + Configuration is the part of modest + that deals with storing all settings. While the design allows for + alternative implementations, currently + only GConf is supported as a backend. + + + + All dealing with configuration is done with + the ModestConf-class. It is declared + in modest-conf.h, and + the GConf-based implementation in + modest-conf.c. As said, there could be + different implementations -- + nothing GConf-specific is visible in the + ModestConf-API. + + + + + Account Management + + Account Management is the part of modest + that deals with the setting related to sending and receiving of + e-mail. We will follow the libcamel-convention of using the + term store for an e-mail storage/retrieval + server, and a transport for a server that + transports mail to its destination. + + + + In practice, the following types are available: + + stores: POP + and IMAP; + transports: sendmail + and SMTP. + + + + + Definitions + + An account is a named entity + consisting of a store and + a transport. Note: For our mobile use-cases, + the transport cannot be a static entity, but + may depend on the network connection. That is however not part of + Account Management, so not discussed here + A server account is account + describing the connection with a specific server. Server accounts + come in two type: + + A transport describes the connection information + (servername, username, password etc.) for a transport + server; + A store describes the connection information for + a store server; + + + + + + + Code + The functions to deal with account and server accounts are + located in ModestAccountMgr, ie. in + modest-account-mgr.[ch]. There function to add + specific values for both, to list the available ones, etc. Please + refer to the source code documentation for details. + + + + + Location in configuration database + + Accounts can be found + in /apps/modest/accounts, + while server accounts can be found + in /app/modest/server_accounts. + + + + The following image show an + account accountstest with server accounts + mystore + and mytransport. + + + + + For each of the stores, there are number of parameters specified: + + hostname - the place where the server resides; + username - the username; + password - the password; + proto - the protocal for communication with this server - for + now these are the following valid values (literal strings): + + sendmail; + smtp; + pop + imap. + + + + + + In modest-proto.[ch] there are various + functions to check whether something is a valid protocol, and + whether it is a transport of a store. + + + Note that server accounts and accounts are relatively independent. While + accounts refer to two server accounts, these server accounts can be + used by other accounts as well. + + + The reason two keep accounts and server accounts separately, is a bit of + flexibility. In mobile use-cases, quite often it's desirable to use a + network-specific smtp-server. The chosen structure makes it easy to iterate + over all smtp-servers and find the right one. + + + + + Account Management and Tinymail + + Tinymail needs the information about all configured accounts - and the + mechanism that it uses for that + is TnyAccountStoreIface. We don't want to use + the tinymail-provided TnyAccountStore, but + provide our own implementation + instead: ModestTnyAccountStore. This class + implements the TnyAccountStoreIface-interace in + terms of the aforementioned ModestAccountMgr. + + + + One unexpected function + that ModestTnyAccountStore needs to implement + is tny account_store get_session (to get the + Camel-session). This function must be provided as a public function, + with that exact name. + + + + + + Finding the right transport + + One of the interesting topics in designing a mobile e-mail client is + to deal with transports (in + particular, SMTP). The reason for that is that + the majority of SMTP-servers only allow e-mail + from the same network. That means that for example + smtp.some-isp.com will only accept mail from + (MAIL FROM:) + user@some-isp.com, and refuse mail + from user@some-other-isp.com, unless the + recipient (RCPT TO:) is on the same network. + + + \ No newline at end of file diff --git a/docs/reference/modest-docs.sgml b/docs/reference/modest-docs.sgml index 2b1caac..6bfe3db 100644 --- a/docs/reference/modest-docs.sgml +++ b/docs/reference/modest-docs.sgml @@ -44,6 +44,11 @@ + + + + + ]> @@ -55,335 +60,13 @@ - - Introduction - modest is a mail user agent - (MUA) targetting small devices, in particular Nokia's - Nokia 770 Internet Tablet. This document - describes the design and implementation of this software. - - - modest lives at the top of a extensive - stack of software. It is built on top - of tinymail, and uses its libcamel - backend. It strives to the be a simple yet powerful program, geared - towards small devices, for example (but not limited - to) Nokia's 770 internet tablet. An important - goal is to minimize memory usage while still being able to handle - significant amounts of email quickly; much of that is achieved simply by - using tinymail, which uses a number of clever - tricks for that, such as the proxy design pattern for listing email - headers, and not needing memory for headers which are not currently - visible. - - - - modest, in turn, also tries to be efficient, - fast and scalable. That means that the MUA should - support multiple user-interfaces, perhaps making it even possible to - switch between them during runtime. - - - To summarize the goals for modest: - - target devices with limited amounts of memory ('limited' in 2006 - terms means less than 64Mb, and of which only part can be used for - e-mail); - target Linux/Unix-like environments with GLib/GTK+-based - support; - support multiple user-interface (UIs) with as much code - sharing as possible between the different UIs. - - - Like tinymail - and libcamel, modest - is programmed in C, using the GObject-system for - object-oriented (OO) features. For now, it specifically targets \gtk based - UIs (and derivatives like 'Hildon'). - - + &preface; - - Architecture - - modest tries to be quite flexible in its - design. However, it's always important not to make things too - generic. Both for reasons of time limitations and keeping the software - understandable and 'modest', it's important to limit the scope. - - - - For modest, the following: - - modest is a e-mail program - using the tinymail and camel - libraries; - modest targets gtk and - gconf-based user-interfaces, including the Hildon - environment; - modest main use-case is in - small, mobile device such as the Nokia 770 Internet - Tablet; - However, effort is made also to - make modest usable as a general-purpose - e-mail client on normal desktop computer. - - - - + &architecture; - - Design - - In this part, we'll discuss the design of various parts of - modest. We'll not go into the details of - various APIs in this chapter. Please consult the documentation generated - from the source code (gtk-doc) for that. - - - - - Configuration - Configuration is the part of modest - that deals with storing all settings. While the design allows for - alternative implementations, currently - only GConf is supported as a backend. - - - - All dealing with configuration is done with - the ModestConf-class. It is declared - in modest-conf.h, and - the GConf-based implementation in - modest-conf.c. As said, there could be - different implementations -- - nothing GConf-specific is visible in the - ModestConf-API. - - - - - Account Management - - Account Management is the part of modest - that deals with the setting related to sending and receiving of - e-mail. We will follow the libcamel-convention of using the - term store for an e-mail storage/retrieval - server, and a transport for a server that - transports mail to its destination. - - - - In practice, the following types are available: - - stores: POP - and IMAP; - transports: sendmail - and SMTP. - - - - - Definitions - - An account is a named entity - consisting of a store and - a transport. Note: For our mobile use-cases, - the transport cannot be a static entity, but - may depend on the network connection. That is however not part of - Account Management, so not discussed here - A server account is account - describing the connection with a specific server. Server accounts - come in two type: - - A transport describes the connection information - (servername, username, password etc.) for a transport - server; - A store describes the connection information for - a store server; - - - - - - - Code - The functions to deal with account and server accounts are - located in ModestAccountMgr, ie. in - modest-account-mgr.[ch]. There function to add - specific values for both, to list the available ones, etc. Please - refer to the source code documentation for details. - - - - - Location in configuration database - - Accounts can be found - in /apps/modest/accounts, - while server accounts can be found - in /app/modest/server_accounts. - - - - The following image show an - account accountstest with server accounts - mystore - and mytransport. - - - - - For each of the stores, there are number of parameters specified: - - hostname - the place where the server resides; - username - the username; - password - the password; - proto - the protocal for communication with this server - for - now these are the following valid values (literal strings): - - sendmail; - smtp; - pop - imap. - - - - - - In modest-proto.[ch] there are various - functions to check whether something is a valid protocol, and - whether it is a transport of a store. - - - Note that server accounts and accounts are relatively independent. While - accounts refer to two server accounts, these server accounts can be - used by other accounts as well. - - - The reason two keep accounts and server accounts separately, is a bit of - flexibility. In mobile use-cases, quite often it's desirable to use a - network-specific smtp-server. The chosen structure makes it easy to iterate - over all smtp-servers and find the right one. - - - - - Account Management and Tinymail - - Tinymail needs the information about all configured accounts - and the - mechanism that it uses for that - is TnyAccountStoreIface. We don't want to use - the tinymail-provided TnyAccountStore, but - provide our own implementation - instead: ModestTnyAccountStore. This class - implements the TnyAccountStoreIface-interace in - terms of the aforementioned ModestAccountMgr. - - - - One unexpected function - that ModestTnyAccountStore needs to implement - is tny account_store get_session (to get the - Camel-session). This function must be provided as a public function, - with that exact name. - - - - - - Finding the right transport - - One of the interesting topics in designing a mobile e-mail client is - to deal with transports (in - particular, SMTP). The reason for that is that - the majority of SMTP-servers only allow e-mail - from the same network. That means that for example - smtp.some-isp.com will only accept mail from - (MAIL FROM:) - user@some-isp.com, and refuse mail - from user@some-other-isp.com, unless the - recipient (RCPT TO:) is on the same network. - - - + &design; - - Coding guidelines - - When hacking on modest, please honour these time-tested coding guidelines. - First, please follow the Linux CodingStyle guidelines - (/usr/src/linux/Documentation/CodingStyle). - - - - Here are only some additional notes. - - - - Your editor may help you with this, for example for emacs: - - (c-set-style "K&R") - (setq tab-width 8) - (setq indent-tabs-mode t) - (setq c-basic-offset 8) - - - Or the equivalent in your favourite editor. - - - - Lines must not exceed 100 characters. - - - - Functions should do one thing, and do it well. In general, functions - should not be much longer than 20-30 lines (except for, say, handling - many different cases in a 'switch'-statement). Files should not get to - big either; if there are more than, say, 800 lines, it's a sign that - some refactoring should take place. - - - - Code should compile cleanly - with gcc's -Wall compile option. Of - course this might not always be possible due to problems in dependent - libraries and/or compiler version. Therefore, do not - include -Werror in the standard compile options; but - do use it when building / testing things yourself. - - - - Code should also run cleanly. GTK+/GLib warnings and errors must be - taken very seriously. If you run modest with - the -d-flag, it will abort whenever - there is such a warning. This can be useful when running inside the - debugger. - - - Global functions (the ones in .h-files) must - be commented using gtk-doc. This way, we - generate nice documentation. After installing - (under /usr/local), we can browse the results - with DevHelp. Just - add /usr/local/share/gtk-doc/html to the - DEVHELP_SEARCH_PATH-environment variable. - - - Furthermore, please follow 'conventional wisdom' for programming with - GLib/GTK+/GObject. Some things to remember: - - g_new, g_malloc and - friends never return NULL. They terminate - the application if it happens (normally). No need to check - for NULL returns; - g_return_if_fail and friends may be - 'turned off', ie. they are to be used for error checking, - but not for your programming logic - - - - + &coding-guidelines; Object Index diff --git a/docs/reference/modest-preface.sgml b/docs/reference/modest-preface.sgml new file mode 100644 index 0000000..461d28d --- /dev/null +++ b/docs/reference/modest-preface.sgml @@ -0,0 +1,47 @@ + + Introduction + modest is a mail user agent + (MUA) targetting small devices, in particular Nokia's + Nokia 770 Internet Tablet. This document + describes the design and implementation of this software. + + + modest lives at the top of a extensive + stack of software. It is built on top + of tinymail, and uses its libcamel + backend. It strives to the be a simple yet powerful program, geared + towards small devices, for example (but not limited + to) Nokia's 770 internet tablet. An important + goal is to minimize memory usage while still being able to handle + significant amounts of email quickly; much of that is achieved simply by + using tinymail, which uses a number of clever + tricks for that, such as the proxy design pattern for listing email + headers, and not needing memory for headers which are not currently + visible. + + + + modest, in turn, also tries to be efficient, + fast and scalable. That means that the MUA should + support multiple user-interfaces, perhaps making it even possible to + switch between them during runtime. + + + To summarize the goals for modest: + + target devices with limited amounts of memory ('limited' in 2006 + terms means less than 64Mb, and of which only part can be used for + e-mail); + target Linux/Unix-like environments with GLib/GTK+-based + support; + support multiple user-interface (UIs) with as much code + sharing as possible between the different UIs. + + + Like tinymail + and libcamel, modest + is programmed in C, using the GObject-system for + object-oriented (OO) features. For now, it specifically targets \gtk based + UIs (and derivatives like 'Hildon'). + + \ No newline at end of file diff --git a/docs/reference/modest-sections.txt b/docs/reference/modest-sections.txt index b645a97..be5f2d6 100644 --- a/docs/reference/modest-sections.txt +++ b/docs/reference/modest-sections.txt @@ -327,6 +327,7 @@ MODEST_ACCOUNT_VIEW_WINDOW_GET_CLASS ModestTransportWidget modest_transport_widget_new modest_transport_widget_get_remember_password +modest_transport_widget_get_requires_auth modest_transport_widget_get_username modest_transport_widget_get_servername modest_transport_widget_get_proto @@ -601,6 +602,217 @@ MODEST_MSG_VIEW_GET_CLASS
+modest-account-view +ModestAccountView +ModestAccountView +modest_account_view_new +modest_account_view_get_selected_account + +MODEST_ACCOUNT_VIEW +MODEST_IS_ACCOUNT_VIEW +MODEST_TYPE_ACCOUNT_VIEW +modest_account_view_get_type +MODEST_ACCOUNT_VIEW_CLASS +MODEST_IS_ACCOUNT_VIEW_CLASS +MODEST_ACCOUNT_VIEW_GET_CLASS +
+ +
+modest-header-view +MODEST_HEADER_VIEW_COLUMN +ModestHeaderViewColumn +ModestHeaderViewStyle +ModestItemType +ModestHeaderView +ModestHeaderView +modest_header_view_new +modest_header_view_set_folder +modest_header_view_get_folder +modest_header_view_set_columns +modest_header_view_get_columns +modest_header_view_set_style +modest_header_view_get_style +modest_header_view_get_selected_headers + +MODEST_HEADER_VIEW +MODEST_IS_HEADER_VIEW +MODEST_TYPE_HEADER_VIEW +modest_header_view_get_type +MODEST_HEADER_VIEW_CLASS +MODEST_IS_HEADER_VIEW_CLASS +MODEST_HEADER_VIEW_GET_CLASS +
+ +
+modest-toolbar +ModestToolbarButton +ModestToolbar +ModestToolbar +modest_toolbar_new + +MODEST_TOOLBAR +MODEST_IS_TOOLBAR +MODEST_TYPE_TOOLBAR +modest_toolbar_get_type +MODEST_TOOLBAR_CLASS +MODEST_IS_TOOLBAR_CLASS +MODEST_TOOLBAR_GET_CLASS +
+ +
+modest-folder-view +ModestFolderView +ModestFolderView +modest_folder_view_new +modest_folder_view_set_title +modest_folder_view_is_empty +modest_folder_view_guess_folder_type +modest_folder_view_get_selected_account + +MODEST_FOLDER_VIEW +MODEST_IS_FOLDER_VIEW +MODEST_TYPE_FOLDER_VIEW +modest_folder_view_get_type +MODEST_FOLDER_VIEW_CLASS +MODEST_IS_FOLDER_VIEW_CLASS +MODEST_FOLDER_VIEW_GET_CLASS +
+ +
+modest-combo-box +ModestComboBox +ModestComboBox +modest_combo_box_new +modest_combo_box_get_active_id +modest_combo_box_get_active_display_name + +MODEST_COMBO_BOX +MODEST_IS_COMBO_BOX +MODEST_TYPE_COMBO_BOX +modest_combo_box_get_type +MODEST_COMBO_BOX_CLASS +MODEST_IS_COMBO_BOX_CLASS +MODEST_COMBO_BOX_GET_CLASS +
+ +
+modest-msg-view +ModestMsgView +ModestMsgView +modest_msg_view_new +modest_msg_view_set_message + +MODEST_MSG_VIEW +MODEST_IS_MSG_VIEW +MODEST_TYPE_MSG_VIEW +modest_msg_view_get_type +MODEST_MSG_VIEW_CLASS +MODEST_IS_MSG_VIEW_CLASS +MODEST_MSG_VIEW_GET_CLASS +
+ +
+modest-account-assistant +ModestAccountAssistant +ModestAccountAssistant +modest_account_assistant_new + +MODEST_ACCOUNT_ASSISTANT +MODEST_IS_ACCOUNT_ASSISTANT +MODEST_TYPE_ACCOUNT_ASSISTANT +modest_account_assistant_get_type +MODEST_ACCOUNT_ASSISTANT_CLASS +MODEST_IS_ACCOUNT_ASSISTANT_CLASS +MODEST_ACCOUNT_ASSISTANT_GET_CLASS +
+ +
+modest-account-view-window +ModestAccountViewWindow +ModestAccountViewWindow +modest_account_view_window_new + +MODEST_ACCOUNT_VIEW_WINDOW +MODEST_IS_ACCOUNT_VIEW_WINDOW +MODEST_TYPE_ACCOUNT_VIEW_WINDOW +modest_account_view_window_get_type +MODEST_ACCOUNT_VIEW_WINDOW_CLASS +MODEST_IS_ACCOUNT_VIEW_WINDOW_CLASS +MODEST_ACCOUNT_VIEW_WINDOW_GET_CLASS +
+ +
+modest-transport-widget +ModestTransportWidget +ModestTransportWidget +modest_transport_widget_new +modest_transport_widget_get_remember_password +modest_transport_widget_get_requires_auth +modest_transport_widget_get_username +modest_transport_widget_get_servername +modest_transport_widget_get_proto + +MODEST_TRANSPORT_WIDGET +MODEST_IS_TRANSPORT_WIDGET +MODEST_TYPE_TRANSPORT_WIDGET +modest_transport_widget_get_type +MODEST_TRANSPORT_WIDGET_CLASS +MODEST_IS_TRANSPORT_WIDGET_CLASS +MODEST_TRANSPORT_WIDGET_GET_CLASS +
+ +
+modest-store-widget +ModestStoreWidget +ModestStoreWidget +modest_store_widget_new +modest_store_widget_get_remember_password +modest_store_widget_get_username +modest_store_widget_get_servername +modest_store_widget_get_proto + +MODEST_STORE_WIDGET +MODEST_IS_STORE_WIDGET +MODEST_TYPE_STORE_WIDGET +modest_store_widget_get_type +MODEST_STORE_WIDGET_CLASS +MODEST_IS_STORE_WIDGET_CLASS +MODEST_STORE_WIDGET_GET_CLASS +
+ +
+modest-edit-msg-window +ModestEditMsgWindow +ModestEditMsgWindow +ModestEditType +modest_edit_msg_window_new +modest_edit_msg_window_set_msg + +MODEST_EDIT_MSG_WINDOW +MODEST_IS_EDIT_MSG_WINDOW +MODEST_TYPE_EDIT_MSG_WINDOW +modest_edit_msg_window_get_type +MODEST_EDIT_MSG_WINDOW_CLASS +MODEST_IS_EDIT_MSG_WINDOW_CLASS +MODEST_EDIT_MSG_WINDOW_GET_CLASS +
+ +
+modest-main-window +ModestMainWindow +ModestMainWindow +modest_main_window_new + +MODEST_MAIN_WINDOW +MODEST_IS_MAIN_WINDOW +MODEST_TYPE_MAIN_WINDOW +modest_main_window_get_type +MODEST_MAIN_WINDOW_CLASS +MODEST_IS_MAIN_WINDOW_CLASS +MODEST_MAIN_WINDOW_GET_CLASS +
+ +
modest-tny-attachment ModestTnyAttachment ModestTnyAttachment @@ -879,118 +1091,18 @@ MODEST_WIDGET_FACTORY_GET_CLASS
modest-tny-account-store ModestTnyGetPassFunc -ModestTnyAccountStore -ModestTnyAccountStore -modest_tny_account_store_new -tny_account_store_get_session - -MODEST_TNY_ACCOUNT_STORE -MODEST_IS_TNY_ACCOUNT_STORE -MODEST_TYPE_TNY_ACCOUNT_STORE -modest_tny_account_store_get_type -MODEST_TNY_ACCOUNT_STORE_CLASS -MODEST_IS_TNY_ACCOUNT_STORE_CLASS -MODEST_TNY_ACCOUNT_STORE_GET_CLASS -
- -
-modest-account-assistant -ModestAccountAssistant -ModestAccountAssistant -modest_account_assistant_new - -MODEST_ACCOUNT_ASSISTANT -MODEST_IS_ACCOUNT_ASSISTANT -MODEST_TYPE_ACCOUNT_ASSISTANT -modest_account_assistant_get_type -MODEST_ACCOUNT_ASSISTANT_CLASS -MODEST_IS_ACCOUNT_ASSISTANT_CLASS -MODEST_ACCOUNT_ASSISTANT_GET_CLASS -
- -
-modest-account-view-window -ModestAccountViewWindow -ModestAccountViewWindow -modest_account_view_window_new - -MODEST_ACCOUNT_VIEW_WINDOW -MODEST_IS_ACCOUNT_VIEW_WINDOW -MODEST_TYPE_ACCOUNT_VIEW_WINDOW -modest_account_view_window_get_type -MODEST_ACCOUNT_VIEW_WINDOW_CLASS -MODEST_IS_ACCOUNT_VIEW_WINDOW_CLASS -MODEST_ACCOUNT_VIEW_WINDOW_GET_CLASS -
- -
-modest-transport-widget -ModestTransportWidget -ModestTransportWidget -modest_transport_widget_new -modest_transport_widget_get_remember_password -modest_transport_widget_get_username -modest_transport_widget_get_servername -modest_transport_widget_get_proto - -MODEST_TRANSPORT_WIDGET -MODEST_IS_TRANSPORT_WIDGET -MODEST_TYPE_TRANSPORT_WIDGET -modest_transport_widget_get_type -MODEST_TRANSPORT_WIDGET_CLASS -MODEST_IS_TRANSPORT_WIDGET_CLASS -MODEST_TRANSPORT_WIDGET_GET_CLASS -
- -
-modest-store-widget -ModestStoreWidget -ModestStoreWidget -modest_store_widget_new -modest_store_widget_get_remember_password -modest_store_widget_get_username -modest_store_widget_get_servername -modest_store_widget_get_proto - -MODEST_STORE_WIDGET -MODEST_IS_STORE_WIDGET -MODEST_TYPE_STORE_WIDGET -modest_store_widget_get_type -MODEST_STORE_WIDGET_CLASS -MODEST_IS_STORE_WIDGET_CLASS -MODEST_STORE_WIDGET_GET_CLASS -
- -
-modest-edit-msg-window -ModestEditMsgWindow -ModestEditMsgWindow -ModestEditType -modest_edit_msg_window_new -modest_edit_msg_window_set_msg - -MODEST_EDIT_MSG_WINDOW -MODEST_IS_EDIT_MSG_WINDOW -MODEST_TYPE_EDIT_MSG_WINDOW -modest_edit_msg_window_get_type -MODEST_EDIT_MSG_WINDOW_CLASS -MODEST_IS_EDIT_MSG_WINDOW_CLASS -MODEST_EDIT_MSG_WINDOW_GET_CLASS -
- -
-modest-main-window -ModestMainWindow -ModestMainWindow -modest_main_window_new +ModestTnyAccountStore +ModestTnyAccountStore +modest_tny_account_store_new +tny_account_store_get_session -MODEST_MAIN_WINDOW -MODEST_IS_MAIN_WINDOW -MODEST_TYPE_MAIN_WINDOW -modest_main_window_get_type -MODEST_MAIN_WINDOW_CLASS -MODEST_IS_MAIN_WINDOW_CLASS -MODEST_MAIN_WINDOW_GET_CLASS +MODEST_TNY_ACCOUNT_STORE +MODEST_IS_TNY_ACCOUNT_STORE +MODEST_TYPE_TNY_ACCOUNT_STORE +modest_tny_account_store_get_type +MODEST_TNY_ACCOUNT_STORE_CLASS +MODEST_IS_TNY_ACCOUNT_STORE_CLASS +MODEST_TNY_ACCOUNT_STORE_GET_CLASS
@@ -1029,6 +1141,7 @@ MODEST_ACCOUNT_VIEW_WINDOW_GET_CLASS ModestTransportWidget modest_transport_widget_new modest_transport_widget_get_remember_password +modest_transport_widget_get_requires_auth modest_transport_widget_get_username modest_transport_widget_get_servername modest_transport_widget_get_proto @@ -1067,6 +1180,7 @@ MODEST_STORE_WIDGET_GET_CLASS ModestEditMsgWindow ModestEditType modest_edit_msg_window_new +modest_edit_msg_window_set_msg MODEST_EDIT_MSG_WINDOW MODEST_IS_EDIT_MSG_WINDOW @@ -1093,116 +1207,6 @@ MODEST_MAIN_WINDOW_GET_CLASS
-modest-account-view -ModestAccountView -ModestAccountView -modest_account_view_new -modest_account_view_get_selected_account - -MODEST_ACCOUNT_VIEW -MODEST_IS_ACCOUNT_VIEW -MODEST_TYPE_ACCOUNT_VIEW -modest_account_view_get_type -MODEST_ACCOUNT_VIEW_CLASS -MODEST_IS_ACCOUNT_VIEW_CLASS -MODEST_ACCOUNT_VIEW_GET_CLASS -
- -
-modest-header-view -MODEST_HEADER_VIEW_COLUMN -ModestHeaderViewColumn -ModestHeaderViewStyle -ModestItemType -ModestHeaderView -ModestHeaderView -modest_header_view_new -modest_header_view_set_folder -modest_header_view_get_folder -modest_header_view_set_columns -modest_header_view_get_columns -modest_header_view_set_style -modest_header_view_get_style -modest_header_view_get_selected_headers - -MODEST_HEADER_VIEW -MODEST_IS_HEADER_VIEW -MODEST_TYPE_HEADER_VIEW -modest_header_view_get_type -MODEST_HEADER_VIEW_CLASS -MODEST_IS_HEADER_VIEW_CLASS -MODEST_HEADER_VIEW_GET_CLASS -
- -
-modest-toolbar -ModestToolbarButton -ModestToolbar -ModestToolbar -modest_toolbar_new - -MODEST_TOOLBAR -MODEST_IS_TOOLBAR -MODEST_TYPE_TOOLBAR -modest_toolbar_get_type -MODEST_TOOLBAR_CLASS -MODEST_IS_TOOLBAR_CLASS -MODEST_TOOLBAR_GET_CLASS -
- -
-modest-folder-view -ModestFolderView -ModestFolderView -modest_folder_view_new -modest_folder_view_set_title -modest_folder_view_is_empty -modest_folder_view_guess_folder_type -modest_folder_view_get_selected_account - -MODEST_FOLDER_VIEW -MODEST_IS_FOLDER_VIEW -MODEST_TYPE_FOLDER_VIEW -modest_folder_view_get_type -MODEST_FOLDER_VIEW_CLASS -MODEST_IS_FOLDER_VIEW_CLASS -MODEST_FOLDER_VIEW_GET_CLASS -
- -
-modest-combo-box -ModestComboBox -ModestComboBox -modest_combo_box_new -modest_combo_box_get_active_id -modest_combo_box_get_active_display_name - -MODEST_COMBO_BOX -MODEST_IS_COMBO_BOX -MODEST_TYPE_COMBO_BOX -modest_combo_box_get_type -MODEST_COMBO_BOX_CLASS -MODEST_IS_COMBO_BOX_CLASS -MODEST_COMBO_BOX_GET_CLASS -
- -
-modest-msg-view -ModestMsgView -ModestMsgView -modest_msg_view_new -modest_msg_view_set_message - -MODEST_MSG_VIEW -MODEST_IS_MSG_VIEW -MODEST_TYPE_MSG_VIEW -modest_msg_view_get_type -MODEST_MSG_VIEW_CLASS -MODEST_IS_MSG_VIEW_CLASS -MODEST_MSG_VIEW_GET_CLASS -
- -
modest-account-assistant ModestAccountAssistant ModestAccountAssistant @@ -1276,7 +1280,6 @@ MODEST_STORE_WIDGET_GET_CLASS ModestEditMsgWindow ModestEditType modest_edit_msg_window_new -modest_edit_msg_window_set_msg MODEST_EDIT_MSG_WINDOW MODEST_IS_EDIT_MSG_WINDOW @@ -1438,6 +1441,7 @@ MODEST_ACCOUNT_HOSTNAME MODEST_ACCOUNT_USERNAME MODEST_ACCOUNT_PROTO MODEST_ACCOUNT_ENABLED +MODEST_ACCOUNT_TYPE MODEST_ACCOUNT_LEAVE_ON_SERVER MODEST_ACCOUNT_PREFERRED_CNX MODEST_ACCOUNT_OPTIONS @@ -1535,6 +1539,19 @@ modest_proto_auth_protos
+modest-widget-memory +modest_widget_memory_save +modest_widget_memory_restore +
+ +
+modest-tny-msg-actions +modest_tny_msg_actions_find_body_part +modest_tny_msg_actions_find_nth_part +modest_tny_msg_actions_find_body +
+ +
modest-marshal modest_marshal_VOID__POINTER_POINTER modest_marshal_VOID__POINTER_POINTER_POINTER @@ -1550,19 +1567,6 @@ modest_marshal_VOID__STRING_POINTER_POINTER_POINTER
-modest-widget-memory -modest_widget_memory_save -modest_widget_memory_restore -
- -
-modest-tny-msg-actions -modest_tny_msg_actions_find_body_part -modest_tny_msg_actions_find_nth_part -modest_tny_msg_actions_find_body -
- -
modest-error ModestErrorDomain ModestErrorCode @@ -1639,6 +1643,43 @@ MODEST_TOOLBAR_ICON_STOP
+modest-header-view-priv +
+ +
+modest-icon-names +PIXMAP_PREFIX +MODEST_APP_ICON +MODEST_HEADER_ICON_READ +MODEST_HEADER_ICON_UNREAD +MODEST_HEADER_ICON_DELETED +MODEST_HEADER_ICON_ATTACH +MODEST_FOLDER_ICON_OPEN +MODEST_FOLDER_ICON_CLOSED +MODEST_FOLDER_ICON_ACCOUNT +MODEST_FOLDER_ICON_INBOX +MODEST_FOLDER_ICON_OUTBOX +MODEST_FOLDER_ICON_SENT +MODEST_FOLDER_ICON_TRASH +MODEST_FOLDER_ICON_JUNK +MODEST_FOLDER_ICON_DRAFTS +MODEST_FOLDER_ICON_NORMAL +MODEST_FOLDER_ICON_CONTACTS +MODEST_FOLDER_ICON_NOTES +MODEST_FOLDER_ICON_CALENDAR +MODEST_TOOLBAR_ICON_MAIL_SEND +MODEST_TOOLBAR_ICON_NEW_MAIL +MODEST_TOOLBAR_ICON_SEND_RECEIVE +MODEST_TOOLBAR_ICON_REPLY +MODEST_TOOLBAR_ICON_REPLY_ALL +MODEST_TOOLBAR_ICON_FORWARD +MODEST_TOOLBAR_ICON_DELETE +MODEST_TOOLBAR_ICON_NEXT +MODEST_TOOLBAR_ICON_PREV +MODEST_TOOLBAR_ICON_STOP +
+ +
modest-tny-store-actions modest_tny_store_actions_create_folder modest_tny_store_actions_remove_folder @@ -1664,6 +1705,7 @@ MODEST_ACCOUNT_HOSTNAME MODEST_ACCOUNT_USERNAME MODEST_ACCOUNT_PROTO MODEST_ACCOUNT_ENABLED +MODEST_ACCOUNT_TYPE MODEST_ACCOUNT_LEAVE_ON_SERVER MODEST_ACCOUNT_PREFERRED_CNX MODEST_ACCOUNT_OPTIONS @@ -1761,6 +1803,19 @@ modest_proto_auth_protos
+modest-widget-memory +modest_widget_memory_save +modest_widget_memory_restore +
+ +
+modest-tny-msg-actions +modest_tny_msg_actions_find_body_part +modest_tny_msg_actions_find_nth_part +modest_tny_msg_actions_find_body +
+ +
modest-marshal modest_marshal_VOID__POINTER_POINTER modest_marshal_VOID__POINTER_POINTER_POINTER @@ -1776,19 +1831,6 @@ modest_marshal_VOID__STRING_POINTER_POINTER_POINTER
-modest-widget-memory -modest_widget_memory_save -modest_widget_memory_restore -
- -
-modest-tny-msg-actions -modest_tny_msg_actions_find_body_part -modest_tny_msg_actions_find_nth_part -modest_tny_msg_actions_find_body -
- -
modest-error ModestErrorDomain ModestErrorCode @@ -1864,40 +1906,3 @@ MODEST_TOOLBAR_ICON_STOP modest-header-view-priv
-
-modest-icon-names -PIXMAP_PREFIX -MODEST_APP_ICON -MODEST_HEADER_ICON_READ -MODEST_HEADER_ICON_UNREAD -MODEST_HEADER_ICON_DELETED -MODEST_HEADER_ICON_ATTACH -MODEST_FOLDER_ICON_OPEN -MODEST_FOLDER_ICON_CLOSED -MODEST_FOLDER_ICON_ACCOUNT -MODEST_FOLDER_ICON_INBOX -MODEST_FOLDER_ICON_OUTBOX -MODEST_FOLDER_ICON_SENT -MODEST_FOLDER_ICON_TRASH -MODEST_FOLDER_ICON_JUNK -MODEST_FOLDER_ICON_DRAFTS -MODEST_FOLDER_ICON_NORMAL -MODEST_FOLDER_ICON_CONTACTS -MODEST_FOLDER_ICON_NOTES -MODEST_FOLDER_ICON_CALENDAR -MODEST_TOOLBAR_ICON_MAIL_SEND -MODEST_TOOLBAR_ICON_NEW_MAIL -MODEST_TOOLBAR_ICON_SEND_RECEIVE -MODEST_TOOLBAR_ICON_REPLY -MODEST_TOOLBAR_ICON_REPLY_ALL -MODEST_TOOLBAR_ICON_FORWARD -MODEST_TOOLBAR_ICON_DELETE -MODEST_TOOLBAR_ICON_NEXT -MODEST_TOOLBAR_ICON_PREV -MODEST_TOOLBAR_ICON_STOP -
- -
-modest-header-view-priv -
- diff --git a/docs/reference/tmpl/modest-account-assistant.sgml b/docs/reference/tmpl/modest-account-assistant.sgml index eb816cb..d142920 100644 --- a/docs/reference/tmpl/modest-account-assistant.sgml +++ b/docs/reference/tmpl/modest-account-assistant.sgml @@ -2,7 +2,7 @@ ModestAccountAssistant -A widget that displays a wizard to create new accounts + diff --git a/docs/reference/tmpl/modest-account-keys.sgml b/docs/reference/tmpl/modest-account-keys.sgml index 1e4a518..ef904c0 100644 --- a/docs/reference/tmpl/modest-account-keys.sgml +++ b/docs/reference/tmpl/modest-account-keys.sgml @@ -131,6 +131,13 @@ modest-account-keys + + + + + + + diff --git a/docs/reference/tmpl/modest-account-mgr.sgml b/docs/reference/tmpl/modest-account-mgr.sgml index 0c8a6a2..f4d862c 100644 --- a/docs/reference/tmpl/modest-account-mgr.sgml +++ b/docs/reference/tmpl/modest-account-mgr.sgml @@ -30,38 +30,19 @@ ModestAccountMgr -@: -@: -@: -@: +@modestaccountmgr: the object which received the signal. +@arg1: +@arg2: +@arg3: -@: -@: -@: - - - - - - -@: -@: -@: -@: - - - - - - -@: -@: -@: +@modestaccountmgr: the object which received the signal. +@arg1: +@arg2: diff --git a/docs/reference/tmpl/modest-account-view-window.sgml b/docs/reference/tmpl/modest-account-view-window.sgml index 0f09541..21e58a3 100644 --- a/docs/reference/tmpl/modest-account-view-window.sgml +++ b/docs/reference/tmpl/modest-account-view-window.sgml @@ -2,7 +2,7 @@ ModestAccountViewWindow -A window that shows the list of available accounts + diff --git a/docs/reference/tmpl/modest-account-view.sgml b/docs/reference/tmpl/modest-account-view.sgml index a842b6b..61fcfb1 100644 --- a/docs/reference/tmpl/modest-account-view.sgml +++ b/docs/reference/tmpl/modest-account-view.sgml @@ -2,7 +2,7 @@ ModestAccountView -A widget that shows a list with the available accounts + diff --git a/docs/reference/tmpl/modest-combo-box.sgml b/docs/reference/tmpl/modest-combo-box.sgml index 1157267..16c4866 100644 --- a/docs/reference/tmpl/modest-combo-box.sgml +++ b/docs/reference/tmpl/modest-combo-box.sgml @@ -2,7 +2,7 @@ ModestComboBox -A wrapper for a #GtkComboBox that shows lists of #ModestPair objects + diff --git a/docs/reference/tmpl/modest-conf.sgml b/docs/reference/tmpl/modest-conf.sgml index c4a1dc7..1381572 100644 --- a/docs/reference/tmpl/modest-conf.sgml +++ b/docs/reference/tmpl/modest-conf.sgml @@ -48,18 +48,9 @@ ModestConf -@: -@: -@: - - - - - - -@: -@: -@: +@modestconf: the object which received the signal. +@arg1: +@arg2: diff --git a/docs/reference/tmpl/modest-edit-msg-window.sgml b/docs/reference/tmpl/modest-edit-msg-window.sgml index 91a8bf8..ecc2065 100644 --- a/docs/reference/tmpl/modest-edit-msg-window.sgml +++ b/docs/reference/tmpl/modest-edit-msg-window.sgml @@ -2,7 +2,7 @@ ModestEditMsgWindow -A window used for composing messages + @@ -46,12 +46,3 @@ A window used for composing messages @Returns: - - - - - -@self: -@msg: - - diff --git a/docs/reference/tmpl/modest-error.sgml b/docs/reference/tmpl/modest-error.sgml index e450e4b..19e571a 100644 --- a/docs/reference/tmpl/modest-error.sgml +++ b/docs/reference/tmpl/modest-error.sgml @@ -2,7 +2,7 @@ modest-error -Modest error stuff + diff --git a/docs/reference/tmpl/modest-folder-view.sgml b/docs/reference/tmpl/modest-folder-view.sgml index 0d0bf02..a28a5a2 100644 --- a/docs/reference/tmpl/modest-folder-view.sgml +++ b/docs/reference/tmpl/modest-folder-view.sgml @@ -2,7 +2,7 @@ ModestFolderView -A widget that shows the list of folders of email accounts + diff --git a/docs/reference/tmpl/modest-formatter.sgml b/docs/reference/tmpl/modest-formatter.sgml index 7d1dd40..9779f1e 100644 --- a/docs/reference/tmpl/modest-formatter.sgml +++ b/docs/reference/tmpl/modest-formatter.sgml @@ -2,7 +2,7 @@ ModestFormatter -An object that creates new emails from others + diff --git a/docs/reference/tmpl/modest-header-view.sgml b/docs/reference/tmpl/modest-header-view.sgml index 4035eaf..bd0c464 100644 --- a/docs/reference/tmpl/modest-header-view.sgml +++ b/docs/reference/tmpl/modest-header-view.sgml @@ -2,7 +2,7 @@ ModestHeaderView -A widget that shows a list of email headers + diff --git a/docs/reference/tmpl/modest-icon-factory.sgml b/docs/reference/tmpl/modest-icon-factory.sgml index 770f928..f15a940 100644 --- a/docs/reference/tmpl/modest-icon-factory.sgml +++ b/docs/reference/tmpl/modest-icon-factory.sgml @@ -2,7 +2,7 @@ modest-icon-factory -A factory that creates the icons for Modest + diff --git a/docs/reference/tmpl/modest-icon-names.sgml b/docs/reference/tmpl/modest-icon-names.sgml index 477cc0a..9e44b91 100644 --- a/docs/reference/tmpl/modest-icon-names.sgml +++ b/docs/reference/tmpl/modest-icon-names.sgml @@ -2,7 +2,7 @@ modest-icon-names -Definitions for the Modest icons + diff --git a/docs/reference/tmpl/modest-mail-operation-queue.sgml b/docs/reference/tmpl/modest-mail-operation-queue.sgml index f2309e0..15e970e 100644 --- a/docs/reference/tmpl/modest-mail-operation-queue.sgml +++ b/docs/reference/tmpl/modest-mail-operation-queue.sgml @@ -2,7 +2,7 @@ ModestMailOperationQueue -An object that stores a queue of #ModestMailOperation + diff --git a/docs/reference/tmpl/modest-mail-operation.sgml b/docs/reference/tmpl/modest-mail-operation.sgml index 13490da..9668d88 100644 --- a/docs/reference/tmpl/modest-mail-operation.sgml +++ b/docs/reference/tmpl/modest-mail-operation.sgml @@ -2,7 +2,7 @@ ModestMailOperation -An object that performs mail operations + @@ -195,6 +195,7 @@ An object that performs mail operations @self: @header: @folder: +@Returns: @@ -205,6 +206,7 @@ An object that performs mail operations @self: @header: @folder: +@Returns: diff --git a/docs/reference/tmpl/modest-msg-view.sgml b/docs/reference/tmpl/modest-msg-view.sgml index fde7239..291af8f 100644 --- a/docs/reference/tmpl/modest-msg-view.sgml +++ b/docs/reference/tmpl/modest-msg-view.sgml @@ -2,7 +2,7 @@ ModestMsgView -A widget that shows the body of a message + @@ -30,24 +30,24 @@ A widget that shows the body of a message -@modestmsgview: the object which received the signal. -@arg1: +@: +@: -@modestmsgview: the object which received the signal. -@arg1: +@: +@: -@modestmsgview: the object which received the signal. -@arg1: +@: +@: diff --git a/docs/reference/tmpl/modest-pair.sgml b/docs/reference/tmpl/modest-pair.sgml index 17156a6..66b40e6 100644 --- a/docs/reference/tmpl/modest-pair.sgml +++ b/docs/reference/tmpl/modest-pair.sgml @@ -2,7 +2,7 @@ modest-pair -An object that stores pairs of related objects + diff --git a/docs/reference/tmpl/modest-presets.sgml b/docs/reference/tmpl/modest-presets.sgml index f531829..42352e7 100644 --- a/docs/reference/tmpl/modest-presets.sgml +++ b/docs/reference/tmpl/modest-presets.sgml @@ -2,7 +2,7 @@ modest-presets -An object that manages Modest presest + diff --git a/docs/reference/tmpl/modest-protocol-mgr.sgml b/docs/reference/tmpl/modest-protocol-mgr.sgml index 0e0fdf9..d8aea74 100644 --- a/docs/reference/tmpl/modest-protocol-mgr.sgml +++ b/docs/reference/tmpl/modest-protocol-mgr.sgml @@ -2,7 +2,7 @@ ModestProtocolMgr -An object that manages the email protocols + diff --git a/docs/reference/tmpl/modest-store-widget.sgml b/docs/reference/tmpl/modest-store-widget.sgml index bdd6f69..1b41490 100644 --- a/docs/reference/tmpl/modest-store-widget.sgml +++ b/docs/reference/tmpl/modest-store-widget.sgml @@ -2,7 +2,7 @@ ModestStoreWidget -A widget that shows the server information for a store account + @@ -25,6 +25,20 @@ A widget that shows the server information for a store account + + + + + +@modeststorewidget: the object which received the signal. + + + + + + +@modeststorewidget: the object which received the signal. + diff --git a/docs/reference/tmpl/modest-text-utils.sgml b/docs/reference/tmpl/modest-text-utils.sgml index cb283a4..bab1d21 100644 --- a/docs/reference/tmpl/modest-text-utils.sgml +++ b/docs/reference/tmpl/modest-text-utils.sgml @@ -2,7 +2,7 @@ modest-text-utils -A library with text utility functions + diff --git a/docs/reference/tmpl/modest-tny-account-store.sgml b/docs/reference/tmpl/modest-tny-account-store.sgml index 7472858..3673db2 100644 --- a/docs/reference/tmpl/modest-tny-account-store.sgml +++ b/docs/reference/tmpl/modest-tny-account-store.sgml @@ -36,27 +36,8 @@ ModestTnyAccountStore -@: -@: - - - - - - -@: -@: -@: -@: -@Param5: - - - - - - -@: -@: +@modesttnyaccountstore: the object which received the signal. +@arg1: @@ -64,9 +45,9 @@ ModestTnyAccountStore @: -@: -@: -@: +@Param2: +@Param3: +@Param4: @Param5: diff --git a/docs/reference/tmpl/modest-tny-platform-factory.sgml b/docs/reference/tmpl/modest-tny-platform-factory.sgml index 3a23c59..b95a37d 100644 --- a/docs/reference/tmpl/modest-tny-platform-factory.sgml +++ b/docs/reference/tmpl/modest-tny-platform-factory.sgml @@ -2,7 +2,7 @@ ModestTnyPlatformFactory -An implementation of a #TnyPlatformFactory + diff --git a/docs/reference/tmpl/modest-tny-stream-gtkhtml.sgml b/docs/reference/tmpl/modest-tny-stream-gtkhtml.sgml index fdb3a4d..d073ba4 100644 --- a/docs/reference/tmpl/modest-tny-stream-gtkhtml.sgml +++ b/docs/reference/tmpl/modest-tny-stream-gtkhtml.sgml @@ -2,7 +2,7 @@ ModestTnyStreamGtkhtml -An implementation of a #TnyStream that uses a #GtkHTMLStream + diff --git a/docs/reference/tmpl/modest-toolbar.sgml b/docs/reference/tmpl/modest-toolbar.sgml index 7df6bc3..9699dce 100644 --- a/docs/reference/tmpl/modest-toolbar.sgml +++ b/docs/reference/tmpl/modest-toolbar.sgml @@ -2,7 +2,7 @@ ModestToolbar -A widgets that shows a toolbar in the Modest main window + diff --git a/docs/reference/tmpl/modest-transport-widget.sgml b/docs/reference/tmpl/modest-transport-widget.sgml index 2bdb33e..eef2c1a 100644 --- a/docs/reference/tmpl/modest-transport-widget.sgml +++ b/docs/reference/tmpl/modest-transport-widget.sgml @@ -2,7 +2,7 @@ ModestTransportWidget -A widget that shows the server information for a transport account + diff --git a/docs/reference/tmpl/modest-widget-factory.sgml b/docs/reference/tmpl/modest-widget-factory.sgml index 007a13e..a6520df 100644 --- a/docs/reference/tmpl/modest-widget-factory.sgml +++ b/docs/reference/tmpl/modest-widget-factory.sgml @@ -2,7 +2,7 @@ ModestWidgetFactory -A factory that creates the widgets of the UI + diff --git a/docs/reference/tmpl/modest-widget-memory.sgml b/docs/reference/tmpl/modest-widget-memory.sgml index e6f341c..74f7955 100644 --- a/docs/reference/tmpl/modest-widget-memory.sgml +++ b/docs/reference/tmpl/modest-widget-memory.sgml @@ -2,7 +2,7 @@ modest-widget-memory -An object that stores preferences of the widgets + diff --git a/src/modest-account-mgr.h b/src/modest-account-mgr.h index 2ae7a21..303a90c 100644 --- a/src/modest-account-mgr.h +++ b/src/modest-account-mgr.h @@ -154,7 +154,8 @@ gboolean modest_account_mgr_add_server_account (ModestAccountMgr *self, * modest_account_mgr_remove_account: * @self: a ModestAccountMgr instance * @name: the name of the account to remove - * @err: a GError ptr, or NULL to ignore. + * @server_account: TRUE if the account to remove is a server account + * @err: a #GError ptr, or NULL to ignore. * * remove an existing account. the account with @name should already exist * diff --git a/src/modest-formatter.h b/src/modest-formatter.h index a74b54b..cf5c040 100644 --- a/src/modest-formatter.h +++ b/src/modest-formatter.h @@ -74,13 +74,13 @@ ModestFormatter* modest_formatter_new (const gchar *content_type); * Original message * ---------------- * Date: 1970/01/01 - * From: somemail@modest.org + * From: somemailATmodest.org * Body: "This is the body of the text" * * Cited message * ------------- * Body: - * On 1970/01/01 somemail@modest.org wrote: + * On 1970/01/01 somemailATmodest.org wrote: * This is the body of the text * * @@ -103,13 +103,13 @@ TnyMsg * modest_formatter_cite (ModestFormatter *self, TnyMimePart *part, TnyH * Original message * ---------------- * Date: 1970/01/01 - * From: somemail@modest.org + * From: somemailATmodest.org * Body: "This is the body of the text" * * Quoted message * ------------- * Body: - * On 1970/01/01 somemail@modest.org wrote: + * On 1970/01/01 somemailATmodest.org wrote: * > This is the body of the text * * @@ -133,8 +133,8 @@ TnyMsg * modest_formatter_quote (ModestFormatter *self, TnyMimePart *part, TnyH * Original message * ---------------- * Date: 1970/01/01 - * From: somemail@modest.org - * To: mymail@modest.org + * From: somemailATmodest.org + * To: mymailATmodest.org * Subject: Mail subject * Body: "This is the body of the text" * @@ -142,11 +142,11 @@ TnyMsg * modest_formatter_quote (ModestFormatter *self, TnyMimePart *part, TnyH * ------------- * Body: * -----Forwarded Message----- - * From: somemail@modest.org + * From: somemailATmodest.org * Sent: 1970/01/01 - * To: mymail@modest.org + * To: mymailATmodest.org * Subject: Fw: Mail subject - * On 1970/01/01 somemail@modest.org wrote: + * On 1970/01/01 somemailATmodest.org wrote: * This is the body of the text * * diff --git a/src/modest-mail-operation.c b/src/modest-mail-operation.c index e0068b3..9a99a59 100644 --- a/src/modest-mail-operation.c +++ b/src/modest-mail-operation.c @@ -80,10 +80,10 @@ static void modest_mail_operation_xfer_folder (ModestMailOperation *self, TnyFolderStore *parent, gboolean delete_original); -static void modest_mail_operation_xfer_msg (ModestMailOperation *self, - TnyHeader *header, - TnyFolder *folder, - gboolean delete_original); +static gboolean modest_mail_operation_xfer_msg (ModestMailOperation *self, + TnyHeader *header, + TnyFolder *folder, + gboolean delete_original); static TnyFolder * modest_mail_operation_find_trash_folder (ModestMailOperation *self, TnyStoreAccount *store_account); @@ -839,26 +839,26 @@ modest_mail_operation_find_trash_folder (ModestMailOperation *self, /* ************************** MSG ACTIONS ************************* */ /* ******************************************************************* */ -void +gboolean modest_mail_operation_copy_msg (ModestMailOperation *self, TnyHeader *header, TnyFolder *folder) { - g_return_if_fail (TNY_IS_HEADER (header)); - g_return_if_fail (TNY_IS_FOLDER (folder)); + g_return_val_if_fail (TNY_IS_HEADER (header), FALSE); + g_return_val_if_fail (TNY_IS_FOLDER (folder), FALSE); - modest_mail_operation_xfer_msg (self, header, folder, FALSE); + return modest_mail_operation_xfer_msg (self, header, folder, FALSE); } -void +gboolean modest_mail_operation_move_msg (ModestMailOperation *self, TnyHeader *header, TnyFolder *folder) { - g_return_if_fail (TNY_IS_HEADER (header)); - g_return_if_fail (TNY_IS_FOLDER (folder)); + g_return_val_if_fail (TNY_IS_HEADER (header), FALSE); + g_return_val_if_fail (TNY_IS_FOLDER (folder), FALSE); - modest_mail_operation_xfer_msg (self, header, folder, TRUE); + return modest_mail_operation_xfer_msg (self, header, folder, TRUE); } void @@ -893,24 +893,44 @@ modest_mail_operation_remove_msg (ModestMailOperation *self, } static void +transfer_msgs_cb (TnyFolder *folder, GError **err, gpointer user_data) +{ + ModestMailOperationPrivate *priv; + + priv = MODEST_MAIL_OPERATION_GET_PRIVATE(user_data); + priv->done = 1; + priv->status = MODEST_MAIL_OPERATION_STATUS_SUCCESS; + + g_signal_emit (G_OBJECT (user_data), signals[PROGRESS_CHANGED_SIGNAL], 0, NULL); +} + +static gboolean modest_mail_operation_xfer_msg (ModestMailOperation *self, TnyHeader *header, TnyFolder *folder, gboolean delete_original) { + ModestMailOperationPrivate *priv; TnyFolder *src_folder; TnyList *headers; src_folder = tny_header_get_folder (header); headers = tny_simple_list_new (); - /* Move */ + priv = MODEST_MAIL_OPERATION_GET_PRIVATE(self); + priv->total = 1; + priv->done = 0; + priv->status = MODEST_MAIL_OPERATION_STATUS_IN_PROGRESS; + tny_list_prepend (headers, G_OBJECT (header)); - tny_folder_transfer_msgs (src_folder, headers, folder, delete_original, NULL); /* FIXME */ + tny_folder_transfer_msgs_async (src_folder, headers, folder, + delete_original, transfer_msgs_cb, self); /* Free */ g_object_unref (headers); g_object_unref (folder); + + return TRUE; } diff --git a/src/modest-mail-operation.h b/src/modest-mail-operation.h index cf2169c..47820f7 100644 --- a/src/modest-mail-operation.h +++ b/src/modest-mail-operation.h @@ -47,27 +47,42 @@ G_BEGIN_DECLS typedef struct _ModestMailOperation ModestMailOperation; typedef struct _ModestMailOperationClass ModestMailOperationClass; -/* typedef enum _ModestMailOperationForwardType ModestMailOperationForwardType; */ -/* typedef enum _ModestMailOperationReplyType ModestMailOperationReplyType; */ -/* typedef enum _ModestMailOperationReplyMode ModestMailOperationReplyMode; */ -/* typedef enum _ModestMailOperationStatus ModestMailOperationStatus; */ - +/** + * ModestMailOperationForwardType: + * + * How the original message will be forwarded to the recipient + */ typedef enum _ModestMailOperationForwardType { MODEST_MAIL_OPERATION_FORWARD_TYPE_INLINE = 1, MODEST_MAIL_OPERATION_FORWARD_TYPE_ATTACHMENT } ModestMailOperationForwardType; +/** + * ModestMailOperationReplyType: + * + * How the original message will be forwarded to the recipient + */ typedef enum _ModestMailOperationReplyType { MODEST_MAIL_OPERATION_REPLY_TYPE_CITE = 1, MODEST_MAIL_OPERATION_REPLY_TYPE_QUOTE } ModestMailOperationReplyType; +/** + * ModestMailOperationReplyMode: + * + * Who will be the recipients of the replied message + */ typedef enum _ModestMailOperationReplyMode { MODEST_MAIL_OPERATION_REPLY_MODE_SENDER, MODEST_MAIL_OPERATION_REPLY_MODE_LIST, MODEST_MAIL_OPERATION_REPLY_MODE_ALL } ModestMailOperationReplyMode; +/** + * ModestMailOperationStatus: + * + * The state of a mail operation + */ typedef enum _ModestMailOperationStatus { MODEST_MAIL_OPERATION_STATUS_INVALID, MODEST_MAIL_OPERATION_STATUS_SUCCESS, @@ -181,7 +196,7 @@ TnyMsg* modest_mail_operation_create_reply_mail (TnyMsg *msg, * * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact) * mail_op = modest_mail_operation_new (); - * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK (on_progress_changed), queue); + * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), queue); * if (modest_mail_operation_update_account (mail_op, account)) * { * modest_mail_operation_queue_add (queue, mail_op); @@ -284,11 +299,26 @@ void modest_mail_operation_copy_folder (ModestMailOperation *self, * @header: the #TnyHeader of the message to copy * @folder: the #TnyFolder where the message will be copied * - * Copies a message from its current folder to another one. This - * operation is synchronous, so the #ModestMailOperation should not be - * added to any #ModestMailOperationQueue + * Asynchronously copies a message from its current folder to another + * one. The caller should add the #ModestMailOperation to a + * #ModestMailOperationQueue and then free it. The caller will be + * notified by the "progress_changed" when the operation is completed. + * + * Example + * + * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact); + * mail_op = modest_mail_operation_new (); + * if (modest_mail_operation_copy_msg (mail_op, account)) + * { + * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), queue); + * modest_mail_operation_queue_add (queue, mail_op); + * } + * g_object_unref (G_OBJECT (mail_op)); + * + * + * Returns: TRUE if the mail operation could be started, or FALSE otherwise **/ -void modest_mail_operation_copy_msg (ModestMailOperation *self, +gboolean modest_mail_operation_copy_msg (ModestMailOperation *self, TnyHeader *header, TnyFolder *folder); @@ -298,11 +328,26 @@ void modest_mail_operation_copy_msg (ModestMailOperation *self, * @header: the #TnyHeader of the message to move * @folder: the #TnyFolder where the message will be moved * - * Moves a message from its current folder to another one. This - * operation is synchronous, so the #ModestMailOperation should not be - * added to any #ModestMailOperationQueue + * Asynchronously moves a message from its current folder to another + * one. The caller should add the #ModestMailOperation to a + * #ModestMailOperationQueue and then free it. The caller will be + * notified by the "progress_changed" when the operation is completed. + * + * Example + * + * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact); + * mail_op = modest_mail_operation_new (); + * if (modest_mail_operation_move_msg (mail_op, account)) + * { + * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), queue); + * modest_mail_operation_queue_add (queue, mail_op); + * } + * g_object_unref (G_OBJECT (mail_op)); + * + * + * Returns: TRUE if the mail operation could be started, or FALSE otherwise **/ -void modest_mail_operation_move_msg (ModestMailOperation *self, +gboolean modest_mail_operation_move_msg (ModestMailOperation *self, TnyHeader *header, TnyFolder *folder); -- 1.7.9.5