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

   1 /* Copyright (c) 2009 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_MAILBOXES_WINDOW_H__
  31 #define __MODEST_MAILBOXES_WINDOW_H__
  32
  33 #ifdef MODEST_TOOLKIT_HILDON2
  34 #include <modest-hildon2-window.h>
  35 #endif
  36 #include <widgets/modest-window.h>
  37 #include <widgets/modest-folder-view.h>
  38
  39 G_BEGIN_DECLS
  40
  41 /* convenience macros */
  42 #define MODEST_TYPE_MAILBOXES_WINDOW             (modest_mailboxes_window_get_type())
  43 #define MODEST_MAILBOXES_WINDOW(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_MAILBOXES_WINDOW,ModestMailboxesWindow))
  44 #define MODEST_MAILBOXES_WINDOW_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_MAILBOXES_WINDOW,ModestWindow))
  45
  46 #define MODEST_IS_MAILBOXES_WINDOW(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_MAILBOXES_WINDOW))
  47 #define MODEST_IS_MAILBOXES_WINDOW_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_MAILBOXES_WINDOW))
  48 #define MODEST_MAILBOXES_WINDOW_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_MAILBOXES_WINDOW,ModestMailboxesWindowClass))
  49
  50 typedef struct _ModestMailboxesWindow      ModestMailboxesWindow;
  51 typedef struct _ModestMailboxesWindowClass ModestMailboxesWindowClass;
  52
  53 struct _ModestMailboxesWindow {
  54 #ifdef MODEST_TOOLKIT_HILDON2
  55         ModestHildon2Window parent;
  56 #else
  57         ModestWindow parent;
  58 #endif
  59 };
  60
  61 struct _ModestMailboxesWindowClass {
  62 #ifdef MODEST_TOOLKIT_HILDON2
  63         ModestHildon2WindowClass parent_class;
  64 #else
  65         ModestWindowClass parent_class;
  66 #endif
  67 };
  68
  69 /**
  70  * modest_mailboxes_window_get_type:
  71  *
  72  * get the GType for the ModestMailboxesWindow class
  73  *
  74  * Returns: a GType for ModestMailboxesWindow
  75  */
  76 GType modest_mailboxes_window_get_type (void) G_GNUC_CONST;
  77
  78
  79 /**
  80  * modest_mailboxes_window_new:
  81  * @query: a #TnyMailboxesStoreQuery that specifies the mailboxess to show
  82  *
  83  * instantiates a new ModestMailboxesWindow widget
  84  *
  85  * Returns: a new ModestMailboxesWindow, or NULL in case of error
  86  */
  87 ModestWindow* modest_mailboxes_window_new (const gchar *account_name);
  88
  89 /**
  90  * modest_mailboxes_window_get_mailboxes_view:
  91  * @self: a #ModestMailboxesWindow
  92  *
  93  * get the mailboxes view inside the mailboxes window
  94  */
  95 ModestFolderView *modest_mailboxes_window_get_folder_view (ModestMailboxesWindow *self);
  96
  97 /**
  98  * modest_mailboxes_window_set_account:
  99  * @self: a #ModestMailboxesWindow
 100  * @account_name: a string
 101  *
 102  * Sets the current active account in the mailboxes window.
 103  */
 104 void modest_mailboxes_window_set_account (ModestMailboxesWindow *self,
 105                                           const gchar *account_name);
 106
 107 G_END_DECLS
 108
 109 #endif