Changeset 903
- Timestamp:
- 09/07/06 23:06:28
- Files:
-
- trunk/docs/devel/reference/Makefile.am (modified) (1 diff)
- trunk/docs/devel/reference/tmpl/libtinymail-unused.sgml (modified) (14 diffs)
- trunk/docs/devel/reference/tmpl/tny-shared.sgml (modified) (13 diffs)
- trunk/libtinymail/tny-account-store.h (modified) (1 diff)
- trunk/libtinymail/tny-account.h (modified) (1 diff)
- trunk/libtinymail/tny-device.h (modified) (1 diff)
- trunk/libtinymail/tny-folder-store-query.h (modified) (1 diff)
- trunk/libtinymail/tny-folder-store.h (modified) (1 diff)
- trunk/libtinymail/tny-folder.h (modified) (1 diff)
- trunk/libtinymail/tny-fs-stream.h (modified) (1 diff)
- trunk/libtinymail/tny-header.h (modified) (1 diff)
- trunk/libtinymail/tny-iterator.h (modified) (1 diff)
- trunk/libtinymail/tny-list.h (modified) (1 diff)
- trunk/libtinymail/tny-mime-part.h (modified) (1 diff)
- trunk/libtinymail/tny-msg.h (modified) (1 diff)
- trunk/libtinymail/tny-shared.h (modified) (2 diffs)
- trunk/libtinymail/tny-store-account.h (modified) (1 diff)
- trunk/libtinymail/tny-stream.h (modified) (1 diff)
- trunk/libtinymail/tny-transport-account.h (modified) (1 diff)
- trunk/libtinymailui/tny-account-store-view.h (modified) (1 diff)
Legend:
- Unmodified
- Added
- Removed
- Modified
- Copied
- Moved
trunk/docs/devel/reference/Makefile.am
r535 r903 48 48 # Header files to ignore when scanning. 49 49 # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h 50 IGNORE_HFILES=tny- account-priv.h tny-attach-list-model-priv.h tny-msg-folder-priv.h tny-msg-priv.h50 IGNORE_HFILES=tny-shared.h *-priv.h 51 51 52 52 # Images to copy into HTML directory. trunk/docs/devel/reference/tmpl/libtinymail-unused.sgml
r902 r903 317 317 @self: 318 318 319 <!-- ##### MACRO G_LIKELY ##### --> 320 <para> 321 Implemented by GLib or a noop 322 </para> 323 324 @expr: the expression 325 326 <!-- ##### MACRO G_UNLIKELY ##### --> 327 <para> 328 Implemented by GLib or a noop 329 </para> 330 331 @expr: the expression 332 319 333 <!-- ##### USER_FUNCTION GetPassFunc ##### --> 320 334 <para> … … 441 455 442 456 <!-- ##### MACRO TNY_TYPE_STORE_ACCOUNT_FOLDER_TYPE ##### --> 457 <para> 458 459 </para> 460 461 462 <!-- ##### STRUCT TnyAccount ##### --> 443 463 <para> 444 464 … … 548 568 @current: 549 569 570 <!-- ##### STRUCT TnyDevice ##### --> 571 <para> 572 573 </para> 574 575 550 576 <!-- ##### SIGNAL TnyDevice::connection-changed ##### --> 551 577 <para> … … 575 601 @forced: 576 602 @fset: 603 604 <!-- ##### STRUCT TnyFolder ##### --> 605 <para> 606 607 </para> 608 609 610 <!-- ##### SIGNAL TnyFolder::folder-inserted ##### --> 611 <para> 612 613 </para> 614 615 @tnyfolderiface: the object which received the signal. 616 @arg1: 617 618 <!-- ##### SIGNAL TnyFolder::folders-reloaded ##### --> 619 <para> 620 621 </para> 622 623 @tnyfolderiface: the object which received the signal. 577 624 578 625 <!-- ##### STRUCT TnyFolderClass ##### --> … … 649 696 @real: 650 697 698 <!-- ##### STRUCT TnyFolderStore ##### --> 699 <para> 700 701 </para> 702 703 651 704 <!-- ##### STRUCT TnyFolderStoreClass ##### --> 652 705 <para> … … 660 713 @get_folders_async_func: 661 714 715 <!-- ##### USER_FUNCTION TnyForgetPassFunc ##### --> 716 <para> 717 This function is used to tell the application that the authentication information it provided via #TnyGetPassFunc was rejected by the service. 718 </para> 719 <para> 720 It can typically be used to tell a key service, like GNOME key ring, to forget the authentication information. This way will a new request for the password typically result in asking to user to type new authentication information. 721 </para> 722 723 @self: The #TnyAccount instance of which the password was not accepted 724 725 <!-- ##### USER_FUNCTION TnyGetFoldersCallback ##### --> 726 <para> 727 728 </para> 729 730 @self: 731 @list: 732 @user_data: 733 662 734 <!-- ##### USER_FUNCTION TnyGetFoldersStatusCallback ##### --> 663 735 <para> … … 687 759 @status: A status field 688 760 @user_data: user data 761 762 <!-- ##### USER_FUNCTION TnyGetPassFunc ##### --> 763 <para> 764 A type used for callback functions that implement asking and the user for a password or other authentication data of an account. 765 </para> 766 <para> 767 It's typically implemented to use a key service, like GNOME key ring. This of course depends on the platform. The function 768 is typically implemented in the #TnyAccountStore implementation and shared between all accounts in the store. 769 </para> 770 771 @self: The #TnyAccount instance for which the password is going to be used 772 @prompt: Prompt to provide to the user 773 @cancel: A byref gboolean variable. If the user cancelled the request, set this to TRUE 774 @Returns: A newly allocated string with the authentication information (the password) 775 776 <!-- ##### STRUCT TnyHeader ##### --> 777 <para> 778 779 </para> 780 689 781 690 782 <!-- ##### STRUCT TnyHeaderClass ##### --> … … 736 828 737 829 830 <!-- ##### STRUCT TnyIterator ##### --> 831 <para> 832 833 </para> 834 835 738 836 <!-- ##### STRUCT TnyIteratorClass ##### --> 739 837 <para> … … 750 848 @get_list_func: 751 849 850 <!-- ##### STRUCT TnyList ##### --> 851 <para> 852 853 </para> 854 855 752 856 <!-- ##### STRUCT TnyListClass ##### --> 753 857 <para> … … 780 884 @iterator_lock: 781 885 @first: 886 887 <!-- ##### STRUCT TnyMimePart ##### --> 888 <para> 889 890 </para> 891 782 892 783 893 <!-- ##### STRUCT TnyMimePartClass ##### --> … … 812 922 @part: 813 923 @cached_content_type: 924 925 <!-- ##### STRUCT TnyMsg ##### --> 926 <para> 927 928 </para> 929 814 930 815 931 <!-- ##### STRUCT TnyMsgClass ##### --> … … 942 1058 943 1059 1060 <!-- ##### USER_FUNCTION TnyRefreshFolderCallback ##### --> 1061 <para> 1062 A callback function for tny_msg_folder_refresh_async that callsback when the headers are refreshed. The function is typically used for putting a tny_msg_folder_get_headers in. It can for example be used for updating a header summary view. 1063 </para> 1064 1065 @self: The #TnyFolder 1066 @cancelled: Whether or not a cancellation occured. 1067 @user_data: user data 1068 1069 <!-- ##### USER_FUNCTION TnyRefreshFolderStatusCallback ##### --> 1070 <para> 1071 A callback function for tny_msg_folder_refresh_async that callsback when new information about refreshing headers is available. The function is typically used for updating a progress bar or writing to a status bar. 1072 </para> 1073 1074 @self: The #TnyFolder 1075 @what: What happened 1076 @status: A status field 1077 @user_data: user data 1078 1079 <!-- ##### STRUCT TnyStoreAccount ##### --> 1080 <para> 1081 1082 </para> 1083 1084 944 1085 <!-- ##### STRUCT TnyStoreAccountClass ##### --> 945 1086 <para> … … 959 1100 @iter: 960 1101 @managed_folders: 1102 1103 <!-- ##### STRUCT TnyStream ##### --> 1104 <para> 1105 1106 </para> 1107 961 1108 962 1109 <!-- ##### STRUCT TnyStreamClass ##### --> … … 981 1128 @parent: 982 1129 1130 <!-- ##### STRUCT TnyTransportAccount ##### --> 1131 <para> 1132 1133 </para> 1134 1135 983 1136 <!-- ##### STRUCT TnyTransportAccountClass ##### --> 984 1137 <para> trunk/docs/devel/reference/tmpl/tny-shared.sgml
r902 r903 16 16 17 17 <!-- ##### SECTION Stability_Level ##### --> 18 19 20 <!-- ##### STRUCT TnyList ##### -->21 <para>22 23 </para>24 25 26 <!-- ##### STRUCT TnyIterator ##### -->27 <para>28 29 </para>30 18 31 19 … … 58 46 @get_list_func: 59 47 60 <!-- ##### STRUCT TnyMsg ##### -->61 <para>62 63 </para>64 65 66 48 <!-- ##### STRUCT TnyMsgIface ##### --> 67 49 <para> … … 76 58 @del_part_func: 77 59 @add_part_func: 78 79 <!-- ##### STRUCT TnyFolder ##### -->80 <para>81 82 </para>83 84 85 <!-- ##### SIGNAL TnyFolder::folder-inserted ##### -->86 <para>87 88 </para>89 90 @tnyfolderiface: the object which received the signal.91 @arg1:92 93 <!-- ##### SIGNAL TnyFolder::folders-reloaded ##### -->94 <para>95 96 </para>97 98 @tnyfolderiface: the object which received the signal.99 60 100 61 <!-- ##### STRUCT TnyFolderIface ##### --> … … 121 82 @refresh_async_func: 122 83 @refresh_func: 123 124 <!-- ##### STRUCT TnyHeader ##### -->125 <para>126 127 </para>128 129 84 130 85 <!-- ##### STRUCT TnyHeaderIface ##### --> … … 155 110 @unset_flags_func: 156 111 157 <!-- ##### STRUCT TnyMimePart ##### -->158 <para>159 160 </para>161 162 163 112 <!-- ##### STRUCT TnyMimePartIface ##### --> 164 113 <para> … … 183 132 @set_content_type_func: 184 133 @is_attachment_func: 185 186 <!-- ##### STRUCT TnyAccount ##### -->187 <para>188 189 </para>190 191 134 192 135 <!-- ##### STRUCT TnyAccountIface ##### --> … … 215 158 @get_account_type_func: 216 159 217 <!-- ##### STRUCT TnyDevice ##### -->218 <para>219 220 </para>221 222 223 160 <!-- ##### STRUCT TnyDeviceIface ##### --> 224 161 <para> … … 233 170 @connection_changed: 234 171 235 <!-- ##### STRUCT TnyStoreAccount ##### -->236 <para>237 238 </para>239 240 241 172 <!-- ##### STRUCT TnyStoreAccountIface ##### --> 242 173 <para> … … 248 179 @unsubscribe_func: 249 180 250 <!-- ##### STRUCT TnyTransportAccount ##### -->251 <para>252 253 </para>254 255 256 181 <!-- ##### STRUCT TnyTransportAccountIface ##### --> 257 182 <para> … … 263 188 264 189 <!-- ##### STRUCT TnyAccountStore ##### --> 265 <para>266 267 </para>268 269 270 <!-- ##### STRUCT TnyStream ##### -->271 190 <para> 272 191 … … 305 224 @alert_func: 306 225 307 <!-- ##### USER_FUNCTION TnyGetPassFunc ##### -->308 <para>309 A type used for callback functions that implement asking and the user for a password or other authentication data of an account.310 </para>311 <para>312 It's typically implemented to use a key service, like GNOME key ring. This of course depends on the platform. The function313 is typically implemented in the #TnyAccountStore implementation and shared between all accounts in the store.314 </para>315 316 @self: The #TnyAccount instance for which the password is going to be used317 @prompt: Prompt to provide to the user318 @cancel: A byref gboolean variable. If the user cancelled the request, set this to TRUE319 @Returns: A newly allocated string with the authentication information (the password)320 321 322 <!-- ##### USER_FUNCTION TnyForgetPassFunc ##### -->323 <para>324 This function is used to tell the application that the authentication information it provided via #TnyGetPassFunc was rejected by the service.325 </para>326 <para>327 It can typically be used to tell a key service, like GNOME key ring, to forget the authentication information. This way will a new request for the password typically result in asking to user to type new authentication information.328 </para>329 330 @self: The #TnyAccount instance of which the password was not accepted331 332 333 <!-- ##### USER_FUNCTION TnyRefreshFolderCallback ##### -->334 <para>335 A callback function for tny_msg_folder_refresh_async that callsback when the headers are refreshed. The function is typically used for putting a tny_msg_folder_get_headers in. It can for example be used for updating a header summary view.336 </para>337 338 @self: The #TnyFolder339 @cancelled: Whether or not a cancellation occured.340 @user_data: user data341 342 343 <!-- ##### USER_FUNCTION TnyRefreshFolderStatusCallback ##### -->344 <para>345 A callback function for tny_msg_folder_refresh_async that callsback when new information about refreshing headers is available. The function is typically used for updating a progress bar or writing to a status bar.346 </para>347 348 @self: The #TnyFolder349 @what: What happened350 @status: A status field351 @user_data: user data352 353 354 226 <!-- ##### STRUCT TnySimpleList ##### --> 355 227 <para> … … 377 249 378 250 @parent: 379 380 <!-- ##### STRUCT TnyFolderStore ##### -->381 <para>382 383 </para>384 385 251 386 252 <!-- ##### STRUCT TnyFolderStoreIface ##### --> … … 421 287 @parent: 422 288 423 <!-- ##### USER_FUNCTION TnyGetFoldersCallback ##### -->424 <para>425 426 </para>427 428 @self:429 @list:430 @user_data:431 432 433 <!-- ##### MACRO G_LIKELY ##### -->434 <para>435 Implemented by GLib or a noop436 </para>437 438 @expr: the expression439 440 441 <!-- ##### MACRO G_UNLIKELY ##### -->442 <para>443 Implemented by GLib or a noop444 </para>445 446 @expr: the expression447 448 trunk/libtinymail/tny-account-store.h
r900 r903 63 63 #endif 64 64 65 struct _TnyAccountStoreIface 66 { 65 #ifndef TNY_SHARED_H 66 typedef struct _TnyAccountStore TnyAccountStore; 67 typedef struct _TnyAccountStoreIface TnyAccountStoreIface; 68 #endif 69 70 struct _TnyAccountStoreIface { 67 71 GTypeInterface parent; 68 72 trunk/libtinymail/tny-account.h
r900 r903 33 33 34 34 #define TNY_TYPE_ACCOUNT_TYPE (tny_account_type_get_type()) 35 36 #ifndef TNY_SHARED_H 37 typedef enum _TnyAccountType TnyAccountType; 38 typedef struct _TnyAccount TnyAccount; 39 typedef struct _TnyAccountIface TnyAccountIface; 40 #endif 35 41 36 42 enum _TnyAccountType trunk/libtinymail/tny-device.h
r900 r903 42 42 }; 43 43 44 #ifndef TNY_SHARED_H 45 typedef struct _TnyDevice TnyDevice; 46 typedef struct _TnyDeviceIface TnyDeviceIface; 47 #endif 48 44 49 struct _TnyDeviceIface 45 50 { trunk/libtinymail/tny-folder-store-query.h
r900 r903 53 53 }; 54 54 55 #ifndef TNY_SHARED_H 56 typedef struct _TnyFolderStoreQuery TnyFolderStoreQuery; 57 typedef struct _TnyFolderStoreQueryClass TnyFolderStoreQueryClass; 58 typedef enum _TnyFolderStoreQueryOption TnyFolderStoreQueryOption; 59 typedef struct _TnyFolderStoreQueryItem TnyFolderStoreQueryItem; 60 typedef struct _TnyFolderStoreQueryItemClass TnyFolderStoreQueryItemClass; 61 #endif 62 55 63 struct _TnyFolderStoreQueryItem 56 64 { trunk/libtinymail/tny-folder-store.h
r900 r903 37 37 #define TNY_FOLDER_STORE_GET_IFACE(inst) (G_TYPE_INSTANCE_GET_INTERFACE ((inst), TNY_TYPE_FOLDER_STORE, TnyFolderStoreIface)) 38 38 39 #ifndef TNY_SHARED_H 40 typedef struct _TnyFolderStore TnyFolderStore; 41 typedef struct _TnyFolderStoreIface TnyFolderStoreIface; 42 #endif 39 43 40 44 struct _TnyFolderStoreIface trunk/libtinymail/tny-folder.h
r900 r903 38 38 #ifndef TNY_FOLDER_C 39 39 extern guint *tny_folder_signals; 40 #endif 41 42 #ifndef TNY_SHARED_H 43 typedef enum _TnyFolderType TnyFolderType; 44 typedef struct _TnyFolder TnyFolder; 45 typedef struct _TnyFolderIface TnyFolderIface; 40 46 #endif 41 47 trunk/libtinymail/tny-fs-stream.h
r900 r903 39 39 #define TNY_FS_STREAM_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), TNY_TYPE_FS_STREAM, TnyFsStreamClass)) 40 40 41 #ifndef TNY_SHARED_H 42 typedef struct _TnyFsStream TnyFsStream; 43 typedef struct _TnyFsStream TnyFsStreamClass; 44 #endif 45 41 46 struct _TnyFsStream 42 47 { trunk/libtinymail/tny-header.h
r900 r903 45 45 46 46 #define TNY_TYPE_HEADER_FLAGS (tny_header_flags_get_type()) 47 48 #ifndef TNY_SHARED_H 49 typedef struct _TnyHeader TnyHeader; 50 typedef struct _TnyHeaderIface TnyHeaderIface; 51 typedef enum _TnyHeaderFlags TnyHeaderFlags; 52 #endif 47 53 48 54 enum _TnyHeaderFlags trunk/libtinymail/tny-iterator.h
r900 r903 33 33 #define TNY_ITERATOR_GET_IFACE(inst) (G_TYPE_INSTANCE_GET_INTERFACE ((inst), TNY_TYPE_ITERATOR, TnyIteratorIface)) 34 34 35 #ifndef TNY_SHARED_H 36 typedef struct _TnyIterator TnyIterator; 37 typedef struct _TnyIteratorIface TnyIteratorIface; 38 #endif 39 35 40 struct _TnyIteratorIface 36 41 { trunk/libtinymail/tny-list.h
r900 r903 34 34 #define TNY_LIST_GET_IFACE(inst) (G_TYPE_INSTANCE_GET_INTERFACE ((inst), TNY_TYPE_LIST, TnyListIface)) 35 35 36 #ifndef TNY_SHARED_H 37 typedef struct _TnyList TnyList; 38 typedef struct _TnyListIface TnyListIface; 39 #endif 40 36 41 struct _TnyListIface 37 42 { trunk/libtinymail/tny-mime-part.h
r900 r903 33 33 #define TNY_IS_MIME_PART(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), TNY_TYPE_MIME_PART)) 34 34 #define TNY_MIME_PART_GET_IFACE(inst) (G_TYPE_INSTANCE_GET_INTERFACE ((inst), TNY_TYPE_MIME_PART, TnyMimePartIface)) 35 36 #ifndef TNY_SHARED_H 37 typedef struct _TnyMimePart TnyMimePart; 38 typedef struct _TnyMimePartIface TnyMimePartIface; 39 #endif 35 40 36 41 struct _TnyMimePartIface trunk/libtinymail/tny-msg.h
r900 r903 34 34 #define TNY_MSG_GET_IFACE(inst) (G_TYPE_INSTANCE_GET_INTERFACE ((inst), TNY_TYPE_MSG, TnyMsgIface)) 35 35 36 #ifndef TNY_SHARED_H 37 typedef struct _TnyMsg TnyMsg; 38 typedef struct _TnyMsgIface TnyMsgIface; 39 #endif 40 36 41 struct _TnyMsgIface 37 42 { trunk/libtinymail/tny-shared.h
r900 r903 23 23 G_BEGIN_DECLS 24 24 25 typedef struct _TnyAccountStore TnyAccountStore; 26 typedef struct _TnyAccountStoreIface TnyAccountStoreIface; 27 25 28 typedef struct _TnyList TnyList; 26 29 typedef struct _TnyIterator TnyIterator; … … 43 46 typedef struct _TnyTransportAccount TnyTransportAccount; 44 47 typedef struct _TnyTransportAccountIface TnyTransportAccountIface; 45 typedef struct _TnyAccountStore TnyAccountStore;46 48 typedef struct _TnyStream TnyStream; 47 49 typedef struct _TnyStreamIface TnyStreamIface; 48 typedef struct _TnyAccountStoreIface TnyAccountStoreIface;49 50 typedef gchar* (*TnyGetPassFunc) (TnyAccount *self, const gchar *prompt, gboolean *cancel); 50 51 typedef void (*TnyForgetPassFunc) (TnyAccount *self); trunk/libtinymail/tny-store-account.h
r900 r903 36 36 #define TNY_STORE_ACCOUNT_GET_IFACE(inst) (G_TYPE_INSTANCE_GET_INTERFACE ((inst), TNY_TYPE_STORE_ACCOUNT, TnyStoreAccountIface)) 37 37 38 #ifndef TNY_SHARED_H 39 typedef struct _TnyStoreAccount TnyStoreAccount; 40 typedef struct _TnyStoreAccountIface TnyStoreAccountIface; 41 #endif 38 42 39 43 struct _TnyStoreAccountIface trunk/libtinymail/tny-stream.h
r900 r903 34 34 #define TNY_STREAM_GET_IFACE(inst) (G_TYPE_INSTANCE_GET_INTERFACE ((inst), TNY_TYPE_STREAM, TnyStreamIface)) 35 35 36 #ifndef TNY_SHARED_H 37 typedef struct _TnyStream TnyStream; 38 typedef struct _TnyStreamIface TnyStreamIface; 39 #endif 40 36 41 struct _TnyStreamIface 37 42 { trunk/libtinymail/tny-transport-account.h
r900 r903 34 34 #define TNY_TRANSPORT_ACCOUNT_GET_IFACE(inst) (G_TYPE_INSTANCE_GET_INTERFACE ((inst), TNY_TYPE_TRANSPORT_ACCOUNT, TnyTransportAccountIface)) 35 35 36 #ifndef TNY_SHARED_H 37 typedef struct _TnyTransportAccount TnyTransportAccount; 38 typedef struct _TnyTransportAccountIface TnyTransportAccountIface; 39 #endif 40 36 41 struct _TnyTransportAccountIface 37 42 { trunk/libtinymailui/tny-account-store-view.h
r900 r903 24 24 #include <glib-object.h> 25 25 #include <tny-shared.h> 26 #include <tny-account-store.h> 26 27 27 28 G_BEGIN_DECLS
