[3153] - tinymail - Trac

trunk/ChangeLog

r3151	r3153
	1	2007-12-19 Philip Van Hoof <pvanhoof@gnome.org>
	2
	3	* New documentaiton style, third commit (libtinymailui-gtk)
	4
1	5	2007-12-18 Philip Van Hoof <pvanhoof@gnome.org>
2	6

trunk/libtinymailui-gtk/tny-gtk-account-list-model.c

r2944	r3153
18	18	*/
19	19
	20	/**
	21	* TnyGtkAccountListModel:
	22	*
	23	* A #GtkTreeModel for #TnyAccount instances
	24	*
	25	* Note that a #TnyGtkAccountListModel is a #TnyList too. You can use the
	26	* #TnyList API on instances of this type too.
	27	*
	28	* Note that you must make sure that you unreference #TnyAccount instances that
	29	* you get out of the instance column of this type using the #GtkTreeModel API
	30	* gtk_tree_model_get().
	31	*
	32	* free-function: g_object_unref
	33	**/
	34
20	35	#include <config.h>
21	36
…	…
46	61	* tny_gtk_account_list_model_new:
47	62	*
48		* Create a new #GtkTreeModel instance suitable for showing a list of accounts.
49		* Note that when using gtk_combo_box_set_model or gtk_tree_view_set_model, the
50		* view will add its reference to your model instance. If you want the view to
51		* become the owner, you must get rid of your initial reference.
52		*
	63	* Create a new #GtkTreeModel suitable for showing a list of accounts. Note
	64	* that when using gtk_combo_box_set_model() or gtk_tree_view_set_model(),
	65	* the view will add its reference to your model instance. If you want the
	66	* view to become the owner, you must get rid of your initial reference.
	67	*
	68	* Example:
53	69	* <informalexample><programlisting>
54	70	* GtkTreeModel *model = tny_gtk_account_list_model_new ();
55	71	* GtkTreeView *view = ...;
	72	* tny_account_store_get_accounts (accstore, TNY_LIST (model), ...);
56	73	* gtk_tree_view_set_model (view, model);
57		* g_object_unref (model); ~~// this is probably what you want to do~~
	74	* g_object_unref (model);
58	75	* </programlisting></informalexample>
59	76	*
60		* Return value: a new #GtkTreeModel instance suitable for showing accounts
	77	* returns (caller-owns): a new #GtkTreeModel for accounts
	78	* since: 1.0
	79	* audience: application-developer
61	80	**/
62	81	GtkTreeModel*
…	…
261	280	}
262	281
	282	/**
	283	* tny_gtk_account_list_model_get_type:
	284	*
	285	* GType system helper function
	286	*
	287	* returns: a #GType
	288	**/
263	289	GType
264	290	tny_gtk_account_list_model_get_type (void)
…	…
305	331	* GType system helper function
306	332	*
307		* ~~Return value: a~~ GType
	333	* returns: a #GType
308	334	**/
309	335	GType

trunk/libtinymailui-gtk/tny-gtk-attach-list-model.c

r3035	r3153
17	17	* Boston, MA 02110-1301, USA.
18	18	*/
	19
	20	/**
	21	* TnyGtkAttachListModel:
	22	*
	23	* A #GtkTreeModel for #TnyMimePart instances that happen to be attachments too.
	24	*
	25	* Note that a #TnyGtkAttachListModel is a #TnyList too. You can use the
	26	* #TnyList API on instances of this type too.
	27	*
	28	* Note that you must make sure that you unreference #TnyMimePart instances
	29	* that you get out of the instance column of this type using the #GtkTreeModel
	30	* API gtk_tree_model_get().
	31	*
	32	* free-function: g_object_unref
	33	**/
19	34
20	35	#include <config.h>
…	…
121	136	* tny_gtk_attach_list_model_new:
122	137	*
123		* Get a new #GtkTreeModel instance suitable for showing #TnyMimePart.
124		*
125		* Return value: a new #GtkTreeModel instance suitable for showing a #TnyMimePart
	138	* Get a new #GtkTreeModel for #TnyMimePart instances that are attachments.
	139	*
	140	* returns (caller-owns) a new #GtkTreeModel #TnyMimePart instances
	141	* since: 1.0
	142	* audience: application-developer
126	143	**/
127	144	GtkTreeModel*
…	…
345	362	}
346	363
	364
	365	/**
	366	* tny_gtk_attach_list_model_get_type:
	367	*
	368	* GType system helper function
	369	*
	370	* returns: a #GType
	371	**/
347	372	GType
348	373	tny_gtk_attach_list_model_get_type (void)
…	…
390	415	* GType system helper function
391	416	*
392		* ~~Return value: a~~ GType
	417	* returns: a #GType
393	418	**/
394	419	GType

trunk/libtinymailui-gtk/tny-gtk-attachment-mime-part-view.c

r2825	r3153
17	17	* Boston, MA 02110-1301, USA.
18	18	*/
	19
	20	/**
	21	* TnyGtkAttachmentMimePartView:
	22	*
	23	* A #TnyMimePartView for showing a #TnyMimePart that is also an attachment
	24	*
	25	* free-function: g_object_unref
	26	**/
19	27
20	28	#include <config.h>
…	…
120	128	/**
121	129	* tny_gtk_attachment_mime_part_view_new:
122		* @iview: A #TnyGtkAttachListModel ~~instance~~
	130	* @iview: A #TnyGtkAttachListModel
123	131	*
124		* Create a new #TnyMimePartView instance implemented for Gtk+
	132	* Create a new #TnyMimePartView for showing MIME parts that are attachments.
	133	* The @iview parameter that you must pass is the #GtkTreeModel containing the
	134	* #TnyMimePart instances that are attachments.
125	135	*
126		* Return value: a new #TnyMimePartView instance implemented for Gtk+
	136	* returns (caller-owns): a new #TnyMimePartView for showing MIME parts that are attachments
	137	* since: 1.0
	138	* audience: application-developer
127	139	**/
128	140	TnyMimePartView*
…	…
203	215	* GType system helper function
204	216	*
205		* ~~Return value: a~~ GType
	217	* returns: a #GType
206	218	**/
207	219	GType

trunk/libtinymailui-gtk/tny-gtk-expander-mime-part-view.c

r3040	r3153
18	18	*/
19	19
	20	/**
	21	* TnyGtkExpanderMimePartView:
	22	*
	23	* A #TnyMimePartView that wraps another #TnyMimePartView into a #GtkExpander.
	24	* The type is a #TnyMimePartView by itself too (it decorates the one it wraps).
	25	*
	26	* free-function: g_object_unref
	27	**/
	28
20	29	#include <config.h>
	30
21	31	#include <gtk/gtk.h>
22	32
…	…
103	113	/**
104	114	* tny_gtk_expander_mime_part_view_set_view:
105		* @self: a #TnyGtkMsgView instance
106		* @view: a #TnyMimePartView to decorate
107		*
108		* Set the @view to decorate with @self. The @view instance must inherit the
109		* #GtkWidget type.
	115	* @self: a #TnyGtkMsgView
	116	* @view: a #TnyMimePartView to make expandable
	117	*
	118	* Set @view to become decorated and expanded by @self. The @view must inherit
	119	* #GtkWidget and implement #TnyMimePartView.
	120	*
	121	* since: 1.0
	122	* audience: application-developer
110	123	**/
111	124	void
…	…
114	127	TnyGtkExpanderMimePartViewPriv *priv = TNY_GTK_EXPANDER_MIME_PART_VIEW_GET_PRIVATE (self);
115	128
	129	g_assert (GTK_IS_WIDGET (view));
	130
116	131	if (priv->decorated)
117	132	gtk_container_remove (GTK_CONTAINER (self), GTK_WIDGET (priv->decorated));
…	…
129	144	/**
130	145	* tny_gtk_expander_mime_part_view_new:
131		* @view: the #TnyMimePartView to make expandable
132		*
133		* Create a new #TnyMimePartView for Gtk+ that wraps another mime part view with
134		* an expander (#GtkExpander). The @view instance must inherit the
135		* #GtkWidget type. The returned value will inherit #GtkExpander.
136		*
137		* Return value: a new #TnyMimePartView instance implemented for Gtk+
	146	* @view: a #TnyMimePartView to make expandable
	147	*
	148	* Create a new #TnyMimePartView that wraps another mime part view with
	149	* a #GtkExpander. The @view instance must inherit #GtkWidget. The
	150	* returned value will inherit #GtkExpander.
	151	*
	152	* returns (caller-owns): a new #TnyMimePartView
	153	* since: 1.0
	154	* audience: application-developer
138	155	**/
139	156	TnyMimePartView*

trunk/libtinymailui-gtk/tny-gtk-folder-store-tree-model.c

r3141	r3153
17	17	* Boston, MA 02110-1301, USA.
18	18	*/
	19
	20
	21	/**
	22	* TnyGtkFolderStoreTreeModel:
	23	*
	24	* A #GtkTreeModel for #TnyFolderStore instances that'll become #TnyFolderStoreObserver
	25	* and #TnyFolderObserver (in case the #TnyFolderStore instance is a #TnyFolder
	26	* too) of each added #TnyFolderStore and each of its children en grandchildren
	27	* (recursively).
	28	*
	29	* It will detect changes in the instance's tree structure this way and it will
	30	* adapt itself to a new situation automatically. It also contains columns that
	31	* contain certain popular numbers (like the unread and the total counts of
	32	* #TnyFolder instances).
	33	*
	34	* Note that a #TnyGtkFolderStoreTreeModel is a #TnyList too. You can use the
	35	* #TnyList API on instances of this type too.
	36	*
	37	* Note that you must make sure that you unreference #TnyFolderStore instances
	38	* that you get out of the instance column of this type using the #GtkTreeModel
	39	* API gtk_tree_model_get().
	40	*
	41	* free-function: g_object_unref
	42	**/
19	43
20	44	#include <config.h>
…	…
475	499	/**
476	500	* tny_gtk_folder_store_tree_model_new:
477		* @query: the #TnyFolderStoreQuery that will be used to retrieve the folders of each folder_store
478		*
479		* Create a new #GtkTreeModel instance suitable for showing
480		* #TnyFolderStore instances
	501	* @query: the #TnyFolderStoreQuery that will be used to retrieve the child folders of each #TnyFolderStore
	502	*
	503	* Create a new #GtkTreeModel for showing #TnyFolderStore instances
481	504	*
482		* Return value: a new #GtkTreeModel instance suitable for showing
483		* #TnyFolderStore instances
	505	* returns (caller-owns): a new #GtkTreeModel for #TnyFolderStore instances
	506	* since: 1.0
	507	* audience: application-developer
484	508	**/
485	509	GtkTreeModel*
…	…
597	621	/**
598	622	* tny_gtk_folder_store_tree_model_prepend:
599		* @self: ~~A #TnyGtkFolderStoreTreeModel instance~~
600		* @item: ~~A #TnyFolderStore instanc~~e to add
	623	* @self: a #TnyGtkFolderStoreTreeModel
	624	* @item: a #TnyFolderStore to add
601	625	* @root_name: The node's root name
602	626	*
603	627	* Prepends an item to the model
	628	*
	629	* since: 1.0
	630	* audience: application-developer
604	631	**/
605	632	void
…	…
638	665	/**
639	666	* tny_gtk_folder_store_tree_model_append:
640		* @self: ~~A #TnyGtkFolderStoreTreeModel instance~~
641		* @item: ~~A #TnyFolderStore instanc~~e to add
	667	* @self: a #TnyGtkFolderStoreTreeModel
	668	* @item: a #TnyFolderStore to add
642	669	* @root_name: The node's root name
643	670	*
644	671	* Appends an item to the model
	672	*
	673	* since: 1.0
	674	* audience: application-developer
645	675	**/
646	676	void
…	…
1069	1099	* GType system helper function
1070	1100	*
1071		* ~~Return value: a~~ GType
	1101	* returns: a #GType
1072	1102	**/
1073	1103	GType
…	…
1130	1160	* GType system helper function
1131	1161	*
1132		* ~~Return value: a~~ GType
	1162	* returns: a #GType
1133	1163	**/
1134	1164	GType

trunk/libtinymailui-gtk/tny-gtk-header-list-model.c

r2913	r3153
17	17	* Boston, MA 02110-1301, USA.
18	18	*/
	19
	20	/**
	21	* TnyGtkFolderStoreTreeModel:
	22	*
	23	* A #GtkTreeModel for #TnyHeader instances. Just like with any other #TnyList,
	24	* you can use it together with a #TnyFolderMonitor. You will typically fill
	25	* instances of this type using tny_folder_get_headers().
	26	*
	27	* Note that a #TnyGtkFolderStoreTreeModel is a #TnyList too. You can use the
	28	* #TnyList API on instances of this type too. This is what #TnyFolderMonitor
	29	* does too.
	30	*
	31	* Note that you must make sure that you unreference #TnyHeader instances that
	32	* you get out of the instance column of this type using the #GtkTreeModel API
	33	* gtk_tree_model_get().
	34	*
	35	* free-function: g_object_unref
	36	**/
19	37
20	38	#include <config.h>
…	…
216	234	/**
217	235	* tny_gtk_header_list_model_received_date_sort_func:
218		* @model: The GtkTreeModel the comparison is within
219		* @a : A GtkTreeIter in model
220		* @b : Another GtkTreeIter in model
221		* @user_data: Data passed
222		*
223		* A GtkTreeIterCompareFunc that sorts using the received date
224		*
225		* Return value: a negative integer, zero, or a positive integer
	236	* @model: a #GtkTreeModel the comparison is within
	237	* @a : a #GtkTreeIter in @model
	238	* @b : another #GtkTreeIter in @model
	239	* @user_data: user data passed
	240	*
	241	* A #GtkTreeIterCompareFunc that sorts using the received date
	242	*
	243	* returns: a negative integer, zero, or a positive integer
	244	* since: 1.0
	245	* audience: application-developer, tinymail-developer
226	246	**/
227	247	gint
…	…
248	268	/**
249	269	* tny_gtk_header_list_model_sent_date_sort_func:
250		* @model: The GtkTreeModel the comparison is within
251		* @a : A GtkTreeIter in model
252		* @b : Another GtkTreeIter in model
253		* @user_data: Data passed
254		*
255		* A GtkTreeIterCompareFunc that sorts using the sent date
256		*
257		* Return value: a negative integer, zero, or a positive integer
	270	* @model: the #GtkTreeModel the comparison is within
	271	* @a : a GtkTreeIter in @model
	272	* @b : another GtkTreeIter in @model
	273	* @user_data: user data passed
	274	*
	275	* A @GtkTreeIterCompareFunc that sorts using the sent date
	276	*
	277	* returns: a negative integer, zero, or a positive integer
	278	* since: 1.0
	279	* audience: application-developer, tinymail-developer
258	280	**/
259	281	gint
…	…
1035	1057	/**
1036	1058	* tny_gtk_header_list_model_set_folder:
1037		* @self: ~~A #TnyGtkHeaderListModel instance~~
1038		* @folder: a #TnyFolder ~~instance~~
	1059	* @self: a #TnyGtkHeaderListModel
	1060	* @folder: a #TnyFolder
1039	1061	* @refresh: refresh first
1040		* @callback~~: a #TnyGetHeadersCallback~~
1041		* @status_callback~~: a #TnyStatusCallback~~
	1062	* @callback (null-ok): a #TnyGetHeadersCallback or NULL
	1063	* @status_callback (null-ok): a #TnyStatusCallback or NULL
1042	1064	* @user_data: user data for the callbacks
1043	1065	*
1044		* Set the ~~folder where th~~e #TnyHeader instances are located
	1066	* Set the @folder of @self where #TnyHeader instances are located
1045	1067	*
	1068	* since: 1.0
	1069	* audience: application-developer
1046	1070	**/
1047	1071	void
…	…
1103	1127	* tny_gtk_header_list_model_new:
1104	1128	*
1105		* Create a new #GtkTreeModel ~~instance suitable for showing lots of~~
1106		* ~~#TnyHeader instances~~
1107		*
1108		* ~~Return value: a new #GtkTreeModel instance suitable for showing lots of~~
1109		* ~~#TnyHeader instances~~
	1129	* Create a new #GtkTreeModel for #TnyHeader instances
	1130	*
	1131	* returns (caller-owns): a new #GtkTreeModel for #TnyHeader instances
	1132	* since: 1.0
	1133	* audience: application-developer
1110	1134	**/
1111	1135	GtkTreeModel*
…	…
1122	1146	* GType system helper function
1123	1147	*
1124		* ~~Return value: a~~ GType
	1148	* returns: a #GType
1125	1149	**/
1126	1150	GType
…	…
1177	1201	* GType system helper function
1178	1202	*
1179		* ~~Return value: a~~ GType
	1203	* returns: a #GType
1180	1204	**/
1181	1205	GType

trunk/libtinymailui-gtk/tny-gtk-header-view.c

r2825	r3153
17	17	* Boston, MA 02110-1301, USA.
18	18	*/
	19
	20	/**
	21	* TnyGtkHeaderView:
	22	*
	23	* A simple view for a #TnyHeader
	24	*
	25	* free-function: g_object_unref
	26	**/
19	27
20	28	#include <config.h>
…	…
139	147	* tny_gtk_header_view_new:
140	148	*
141		* Create a new #TnyHeaderView instance implemented for Gtk+
142		*
143		* Return value: a new #TnyHeaderView instance implemented for Gtk+
	149	* Create a new #TnyHeaderView
	150	*
	151	* returns (caller-owns): a new #TnyHeaderView
	152	* since: 1.0
	153	* audience: application-developer
144	154	**/
145	155	TnyHeaderView*
…	…
277	287	* GType system helper function
278	288	*
279		* ~~Return value: a~~ GType
	289	* returns: a #GType
280	290	**/
281	291	GType

trunk/libtinymailui-gtk/tny-gtk-image-mime-part-view.c

r3151	r3153
17	17	* Boston, MA 02110-1301, USA.
18	18	*/
	19
	20	/**
	21	* TnyGtkImageMimePartView:
	22	*
	23	* A #TnyMimePartView that can render a #TnyMimePart that is an image. It's
	24	* recommended to use this type together with a #TnyGtkExpanderMimePartView.
	25	*
	26	* free-function: g_object_unref
	27	**/
19	28
20	29	#include <config.h>
…	…
137	146	/**
138	147	* tny_gtk_image_mime_part_view_new:
139		* @status_callback: a #TnyStatusCallback for when status information happens
140		* @status_user_data: user data for @status_callback
141		*
142		* Create a new #TnyMimePartView for Gtk+. The returned value will inherit
143		* #GtkImage. It's recommended to use a #TnyGtkExpanderMimePartView to wrap this
144		* type.
145		*
146		* Return value: a new #TnyMimePartView instance implemented for Gtk+
	148	* @status_callback (null-ok): a #TnyStatusCallback or NULL
	149	* @status_user_data (null-ok): user data for @status_callback
	150	*
	151	* Create a new #TnyMimePartView for displaying image #TnyMimePartView instances.
	152	* The returned value inherits #GtkImage. It's recommended to use a
	153	* #TnyGtkExpanderMimePartView to wrap this type.
	154	*
	155	* Whenever data must be retrieved or takes long to load, @status_callback will
	156	* be called to let the outside world know about what this compenent is doing.
	157	*
	158	* returns (caller-owns): a new #TnyMimePartView for images
	159	* since: 1.0
	160	* audience: application-developer
147	161	**/
148	162	TnyMimePartView*

trunk/libtinymailui-gtk/tny-gtk-lockable.c

r2825	r3153
17	17	* Boston, MA 02110-1301, USA.
18	18	*/
	19
	20	/**
	21	* TnyGtkLockable:
	22	*
	23	* A #TnyLockable that has its tny_lockable_lock() and tny_lockable_ulock()
	24	* implemented using gdk_threads_enter() and gdk_threads_leave().
	25	*
	26	* free-function: g_object_unref
	27	**/
19	28
20	29	#include <config.h>
…	…
70	79	* tny_gtk_lockable_new:
71	80	*
72		* Create a #TnyLockable ~~instance that uses gdk_threads_enter and gdk_threads_leave~~
	81	* Create a #TnyLockable that uses gdk_threads_enter() and gdk_threads_leave()
73	82	* as lock and unlock implementations.
74	83	*
75		* Return value: a new #TnyLockable instance implemented for Gtk+
	84	* returns (caller-owns): a new #TnyLockable
	85	* since: 1.0
	86	* audience: application-developer
76	87	**/
77	88	TnyLockable*

trunk/libtinymailui-gtk/tny-gtk-mime-part-save-strategy.c

r3071	r3153
17	17	* Boston, MA 02110-1301, USA.
18	18	*/
	19
	20	/**
	21	* TnyGtkMimePartSaveStrategy:
	22	*
	23	* a #TnyMimePartSaveStrategy that saves a #TnyMimePart using a file dialog
	24	* in Gtk+ and GnomeVFS if available.
	25	*
	26	* free-function: g_object_unref
	27	**/
19	28
20	29	#include <config.h>
…	…
182	191	/**
183	192	* tny_gtk_mime_part_save_strategy_new:
184		* @status_callback~~: a #TnyStatusCallback for when status information happens~~
	193	* @status_callback (null-ok): a #TnyStatusCallback for when status information happens or NULL
185	194	* @status_user_data: user data for @status_callback
186	195	*
187		* Create a new #TnyMimePartSaveStrategy instance implemented for Gtk+. It will
188		* use the GtkFileChooserDialog type and if available support for GnomeVFS.
189		*
190		* Return value: a new #TnyMimePartSaveStrategy instance implemented for Gtk+
	196	* Create a new #TnyMimePartSaveStrategy It will use the #GtkFileChooserDialog type and if
	197	* available consume its support for GnomeVFS.
	198	*
	199	* Whenever data must be retrieved or takes long to load, @status_callback will
	200	* be called to let the outside world know about what this compenent is doing.
	201	*
	202	* returns (caller-owns): a new #TnyMimePartSaveStrategy
	203	* since: 1.0
	204	* audience: application-developer
191	205	**/
192	206	TnyMimePartSaveStrategy*

trunk/libtinymailui-gtk/tny-gtk-msg-view.c

r3070	r3153
17	17	* Boston, MA 02110-1301, USA.
18	18	*/
	19
	20	/**
	21	* TnyGtkMsgView:
	22	*
	23	* a #TnyMsgView for showing a message in Gtk+. It's recommended to wrap instances
	24	* of this type into a #GtkScrolledWindow.
	25	*
	26	* free-function: g_object_unref
	27	**/
	28
19	29
20	30	#include <config.h>
…	…
95	105	/**
96	106	* tny_gtk_msg_view_get_display_html:
97		* @self: ~~A #TnyGtkMsgView instance~~
	107	* @self: a #TnyGtkMsgView
98	108	*
99	109	* Get whether or not to display text/html mime parts
100	110	*
101		* Return value: whether or not to display text/html mime parts
	111	* returns: whether or not to display text/html mime parts
	112	* since: 1.0
	113	* audience: application-developer
102	114	**/
103	115	gboolean
…	…
110	122	/**
111	123	* tny_gtk_msg_view_get_display_rfc822:
112		* @self: ~~A #TnyGtkMsgView instance~~
	124	* @self: a #TnyGtkMsgView
113	125	*
114	126	* Get whether or not to display message/rfc822 mime parts
115	127	*
116		* Return value: whether or not to display message/rfc822 mime parts
	128	* returns: whether or not to display message/rfc822 mime parts
	129	* since: 1.0
	130	* audience: application-developer
117	131	**/
118	132	gboolean
…	…
125	139	/**
126	140	* tny_gtk_msg_view_get_display_attachments:
127		* @self: ~~A #TnyGtkMsgView instance~~
	141	* @self: a #TnyGtkMsgView
128	142	*
129	143	* Get whether or not to display attachments
130	144	*
131		* Return value: whether or not to display attachments
	145	* returns: whether or not to display attachments
	146	* since: 1.0
	147	* audience: application-developer
132	148	**/
133	149	gboolean
…	…
140	156	/**
141	157	* tny_gtk_msg_view_get_display_plain:
142		* @self: ~~A #TnyGtkMsgView instance~~
	158	* @self: a #TnyGtkMsgView
143	159	*
144	160	* Get whether or not to display text/plain mime parts
145	161	*
146		* Return value: whether or not to display text/plain mime parts
	162	* returns: whether or not to display text/plain mime parts
	163	* since: 1.0
	164	* audience: application-developer
147	165	**/
148	166	gboolean
…	…
156	174	/**
157	175	* tny_gtk_msg_view_set_display_html:
158		* @self: ~~A #TnyGtkMsgView instance~~
	176	* @self: a #TnyGtkMsgView
159	177	* @setting: whether or not to display text/html mime parts
160	178	*
…	…
163	181	*
164	182	* Note that these settings only affect the instance in case an overridden
165		* implementation of tny_msg_view_create_mime_part_view_for doesn't handle
	183	* implementation of tny_msg_view_create_mime_part_view_for() doesn't handle
166	184	* creating a viewer for a mime part.
167	185	*
168	186	* So for example in case a more advanced implementation that inherits this
169	187	* type implements viewing a text/html mime part, and will therefore not call
170		* this types original tny_msg_view_create_mime_part_view_for method for the
171		* mime part anymore, the setting isn't used.
	188	* this types original tny_msg_view_create_mime_part_view_for() method for
	189	* the mime part anymore, the setting isn't used.
	190	*
	191	* The effect, by default, of this setting is showing the HTML source code.
	192	*
	193	* since: 1.0
	194	* audience: application-developer
172	195	**/
173	196	void
…	…
181	204	/**
182	205	* tny_gtk_msg_view_set_display_rfc822:
183		* @self: ~~A #TnyGtkMsgView instance~~
	206	* @self: a #TnyGtkMsgView
184	207	* @setting: whether or not to display message/rfc822 mime parts
185	208	*
…	…
187	210	* RFC822 inline message mime parts (forwards). Default is FALSE.
188	211	*
189		* (Note that this support is unimplemented at this moment)
190		*
191	212	* Note that these settings only affect the instance in case an overridden
192		* implementation of tny_msg_view_create_mime_part_view_for doesn't handle
	213	* implementation of tny_msg_view_create_mime_part_view_for() doesn't handle
193	214	* creating a viewer for a mime part.
194	215	*
195	216	* So for example in case a more advanced implementation that inherits this
196	217	* type implements viewing a text/html mime part, and will therefore not call
197		* this types original tny_msg_view_create_mime_part_view_for method for the
198		* mime part anymore, the setting isn't used.
	218	* this types original tny_msg_view_create_mime_part_view_for() method for
	219	* the mime part anymore, the setting isn't used.
	220	*
	221	* since: 1.0
	222	* audience: application-developer
199	223	**/
200	224	void
…	…
209	233	/**
210	234	* tny_gtk_msg_view_set_display_attachments:
211		* @self: ~~A #TnyGtkMsgView instance~~
	235	* @self: a #TnyGtkMsgView
212	236	* @setting: whether or not to display attachment mime parts
213	237	*
…	…
217	241	*
218	242	* Note that these settings only affect the instance in case an overridden
219		* implementation of tny_msg_view_create_mime_part_view_for doesn't handle
	243	* implementation of tny_msg_view_create_mime_part_view_for() doesn't handle
220	244	* creating a viewer for a mime part.
221	245	*
222	246	* So for example in case a more advanced implementation that inherits this
223	247	* type implements viewing a text/html mime part, and will therefore not call
224		* this types original tny_msg_view_create_mime_part_view_for method for the
225		* mime part anymore, the setting isn't used.
	248	* this types original tny_msg_view_create_mime_part_view_for() method for
	249	* the mime part anymore, the setting isn't used.
	250	*
	251	* since: 1.0
	252	* audience: application-developer
226	253	**/
227	254	void
…	…
242	269	*
243	270	* Note that these settings only affect the instance in case an overridden
244		* implementation of tny_msg_view_create_mime_part_view_for doesn't handle
	271	* implementation of tny_msg_view_create_mime_part_view_for() doesn't handle
245	272	* creating a viewer for a mime part.
246	273	*
247	274	* So for example in case a more advanced implementation that inherits this
248	275	* type implements viewing a text/html mime part, and will therefore not call
249		* this types original tny_msg_view_create_mime_part_view_for method for the
250		* mime part anymore, the setting isn't used.
	276	* this types original tny_msg_view_create_mime_part_view_for() method for
	277	* the mime part anymore, the setting isn't used.
	278	*
	279	* since: 1.0
	280	* audience: application-developer
251	281	**/
252	282	void
…	…
303	333	/**
304	334	* tny_gtk_msg_view_set_parented:
305		* @self: a #TnyGtkMsgView ~~instance~~
	335	* @self: a #TnyGtkMsgView
306	336	* @parented: parented or not
307	337	*
308	338	* Set @self as parented. Usually internally used.
	339	*
	340	* since: 1.0
	341	* audience: type-implementer, tinymail-developer
309	342	**/
310	343	void
…	…
318	351	/**
319	352	* tny_gtk_msg_view_set_status_callback:
320		* @status_callback~~: a #TnyStatusCallback~~
321		* @stats_user_data: user data for @status_callback
	353	* @status_callback (null-ok): a #TnyStatusCallback or NULL
	354	* @stats_user_data (null-ok): user data for @status_callback
322	355	*
323	356	* Set the status callback info. This callback can be NULL and will be called
324	357	* when status information happens. You can for example set a progress bar's
325	358	* position here (for for example when downloading of a message takes place).
	359	*
	360	* since: 1.0
	361	* audience: application-developer, type-implementer, tinymail-developer
326	362	**/
327	363	void
…	…
335	371
336	372	/**
337		* tny_gtk_msg_view_set_status_callback:
338		* @status_callback: byref a #TnyStatusCallback
339		* @stats_user_data: byref user data for @status_callback
	373	* tny_gtk_msg_view_get_status_callback:
	374	* @status_callback (out): byref a #TnyStatusCallback
	375	* @stats_user_data (out): byref user data for @status_callback
340	376	*
341	377	* Get the status callback info. Usually internally used.
	378	*
	379	* since: 1.0
	380	* audience: type-implementer, tinymail-developer
342	381	**/
343	382	void
…	…
371	410	/**
372	411	* tny_gtk_msg_view_create_mime_part_view_for_default:
373		* @self: a #TnyGtkMsgView ~~instance~~
374		* @part: a #TnyMimePart ~~instance~~
	412	* @self: a #TnyGtkMsgView
	413	* @part: a #TnyMimePart
375	414	*
376	415	* This is non-public API documentation
…	…
470	509	/**
471	510	* tny_gtk_msg_view_display_part:
472		* @self: a #TnyGtkMsgView ~~instance~~
473		* @part: a #TnyMimePart ~~instance~~
	511	* @self: a #TnyGtkMsgView
	512	* @part: a #TnyMimePart
474	513	*
475	514	* This is non-public API documentation
…	…
557	596	/**
558	597	* tny_gtk_msg_view_display_parts:
559		* @self: a #TnyGtkMsgView ~~instance~~
	598	* @self: a #TnyGtkMsgView
560	599	* @parts: a #TnyList instance containing #TnyMimePart instances
561	600	* @desc: description of the parent part (if any)
…	…
662	701	/**
663	702	* tny_gtk_msg_view_mp_set_part_default:
664		* @self: a #TnyGtkMsgView ~~instance~~
665		* @part: a #TnyMimePart ~~instance~~
	703	* @self: a #TnyGtkMsgView
	704	* @part: a #TnyMimePart
666	705	*
667	706	* This is non-public API documentation
…	…
739	778	* tny_gtk_msg_view_new:
740	779	*
741		* Create a new #TnyMsgView instance implemented for Gtk+
742		*
743		* Return value: a new #TnyMsgView instance implemented for Gtk+
	780	* Create a new #TnyMsgView
	781	*
	782	* returns (caller-owns): a new #TnyMsgView
	783	* since: 1.0
	784	* audience: application-developer
744	785	**/
745	786	TnyMsgView*
…	…
916	957	* GType system helper function
917	958	*
918		* ~~Return value: a~~ GType
	959	* returns: a #GType
919	960	**/
920	961	GType

trunk/libtinymailui-gtk/tny-gtk-msg-window.c

r3040	r3153
22	22	* TnyGtkMsgWindow:
23	23	*
	24	* A #TnyMsgView that is a #GtkWindow too.
	25	*
24	26	* All implementations are rather simple, they all simply forward the instruction
25	27	* to a priv->msg_view instance which is a #TnyMsgView or the decorated one.
26	28	*
27	29	* Next to forwarding the instructions, this implementation also makes sure that
28		* priv->msg_view is embedded in a GtkWindow and that for example the window's
	30	* priv->msg_view is embedded in a #GtkWindow and that for example the window's
29	31	* title is set correctly (and things like that).
30	32	*
…	…
32	34	* message viewer. You can also again decorate it (I would recommend decorating
33	35	* #TnyGtkMsgView in stead, in that case).
	36	*
	37	* free-function: g_object_unref
34	38	**/
35	39
…	…
209	213	/**
210	214	* tny_gtk_msg_window_set_view:
211		* @self: a #TnyGtkMsgView ~~instance~~
	215	* @self: a #TnyGtkMsgView
212	216	* @view: a #TnyMsgView to decorate
213	217	*
214		* Set the @view to decorate with @self. The @view instance must inherit the
215		* #GtkWidget type.
	218	* Set @view to become decorated or windowed by @self. The @view must inherit
	219	* #GtkWidget.
	220	*
	221	* since: 1.0
	222	* audience: application-developer
216	223	**/
217	224	void
…	…
237	244	/**
238	245	* tny_gtk_msg_window_new:
239		* @msgview: a #TnyMsgView to decorate
240		*
241		* Create a GtkWindow that implements #TnyMsgView by decorating @msgview. The
	246	* @msgview: a #TnyMsgView to decorate or wrap with a #GtkWindow
	247	*
	248	* Create a #GtkWindow that implements #TnyMsgView by decorating @msgview. The
242	249	* @view instance must inherit the #GtkWidget type. The returned value will
243	250	* inherit #GtkWindow
244	251	*
245		* Return value: a new #TnyMsgWindow instance implemented for Gtk+
	252	* returns: a new #TnyMsgWindow
	253	* since: 1.0
	254	* audience: application-developer
246	255	**/
247	256	TnyMsgWindow*

trunk/libtinymailui-gtk/tny-gtk-password-dialog.c

r2825	r3153
18	18	*/
19	19
20		/* TODO: Refactory this type to libtinymailui-gtk */
	20	/**
	21	* TnyGtkPasswordDialog:
	22	*
	23	* A #TnyPasswordGetter that will ask the user to enter the password in Gtk+
	24	*
	25	* free-function: g_object_unref
	26	**/
	27
21	28	#include <config.h>
	29
22	30	#include <string.h>
23	31	#include <sys/mman.h>
…	…
121	129	* Create a dialog window that will ask the user for a password
122	130	*
123		* Return value: A new #GtkDialog password dialog instance implemented for Gtk+
	131	* returns (caller-owns): A new #GtkDialog password dialog
	132	* since: 1.0
	133	* audience: application-developer
124	134	**/
125	135	TnyPasswordGetter*

trunk/libtinymailui-gtk/tny-gtk-pixbuf-stream.c

r2975	r3153
17	17	* Boston, MA 02110-1301, USA.
18	18	*/
	19
	20
	21	/**
	22	* TnyGtkPixbufStream:
	23	*
	24	* A #TnyStream for building a #GdkPixbuf from a stream in Tinymail, like when
	25	* streaming a #TnyMimePart that is an image to a #GdkPixbuf that will be used
	26	* by a #GtkImage.
	27	*
	28	* free-function: g_object_unref
	29	**/
	30
19	31	#include <config.h>
	32
	33
20	34	#include <string.h>
21	35	#include <glib.h>
…	…
172	186	* Create an adaptor instance between #TnyStream and #GdkPixbuf
173	187	*
174		* Return value: a new #TnyStream instance
	188	* returns (caller-owns): a new #TnyStream instance
	189	* since: 1.0
	190	* audience: application-developer
175	191	**/
176	192	TnyStream*

trunk/libtinymailui-gtk/tny-gtk-text-buffer-stream.c

r3099	r3153
17	17	* Boston, MA 02110-1301, USA.
18	18	*/
	19
	20	/**
	21	* TnyGtkTextBufferStream:
	22	*
	23	* A #TnyStream for building a #GtkTextBuffer from a stream in Tinymail, like when
	24	* streaming a #TnyMimePart that is a plain text to a #GtkTextBuffer that will be
	25	* used by a #GtkTextView.
	26	*
	27	* free-function: g_object_unref
	28	**/
	29
19	30	#include <config.h>
	31
20	32	#include <string.h>
21	33	#include <glib.h>
…	…
206	218	/**
207	219	* tny_gtk_text_buffer_stream_set_text_buffer:
208		* @self: ~~A #TnyGtkTextBufferStream instance~~
209		* @buffer: ~~The~~ #GtkTextBuffer to write to or read from

Changeset Navigation

Changeset 3153

Legend:

trunk/ChangeLog

trunk/libtinymailui-gtk/tny-gtk-account-list-model.c

trunk/libtinymailui-gtk/tny-gtk-attach-list-model.c

trunk/libtinymailui-gtk/tny-gtk-attachment-mime-part-view.c

trunk/libtinymailui-gtk/tny-gtk-expander-mime-part-view.c

trunk/libtinymailui-gtk/tny-gtk-folder-store-tree-model.c

trunk/libtinymailui-gtk/tny-gtk-header-list-model.c

trunk/libtinymailui-gtk/tny-gtk-header-view.c

trunk/libtinymailui-gtk/tny-gtk-image-mime-part-view.c

trunk/libtinymailui-gtk/tny-gtk-lockable.c

trunk/libtinymailui-gtk/tny-gtk-mime-part-save-strategy.c

trunk/libtinymailui-gtk/tny-gtk-msg-view.c

trunk/libtinymailui-gtk/tny-gtk-msg-window.c

trunk/libtinymailui-gtk/tny-gtk-password-dialog.c

trunk/libtinymailui-gtk/tny-gtk-pixbuf-stream.c

trunk/libtinymailui-gtk/tny-gtk-text-buffer-stream.c