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

   1 /* Copyright (c) 2008 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_FOLDER_WINDOW_H__
  31 #define __MODEST_FOLDER_WINDOW_H__
  32
  33 #ifdef MODEST_TOOLKIT_HILDON2
  34 #include <modest-hildon2-window.h>
  35 #else
  36 #include <modest-shell-window.h>
  37 #endif
  38 #include <widgets/modest-window.h>
  39 #include <widgets/modest-folder-view.h>
  40 #include <tny-folder-store-query.h>
  41
  42 G_BEGIN_DECLS
  43
  44 /* convenience macros */
  45 #define MODEST_TYPE_FOLDER_WINDOW             (modest_folder_window_get_type())
  46 #define MODEST_FOLDER_WINDOW(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_FOLDER_WINDOW,ModestFolderWindow))
  47 #define MODEST_FOLDER_WINDOW_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_FOLDER_WINDOW,ModestWindow))
  48
  49 #define MODEST_IS_FOLDER_WINDOW(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_FOLDER_WINDOW))
  50 #define MODEST_IS_FOLDER_WINDOW_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_FOLDER_WINDOW))
  51 #define MODEST_FOLDER_WINDOW_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_FOLDER_WINDOW,ModestFolderWindowClass))
  52
  53 typedef struct _ModestFolderWindow      ModestFolderWindow;
  54 typedef struct _ModestFolderWindowClass ModestFolderWindowClass;
  55
  56 struct _ModestFolderWindow {
  57 #ifdef MODEST_TOOLKIT_HILDON2
  58         ModestHildon2Window parent;
  59 #else
  60         ModestShellWindow parent;
  61 #endif
  62 };
  63
  64 struct _ModestFolderWindowClass {
  65 #ifdef MODEST_TOOLKIT_HILDON2
  66         ModestHildon2WindowClass parent_class;
  67 #else
  68         ModestShellWindowClass parent_class;
  69 #endif
  70 };
  71
  72 /**
  73  * modest_folder_window_get_type:
  74  *
  75  * get the GType for the ModestFolderWindow class
  76  *
  77  * Returns: a GType for ModestFolderWindow
  78  */
  79 GType modest_folder_window_get_type (void) G_GNUC_CONST;
  80
  81
  82 /**
  83  * modest_folder_window_new:
  84  * @query: a #TnyFolderStoreQuery that specifies the folders to show
  85  *
  86  * instantiates a new ModestFolderWindow widget
  87  *
  88  * Returns: a new ModestFolderWindow, or NULL in case of error
  89  */
  90 ModestWindow* modest_folder_window_new (TnyFolderStoreQuery *query);
  91
  92 /**
  93  * modest_folder_window_get_folder_view:
  94  * @self: a #ModestFolderWindow
  95  *
  96  * get the folder view inside the folder window
  97  */
  98 ModestFolderView *modest_folder_window_get_folder_view (ModestFolderWindow *self);
  99
 100 /**
 101  * modest_folder_window_set_account:
 102  * @self: a #ModestFolderWindow
 103  * @account_name: a string
 104  *
 105  * Sets the current active account in the folder window.
 106  */
 107 void modest_folder_window_set_account (ModestFolderWindow *self,
 108                                        const gchar *account_name);
 109
 110 /**
 111  * modest_folder_window_set_mailbox:
 112  * @self: a #ModestFolderWindow
 113  * @mailbox: a string
 114  *
 115  * Sets the current mailbox in the folder window.
 116  */
 117 void modest_folder_window_set_mailbox (ModestFolderWindow *self,
 118                                        const gchar *mailbox);
 119
 120 /**
 121  * modest_folder_Window_transfer_mode_enabled:
 122  * @self: a #ModestFolderWindow
 123  *
 124  * if @self is in transfer mode (progress hint visible)
 125  *
 126  * Returns: %TRUE if progress hint should be visible
 127  */
 128 gboolean modest_folder_window_transfer_mode_enabled (ModestFolderWindow *self);
 129
 130 G_END_DECLS
 131
 132 #endif