Changeset 903

Show
Ignore:
Timestamp:
09/07/06 23:06:28
Author:
pvanhoof
Message:

Forward typedefs

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • trunk/docs/devel/reference/Makefile.am

    r535 r903  
    4848# Header files to ignore when scanning. 
    4949# 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.h 
     50IGNORE_HFILES=tny-shared.h *-priv.h 
    5151 
    5252# Images to copy into HTML directory. 
  • trunk/docs/devel/reference/tmpl/libtinymail-unused.sgml

    r902 r903  
    317317@self:  
    318318 
     319<!-- ##### MACRO G_LIKELY ##### --> 
     320<para> 
     321Implemented by GLib or a noop 
     322</para> 
     323 
     324@expr: the expression 
     325 
     326<!-- ##### MACRO G_UNLIKELY ##### --> 
     327<para> 
     328Implemented by GLib or a noop 
     329</para> 
     330 
     331@expr: the expression 
     332 
    319333<!-- ##### USER_FUNCTION GetPassFunc ##### --> 
    320334<para> 
     
    441455 
    442456<!-- ##### MACRO TNY_TYPE_STORE_ACCOUNT_FOLDER_TYPE ##### --> 
     457<para> 
     458 
     459</para> 
     460 
     461 
     462<!-- ##### STRUCT TnyAccount ##### --> 
    443463<para> 
    444464 
     
    548568@current:  
    549569 
     570<!-- ##### STRUCT TnyDevice ##### --> 
     571<para> 
     572 
     573</para> 
     574 
     575 
    550576<!-- ##### SIGNAL TnyDevice::connection-changed ##### --> 
    551577<para> 
     
    575601@forced:  
    576602@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. 
    577624 
    578625<!-- ##### STRUCT TnyFolderClass ##### --> 
     
    649696@real:  
    650697 
     698<!-- ##### STRUCT TnyFolderStore ##### --> 
     699<para> 
     700 
     701</para> 
     702 
     703 
    651704<!-- ##### STRUCT TnyFolderStoreClass ##### --> 
    652705<para> 
     
    660713@get_folders_async_func:  
    661714 
     715<!-- ##### USER_FUNCTION TnyForgetPassFunc ##### --> 
     716<para> 
     717This function is used to tell the application that the authentication information it provided via #TnyGetPassFunc was rejected by the service. 
     718</para> 
     719<para> 
     720It 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 
    662734<!-- ##### USER_FUNCTION TnyGetFoldersStatusCallback ##### --> 
    663735<para> 
     
    687759@status: A status field 
    688760@user_data: user data 
     761 
     762<!-- ##### USER_FUNCTION TnyGetPassFunc ##### --> 
     763<para> 
     764A 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> 
     767It's typically implemented to use a key service, like GNOME key ring. This of course depends on the platform. The function 
     768is 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 
    689781 
    690782<!-- ##### STRUCT TnyHeaderClass ##### --> 
     
    736828 
    737829 
     830<!-- ##### STRUCT TnyIterator ##### --> 
     831<para> 
     832 
     833</para> 
     834 
     835 
    738836<!-- ##### STRUCT TnyIteratorClass ##### --> 
    739837<para> 
     
    750848@get_list_func:  
    751849 
     850<!-- ##### STRUCT TnyList ##### --> 
     851<para> 
     852 
     853</para> 
     854 
     855 
    752856<!-- ##### STRUCT TnyListClass ##### --> 
    753857<para> 
     
    780884@iterator_lock:  
    781885@first:  
     886 
     887<!-- ##### STRUCT TnyMimePart ##### --> 
     888<para> 
     889 
     890</para> 
     891 
    782892 
    783893<!-- ##### STRUCT TnyMimePartClass ##### --> 
     
    812922@part:  
    813923@cached_content_type:  
     924 
     925<!-- ##### STRUCT TnyMsg ##### --> 
     926<para> 
     927 
     928</para> 
     929 
    814930 
    815931<!-- ##### STRUCT TnyMsgClass ##### --> 
     
    9421058 
    9431059 
     1060<!-- ##### USER_FUNCTION TnyRefreshFolderCallback ##### --> 
     1061<para> 
     1062A 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> 
     1071A 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 
    9441085<!-- ##### STRUCT TnyStoreAccountClass ##### --> 
    9451086<para> 
     
    9591100@iter:  
    9601101@managed_folders:  
     1102 
     1103<!-- ##### STRUCT TnyStream ##### --> 
     1104<para> 
     1105 
     1106</para> 
     1107 
    9611108 
    9621109<!-- ##### STRUCT TnyStreamClass ##### --> 
     
    9811128@parent:  
    9821129 
     1130<!-- ##### STRUCT TnyTransportAccount ##### --> 
     1131<para> 
     1132 
     1133</para> 
     1134 
     1135 
    9831136<!-- ##### STRUCT TnyTransportAccountClass ##### --> 
    9841137<para> 
  • trunk/docs/devel/reference/tmpl/tny-shared.sgml

    r902 r903  
    1616 
    1717<!-- ##### SECTION Stability_Level ##### --> 
    18  
    19  
    20 <!-- ##### STRUCT TnyList ##### --> 
    21 <para> 
    22  
    23 </para> 
    24  
    25  
    26 <!-- ##### STRUCT TnyIterator ##### --> 
    27 <para> 
    28  
    29 </para> 
    3018 
    3119 
     
    5846@get_list_func:  
    5947 
    60 <!-- ##### STRUCT TnyMsg ##### --> 
    61 <para> 
    62  
    63 </para> 
    64  
    65  
    6648<!-- ##### STRUCT TnyMsgIface ##### --> 
    6749<para> 
     
    7658@del_part_func:  
    7759@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. 
    9960 
    10061<!-- ##### STRUCT TnyFolderIface ##### --> 
     
    12182@refresh_async_func:  
    12283@refresh_func:  
    123  
    124 <!-- ##### STRUCT TnyHeader ##### --> 
    125 <para> 
    126  
    127 </para> 
    128  
    12984 
    13085<!-- ##### STRUCT TnyHeaderIface ##### --> 
     
    155110@unset_flags_func:  
    156111 
    157 <!-- ##### STRUCT TnyMimePart ##### --> 
    158 <para> 
    159  
    160 </para> 
    161  
    162  
    163112<!-- ##### STRUCT TnyMimePartIface ##### --> 
    164113<para> 
     
    183132@set_content_type_func:  
    184133@is_attachment_func:  
    185  
    186 <!-- ##### STRUCT TnyAccount ##### --> 
    187 <para> 
    188  
    189 </para> 
    190  
    191134 
    192135<!-- ##### STRUCT TnyAccountIface ##### --> 
     
    215158@get_account_type_func:  
    216159 
    217 <!-- ##### STRUCT TnyDevice ##### --> 
    218 <para> 
    219  
    220 </para> 
    221  
    222  
    223160<!-- ##### STRUCT TnyDeviceIface ##### --> 
    224161<para> 
     
    233170@connection_changed:  
    234171 
    235 <!-- ##### STRUCT TnyStoreAccount ##### --> 
    236 <para> 
    237  
    238 </para> 
    239  
    240  
    241172<!-- ##### STRUCT TnyStoreAccountIface ##### --> 
    242173<para> 
     
    248179@unsubscribe_func:  
    249180 
    250 <!-- ##### STRUCT TnyTransportAccount ##### --> 
    251 <para> 
    252  
    253 </para> 
    254  
    255  
    256181<!-- ##### STRUCT TnyTransportAccountIface ##### --> 
    257182<para> 
     
    263188 
    264189<!-- ##### STRUCT TnyAccountStore ##### --> 
    265 <para> 
    266  
    267 </para> 
    268  
    269  
    270 <!-- ##### STRUCT TnyStream ##### --> 
    271190<para> 
    272191 
     
    305224@alert_func:  
    306225 
    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 function 
    313 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 used 
    317 @prompt: Prompt to provide to the user 
    318 @cancel: A byref gboolean variable. If the user cancelled the request, set this to TRUE 
    319 @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 accepted 
    331  
    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 #TnyFolder 
    339 @cancelled: Whether or not a cancellation occured. 
    340 @user_data: user data 
    341  
    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 #TnyFolder 
    349 @what: What happened 
    350 @status: A status field 
    351 @user_data: user data 
    352  
    353  
    354226<!-- ##### STRUCT TnySimpleList ##### --> 
    355227<para> 
     
    377249 
    378250@parent:  
    379  
    380 <!-- ##### STRUCT TnyFolderStore ##### --> 
    381 <para> 
    382  
    383 </para> 
    384  
    385251 
    386252<!-- ##### STRUCT TnyFolderStoreIface ##### --> 
     
    421287@parent:  
    422288 
    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 noop 
    436 </para> 
    437  
    438 @expr: the expression 
    439  
    440  
    441 <!-- ##### MACRO G_UNLIKELY ##### --> 
    442 <para> 
    443 Implemented by GLib or a noop 
    444 </para> 
    445  
    446 @expr: the expression 
    447  
    448  
  • trunk/libtinymail/tny-account-store.h

    r900 r903  
    6363#endif 
    6464 
    65 struct _TnyAccountStoreIface 
    66 
     65#ifndef TNY_SHARED_H 
     66typedef struct _TnyAccountStore TnyAccountStore; 
     67typedef struct _TnyAccountStoreIface TnyAccountStoreIface; 
     68#endif 
     69 
     70struct _TnyAccountStoreIface { 
    6771        GTypeInterface parent; 
    6872 
  • trunk/libtinymail/tny-account.h

    r900 r903  
    3333 
    3434#define TNY_TYPE_ACCOUNT_TYPE (tny_account_type_get_type()) 
     35 
     36#ifndef TNY_SHARED_H 
     37typedef enum _TnyAccountType TnyAccountType; 
     38typedef struct _TnyAccount TnyAccount; 
     39typedef struct _TnyAccountIface TnyAccountIface; 
     40#endif 
    3541 
    3642enum _TnyAccountType 
  • trunk/libtinymail/tny-device.h

    r900 r903  
    4242}; 
    4343 
     44#ifndef TNY_SHARED_H 
     45typedef struct _TnyDevice TnyDevice; 
     46typedef struct _TnyDeviceIface TnyDeviceIface; 
     47#endif 
     48 
    4449struct _TnyDeviceIface 
    4550{ 
  • trunk/libtinymail/tny-folder-store-query.h

    r900 r903  
    5353}; 
    5454 
     55#ifndef TNY_SHARED_H 
     56typedef struct _TnyFolderStoreQuery TnyFolderStoreQuery; 
     57typedef struct _TnyFolderStoreQueryClass TnyFolderStoreQueryClass; 
     58typedef enum _TnyFolderStoreQueryOption TnyFolderStoreQueryOption; 
     59typedef struct _TnyFolderStoreQueryItem TnyFolderStoreQueryItem; 
     60typedef struct _TnyFolderStoreQueryItemClass TnyFolderStoreQueryItemClass; 
     61#endif 
     62 
    5563struct _TnyFolderStoreQueryItem  
    5664{ 
  • trunk/libtinymail/tny-folder-store.h

    r900 r903  
    3737#define TNY_FOLDER_STORE_GET_IFACE(inst)  (G_TYPE_INSTANCE_GET_INTERFACE ((inst), TNY_TYPE_FOLDER_STORE, TnyFolderStoreIface)) 
    3838 
     39#ifndef TNY_SHARED_H 
     40typedef struct _TnyFolderStore TnyFolderStore; 
     41typedef struct _TnyFolderStoreIface TnyFolderStoreIface; 
     42#endif 
    3943 
    4044struct _TnyFolderStoreIface 
  • trunk/libtinymail/tny-folder.h

    r900 r903  
    3838#ifndef TNY_FOLDER_C 
    3939extern guint *tny_folder_signals; 
     40#endif 
     41 
     42#ifndef TNY_SHARED_H 
     43typedef enum _TnyFolderType TnyFolderType; 
     44typedef struct _TnyFolder TnyFolder; 
     45typedef struct _TnyFolderIface TnyFolderIface; 
    4046#endif 
    4147 
  • trunk/libtinymail/tny-fs-stream.h

    r900 r903  
    3939#define TNY_FS_STREAM_GET_CLASS(inst)  (G_TYPE_INSTANCE_GET_CLASS ((inst), TNY_TYPE_FS_STREAM, TnyFsStreamClass)) 
    4040 
     41#ifndef TNY_SHARED_H 
     42typedef struct _TnyFsStream TnyFsStream; 
     43typedef struct _TnyFsStream TnyFsStreamClass; 
     44#endif 
     45 
    4146struct _TnyFsStream 
    4247{ 
  • trunk/libtinymail/tny-header.h

    r900 r903  
    4545 
    4646#define TNY_TYPE_HEADER_FLAGS (tny_header_flags_get_type()) 
     47 
     48#ifndef TNY_SHARED_H 
     49typedef struct _TnyHeader TnyHeader; 
     50typedef struct _TnyHeaderIface TnyHeaderIface; 
     51typedef enum _TnyHeaderFlags TnyHeaderFlags; 
     52#endif 
    4753 
    4854enum _TnyHeaderFlags  
  • trunk/libtinymail/tny-iterator.h

    r900 r903  
    3333#define TNY_ITERATOR_GET_IFACE(inst)  (G_TYPE_INSTANCE_GET_INTERFACE ((inst), TNY_TYPE_ITERATOR, TnyIteratorIface)) 
    3434 
     35#ifndef TNY_SHARED_H 
     36typedef struct _TnyIterator TnyIterator; 
     37typedef struct _TnyIteratorIface TnyIteratorIface; 
     38#endif 
     39 
    3540struct _TnyIteratorIface 
    3641{ 
  • trunk/libtinymail/tny-list.h

    r900 r903  
    3434#define TNY_LIST_GET_IFACE(inst)  (G_TYPE_INSTANCE_GET_INTERFACE ((inst), TNY_TYPE_LIST, TnyListIface)) 
    3535 
     36#ifndef TNY_SHARED_H 
     37typedef struct _TnyList TnyList; 
     38typedef struct _TnyListIface TnyListIface; 
     39#endif 
     40 
    3641struct _TnyListIface 
    3742{ 
  • trunk/libtinymail/tny-mime-part.h

    r900 r903  
    3333#define TNY_IS_MIME_PART(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), TNY_TYPE_MIME_PART)) 
    3434#define TNY_MIME_PART_GET_IFACE(inst)  (G_TYPE_INSTANCE_GET_INTERFACE ((inst), TNY_TYPE_MIME_PART, TnyMimePartIface)) 
     35 
     36#ifndef TNY_SHARED_H 
     37typedef struct _TnyMimePart TnyMimePart; 
     38typedef struct _TnyMimePartIface TnyMimePartIface; 
     39#endif 
    3540 
    3641struct _TnyMimePartIface 
  • trunk/libtinymail/tny-msg.h

    r900 r903  
    3434#define TNY_MSG_GET_IFACE(inst)  (G_TYPE_INSTANCE_GET_INTERFACE ((inst), TNY_TYPE_MSG, TnyMsgIface)) 
    3535 
     36#ifndef TNY_SHARED_H 
     37typedef struct _TnyMsg TnyMsg; 
     38typedef struct _TnyMsgIface TnyMsgIface; 
     39#endif 
     40 
    3641struct _TnyMsgIface 
    3742{ 
  • trunk/libtinymail/tny-shared.h

    r900 r903  
    2323G_BEGIN_DECLS 
    2424 
     25typedef struct _TnyAccountStore TnyAccountStore; 
     26typedef struct _TnyAccountStoreIface TnyAccountStoreIface; 
     27 
    2528typedef struct _TnyList TnyList; 
    2629typedef struct _TnyIterator TnyIterator; 
     
    4346typedef struct _TnyTransportAccount TnyTransportAccount; 
    4447typedef struct _TnyTransportAccountIface TnyTransportAccountIface; 
    45 typedef struct _TnyAccountStore TnyAccountStore; 
    4648typedef struct _TnyStream TnyStream; 
    4749typedef struct _TnyStreamIface TnyStreamIface; 
    48 typedef struct _TnyAccountStoreIface TnyAccountStoreIface; 
    4950typedef gchar* (*TnyGetPassFunc) (TnyAccount *self, const gchar *prompt, gboolean *cancel); 
    5051typedef void (*TnyForgetPassFunc) (TnyAccount *self); 
  • trunk/libtinymail/tny-store-account.h

    r900 r903  
    3636#define TNY_STORE_ACCOUNT_GET_IFACE(inst)  (G_TYPE_INSTANCE_GET_INTERFACE ((inst), TNY_TYPE_STORE_ACCOUNT, TnyStoreAccountIface)) 
    3737 
     38#ifndef TNY_SHARED_H 
     39typedef struct _TnyStoreAccount TnyStoreAccount; 
     40typedef struct _TnyStoreAccountIface TnyStoreAccountIface; 
     41#endif 
    3842 
    3943struct _TnyStoreAccountIface 
  • trunk/libtinymail/tny-stream.h

    r900 r903  
    3434#define TNY_STREAM_GET_IFACE(inst)  (G_TYPE_INSTANCE_GET_INTERFACE ((inst), TNY_TYPE_STREAM, TnyStreamIface)) 
    3535 
     36#ifndef TNY_SHARED_H 
     37typedef struct _TnyStream TnyStream; 
     38typedef struct _TnyStreamIface TnyStreamIface; 
     39#endif 
     40 
    3641struct _TnyStreamIface 
    3742{ 
  • trunk/libtinymail/tny-transport-account.h

    r900 r903  
    3434#define TNY_TRANSPORT_ACCOUNT_GET_IFACE(inst)  (G_TYPE_INSTANCE_GET_INTERFACE ((inst), TNY_TYPE_TRANSPORT_ACCOUNT, TnyTransportAccountIface)) 
    3535 
     36#ifndef TNY_SHARED_H 
     37typedef struct _TnyTransportAccount TnyTransportAccount; 
     38typedef struct _TnyTransportAccountIface TnyTransportAccountIface; 
     39#endif 
     40 
    3641struct _TnyTransportAccountIface 
    3742{ 
  • trunk/libtinymailui/tny-account-store-view.h

    r900 r903  
    2424#include <glib-object.h> 
    2525#include <tny-shared.h> 
     26#include <tny-account-store.h> 
    2627 
    2728G_BEGIN_DECLS