Changeset 981

Timestamp:

10/12/06 20:31:55

Author:

pvanhoof

Message:

--

Files:

• trunk/libtinymailui/tny-mime-part-view.c (modified) (1 diff)
• trunk/libtinymailui/tny-mime-part-view.h (modified) (3 diffs)

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

@@ -21 +21 @@
-
-#include <tny-mime-part-view.h>
+
+
+
+/**
+ * tny_mime_part_view_set_save_strategy:
+ * @self: A #TnyMimePartView instance
+ * @strategy: A TnySaveStrategy instace
+ *
+ * Set the strategy used for saving mime-parts
+ * 
+ * Implementors: This method should set the strategy for saving a mime-part.
+ * The user interface of the view can for example have a popup menu in its
+ * attachment viewer that will have to use this strategy for saving the
+ * mime-part.
+ *
+ * Example:
+ * <informalexample><programlisting>
+ * static void 
+ * tny_my_mime_part_view_set_save_strategy (TnyMimePartView *self_i, TnySaveStrategy *strat)
+ * {
+ *      TnyMyMimePartView *self = TNY_MY_MIME_PART_VIEW (self_i);
+ *      if (self->save_strategy)
+ *            g_object_unref (G_OBJECT (self->save_strategy));
+ *      self->save_strategy = g_object_ref (G_OBJECT (strat));
+ * }
+ * static void
+ * tny_my_mime_part_view_finalize (TnyMyMimePartView *self)
+ * {
+ *      if (self->save_strategy))
+ *              g_object_unref (G_OBJECT (self->save_strategy));
+ * }
+ * </programlisting></informalexample>
+ *
+ * <informalexample><programlisting>
+ * static void 
+ * tny_my_mime_part_view_on_save_clicked (TnyMimePartView *self, TnyMimePart *attachment)
+ * {
+ *     TnyMyMimePartView *self = TNY_MY_MIME_PART_VIEW (self_i);
+ *     tny_save_strategy_save (self->save_strategy, attachment);
+ * }
+ * </programlisting></informalexample>
+ *
+ * The idea is that devices can have a specific such strategy. For example a
+ * strategy that sends it to another computer or a strategy that saves it to
+ * a flash disk. However. In the mime part view component, you don't care about
+ * that. You only care about the API of the save-strategy interface.
+ *
+ **/
+void 
+tny_mime_part_view_set_save_strategy (TnyMimePartView *self, TnySaveStrategy *strategy)
+{
+#ifdef DEBUG
+        if (!TNY_MIME_PART_VIEW_GET_IFACE (self)->set_save_strategy_func)
+                g_critical ("You must implement tny_mime_part_view_set_save_strategy\n");
+#endif
+
+        TNY_MIME_PART_VIEW_GET_IFACE (self)->set_save_strategy_func (self, strategy);
+        return;
+}
+
+/**
+ * tny_mime_part_view_is_supported:
+ * @self: A #TnyMimePartView instance
+ * @part: a #TnyMimePart instance
+ *
+ * Figures out whether or not the view supports viewing a mime part 
+ *
+ * Return value: Whether or not the view supports viewing this mime-part
+ **/
+gboolean 
+tny_mime_part_view_is_supported (TnyMimePartView *self, TnyMimePart *part)
+{
+#ifdef DEBUG
+        if (!TNY_MIME_PART_VIEW_GET_IFACE (self)->can_view_func)
+                g_critical ("You must implement tny_mime_part_view_is_supported\n");
+#endif
+
+        TNY_MIME_PART_VIEW_GET_IFACE (self)->can_view_func (self, part);
+        return;
+}
-
-

trunk/libtinymailui/tny-mime-part-view.h

@@ -25 +25 @@
-
-#include <tny-mime-part.h>
+#include <tny-save-strategy.h>
-
-G_BEGIN_DECLS
@@ -40 +41 @@
-        GTypeInterface parent;
-
+        void (*set_save_strategy_func) (TnyMimePartView *self, TnySaveStrategy *strategy);
+        gboolean (*can_view_func) (TnyMimePartView *self, TnyMimePart *part);
-        void (*view_mime_part_func) (TnyMimePartView *self, TnyMimePart *part);
-        void (*clear_func) (TnyMimePartView *self); 
@@ -46 +49 @@
-GType tny_mime_part_view_get_type();
-
+void tny_mime_part_view_set_save_strategy (TnyMimePartView *self, TnySaveStrategy *strategy);
+gboolean tny_mime_part_view_is_supported (TnyMimePartView *self, TnyMimePart *part);
+void tny_mime_part_view_clear (TnyMimePartView *self);
+void tny_mime_part_view_set_mime_part (TnyMimePartView *self, TnyMimePart *mime_part);
+
+
-G_END_DECLS
-