git.maemo.org Git - modest/blob - src/widgets/modest-account-view.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_ACCOUNT_VIEW_H__
  31 #define __MODEST_ACCOUNT_VIEW_H__
  32
  33 #include "modest-account-mgr.h"
  34 #include <gtk/gtktreeview.h>
  35
  36 G_BEGIN_DECLS
  37
  38 /* convenience macros */
  39 #define MODEST_TYPE_ACCOUNT_VIEW             (modest_account_view_get_type())
  40 #define MODEST_ACCOUNT_VIEW(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_ACCOUNT_VIEW,ModestAccountView))
  41 #define MODEST_ACCOUNT_VIEW_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_ACCOUNT_VIEW,GtkTreeView))
  42 #define MODEST_IS_ACCOUNT_VIEW(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_ACCOUNT_VIEW))
  43 #define MODEST_IS_ACCOUNT_VIEW_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_ACCOUNT_VIEW))
  44 #define MODEST_ACCOUNT_VIEW_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_ACCOUNT_VIEW,ModestAccountViewClass))
  45
  46 typedef struct _ModestAccountView      ModestAccountView;
  47 typedef struct _ModestAccountViewClass ModestAccountViewClass;
  48
  49 struct _ModestAccountView {
  50          GtkTreeView parent;
  51 };
  52
  53 struct _ModestAccountViewClass {
  54         GtkTreeViewClass parent_class;
  55 };
  56
  57
  58 /**
  59  * modest_account_view_get_type
  60  *
  61  * Gets the #GType for the account view class
  62  *
  63  * Returns: the #GType
  64  **/
  65 GType        modest_account_view_get_type    (void) G_GNUC_CONST;
  66
  67
  68 /**
  69  * modest_account_view_new:
  70  * @account_view: a #ModestAccountView
  71  *
  72  * Create a new acccount view widget = ie, a list with accounts
  73  *
  74  * Returns: a new account view widget, or NULL in case of error
  75  **/
  76 ModestAccountView*   modest_account_view_new         (ModestAccountMgr *account_mgr);
  77
  78
  79 /**
  80  * modest_account_view_get_selected_account:
  81  * @account_view: a #ModestAccountView
  82  *
  83  * Gets the name of the account currently selected
  84  *
  85  * Returns: the name of the selected account or NULL if none is
  86  * selected
  87  **/
  88 gchar*   modest_account_view_get_selected_account    (ModestAccountView *account_view);
  89
  90 G_END_DECLS
  91
  92 #endif /* __MODEST_ACCOUNT_VIEW_H__ */
  93