Changeset 817

Show
Ignore:
Timestamp:
08/29/06 14:23:40
Author:
pvanhoof
Message:

Documentation updates

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/docs/devel/reference/tmpl/tny-header-view-iface.sgml

    r806 r817  
    33 
    44<!-- ##### SECTION Short_Description ##### --> 
    5 A type for showing a #TnyHeaderIface 
     5A type for showing a header 
    66 
    77<!-- ##### SECTION Long_Description ##### --> 
    88<para> 
    9 A type for showing a #TnyHeaderIface to the user 
     9A type for showing a #TnyHeaderIface implementation to the user. This type is often used in a composition 
     10with a #TnyMsgViewIface implementation. 
    1011</para> 
    1112 
    1213<!-- ##### SECTION See_Also ##### --> 
    1314<para> 
    14 #TnyHeaderIface 
     15#TnyHeaderIface, #TnyMsgViewIface, #TnyMsgWindowIface, #TnyMsgView, #TnyMsgWindow 
    1516</para> 
    1617 

  • trunk/docs/devel/reference/tmpl/tny-msg-view-iface.sgml

    r806 r817  
    33 
    44<!-- ##### SECTION Short_Description ##### --> 
    5 A type that defines a message view 
     5A type that defines a view for a message 
    66 
    77<!-- ##### SECTION Long_Description ##### --> 
    88<para> 
    9 A view for a message. Implementations of this type should show a message 
    10 to the user. 
     9A type that defines a view for a #TnyMsgIface implementation. The type is sometimes decorated by a  
     10#TnyMsgWindowIface implementation. 
    1111</para> 
    1212 
    1313<!-- ##### SECTION See_Also ##### --> 
    1414<para> 
    15 #TnyMsgIface, #TnyMsgMimePartIface 
     15#TnyMsgIface, #TnyMsgMimePartIface, #TnyMsgWindowIface, #TnyMsgView, #TnyMsgWindow 
    1616</para> 
    1717 

  • trunk/docs/devel/reference/tmpl/tny-msg-window-iface.sgml

    r388 r817  
    33 
    44<!-- ##### SECTION Short_Description ##### --> 
    5 A type that defines a message window 
     5A type that defines a window for showing a message 
    66 
    77<!-- ##### SECTION Long_Description ##### --> 
    88<para> 
    9 A type that shows a new window in which you can view a message 
     9A type that shows a new window in which you can view a #TnyMsgIface implementation. The implementation of this type 
     10is often designed as a decorator of a #TnyMsgViewIface implementation. It usually wraps the #TnyMsgViewIface  
     11implementation with the API and implementation of a window. 
    1012</para> 
    1113 
    1214<!-- ##### SECTION See_Also ##### --> 
    1315<para> 
    14 #TnyMsgIface 
     16#TnyMsgIface, #TnyMsgViewIface, #TnyMsgWindow, #TnyMsgView 
    1517</para> 
    1618 

  • trunk/libtinymail/tny-account-iface.c

    r758 r817  
    2727 * @self: a #TnyAccountIface object 
    2828 * 
    29  * Get the account type 
     29 * Get the account type. There's two account types: a store and a transport 
     30 * account type. A store account will implement the #TnyFolderStoreIface  
     31 * interfaces which defines that the type contains folders. 
     32 * 
     33 * A transport account has a send method for sending #TnyMsgIface instances 
     34 * using the transport protocol of the account (for example using SMTP). 
    3035 * 
    3136 * Return value: The account type 
    …… 
    4752 * @self: a #TnyAccountIface object 
    4853 * 
     54 * Get the connection status of an account 
     55 * 
    4956 * Return value: whether or not the account is connected 
    5057 **/ 
    …… 
    6572 * @self: a #TnyAccountIface object 
    6673 *  
    67  * Get an unique id for the account. 
    68  *  
    69  * Return value: Unique id.  
     74 * Get an unique id for the account. The only certainty you have is that the 
     75 * id is unique. The format of the id isn't specified. The implementor of the 
     76 * #TnyAccountStoreIface will set this id using tny_account_iface_set_id. 
     77 *  
     78 * Return value: Unique id 
    7079 **/ 
    7180const gchar* 
    …… 
    105114 * @id: the id 
    106115 * 
    107  * Set the account's unique id. You need to set this property 
    108  * before you can start using the account. 
     116 * Set the account's unique id. You need to set this property before you can  
     117 * start using the account. The id must be unique and is typically set in the 
     118 * implementation of a #TnyAccountStoreIface. 
    109119 *  
    110120 **/ 
    …… 
    129139 * therefore can be forgotten by the password store. 
    130140 * 
    131  * You need to set this property before you can start using the account. 
     141 * You need to set this property before you can start using the account. This 
     142 * property is typically set in the implementation of a #TnyAccountStoreIface. 
    132143 *  
    133144 * Also see #TnyForgetPassFunc for more information about the function itself. 
    …… 
    170181 *   
    171182 * Set the url string of an account. You don't need to use this for imap and pop 
    172  * where you can use the simplified API (set_proto, set_hostname, etc). 
     183 * where you can use the simplified API (set_proto, set_hostname, etc). This 
     184 * property is typically set in the implementation of a #TnyAccountStoreIface. 
    173185 *  
    174186 **/ 
    …… 
    190202 * @proto: the protocol (ex. "imap") 
    191203 *  
    192  * Set the protocol of an account. You need to set this property 
    193  * before you can start using the account. 
     204 * Set the protocol of an account. You need to set this property before you can 
     205 * start using the account. This property is typically set in the implementation 
     206 * of a #TnyAccountStoreIface. 
    194207 *  
    195208 **/ 
    …… 
    211224 * @user: the username 
    212225 *  
    213  * Set the user or login of an account. You need to set this property 
    214  * before you can start using the account. 
     226 * Set the user or login of an account. You need to set this property before you 
     227 * can start using the account. This property is typically set in the 
     228 * implementation of a #TnyAccountStoreIface. 
    215229 * 
    216230 **/ 
    …… 
    232246 * @host: the hostname 
    233247 *  
    234  * Set the hostname of an account. You need to set this property 
    235  * before you can start using the account. 
     248 * Set the hostname of an account. You need to set this property before you can 
     249 * start using the account. This property is typically set in the implementation 
     250 * of a #TnyAccountStoreIface. 
     251 * 
    236252 **/ 
    237253void 
    …… 
    256272 * function should return the password for a specific account. 
    257273 * 
    258  * You need to set this property before you can start using the account. 
     274 * You need to set this property before you can start using the account. This 
     275 * property is typically set in the implementation of a #TnyAccountStoreIface. 
    259276 *  
    260277 * Also see #TnyGetPassFunc for more information about the function itself.  
    …… 
    379396 * tny_account_iface_get_pass_func: 
    380397 * @self: a #TnyAccountIface object 
    381  *  
    382  * 
    383398 *  
    384399 * Return value: A pointer to the get-password function 

  • trunk/libtinymail/tny-account-store-iface.c

    r758 r817  
    4444 * as prompt. It will return TRUE if the reply was affirmative. Or FALSE if not. 
    4545 * 
    46  * When implementing a platform-specific library, you need to implement this 
    47  * method. For example in Gtk+ by using the GtkDialog API. 
     46 * Implementors: when implementing a platform-specific library, you must 
     47 * implement this method. For example in Gtk+ by using the GtkDialog API. 
    4848 * 
    4949 * Return value: Whether the user pressed Ok/Yes (TRUE) or Cancel/No (FALSE) 
    …… 
    6666 * This method returns a #TnyDeviceIface instance 
    6767 * 
    68  * When implementing a platform-specific library, you need to implement this 
    69  * method and a #TnyDeviceIface implementation. 
     68 * Implementors: when implementing a platform-specific library, you must 
     69 * implement this method and a #TnyDeviceIface implementation. 
    7070 * 
    7171 * Return value: the device attached to this account store 
    …… 
    8888 * Get the local path that will be used for storing the disk cache 
    8989 * 
    90  * When implementing a platform-specific library, you need to implement this 
    91  * method. You can simply let it return the path to some folder on the file 
    92  * system. Note that the callers of this method will not free the result. You 
     90 * Implementors: when implementing a platform-specific library, you must 
     91 * implement this method. You can for example let it return the path to some 
     92 * folder on the file system. 
     93 * 
     94 * Note that the callers of this method will not free the result. You 
    9395 * are responsible of freeing it up. For example when destroying the  
    9496 * #TnyAccountStoreIface implementation instance. 
    …… 
    114116 * @types: a #TnyGetAccountsRequestType that describes which account types are needed 
    115117 *  
    116  * Get a read-only list of accounts in the store. 
    117  * 
    118  * When implementing a platform-specific library, you need to implement this 
    119  * method. It is allowed to cache the list (but not required). If you are  
    120  * implementing an account store for account implementations from libtinymail-camel, 
    121  * you must register the created accounts with a #TnySessionCamel instance. 
    122  * 
    123  * Each created account must also be informed about the #TnySessionCamel instance 
    124  * being used. Read more about this at tny_account_set_session of #TnyAccount  
    125  * and tny_session_camel_set_current_accounts of #TnySessionCamel. Note that 
    126  * this is specific for the libtinymail-camel implementation and isn't a contract 
    127  * requirement of the interfaces. 
    128  *  
    129  * There's multiple samples of #TnyAccountStoreIface implementations in 
     118 * Get a read-only list of accounts in the store 
     119 * 
     120 * Implementors: when implementing a platform-specific library, you must  
     121 * implement this method. 
     122 *  
     123 * It is allowed to cache the list (but not required). If you are implementing 
     124 * an account store for account implementations from libtinymail-camel, you must 
     125 * register the created accounts with a #TnySessionCamel instance using the  
     126 * libtinymail-camel specific tny_session_camel_set_current_accounts API. 
     127 * 
     128 * The implementation must fillup @list with instances to the available accounts. 
     129 * Note that if you cache the list, you must add a reference to each account 
     130 * added to the list (they will be unreferenced and if the reference count 
     131 * would reaches zero, an account would no longer be cached). 
     132 * 
     133 * With libtinymail-camel each created account must also be informed about the 
     134 * #TnySessionCamel instance being used. Read more about this at 
     135 * tny_account_set_session of the libtinymail-camel specific #TnyAccount. 
     136 * 
     137 * There are multiple samples of #TnyAccountStoreIface implementations in 
    130138 * libtinymail-gnome-desktop, libtinymail-olpc, libtinymail-gpe,  
    131139 * libtinymail-maemo and tests/shared/account-store.c which is being used by 

  • trunk/libtinymail/tny-device-iface.c

    r723 r817  
    3737 * @self: a #TnyDeviceIface object 
    3838 *  
    39  * Reset status 
     39 * Reset status (unforce the status) 
    4040 **/ 
    4141void  

  • trunk/libtinymail/tny-folder-iface.c

    r813 r817  
    3333 * Sync changes made to a folder to its backing store, expunging deleted  
    3434 * messages (the ones marked with TNY_HEADER_FLAG_DELETED) as well. 
     35 * 
    3536 **/ 
    3637void  
    …… 
    6162 * removed message in the list until the expunge happened. You are advised to 
    6263 * hide messages that have been marked as being deleted from your summary view. 
     64 *  
    6365 * In Gtk+ for the #GtkTreeView component, you can do this using the  
    6466 * #GtkTreeModelFilter tree model filtering model. 
    …… 
    9193 * called. 
    9294 *  
    93  * Under a #GMainLoop will this method callback using g_idle_add_full. Without 
    94  * a #GMainLoop, which the framework detects using (g_main_depth > 0), the 
    95  * callbacks will happen in a worker thread at an unknown moment in time (check 
    96  * your locking). 
    97  * 
    98  * Under a #GMainLoop the callback doesn't need gdk_threads_enter and  
     95 * When using a #GMainLoop this method will callback using g_idle_add_full. 
     96 * Without a #GMainLoop, which the libtinymail-camel implementation detects 
     97 * using (g_main_depth > 0), the callbacks will happen in a worker thread at an 
     98 * unknown moment in time (check your locking). 
     99 * 
     100 * When using Gtk+, the callback doesn't need gdk_threads_enter and  
    99101 * gdk_threads_leave in Gtk+. 
    100102 * 
    …… 
    118120 * @self: a TnyFolderIface object 
    119121 * 
    120  * Refresh the folder. This gets the summary information from the IMAP service 
    121  * to the ondisk cache and updates it if there was cache already. 
     122 * Refresh the folder. This gets the summary information from the E-Mail service 
     123 * and writes it to the the on-disk cache or updates it. 
    122124 * 
    123125 * After this method, tny_folder_iface_get_all_count and  
    …… 
    125127 * 
    126128 * Also read about tny_folder_iface_get_headers. 
     129 * 
    127130 **/ 
    128131void 
    …… 
    189192 *  
    190193 * Return value: amount of unread messages 
     194 * 
    191195 **/ 
    192196guint 
    …… 
    209213 *  
    210214 * Return value: amount of messages 
     215 * 
    211216 **/ 
    212217guint 
    …… 
    228233 *  
    229234 * Return value: the account of this folder 
    230  **/ 
    231 TnyAccountIface*   
     235 * 
     236 **/ 
     237TnyStoreAccountIface*   
    232238tny_folder_iface_get_account (TnyFolderIface *self) 
    233239{ 
    …… 
    250256 *  
    251257 * Return value: The message instance or NULL on failure 
     258 * 
    252259 **/ 
    253260TnyMsgIface* 
    …… 
    271278 * Get a list of message header instances that are in this folder. Also read 
    272279 * about tny_folder_iface_refresh. 
     280 * 
    273281 **/ 
    274282void 
    …… 
    296304 *  
    297305 * Return value: A unique id 
     306 * 
    298307 **/ 
    299308const gchar* 
    …… 
    316325 *  
    317326 * Return value: The folder name 
     327 * 
    318328 **/ 
    319329const gchar* 
    …… 
    336346 * Rename a folder. Most services require the name to be unique in the  
    337347 * parent folder. 
     348 * 
    338349 **/ 
    339350void 
    …… 
    358369 *  
    359370 * Return value: The folder type as  a #TnyFolderType enum 
     371 * 
    360372 **/ 
    361373TnyFolderType  

  • trunk/libtinymail/tny-folder-iface.h

    r813 r817  
    7979        const gchar* (*get_name_func) (TnyFolderIface *self); 
    8080        const gchar* (*get_id_func) (TnyFolderIface *self); 
    81         TnyAccountIface* (*get_account_func) (TnyFolderIface *self); 
     81        TnyStoreAccountIface* (*get_account_func) (TnyFolderIface *self); 
    8282        void (*set_name_func) (TnyFolderIface *self, const gchar *name); 
    8383        TnyFolderType (*get_folder_type_func) (TnyFolderIface *self); 
    …… 
    9797TnyMsgIface* tny_folder_iface_get_message (TnyFolderIface *self, TnyHeaderIface *header); 
    9898void tny_folder_iface_get_headers (TnyFolderIface *self, TnyListIface *headers, gboolean refresh); 
    99 TnyAccountIface* tny_folder_iface_get_account (TnyFolderIface *self); 
     99TnyStoreAccountIface* tny_folder_iface_get_account (TnyFolderIface *self); 
    100100const gchar* tny_folder_iface_get_id (TnyFolderIface *self); 
    101101const gchar* tny_folder_iface_get_name (TnyFolderIface *self); 

  • trunk/libtinymail/tny-folder-store-iface.c

    r812 r817  
    2828 * @folder: The folder to remove 
    2929 * 
    30  * Removes folder from self 
     30 * Removes a folder represented by @folder from the folder store @self 
    3131 *  
    3232 **/ 
    …… 
    4848 * @name: The folder name to create 
    4949 * 
    50  * Creates a new folder in self 
     50 * Creates a new folder in folder store @self 
    5151 *  
    5252 * Return value: A new folder instance representing the folder that was created 
     53 * 
    5354 **/ 
    5455TnyFolderIface * 
    …… 
    6768 * @self: a #TnyFolderStoreIface object 
    6869 * @list: A #TnyListIface to fillup 
    69  * @query: A #TnyFolderStoreQuery object 
     70 * @query: A #TnyFolderStoreQuery object or NULL 
    7071 * 
    71  * Get a list of child folders from this folder store 
     72 * Get a list of child folders from the folder store @self. You can use @query to  
     73 * limit the list of folders with only folders that match the query. 
    7274 *  
    7375 **/ 
    …… 
    9395 * @user_data: user data for the callback 
    9496 * 
    95  * Get a list of child folders from this folder store and call back when  
     97 * Get a list of child folders from the folder store @self and call back when  
    9698 * finished.  
    9799 * 
    …… 
    100102 * called. 
    101103 *  
    102  * Under a #GMainLoop will this method callback using g_idle_add_full. Without 
    103  * a #GMainLoop, which the framework detects using (g_main_depth > 0), the 
    104  * callbacks will happen in a worker thread at an unknown moment in time (check 
    105  * your locking). 
     104 * When using a #GMainLoop, this method will callback using g_idle_add_full. 
     105 * Without a #GMainLoop, which the libtinymail-camel implementations detect 
     106 * using (g_main_depth > 0), the callbacks will happen in a worker thread at an  
     107 * unknown moment in time (check your locking). 
    106108 * 
    107  * Under a #GMainLoop the callback doesn't need gdk_threads_enter and  
     109 * When using Gtk+ the callback doesn't need gdk_threads_enter and  
    108110 * gdk_threads_leave in Gtk+. 
    109111 * 

  • trunk/libtinymail/tny-folder-store-query.c

    r802 r817  
    2929static GObjectClass *item_parent_class; 
    3030 
     31/** 
     32 * tny_folder_store_query_new: 
     33 * 
     34 * Return value: a new #TnyFolderStoreQuery instance 
     35 * 
     36 **/ 
    3137TnyFolderStoreQuery*  
    3238tny_folder_store_query_new (void) 
    …… 
    173179} 
    174180 
     181/** 
     182 * tny_folder_store_query_add_item: 
     183 * @query: a #TnyFolderStoreQuery object 
     184 * @pattern: a regular expression 
     185 * @options: a #TnyFolderStoreQueryOption enum 
     186 * 
     187 * Add a "AND" query-item to the query. 
     188 *  
     189 * If the options contain TNY_FOLDER_STORE_QUERY_OPTION_MATCH_ON_NAME or  
     190 * TNY_FOLDER_STORE_QUERY_OPTION_MATCH_ON_ID then pattern will be used as 
     191 * regular expression for matching the property of the folders. 
     192 * 
     193 * The tny_folder_iface_get_name and tny_folder_iface_get_id properties will 
     194 * then be used. 
     195 *  
     196 * For the options TNY_FOLDER_STORE_QUERY_OPTION_SUBSCRIBED and  
     197 * TNY_FOLDER_STORE_QUERY_OPTION_UNSUBSCRIBED, the folder subscription status 
     198 * is used. 
     199 * 
     200 **/ 
    175201void  
    176202tny_folder_store_query_add_item (TnyFolderStoreQuery *query, const gchar *pattern, TnyFolderStoreQueryOption options) 
    …… 
    209235} 
    210236 
     237/** 
     238 * tny_folder_store_query_get_items: 
     239 * @query: a #TnyFolderStoreQuery object 
     240 * 
     241 * Get a list of AND query items  
     242 * 
     243 * Return value: a list of AND query items 
     244 **/ 
    211245TnyListIface* 
    212246tny_folder_store_query_get_items (TnyFolderStoreQuery *query) 
    …… 
    216250 
    217251 
     252/** 
     253 * tny_folder_store_query_item_get_options: 
     254 * @item: a #TnyFolderStoreQueryItem object 
     255 * 
     256 * Get the options of the AND query item @item 
     257 * 
     258 * Return value: the options of a AND query item 
     259 * 
     260 **/ 
    218261TnyFolderStoreQueryOption  
    219262tny_folder_store_query_item_get_options (TnyFolderStoreQueryItem *item) 
    …… 
    223266 
    224267 
     268/** 
     269 * tny_folder_store_query_item_get_regex: 
     270 * @item: a #TnyFolderStoreQueryItem object 
     271 * 
     272 * Get the compiled regular expression of the AND query item @item 
     273 * 
     274 * Return value: the compiled regular expression of a AND query item 
     275 * 
     276 **/ 
    225277regex_t* 
    226278tny_folder_store_query_item_get_regex (TnyFolderStoreQueryItem *item) 

  • trunk/libtinymail/tny-header-iface.c

    r760 r817  
    6767 * @bcc: the bcc header in a comma separated list 
    6868 *  
    69  * Set the bcc header. Also look at the to header for more information 
     69 * Set the bcc header. Look at the to header for more information 
    7070 * about formatting. 
    7171 *  
    …… 
    8888 * @cc: the cc header in a comma separated list 
    8989 *  
    90  * Set the cc header. Also look at the to header for more information 
     90 * Set the cc header. Look at the to header for more information 
    9191 * about formatting. 
    9292 *  

  • trunk/libtinymail/tny-list-iface.c

    r760 r817  
    117117 * An iterator is a position indicator for a list. It keeps the position 
    118118 * state of a list iteration. The list itself does not keep any position  
    119  * information. This makes it possible to create multiple iterations consuming 
    120  * multiple iterator instances simultanously. 
     119 * information. This makes it possible to have multiple list-iterations by 
     120 * consuming multiple iterator instances simultanously. 
    121121 * 
    122122 * The reason why the method isn't called get_iterator is because it's a 

  • trunk/libtinymail/tny-msg-iface.c

    r803 r817  
    3030 * unreferenced after use. 
    3131 * 
    32  * Return value: The parent folder of this message 
     32 * Return value: The parent folder of this message or NULL if none 
    3333 **/ 
    3434TnyFolderIface*  
    …… 
    9494 * 
    9595 * Return value: The id of the added mime-part 
     96 * 
    9697 **/ 
    9798gint 

  • trunk/libtinymailui/tny-account-store-view-iface.c

    r520 r817  
    2828 * @account_store: A #TnyAccountStoreIface instace 
    2929 * 
    30  * Set the account store 
     30 * Set the account store of the view 
    3131 *  
    3232 **/ 

  • trunk/libtinymailui/tny-account-store-view-iface.h

    r387 r817  
    4545}; 
    4646 
    47 GType tny_account_store_view_iface_get_type         (void); 
     47GType tny_account_store_view_iface_get_type (void); 
    4848 
    4949void tny_account_store_view_iface_set_account_store (TnyAccountStoreViewIface *self, TnyAccountStoreIface *account_store); 

  • trunk/libtinymailui/tny-header-view-iface.c

    r805 r817  
    2222#include <tny-header-view-iface.h> 
    2323 
     24 
     25/** 
     26 * tny_header_view_iface_clear: 
     27 * @self: A #TnyHeaderViewIface instance 
     28 * 
     29 * Clear the view @self (show nothing) 
     30 * 
     31 * Implementors:  this method should clear @self (display nothing) 
     32 *  
     33 **/ 
    2434void 
    2535tny_header_view_iface_clear (TnyHeaderViewIface *self) 
    …… 
    4050 * @header: A #TnyHeaderIface instace 
    4151 * 
    42  * Set header to view 
     52 * Set header of the view @self (show nothing) 
    4353 *  
     54 * Implementors: this method should cause the view @self to show the header 
     55 * @header to the user. Often this means showing the from, to, subject, date 
     56 * and cc labels. 
     57 * 
     58 * #TnyHeaderViewIface is often used in a composition with the #TnyMsgViewIface 
     59 * type (the #TnyMsgViewIface implementation contains a #TnyHeaderViewIface). 
     60 * 
    4461 **/ 
    4562void 

  • trunk/libtinymailui/tny-msg-view-iface.c

    r805 r817  
    2727 * @self: A #TnyMsgViewIface instance 
    2828 * 
    29  * Clear the view (show nothing) 
     29 * Clear the view @self (show nothing) 
    3030 *  
     31 * Implementors: this method should clear @self (display nothing) 
     32 * 
    3133 **/ 
    3234void 
    …… 
    4749 * @self: A #TnyMsgViewIface instance 
    4850 * 
    49  * Set the view to display the fact that the message was unavailable 
     51 * Set the view @self to display that the message was unavailable 
    5052 *  
     53 * Implementors: this method should set @self to display a message like 
     54 * "Message unavailable" or any other indication that a specific message 
     55 * isn't available. 
     56 * 
    5157 **/ 
    5258void 
    …… 
    7076 * Set the strategy used for saving mime-parts 
    7177 *  
     78 * Implementors: This method should set the strategy for saving a mime-part. 
     79 * The user interface of the view can for example have a popup menu in its 
     80 * attachment viewer that will have to use this strategy for saving the 
     81 * mime-part. 
     82 * 
     83 * The idea is that devices can have a specific such strategy. For example a 
     84 * strategy that sends it to another computer or a strategy that saves it to 
     85 * a flash disk. However. In the message view component, you don't care about 
     86 * that. You only care about the API of the save-strategy interface. 
     87 * 
    7288 **/ 
    7389void 
    …… 
    91107 * @msg: A #TnyMsgIface instace 
    92108 * 
    93  * Set message to view 
     109 * Set message of the view @self 
    94110 *  
     111 * Implementors: this method should cause the view @self to show the message 
     112 * @msg to the user. This includes showing the header (for which you can 
     113 * make a composition with a #TnyHeaderViewIface), the message body and the 
     114 * attachments. 
     115 * 
     116 * You can get a list of mime-parts using the tny_msg_iface_get_parts API of 
     117 * the #TnyMsgIface type. If the mime-part has as content type a type that your 
     118 * viewer supports and recognises as an E-mail body (you can check the content 
     119 * type if a mime-part using tny_mime_part_iface_content_type_is), the view 
     120 * should show it. 
     121 * 
     122 * It's advised to use the #TnyStreamIface API for streaming the decoded content 
     123 * of the mime-part to the model of your view that will display the body. 
     124 * Examples are #TnyMsgView in libtinymailui-gtk and #TnyMozEmbedMsgView in 
     125 * libtinymailui-mozembed. If you don't decode the content of the mime-part, 
     126 * for example using tny_mime_part_iface_decode_to_stream, the content might be 
     127 * encoded in a format suitable for data transfer over for example SMTP. 
     128 * 
    95129 **/ 
    96130void 

  • trunk/libtinymailui/tny-msg-view-iface.h

    r805 r817  
    4444        GTypeInterface parent; 
    4545 
    46         void (*set_msg_func)           (TnyMsgViewIface *self, TnyMsgIface *msg); 
     46        void (*set_msg_func) (TnyMsgViewIface *self, TnyMsgIface *msg); 
    4747        void (*set_save_strategy_func) (TnyMsgViewIface *self, TnySaveStrategyIface *strategy); 
    48         void (*set_unavailable_func)   (TnyMsgViewIface *self); 
    49         void (*clear_func)             (TnyMsgViewIface *self); 
     48        void (*set_unavailable_func) (TnyMsgViewIface *self); 
     49        void (*clear_func) (TnyMsgViewIface *self); 
    5050     
    5151}; 
    5252 
    53 GType tny_msg_view_iface_get_type          (void); 
     53GType tny_msg_view_iface_get_type (void); 
    5454 
    55 void  tny_msg_view_iface_set_msg           (TnyMsgViewIface *self, TnyMsgIface *msg); 
     55void  tny_msg_view_iface_set_msg (TnyMsgViewIface *self, TnyMsgIface *msg); 
    5656void  tny_msg_view_iface_set_save_strategy (TnyMsgViewIface *self, TnySaveStrategyIface *strategy); 
    57 void  tny_msg_view_iface_set_unavailable   (TnyMsgViewIface *self); 
    58 void  tny_msg_view_iface_clear             (TnyMsgViewIface *self); 
     57void  tny_msg_view_iface_set_unavailable (TnyMsgViewIface *self); 
     58void  tny_msg_view_iface_clear (TnyMsgViewIface *self); 
    5959 
    6060 

  • trunk/libtinymailui/tny-msg-window-iface.h

    r286 r817  
    4444}; 
    4545 
    46 GType         tny_msg_window_iface_get_type        (void); 
     46GType tny_msg_window_iface_get_type (void); 
    4747 
    4848 

  • trunk/libtinymailui/tny-platform-factory-iface.c

    r762 r817  
    2929 * @self: a TnyPlatformFactoryIface object 
    3030 * 
    31  * When implementing a platform-specific library, you need to implement this 
    32  * method. You must simply return a new #TnyAccountStoreIface instance. 
     31 * Implementors: when implementing a platform-specific library, return a  
     32 * new #TnyAccountStoreIface instance. 
    3333 * 
    3434 * Return value: a #TnyAccountStoreIface instance 
    …… 
    5050 * @self: a TnyPlatformFactoryIface object 
    5151 * 
    52  * When implementing a platform-specific library, you need to implement this 
    53  * method. You must simply return a new #TnyDeviceIface instance. 
     52 * Implementors: when implementing a platform-specific library, return a  
     53 * new #TnyDeviceIface instance. 
    5454 * 
    5555 * Return value: a #TnyDeviceIface instance 
    …… 
    7171 * @self: a TnyPlatformFactoryIface object 
    7272 * 
    73  * When implementing a platform-specific library, you need to implement this 
    74  * method. You must simply return a new #TnyMsgViewIface instance. 
     73 * Implementors: when implementing a platform-specific library, return a  
     74 * new #TnyMsgViewIface instance. 
    7575 * 
    7676 * Return value: a #TnyMsgViewIface instance 

  • trunk/libtinymailui/tny-platform-factory-iface.h

    r687 r817  
    4444        GTypeInterface parent; 
    4545 
    46         TnyAccountStoreIface* (*new_account_store_func) (TnyPlatformFactoryIface *self); 
    47         TnyDeviceIface*        (*new_device_func)        (TnyPlatformFactoryIface *self); 
    48         TnyMsgViewIface*       (*new_msg_view_func)      (TnyPlatformFactoryIface *self); 
     46        TnyAccountStoreIface* (*new_account_store_func) (TnyPlatformFactoryIface *self); 
     47        TnyDeviceIface* (*new_device_func) (TnyPlatformFactoryIface *self); 
     48        TnyMsgViewIface* (*new_msg_view_func) (TnyPlatformFactoryIface *self); 
    4949}; 
    5050 
    5151GType tny_platform_factory_iface_get_type (void); 
    5252 
    53 TnyAccountStoreIface* tny_platform_factory_iface_new_account_store (TnyPlatformFactoryIface *self); 
    54 TnyDeviceIface*        tny_platform_factory_iface_new_device        (TnyPlatformFactoryIface *self); 
    55 TnyMsgViewIface*       tny_platform_factory_iface_new_msg_view      (TnyPlatformFactoryIface *self); 
     53TnyAccountStoreIface* tny_platform_factory_iface_new_account_store (TnyPlatformFactoryIface *self); 
     54TnyDeviceIface* tny_platform_factory_iface_new_device (TnyPlatformFactoryIface *self); 
     55TnyMsgViewIface* tny_platform_factory_iface_new_msg_view (TnyPlatformFactoryIface *self); 
    5656 
    5757G_END_DECLS 

  • trunk/libtinymailui/tny-save-strategy-iface.c

    r762 r817  
    2828 * 
    2929 * Performs the saving of a mime part 
     30 * 
     31 * Implementors: the idea is that devices can have a specific such strategy. 
     32 * For example a strategy that sends it to another computer or a strategy that 
     33 * saves it to a flash disk.  
     34 * 
     35 * The method is typically called by the implementation of a #TnyMsgViewIface. 
     36 * For example a clicked handler of a popup menu of a attachment view in the 
     37 * #TnyMsgViewIface implementation. 
    3038 *  
    3139 **/ 

  • trunk/libtinymailui/tny-save-strategy-iface.h

    r710 r817  
    4545 
    4646GType tny_save_strategy_iface_get_type (void); 
    47 void tny_save_strategy_iface_save    (TnySaveStrategyIface *self, TnyMimePartIface *part); 
     47void tny_save_strategy_iface_save (TnySaveStrategyIface *self, TnyMimePartIface *part); 
    4848 
    4949G_END_DECLS