* deal (optionally) with the gtk2 ui code

[modest] / src / modest-viewer-window.h

diff --git a/src/modest-viewer-window.h b/src/modest-viewer-window.h
index 92d6cdc..00385a4 100644 (file)
--- a/src/modest-viewer-window.h
+++ b/src/modest-viewer-window.h
@@ -1,11 +1,36 @@
-/* modest-viewer-window.h */
-/* insert (c)/licensing information) */
+/* Copyright (c) 2006, Nokia Corporation
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ * * Redistributions of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ *   notice, this list of conditions and the following disclaimer in the
+ *   documentation and/or other materials provided with the distribution.
+ * * Neither the name of the Nokia Corporation nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+ * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+ * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+ * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
+ * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
 
 #ifndef __MODEST_VIEWER_WINDOW_H__
 #define __MODEST_VIEWER_WINDOW_H__
 
 #include <gtk/gtkwindow.h>
-/* other include files */
 
 G_BEGIN_DECLS
 
@@ -22,27 +47,34 @@ typedef struct _ModestViewerWindowClass ModestViewerWindowClass;
 
 struct _ModestViewerWindow {
         GtkWindow parent;
-       /* insert public members, if any */
 };
 
 struct _ModestViewerWindowClass {
        GtkWindowClass parent_class;
-       /* insert signal callback declarations, eg. */
-       /* void (* my_event) (ModestViewerWindow* obj); */
 };
 
 /* member functions */
 GType        modest_viewer_window_get_type    (void) G_GNUC_CONST;
 
-/* typical parameter-less _new function */
-/* if this is a kind of GtkWidget, it should probably return at GtkWidget*, */
-/*    otherwise probably a GObject*. */
 GtkWidget*   modest_viewer_window_new (ModestUI *ui, TnyMsgIface *msg);
 
+/**
+ * modest_viewer_window_get_data:
+ * @viewer_win: a ModestViewerWindow instance
+ *
+ * Retrieves the data pointer that was set at creation of this instance
+ *
+ * Returns: the data pointer
+ */
+gpointer modest_viewer_window_get_data(ModestViewerWindow *viewer_win);
 
-/* fill in other public functions, eg.: */
-/*     void       modest_viewer_window_do_something (ModestViewerWindow *self, const gchar* param); */
-/*     gboolean   modest_viewer_window_has_foo      (ModestViewerWindow *self, gint value); */
+/**
+ * modest_viewer_window_get_tiny_msg_view:
+ * @viewer_win: a ModestViewerWindow instance
+ *
+ * Returns: the ModestTnyMsgView widget from the viewer instance
+ */
+ModestTnyMsgView *modest_viewer_window_get_tiny_msg_view(ModestViewerWindow *viewer_win);
 
 
 G_END_DECLS