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 G_END_DECLS
  68 #endif /* __MODEST_PLUGIN_UI_ACTIONS_H__ */