git.maemo.org Git - modest/blob - src/modest-ui.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_UI_H__
  31 #define __MODEST_UI_H__
  32
  33 #include <glib-object.h>
  34 #include <tny-account-store.h>
  35
  36 G_BEGIN_DECLS
  37
  38 /* convenience macros */
  39 #define MODEST_TYPE_UI             (modest_ui_get_type())
  40 #define MODEST_UI(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_UI,ModestUI))
  41 #define MODEST_UI_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_UI,GObject))
  42 #define MODEST_IS_UI(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_UI))
  43 #define MODEST_IS_UI_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_UI))
  44 #define MODEST_UI_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_UI,ModestUIClass))
  45
  46 typedef struct _ModestUI      ModestUI;
  47 typedef struct _ModestUIClass ModestUIClass;
  48
  49 struct _ModestUI {
  50          GObject parent;
  51         /* insert public members, if any */
  52 };
  53
  54 struct _ModestUIClass {
  55         GObjectClass parent_class;
  56         /* insert signal callback declarations, eg. */
  57         /* void (* my_event) (ModestUI* obj); */
  58 };
  59
  60 /**
  61  * modest_ui_get_type:
  62  *
  63  * get the GType for ModestUI
  64  *
  65  * Returns: the GType
  66  */
  67 GType        modest_ui_get_type        (void) G_GNUC_CONST;
  68
  69 /**
  70  * modest_ui_new:
  71  * @account_store: a #TnyAccountStore
  72  *
  73  * Returns: a new ModestUI, or NULL in case of error
  74  */
  75 ModestUI*     modest_ui_new            (TnyAccountStore *account_store);
  76
  77
  78 /**
  79  * modest_ui_main_window:
  80  * @modest_ui: a ModestUI instance
  81  *
  82  * Creates an new main window and returns it. If there is already a
  83  * main window then the current one is returned and no new window is
  84  * created
  85  *
  86  * Returns: a #ModestMainWindow, or NULL in case of error
  87  */
  88 GtkWidget*    modest_ui_main_window    (ModestUI *modest_ui);
  89
  90
  91
  92 G_END_DECLS
  93 #endif /* __MODEST_UI_H__ */