Changeset 388

Show
Ignore:
Timestamp:
05/26/06 18:11:38
Author:
pvanhoof
Message:

Updated the api docs

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

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

    r311 r388  
    77<!-- ##### SECTION Long_Description ##### --> 
    88<para> 
    9 An account contains the folders of an E-mail service and handles the authentication with a service. 
     9A abstract type that contains the shared functionality of the #TnyStoreAccountIface and the #TnyTransportAccountIface types. 
    1010</para> 
    1111 
    1212<!-- ##### SECTION See_Also ##### --> 
    1313<para> 
    14  
     14#TnyStoreAccountIface, #TnyTransportAccountIface 
    1515</para> 
    1616 

  • trunk/docs/devel/reference/tmpl/tny-account-store-iface.sgml

    r311 r388  
    33 
    44<!-- ##### SECTION Short_Description ##### --> 
    5 An interface that defines an account store type 
     5A store for accounts 
    66 
    77<!-- ##### SECTION Long_Description ##### --> 
    88<para> 
    9 An account store is an observable and factory that can deliver 
    10 configured accounts and that will update its observers on changes that 
    11 happen to the accounts. 
     9A type that returns stored (configured) accounts. Both transport and store accounts. 
    1210</para> 
    1311 
    1412<!-- ##### SECTION See_Also ##### --> 
    1513<para> 
    16  
     14#TnyAccountIface, #TnyStoreAccountIface, #TnyTransportAccountIface 
    1715</para> 
    1816 

  • trunk/docs/devel/reference/tmpl/tny-account-store.sgml

    r311 r388  
    33 
    44<!-- ##### SECTION Short_Description ##### --> 
    5 A store with accounts that uses libtinymail-camel and GConf 
     5A account store implemented for Camel and GConf 
    66 
    77<!-- ##### SECTION Long_Description ##### --> 
    88<para> 
    9 An implementation of #TnyAccountStoreIface that uses libtinymail-camel and GConf. 
     9An implementation of #TnyAccountStoreIface that uses Camel and GConf. This implementation is coupled with the #TnyStoreAccount and #TnyTransportAccount implementations. It can only return instances of those implementations of #TnyStoreAccountIface and #TnyTransportAccountIface. 
    1010</para> 
    1111 
    1212<!-- ##### SECTION See_Also ##### --> 
    1313<para> 
    14 #TnyAccountStoreIface 
     14#TnyAccountStoreIface, #TnyAccountIface, #TnyStoreAccountIface, #TnyTransportAccountIface, #TnyAccount, #TnyStoreAccount, #TnyTransportAccount 
    1515</para> 
    1616 

  • trunk/docs/devel/reference/tmpl/tny-account-tree-model.sgml

    r193 r388  
    77<!-- ##### SECTION Long_Description ##### --> 
    88<para> 
    9 A #GtkTreeModel suitable for storing #TnyAccountIface instances. It's 
    10 implementing using a simple #GtkTreeStore and recursively walks the 
    11 folders of account instances that get added. 
     9A #GtkTreeModel suitable for storing #TnyStoreAccountIface instances. The  
     10implementation inherits the #GtkTreeStore. It recursively walks the 
     11folders of account instances that get added. Using it as a model for a 
     12#GtkTreeView will display the account name as parent row with the 
     13account-folders as the child rows. 
    1214</para> 
    1315 
    1416<!-- ##### SECTION See_Also ##### --> 
    1517<para> 
    16  
     18#TnyStoreAccountIface, #GtkTreeView, #GtkTreeStore, #GtkTreeModel 
    1719</para> 
    1820 

  • trunk/docs/devel/reference/tmpl/tny-attach-list-model.sgml

    r193 r388  
    33 
    44<!-- ##### SECTION Short_Description ##### --> 
    5 A #GtkTreeModel suitable for storing #TnyMsgMimePartIface instaces 
     5A #GtkTreeModel suitable for storing #TnyMsgMimePartIface instances 
    66 
    77<!-- ##### SECTION Long_Description ##### --> 
    88<para> 
    9 A #GtkTreeModel suitable for storing #TnyMsgMimePartIface instaces. It 
    10 inherits from a #GtkListStore and handles the mime-type icon of the 
    11 icon column automatically. 
     9A #GtkTreeModel suitable for storing #TnyMsgMimePartIface instaces. The 
     10implementation inherits the #GtkListStore. If the library was compiled 
     11with gnome features, the implementation will handle the mime-type icon  
     12automatically. 
    1213</para> 
    1314 
    1415<!-- ##### SECTION See_Also ##### --> 
    1516<para> 
    16  
     17#TnyMsgMimePartIface, #GtkTreeModel, #GtkListStore, #GtkTreeView 
    1718</para> 
    1819 

  • trunk/docs/devel/reference/tmpl/tny-camel-stream.sgml

    r193 r388  
    33 
    44<!-- ##### SECTION Short_Description ##### --> 
    5 A #CamelStream as a proxy for a #TnyStreamIface 
     5A #CamelStream as adaptor for a #TnyStreamIface 
    66 
    77<!-- ##### SECTION Long_Description ##### --> 
    88<para> 
    9 A #CamelStream as a proxy for a #TnyStreamIface 
     9This type adapts the #TnyStreamIface to a #CamelStream. It's used in the  
     10libtinymail-camel implementation library for converting a #TnyStreamIface  
     11to a #CamelStream. 
    1012</para> 
    1113 
    1214<!-- ##### SECTION See_Also ##### --> 
    1315<para> 
    14  
     16#TnyStreamIface, #CamelStream, #TnyStreamCamel 
    1517</para> 
    1618 

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

    r313 r388  
    33 
    44<!-- ##### SECTION Short_Description ##### --> 
    5  
     5A type that implements a few device specific things 
    66 
    77<!-- ##### SECTION Long_Description ##### --> 
    88<para> 
    9  
     9A type that implements a few device specific things like the  
     10online/offline status. 
    1011</para> 
    1112 

  • trunk/docs/devel/reference/tmpl/tny-device.sgml

    r313 r388  
    33 
    44<!-- ##### SECTION Short_Description ##### --> 
    5  
     5A #TnyDeviceIface implementation for the gnome platform 
    66 
    77<!-- ##### SECTION Long_Description ##### --> 
    88<para> 
    9  
     9A #TnyDeviceIface implementation for the gnome platform 
     10that uses NetworkManager for the online/offline status 
     11updates. 
    1012</para> 
    1113 
    1214<!-- ##### SECTION See_Also ##### --> 
    1315<para> 
    14  
     16#TnyDeviceIface, Network Manager 
    1517</para> 
    1618 

  • trunk/docs/devel/reference/tmpl/tny-fs-stream.sgml

    r356 r388  
    33 
    44<!-- ##### SECTION Short_Description ##### --> 
    5  
     5A #TnyStreamIface adaptor for a file discriptor 
    66 
    77<!-- ##### SECTION Long_Description ##### --> 
    88<para> 
    9  
     9An adaptor for a file descriptor to a #TnyStreamIface type. You need to 
     10use the standard POSIX open() syscall. The implementation will, upon 
     11destruction, close() the filedescriptor. This behaviour might change in 
     12future (as I'm not yet sure whether this is the best thing to do). 
    1013</para> 
    1114 
    1215<!-- ##### SECTION See_Also ##### --> 
    1316<para> 
    14  
     17#TnyStreamIface 
    1518</para> 
    1619 

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

    r352 r388  
    33 
    44<!-- ##### SECTION Short_Description ##### --> 
    5  
     5A #TnyMsgViewIface implementation that uses GtkMozEmbed 
    66 
    77<!-- ##### SECTION Long_Description ##### --> 
    88<para> 
     9A #TnyMsgViewIface implementation that uses the GtkMozEmbed HTML 
     10component. This implementation is coupled with the #TnyMozEmbedStream 
     11#TnyStreamIface implementation. 
    912 
     13The developer needs to decode the #TnyMsgMimePartIface instance of the 
     14#TnyMsgIface instance that has as mime-type "text/html" to a #TnyMozEmbedStream 
     15instance. A #TnyMozEmbedStream instance will update the instance of this type. 
     16 
     17You need to construct this type with a #TnySaveStrategyIface. It's recommended  
     18to use the #TnySaveStrategy implementation in libtinymailui-gtk. 
    1019</para> 
    1120 
    1221<!-- ##### SECTION See_Also ##### --> 
    1322<para> 
    14  
     23#TnyMsgViewIface, #GtkMozEmbed, #TnyStreamIface, #TnyMozEmbedStream, #TnySaveStrategyIface, #TnySaveStrategy 
    1524</para> 
    1625 

  • trunk/docs/devel/reference/tmpl/tny-moz-embed-stream.sgml

    r313 r388  
    33 
    44<!-- ##### SECTION Short_Description ##### --> 
    5  
     5A #TnyStreamIface implementation that updates a #TnyMozEmbedMsgView 
    66 
    77<!-- ##### SECTION Long_Description ##### --> 
    88<para> 
     9The developer needs to decode the #TnyMsgMimePartIface instance of the 
     10#TnyMsgIface instance that has as mime-type "text/html" to a an instance 
     11of this type. The implementation will update the #TnyMozEmbedMsgView 
     12instance which you used to construct this type with. 
    913 
    1014</para> 
    …… 
    1216<!-- ##### SECTION See_Also ##### --> 
    1317<para> 
    14  
     18#TnyMozEmbedMsgView, #TnyMsgViewIface, #GtkMozEmbed, #TnyStreamIface 
    1519</para> 
    1620 

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

    r311 r388  
    33 
    44<!-- ##### SECTION Short_Description ##### --> 
    5 An interface that defines a folder type 
     5A type that defines a folder 
    66 
    77<!-- ##### SECTION Long_Description ##### --> 
    88<para> 
    9 A folder type contains both headers and children folders.  
    10 A folder can have a account or another folder as parent. 
     9A folder contains headers and children folders. A folder can have a account or another  
     10folder as parent. An implementation of a #TnyStoreAccountIface will typically keep 
     11track of instances of this type. If you got them from a #TnyStoreAccountIface implementation, 
     12you typically don't destroy instances of this type. The #TnyStoreAccountIface implementation 
     13will do that for you upon destruction of the account. You can, however, uncache the folder  
     14instances. Depending on the implementation, this will reduce memory usage. 
    1115</para> 
    1216 
    1317<!-- ##### SECTION See_Also ##### --> 
    1418<para> 
    15  
     19#TnyStoreAccountIface 
    1620</para> 
    1721 

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

    r193 r388  
    33 
    44<!-- ##### SECTION Short_Description ##### --> 
    5 A #TnyFolderIface implementation as a proxy for #CamelFolder 
     5A Camel #TnyMsgFolderIface implementation 
    66 
    77<!-- ##### SECTION Long_Description ##### --> 
    88<para> 
     9A #TnyMsgFolderIface proxy for the #CamelFolder type in Camel. 
    910 
     11It's recommended to launch the uncache method on instances of 
     12this type once the instance is no longer actively used. Doing so 
     13will dramatically reduce memory usage. Doing it too early will 
     14cause a reload of folder data (it will slow things down). 
     15 
     16For example when a new folder becomes the visible or active folder, 
     17you can launch the uncache method on the old folder instance. You 
     18shouldn't destroy the instance as the #TnyStoreAccount implementation 
     19for camel is the type that keeps track of instances of this type. 
     20But you can uncache them. 
     21 
     22This type is coupled with the #TnyStoreAccount implementation for 
     23Camel. 
    1024</para> 
    1125 
    1226<!-- ##### SECTION See_Also ##### --> 
    1327<para> 
    14  
     28#TnyMsgFolderIface, #CamelFolder, #TnyStoreAccount, #TnyStoreAccountIface 
    1529</para> 
    1630 

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

    r193 r388  
    33 
    44<!-- ##### SECTION Short_Description ##### --> 
    5 An interfaces that defines a header type 
     5A type that defines a header 
    66 
    77<!-- ##### SECTION Long_Description ##### --> 
    88<para> 
    9  
     9A header of a #TnyMsgIface instance is the non-body information. It contains for example  
     10the "to", the "from", the "subject" and the "sent-date" information. It's typically used  
     11by a summary view to give the user an overview of the available messages in a folder. 
    1012</para> 
    1113 
    1214<!-- ##### SECTION See_Also ##### --> 
    1315<para> 
    14  
     16#TnyMsgIface, #TnyMsgFolderIface 
    1517</para> 
    1618 

  • trunk/docs/devel/reference/tmpl/tny-msg-header-list-model.sgml

    r311 r388  
    11<!-- ##### SECTION Title ##### --> 
    2 tny-msg-header-list-model 
     2TnyMsgHeaderListModel 
    33 
    44<!-- ##### SECTION Short_Description ##### --> 
    …… 
    77<!-- ##### SECTION Long_Description ##### --> 
    88<para> 
    9 This #GtkTreeModel will attempt to uncache #TnyMsgHeaderIface instances 
    10 that are implemented as a proxy for real header instances once their 
    11 corresponding row in the #GtkTreeView become invisible. 
     9This #GtkTreeModel implementation will attempt to aggressively uncache  
     10#TnyMsgHeaderIface instances once their corresponding row in the  
     11#GtkTreeView become invisible. This reduces memory usage. 
    1212</para> 
    1313 
    1414<!-- ##### SECTION See_Also ##### --> 
    1515<para> 
    16  
     16#TnyMsgViewIface 
    1717</para> 
    1818 

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

    r193 r388  
    11<!-- ##### SECTION Title ##### --> 
    2 tny-msg-header 
     2TnyMsgHeader 
    33 
    44<!-- ##### SECTION Short_Description ##### --> 
    5 An implementation of #TnyMsgHeaderIface that plays proxy for CamelMessageInfo 
     5A Camel implementation of #TnyMsgHeaderIface 
    66 
    77<!-- ##### SECTION Long_Description ##### --> 
    88<para> 
    9 TnyMsgHeader is a proxy for real subject CamelMessageInfo. The type doesn't 
    10 use a priv pointer, but in stead is an opaque structure. This is done for  
    11 decreasing the amount of allocations (a priv pointer is an unnecessary  
    12 allocation). Allocations are slow. 
     9A proxy for a #CamelMessageInfo. The type doesn't use a priv pointer, it's  
     10implemented as a opaque structure. This is done for decreasing the amount  
     11of allocations (a priv pointer is an unnecessary allocation). Allocations are  
     12slow. 
    1313 
    1414A list model (like a tree model) is responsible for calling the uncache 
    15 method whenever the corresponding row becomes invisble. 
     15method whenever the corresponding row becomes invisble. Most list model  
     16implementations will do this. This implementation copes with this. 
    1617 
    1718All kinds of dirty non-gobject-standard tricks have been applied to make this 
    …… 
    2627<!-- ##### SECTION See_Also ##### --> 
    2728<para> 
    28  
     29#TnyMsgHeaderIface, #TnyMsgFolder, #TnyMsgFolderIface, #TnyMsgHeaderListModel 
    2930</para> 
    3031 

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

    r193 r388  
    33 
    44<!-- ##### SECTION Short_Description ##### --> 
    5 An interfaces that defines a message type 
     5A type that defines a message 
    66 
    77<!-- ##### SECTION Long_Description ##### --> 
    88<para> 
    9  
     9A type that defines a message. It inherits from #TnyMsgMimePartIface and can 
     10therefore be used as a mime part. 
    1011</para> 
    1112 
    1213<!-- ##### SECTION See_Also ##### --> 
    1314<para> 
    14  
     15#TnyMsgHeaderIface, #TnyMsgFolderIface, #TnyMsgMimePartIface 
    1516</para> 
    1617 

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

    r337 r388  
    33 
    44<!-- ##### SECTION Short_Description ##### --> 
    5 An interfaces that defines a mime part type 
     5A type that defines a mime part 
    66 
    77<!-- ##### SECTION Long_Description ##### --> 
    88<para> 
    9  
     9A mime part is a part of a message. Like the body, an attachment or the PGP key of a message. 
    1010</para> 
    1111 
    1212<!-- ##### SECTION See_Also ##### --> 
    1313<para> 
    14  
     14#TnyMsgIface 
    1515</para> 
    1616 

  • trunk/docs/devel/reference/tmpl/tny-msg-mime-part.sgml

    r193 r388  
    33 
    44<!-- ##### SECTION Short_Description ##### --> 
    5 An implementation of #TnyMsgMimePartIface that plays proxy for a #CamelMimePart 
     5A Camel implementation of #TnyMsgMimePartIface 
    66 
    77<!-- ##### SECTION Long_Description ##### --> 
    88<para> 
    9  
     9A implementation that plays proxy for a #CamelMimePart. 
    1010</para> 
    1111 
    1212<!-- ##### SECTION See_Also ##### --> 
    1313<para> 
    14  
     14#TnyMsg, #TnyMsgIface, #TnyMsgMimePartIface 
    1515</para> 
    1616 

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

    r355 r388  
    33 
    44<!-- ##### SECTION Short_Description ##### --> 
    5 An interfaces that defines a message view type 
     5A type that defines a message view 
    66 
    77<!-- ##### SECTION Long_Description ##### --> 
    88<para> 
    9  
     9A view for a message. Implementations of this type should show a message 
     10to the user. 
    1011</para> 
    1112 
    1213<!-- ##### SECTION See_Also ##### --> 
    1314<para> 
    14  
     15#TnyMsgIface, #TnyMsgMimePartIface 
    1516</para> 
    1617 

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

    r352 r388  
    33 
    44<!-- ##### SECTION Short_Description ##### --> 
    5 An implementation of #TnyMsgViewIface for Gtk+ 
     5A implementation of #TnyMsgViewIface for Gtk+. 
    66 
    77<!-- ##### SECTION Long_Description ##### --> 
    88<para> 
     9A type that uses the #GtkTextBuffer and #GtkTextView types for displaying the message. 
    910 
     11It obviously doesn't support showing HTML formatted content. It will, however, 
     12display the source code of such content. 
     13 
     14This type is coupled with the #TnyTextBufferStream. 
    1015</para> 
    1116 
    1217<!-- ##### SECTION See_Also ##### --> 
    1318<para> 
    14  
     19#TnyMsgIface, #TnyMsgMimePartIface, #TnyTextBufferStream, #GtkTextBuffer, #GtkTextView 
    1520</para> 
    1621 

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

    r311 r388  
    33 
    44<!-- ##### SECTION Short_Description ##### --> 
    5 An implementation that defines a message window type 
     5A type that defines a message window 
    66 
    77<!-- ##### SECTION Long_Description ##### --> 
    88<para> 
    9  
     9A type that shows a new window in which you can view a message 
    1010</para> 
    1111 
    1212<!-- ##### SECTION See_Also ##### --> 
    1313<para> 
    14  
     14#TnyMsgIface 
    1515</para> 
    1616 

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

    r311 r388  
    33 
    44<!-- ##### SECTION Short_Description ##### --> 
    5 An implementation of #TnyMsgWindowIface for Gtk+ 
     5A implementation of #TnyMsgWindowIface for Gtk+ 
    66 
    77<!-- ##### SECTION Long_Description ##### --> 
    88<para> 
     9A type that decorates the #TnyMsgViewIface and is implemented as a GtkWindow. It 
     10wraps the #TnyMsgViewIface instance with a window. It expects the view implementation 
     11to inherit from GtkWidget. Therefore it's soft coupled with implementations like 
     12#TnyMsgView for Gtk+ and #TnyMozEmbedMsgView which is also implemented by inheriting 
     13from a #GtkWidget descendant, but uses a #GtkMozEmbed HTML component. 
    914 
     15You cannot use #TnyMsgViewIface implementations that don't inherit from a #GtkWidget 
     16type with this type. 
    1017</para> 
    1118 
    1219<!-- ##### SECTION See_Also ##### --> 
    1320<para> 
    14  
     21#TnyMsgViewIface, #TnyMsgView, #TnyMozEmbedMsgView, #GtkWindow, #GtkWidget 
    1522</para> 
    1623 

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

    r193 r388  
    33 
    44<!-- ##### SECTION Short_Description ##### --> 
    5 An implementation of #TnyMsgIface that plays proxy for #CamelMimeMessage 
     5A Camel implementation of the #TnyMsgIface 
    66 
    77<!-- ##### SECTION Long_Description ##### --> 
    88<para> 
     9A #TnyMsgIface proxy for the #CamelMimeMessage type in Camel. It inherits from #TnyMsgMimePart and can 
     10therefore be used as a mime part.  
    911 
     12This implementation is coupled with #TnyMsgMimePart. 
    1013</para> 
    1114 
    1215<!-- ##### SECTION See_Also ##### --> 
    1316<para> 
    14  
     17#TnyMsgIface, #CamelMimeMessage, #TnyMsgMimePart, #TnyMsgMimePartIface 
    1518</para> 
    1619 

  • trunk/docs/devel/reference/tmpl/tny-password-dialog.sgml

    r193 r388  
    33 
    44<!-- ##### SECTION Short_Description ##### --> 
    5 A password dialog 
     5A password dialog implemented for the gnome platform 
    66 
    77<!-- ##### SECTION Long_Description ##### --> 
    88<para> 
    9  
     9A password dialog being used by the #TnyAccountStoreIface implementation for the  
     10gnome platform: #TnyAccountStore. 
    1011</para> 
    1112 
    1213<!-- ##### SECTION See_Also ##### --> 
    1314<para> 
    14  
     15#TnyAccountStore 
    1516</para> 
    1617 

  • trunk/docs/devel/reference/tmpl/tny-platform-factory-iface.sgml

    r313 r388  
    33 
    44<!-- ##### SECTION Short_Description ##### --> 
     5A factory that returns implementations for a platform    
    56 
    67 
    78<!-- ##### SECTION Long_Description ##### --> 
    89<para> 
    9  
     10A factory type that returns specific implementations for a specific platform. 
    1011</para> 
    1112 
    1213<!-- ##### SECTION See_Also ##### --> 
    1314<para> 
    14  
     15#TnyDeviceIface, #TnyMsgViewIface, #TnyAccountStoreIface 
    1516</para> 
    1617 

  • trunk/docs/devel/reference/tmpl/tny-platform-factory.sgml

    r313 r388  
    33 
    44<!-- ##### SECTION Short_Description ##### --> 
    5  
     5A implementation of #TnyPlatformFactoryIface for the gnome platform 
    66 
    77<!-- ##### SECTION Long_Description ##### --> 
    88<para> 
    9  
     9A factory that returns specific implementations for a specific platform. Like the 
     10#TnyDevice, the #TnyMsgView or the #TnyMozEmbedMsgView and the #TnyAccountStore. 
    1011</para> 
    1112 
    1213<!-- ##### SECTION See_Also ##### --> 
    1314<para> 
    14  
     15#TnyDeviceIface, #TnyDevice, #TnyMsgViewIface, #TnyMozEmbedMsgView, #TnyMsgView, #TnyAccountStoreIface, #TnyAccountStore 
    1516</para> 
    1617 

  • trunk/docs/devel/reference/tmpl/tny-save-strategy-iface.sgml

    r356 r388  
    33 
    44<!-- ##### SECTION Short_Description ##### --> 
    5  
     5A strategy for saving a mime part 
    66 
    77<!-- ##### SECTION Long_Description ##### --> 
    88<para> 
    9  
     9A type used by a #TnyMsgViewIface instance for saving a #TnyMsgMimePartIface 
     10(like an attachment) to a file. 
    1011</para> 
    1112 
    1213<!-- ##### SECTION See_Also ##### --> 
    1314<para> 
    14  
     15#TnyMsgViewIface, #TnyMsgMimePartIface 
    1516</para> 
    1617 

  • trunk/docs/devel/reference/tmpl/tny-save-strategy.sgml

    r356 r388  
    33 
    44<!-- ##### SECTION Short_Description ##### --> 
    5  
     5A strategy for saving a mime part using Gtk+ 
    66 
    77<!-- ##### SECTION Long_Description ##### --> 
    88<para> 
     9A strategy type, used by a #TnyMsgViewIface implementation, that uses Gtk+  
     10for saving a #TnyMsgMimePartIface instance. It will for example instantiate  
     11a #GtkFileChooserDialog instance for asking the user where to put the file. 
    912 
     13If the library is compiled with gnome features, it will also use the 
     14#TnyVfsStream for saving to a GnomeVFS destination. If not, it will 
     15use a #TnyFsStream #TnyStreamIface implementation for saving to a 
     16normal file descriptor. 
    1017</para> 
    1118 
    1219<!-- ##### SECTION See_Also ##### --> 
    1320<para> 
    14  
     21#TnySaveStrategyIface, #TnyMsgMimePartIface, #TnyMsgViewIface, #GtkFileChooserDialog, #TnyVfsStream, #TnyFsStream, #TnyStreamIface, GnomeVFS 
    1522</para> 
    1623 

  • trunk/docs/devel/reference/tmpl/tny-session-camel.sgml

    r311 r388  
    33 
    44<!-- ##### SECTION Short_Description ##### --> 
    5 A session singleton type for Camel 
     5A session type for Camel 
    66 
    77<!-- ##### SECTION Long_Description ##### --> 
    88<para> 
    9  
     9A type being used internally by the libtinymail-camel implementation. It,  
     10for example, observes the #TnyDeviceIface instance for the online/offline 
     11status of the device. 
    1012</para> 
    1113 
    1214<!-- ##### SECTION See_Also ##### --> 
    1315<para> 
    14  
     16#TnyDeviceIface, #TnyAccountIface, #TnyStoreAccountIface, #TnyTransportAccountIface 
    1517</para> 
    1618 

  • trunk/docs/devel/reference/tmpl/tny-store-account-iface.sgml

    r193 r388  
    33 
    44<!-- ##### SECTION Short_Description ##### --> 
    5  
     5A type for getting folders (and E-mails) of an account 
    66 
    77<!-- ##### SECTION Long_Description ##### --> 
    88<para> 
    9  
     9A store account contains the folders of an E-mail service and handles the authentication with the service. 
    1010</para> 
    1111 
    1212<!-- ##### SECTION See_Also ##### --> 
    1313<para> 
    14  
     14#TnyAccountIface, #TnyTransportAccountIface 
    1515</para> 
    1616 

  • trunk/docs/devel/reference/tmpl/tny-store-account.sgml

    r193 r388  
    33 
    44<!-- ##### SECTION Short_Description ##### --> 
    5  
     5A store account type implemented for camel. 
    66 
    77<!-- ##### SECTION Long_Description ##### --> 
    88<para> 
    9  
     9A store account type implemented for camel. 
    1010</para> 
    1111 
    1212<!-- ##### SECTION See_Also ##### --> 
    1313<para> 
    14  
     14#TnyAccountIface, #TnyTransportAccountIface, #TnyTransportAccount, #TnyAccount 
    1515</para> 
    1616 

  • trunk/docs/devel/reference/tmpl/tny-stream-camel.sgml

    r193 r388  
    33 
    44<!-- ##### SECTION Short_Description ##### --> 
    5 A #TnyStreamIface implemented as a proxy for a #CamelStream 
     5A #TnyStreamIface as adaptor for a #CamelStream 
    66 
    77<!-- ##### SECTION Long_Description ##### --> 
    88<para> 
    9  
     9This type adapts the #CamelStream to a #TnyStreamIface. It's used in the  
     10libtinymail-camel implementation library for converting a #CamelStream 
     11to a #TnyStreamIface. 
    1012</para> 
    1113 
    1214<!-- ##### SECTION See_Also ##### --> 
    1315<para> 
    14  
     16#TnyStreamIface, #CamelStream, #TnyCamelStream 
    1517</para> 
    1618 

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

    r193 r388  
    33 
    44<!-- ##### SECTION Short_Description ##### --> 
    5 An interfaces that defines a stream type 
     5A type that defines a stream 
    66 
    77<!-- ##### SECTION Long_Description ##### --> 
    …… 
    1212<!-- ##### SECTION See_Also ##### --> 
    1313<para> 
    14  
     14#TnyMsgMimePartIface, #TnyMsgViewIface, #TnySaveStrategyIface, #TnyCamelStream, #TnyStreamCamel, #TnyMozEmbedStream, #TnyTextBufferStream, #TnyFsStream, #TnyVfsStream 
    1515</para> 
    1616 

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

    r193 r388  
    33 
    44<!-- ##### SECTION Short_Description ##### --> 
    5 An interfaces that defines a summary window type 
     5A type that defines a summary window 
    66 
    77<!-- ##### SECTION Long_Description ##### --> 
    88<para> 
     9You can let your summary window type implement this type. Not that it defines a lot at this moment. 
    910 
     11Typical implementations will go in a composition relation with a type that implements #TnyAccountStoreViewIface. 
     12The demo-ui of tinymail, however, *is* also a #TnyAccountStoreViewIface implementation. 
    1013</para> 
    1114 
    1215<!-- ##### SECTION See_Also ##### --> 
    1316<para> 
    14  
     17#TnyAccountStoreViewIface, #TnyAccountStoreIface 
    1518</para> 
    1619 
    …… 
    2427 
    2528 
    26 <!-- ##### FUNCTION tny_summary_window_iface_set_account_store ##### --> 
    27 <para> 
    28  
    29 </para> 
    30  
    31 @self:  
    32 @account_store:  
    33  
    34  

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

    r193 r388  
    33 
    44<!-- ##### SECTION Short_Description ##### --> 
    5 An implementation of #TnySummaryWindowIface for Gtk+ 
     5A demo implementation of #TnySummaryWindowIface for Gtk+ 
    66 
    77<!-- ##### SECTION Long_Description ##### --> 
    88<para> 
     9A demo implementation of a summary window. Implemented for Gtk+. 
    910 
     11The implementation claims to also be a #TnyAccountStoreViewIface implementation. 
     12Which is, of course, perfectly legal. It's possible that a summary window is a 
     13view for the account store. 
     14 
     15You can, however, also do it more finegrained and create a real view type that 
     16implements the #TnyAccountStoreViewIface. And you can let the summary window 
     17for example decorate that. Or simply goes in a composition relation with that 
     18type. In a human language: embed the view type in the summary window. 
     19 
     20The demo-ui, however, implements the summary window *as* the view type. The  
     21main reason for this is because that reduces the amount of code. People might 
     22other wise get scared about having to implement a lot own GObjects if they 
     23want to use the tinymail framework. This isn't true.  
     24 
     25But that doesn't mean the scared people are right. It's probably more correct 
     26to implement a type as a #TnyAccountStoreViewIface and put it in composition 
     27with the #TnySummaryWindowIface implementation. 
     28 
     29Mine is just a simple demo. 
    1030</para> 
    1131<