git.maemo.org Git - modest/blob - src/modest-plugin-ui-actions.h

   1 /* Copyright (c) 2008, 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_PLUGIN_UI_ACTIONS_H__
  31 #define __MODEST_PLUGIN_UI_ACTIONS_H__
  32
  33 /* This should contain simple facades for internal ui actions in modest
  34  * that should be available in plugins.
  35  */
  36
  37 #include <gtk/gtk.h>
  38 #include <glib.h>
  39
  40 G_BEGIN_DECLS
  41
  42 /**
  43  * modest_ui_actions_on_delete_account:
  44  * @parent_window: the parent #GtkWindow of the dialog that will be shown
  45  * @account_name: the modest name for the account to be deleted
  46  * @account_display_name: the display name that will be used in the dialog
  47  *
  48  * This function will perform the actions required to delete an
  49  * account. This function assumes that the account to be deleted is
  50  * already disconnected, so the caller must verify that this is the
  51  * case. Otherwise weird behaviours could happen
  52  *
  53  * Returns: TRUE if the account was successfully deleted, FALSE otherwise
  54  **/
  55 gboolean modest_ui_actions_on_delete_account (GtkWindow *parent_window,
  56                                               const gchar *account_name,
  57                                               const gchar *account_display_name);
  58
  59 /**
  60  * modest_ui_actions_on_reload_message:
  61  * @msg_id: a message id
  62  *
  63  * Reload the message if it's currently being shown in a view.
  64  */
  65 void
  66 modest_ui_actions_on_reload_message (const gchar *msg_id);
  67
  68 /**
  69  * modest_ui_actions_reply_calendar:
  70  * @win: parent #ModestWindow
  71  * @header_pairs: #TnyList of #TnyPair of header pairs
  72  *
  73  * this method opens the mail composer with a reply of a message with calendar
  74  * allowing to add @header_pairs with the result of the calendar request.
  75  *
  76  * @win should be a #ModestMsgViewWindow. We don't put the exact type to avoid
  77  * exporting to plugins #ModestMsgViewWindow API
  78  */
  79 void
  80 modest_ui_actions_reply_calendar (ModestWindow *win, TnyList *header_pairs);
  81
  82 /**
  83  * modest_ui_actions_reply_calendar_with_subject:
  84  * @win: parent #ModestWindow
  85  * @subject: a string, or %NULL to use default reply subject
  86  * @header_pairs: #TnyList of #TnyPair of header pairs
  87  *
  88  * this method opens the mail composer with a reply of a message with calendar
  89  * allowing to add @header_pairs with the result of the calendar request.
  90  *
  91  * @win should be a #ModestMsgViewWindow. We don't put the exact type to avoid
  92  * exporting to plugins #ModestMsgViewWindow API
  93  */
  94 void
  95 modest_ui_actions_reply_calendar_with_subject (ModestWindow *win, const gchar *custom_subject, TnyList *header_pairs);
  96
  97 /**
  98  * modest_ui_actions_on_send_msg:
  99  * @window: parent window requesting to send the message
 100  * @msg: a #TnyMsg
 101  *
 102  * This method will send @msg without showing the message editor.
 103  *
 104  * Returns: %TRUE if succesful, %FALSE otherwise
 105  */
 106 gboolean
 107 modest_ui_actions_on_send_msg (ModestWindow *window,
 108                                TnyMsg *msg);
 109
 110 /**
 111  * modest_ui_actions_on_send_custom_msg:
 112  * @account_name: the account name to use for sending
 113  * @from: a string
 114  * @to: a string
 115  * @cc: a string
 116  * @bcc: a string
 117  * @plain_body: a string with body of the message in plain text
 118  * @html_body: a string with body of the message in html (or %NULL if message is only in plain text)
 119  * @attachments_list: a #GList of attachments to add (#TnyMimePart)
 120  * @images_list: a #GList of embedded images to add (#TnyMimePart)
 121  * @references: list of messages this new message refers to
 122  * @in_reply_to: a string with new in-reply-to header
 123  * @priority_flags: the priority of the message as #TnyHeaderFlag mask
 124  * @header_pairs: a #TnyList of #TnyPair with custom headers to add
 125  */
 126 gboolean
 127 modest_ui_actions_on_send_custom_msg (const gchar *account_name,
 128                                       const gchar *from, const gchar *to, const gchar *cc, const gchar *bcc,
 129                                       const gchar *subject,
 130                                       const gchar *plain_body, const gchar *html_body,
 131                                       const GList *attachments_list, const GList *images_list,
 132                                       const gchar *references, const gchar *in_reply_to,
 133                                       TnyHeaderFlags priority_flags, TnyList *header_pairs);
 134
 135 /**
 136  * modest_ui_actions_on_send_custom_msg:
 137  * @transport_account: a #TnyTransportAccount
 138  * @draft_msg: original draft message to delete on sending
 139  * @from: a string
 140  * @to: a string
 141  * @cc: a string
 142  * @bcc: a string
 143  * @plain_body: a string with body of the message in plain text
 144  * @html_body: a string with body of the message in html (or %NULL if message is only in plain text)
 145  * @attachments_list: a #GList of attachments to add (#TnyMimePart)
 146  * @images_list: a #GList of embedded images to add (#TnyMimePart)
 147  * @references: list of messages this new message refers to
 148  * @in_reply_to: a string with new in-reply-to header
 149  * @priority_flags: the priority of the message as #TnyHeaderFlag mask
 150  * @header_pairs: a #TnyList of #TnyPair with custom headers to add
 151  */
 152 gboolean
 153 modest_ui_actions_send_msg_with_transport (TnyTransportAccount *transport_account,
 154                                            TnyMsg *draft_msg,
 155                                            const gchar *from, const gchar *to, const gchar *cc, const gchar *bcc,
 156                                            const gchar *subject,
 157                                            const gchar *plain_body, const gchar *html_body,
 158                                            const GList *attachments_list, const GList *images_list,
 159                                            const gchar *references, const gchar *in_reply_to,
 160                                            TnyHeaderFlags priority_flags, TnyList *header_pairs);
 161
 162 G_END_DECLS
 163 #endif /* __MODEST_PLUGIN_UI_ACTIONS_H__ */