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

   1 /* Copyright (c) 2006,2007 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
  31 #ifndef __MODEST_MAIN_WINDOW_H__
  32 #define __MODEST_MAIN_WINDOW_H__
  33
  34 #include <gtk/gtkwidget.h>
  35 #include <widgets/modest-window.h>
  36 #include <widgets/modest-header-view.h>
  37 #include <widgets/modest-folder-view.h>
  38 #include <widgets/modest-msg-view.h>
  39
  40
  41 G_BEGIN_DECLS
  42
  43 /* convenience macros */
  44 #define MODEST_TYPE_MAIN_WINDOW             (modest_main_window_get_type())
  45 #define MODEST_MAIN_WINDOW(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_MAIN_WINDOW,ModestMainWindow))
  46 #define MODEST_MAIN_WINDOW_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_MAIN_WINDOW,ModestWindow))
  47
  48 #define MODEST_IS_MAIN_WINDOW(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_MAIN_WINDOW))
  49 #define MODEST_IS_MAIN_WINDOW_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_MAIN_WINDOW))
  50 #define MODEST_MAIN_WINDOW_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_MAIN_WINDOW,ModestMainWindowClass))
  51
  52 typedef struct _ModestMainWindow      ModestMainWindow;
  53 typedef struct _ModestMainWindowClass ModestMainWindowClass;
  54
  55 struct _ModestMainWindow {
  56         ModestWindow parent;
  57 };
  58
  59 struct _ModestMainWindowClass {
  60         ModestWindowClass parent_class;
  61 };
  62
  63 /*
  64  * MODEST_MAIN_WINDOW_STYLE_SIMPLE: shows only the header list
  65  * MODEST_MAIN_WINDOW_STYLE_SPLIT: shows a right pane with the folder
  66  * tree and a left pane with the header list
  67  */
  68 typedef enum _ModestMainWindowStyle {
  69         MODEST_MAIN_WINDOW_STYLE_SIMPLE,
  70         MODEST_MAIN_WINDOW_STYLE_SPLIT
  71 } ModestMainWindowStyle;
  72
  73 /*
  74  * MODEST_MAIN_WINDOW_FOLDER_CONTENTS_STYLE_HEADERS
  75  * MODEST_MAIN_WINDOW_FOLDER_CONTENTS_STYLE_HEADERS
  76  */
  77 typedef enum _ModestMainWindowContentsStyle {
  78         MODEST_MAIN_WINDOW_CONTENTS_STYLE_HEADERS,
  79         MODEST_MAIN_WINDOW_CONTENTS_STYLE_DETAILS,
  80 } ModestMainWindowContentsStyle;
  81
  82 /**
  83  * modest_main_window_get_type:
  84  *
  85  * get the GType for the ModestMainWindow class
  86  *
  87  * Returns: a GType for ModestMainWindow
  88  */
  89 GType modest_main_window_get_type (void) G_GNUC_CONST;
  90
  91
  92 /**
  93  * modest_main_window_new
  94  *
  95  * instantiates a new ModestMainWindow widget
  96  *
  97  * Returns: a new ModestMainWindow, or NULL in case of error
  98  */
  99 ModestWindow* modest_main_window_new (void);
 100
 101 /*
 102  * we could use the GType instead, but that would require
 103  * that there only on widget of a certain type; that is
 104  * true now, but might not be. Therefore, these types
 105  */
 106 typedef enum {
 107         MODEST_WIDGET_TYPE_HEADER_VIEW,
 108         MODEST_WIDGET_TYPE_FOLDER_VIEW,
 109         MODEST_WIDGET_TYPE_MSG_PREVIEW,
 110
 111         MODEST_WIDGET_TYPE_NUM,
 112 } ModestWidgetType;
 113
 114
 115 /**
 116  * modest_main_window_get_child_widget
 117  *
 118  * get a child window for this window
 119  *
 120  * Returns: a child window or NULL
 121  */
 122 GtkWidget* modest_main_window_get_child_widget (ModestMainWindow *self,
 123                                                 ModestWidgetType widget_type);
 124
 125 /**
 126  * modest_main_window_close_all:
 127  * @self:
 128  *
 129  * this function will ask the user about if the user wants to close
 130  * all the windows or just the main one
 131  *
 132  * Returns: TRUE if the user selected to close all the windows, otherwise FALSE
 133  **/
 134 gboolean   modest_main_window_close_all        (ModestMainWindow *self);
 135
 136
 137 /**
 138  * modest_main_window_set_style:
 139  * @self: the #ModestMainWindow
 140  * @style: a #ModestMainWindowStyle that will be set
 141  *
 142  * sets the style of the main window, a splitview with folders at
 143  * the left and messages at the right, or the simple view, with just
 144  * messages.
 145  **/
 146 void       modest_main_window_set_style        (ModestMainWindow *self,
 147                                                 ModestMainWindowStyle style);
 148
 149 /**
 150  * modest_main_window_get_style:
 151  * @self:
 152  *
 153  * gets the current show style of the main window
 154  *
 155  * Return value: the current #ModestWindowStyle
 156  **/
 157 ModestMainWindowStyle       modest_main_window_get_style        (ModestMainWindow *self);
 158
 159 /**
 160  * modest_main_window_set_contents_style:
 161  * @self: the #ModestMainWindow
 162  * @style: a #ModestMainWindowContentsStyle that will be set
 163  *
 164  * Shows either the folder details, or the header list of the current
 165  * selected folder
 166  **/
 167 void       modest_main_window_set_contents_style       (ModestMainWindow *self,
 168                                                         ModestMainWindowContentsStyle style);
 169
 170
 171 G_END_DECLS
 172
 173 #endif /* __MODEST_MAIN_WINDOW_H__ */