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