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 #include <gtk/gtkactiongroup.h>
  36 #include <widgets/modest-window.h>
  37 #include <widgets/modest-edit-msg-window.h>
  38
  39 G_BEGIN_DECLS
  40
  41 /* convenience macros */
  42 #define MODEST_TYPE_UI             (modest_ui_get_type())
  43 #define MODEST_UI(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_UI,ModestUI))
  44 #define MODEST_UI_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_UI,GObject))
  45 #define MODEST_IS_UI(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_UI))
  46 #define MODEST_IS_UI_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_UI))
  47 #define MODEST_UI_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_UI,ModestUIClass))
  48
  49 typedef struct _ModestUI      ModestUI;
  50 typedef struct _ModestUIClass ModestUIClass;
  51
  52 struct _ModestUI {
  53          GObject parent;
  54         /* insert public members, if any */
  55 };
  56
  57 struct _ModestUIClass {
  58         GObjectClass parent_class;
  59         /* insert signal callback declarations, eg. */
  60 };
  61
  62 /**
  63  * modest_ui_get_type:
  64  *
  65  * get the GType for ModestUI
  66  *
  67  * Returns: the GType
  68  */
  69 GType        modest_ui_get_type        (void) G_GNUC_CONST;
  70
  71 /**
  72  * modest_ui_new:
  73  * @account_store: a #TnyAccountStore
  74  *
  75  * Returns: a new ModestUI, or NULL in case of error
  76  */
  77 ModestUI*     modest_ui_new            (TnyAccountStore *account_store);
  78
  79
  80 /**
  81  * modest_ui_main_window:
  82  * @modest_ui: a ModestUI instance
  83  *
  84  * Creates an new main window and returns it. If there is already a
  85  * main window then the current one is returned and no new window is
  86  * created
  87  *
  88  * Returns: a #ModestMainWindow, or NULL in case of error
  89  */
  90 ModestWindow*    modest_ui_main_window    (ModestUI *modest_ui);
  91
  92
  93 /**
  94  * modest_edit_msg_ui_main_window:
  95  * @modest_edit_msg_ui: a ModestEditMsgUI instance
  96  * @edit_type: the type of edit window
  97  *
  98  * Creates an new main window and returns it. If there is already a
  99  * main window then the current one is returned and no new window is
 100  * created
 101  *
 102  * Returns: a #ModestEditMsgWindow, or NULL in case of error
 103  */
 104 ModestWindow*    modest_ui_edit_window    (ModestUI       *modest_ui,
 105                                            ModestEditType  edit_type);
 106
 107
 108 G_END_DECLS
 109 #endif /* __MODEST_UI_H__ */