git.maemo.org Git - modest/blob - src/modest-viewer-window.h

   1 /* Copyright (c) 2006, Nokia Corporation
   2  * All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  * * Redistributions of source code must retain the above copyright
   9  *   notice, this list of conditions and the following disclaimer.
  10  * * Redistributions in binary form must reproduce the above copyright
  11  *   notice, this list of conditions and the following disclaimer in the
  12  *   documentation and/or other materials provided with the distribution.
  13  * * Neither the name of the Nokia Corporation nor the names of its
  14  *   contributors may be used to endorse or promote products derived from
  15  *   this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
  18  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  19  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  20  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
  21  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  23  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  24  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  25  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  26  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  27  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 #ifndef __MODEST_VIEWER_WINDOW_H__
  31 #define __MODEST_VIEWER_WINDOW_H__
  32
  33 #include <gtk/gtkwindow.h>
  34
  35 G_BEGIN_DECLS
  36
  37 /* convenience macros */
  38 #define MODEST_TYPE_VIEWER_WINDOW             (modest_viewer_window_get_type())
  39 #define MODEST_VIEWER_WINDOW(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_VIEWER_WINDOW,ModestViewerWindow))
  40 #define MODEST_VIEWER_WINDOW_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_VIEWER_WINDOW,GtkWindow))
  41 #define MODEST_IS_VIEWER_WINDOW(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_VIEWER_WINDOW))
  42 #define MODEST_IS_VIEWER_WINDOW_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_VIEWER_WINDOW))
  43 #define MODEST_VIEWER_WINDOW_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_VIEWER_WINDOW,ModestViewerWindowClass))
  44
  45 typedef struct _ModestViewerWindow      ModestViewerWindow;
  46 typedef struct _ModestViewerWindowClass ModestViewerWindowClass;
  47
  48 struct _ModestViewerWindow {
  49          GtkWindow parent;
  50 };
  51
  52 struct _ModestViewerWindowClass {
  53         GtkWindowClass parent_class;
  54 };
  55
  56 /* member functions */
  57 GType        modest_viewer_window_get_type    (void) G_GNUC_CONST;
  58
  59 GtkWidget*   modest_viewer_window_new (ModestUI *ui, TnyMsgIface *msg);
  60
  61 /**
  62  * modest_viewer_window_get_data:
  63  * @viewer_win: a ModestViewerWindow instance
  64  *
  65  * Retrieves the data pointer that was set at creation of this instance
  66  *
  67  * Returns: the data pointer
  68  */
  69 gpointer modest_viewer_window_get_data(ModestViewerWindow *viewer_win);
  70
  71 /**
  72  * modest_viewer_window_get_tiny_msg_view:
  73  * @viewer_win: a ModestViewerWindow instance
  74  *
  75  * Returns: the ModestTnyMsgView widget from the viewer instance
  76  */
  77 ModestTnyMsgView *modest_viewer_window_get_tiny_msg_view(ModestViewerWindow *viewer_win);
  78
  79
  80 G_END_DECLS
  81
  82 #endif /* __MODEST_VIEWER_WINDOW_H__ */
  83