git.maemo.org Git - modest/blob - src/modest-ui-actions.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_ACTIONS_H__
  31 #define __MODEST_UI_ACTIONS_H__
  32
  33 #include <widgets/modest-main-window.h>
  34 #include <widgets/modest-msg-edit-window.h>
  35 #include <widgets/modest-recpt-view.h>
  36 #include "modest-mail-operation.h"
  37 #include "modest-tny-send-queue.h"
  38
  39 G_BEGIN_DECLS
  40
  41 /* Menu & toolbar actions */
  42 void     modest_ui_actions_on_about         (GtkAction *action, ModestWindow *win);
  43
  44 void     modest_ui_actions_refresh_message_window_after_delete (ModestMsgViewWindow* win);
  45
  46 void     modest_ui_actions_on_delete_message     (GtkAction *action, ModestWindow *win);
  47
  48 void     modest_ui_actions_on_delete_message_or_folder (GtkAction *action, ModestWindow *win);
  49
  50 void     modest_ui_actions_on_quit          (GtkAction *action, ModestWindow *win);
  51
  52 void     modest_ui_actions_on_close_window  (GtkAction *action, ModestWindow *win);
  53
  54 void     modest_ui_actions_on_new_account      (GtkAction *action, ModestWindow *win);
  55
  56 void     modest_ui_actions_on_accounts      (GtkAction *action, ModestWindow *win);
  57
  58 void     modest_ui_actions_on_smtp_servers  (GtkAction *action, ModestWindow *win);
  59
  60 void     modest_ui_actions_on_add_to_contacts   (GtkAction *action, ModestWindow *win);
  61
  62 void     modest_ui_actions_on_select_contacts (GtkAction *action, ModestMsgEditWindow *win);
  63
  64 void     modest_ui_actions_on_open_addressbook (GtkAction *action, ModestWindow *win);
  65
  66 void     modest_ui_actions_on_check_names (GtkAction *action, ModestMsgEditWindow *win);
  67
  68 void     modest_ui_actions_on_new_msg       (GtkAction *action, ModestWindow *win);
  69
  70 void     modest_ui_actions_on_open           (GtkAction *action, ModestWindow *win);
  71
  72 void     modest_ui_actions_on_reply         (GtkAction *action, ModestWindow *win);
  73
  74 void     modest_ui_actions_on_forward       (GtkAction *action, ModestWindow *win);
  75
  76 void     modest_ui_actions_on_sort          (GtkAction *action, ModestWindow *window);
  77
  78 void     modest_ui_actions_on_reply_all     (GtkAction *action, ModestWindow *win);
  79
  80 void     modest_ui_actions_on_next          (GtkAction *action, ModestWindow *main_window);
  81
  82 void     modest_ui_actions_on_prev          (GtkAction *action, ModestWindow *main_window);
  83
  84 void     modest_ui_actions_on_details       (GtkAction *action, ModestWindow *win);
  85
  86 void     modest_ui_actions_on_move_to       (GtkAction *action, ModestWindow *win);
  87
  88 void     modest_ui_actions_on_settings      (GtkAction *action, ModestWindow *win);
  89
  90 /**
  91  * modest_ui_actions_on_help:
  92  * @action: a #GtkAction
  93  * @win: a #ModestWindow
  94  *
  95  * Shows the help dialog
  96  **/
  97 void     modest_ui_actions_on_help          (GtkAction *action, GtkWindow *win);
  98
  99 /**
 100  * modest_ui_actions_toggle_folders_view:
 101  * @action: the #GtkAction
 102  * @main_window: the #ModestMainWindow
 103  *
 104  * this action switches between split view (with a folders pane at the
 105  * left) and simple view without the left pane with the folders and
 106  * accounts. Maybe it's only useful for Maemo code, but as it uses
 107  * generic code could be used also by the GNOME UI
 108  **/
 109 void     modest_ui_actions_toggle_folders_view       (GtkAction *action,
 110                                                       ModestMainWindow *main_window);
 111
 112 /**
 113  * modest_ui_actions_toggle_folders_view:
 114  * @action: the #GtkAction
 115  * @main_window: the #ModestMainWindow
 116  *
 117  * this action shows or hides the column titles of the header list
 118  * view. It also enables the two lines rendering for the treeview rows
 119  **/
 120 void     modest_ui_actions_toggle_header_list_view    (GtkAction *action,
 121                                                        ModestMainWindow *main_window);
 122
 123 /* Widget actions */
 124 void     modest_ui_actions_on_header_selected          (ModestHeaderView *folder_view,
 125                                                         TnyHeader *header,
 126                                                         ModestMainWindow *main_window);
 127 void     modest_ui_actions_on_header_activated         (ModestHeaderView *folder_view,
 128                                                          TnyHeader *header,
 129                                                          ModestMainWindow *main_window);
 130
 131 void     modest_ui_actions_on_folder_selection_changed (ModestFolderView *folder_view,
 132                                                          TnyFolderStore *folder_store,
 133                                                          gboolean selected,
 134                                                          ModestMainWindow *main_window);
 135
 136 void     modest_ui_actions_on_item_not_found           (ModestHeaderView *header_view,
 137                                                          ModestItemType type,
 138                                                          ModestWindow *window);
 139
 140 void     modest_ui_actions_on_msg_link_hover           (ModestMsgView *msgview, const gchar* link,
 141                                                         ModestWindow *win);
 142
 143 void     modest_ui_actions_on_msg_link_clicked         (ModestMsgView *msgview, const gchar* link,
 144                                                         ModestWindow *win);
 145
 146 void     modest_ui_actions_on_msg_link_contextual      (ModestMsgView *msgview, const gchar* link,
 147                                                         ModestWindow *win);
 148
 149 void     modest_ui_actions_on_msg_attachment_clicked   (ModestMsgView *msgview, TnyMimePart *mime_part,
 150                                                         ModestWindow *win);
 151
 152 void     modest_ui_actions_on_msg_recpt_activated   (ModestMsgView *msgview, const gchar *address,
 153                                                      ModestWindow *win);
 154
 155 void     modest_ui_actions_on_send                     (GtkWidget *widget,
 156                                                         ModestMsgEditWindow *edit_window);
 157 void     modest_ui_actions_on_save_to_drafts           (GtkWidget *widget,
 158                                                         ModestMsgEditWindow *edit_window);
 159
 160
 161 void     modest_ui_actions_on_toggle_bold              (GtkToggleAction *action,
 162                                                         ModestMsgEditWindow *window);
 163
 164 void     modest_ui_actions_on_toggle_italics           (GtkToggleAction *action,
 165                                                         ModestMsgEditWindow *window);
 166
 167 void     modest_ui_actions_on_toggle_bullets           (GtkToggleAction *action,
 168                                                         ModestMsgEditWindow *window);
 169
 170 void     modest_ui_actions_on_change_justify      (GtkRadioAction *action,
 171                                                    GtkRadioAction *selected,
 172                                                    ModestMsgEditWindow *window);
 173
 174 void     modest_ui_actions_on_select_editor_color      (GtkAction *action,
 175                                                         ModestMsgEditWindow *window);
 176
 177 void     modest_ui_actions_on_select_editor_background_color      (GtkAction *action,
 178                                                                    ModestMsgEditWindow *window);
 179
 180 void     modest_ui_actions_on_insert_image             (GtkAction *action,
 181                                                         ModestMsgEditWindow *window);
 182
 183 void     modest_ui_actions_on_attach_file             (GtkAction *action,
 184                                                        ModestMsgEditWindow *window);
 185
 186 void     modest_ui_actions_on_remove_attachments      (GtkAction *action,
 187                                                        ModestMsgEditWindow *window);
 188 void     modest_ui_actions_on_mark_as_read            (GtkAction *action,
 189                                                        ModestWindow *window);
 190
 191 void     modest_ui_actions_on_mark_as_unread            (GtkAction *action,
 192                                                          ModestWindow *window);
 193
 194 void     modest_ui_actions_cancel_send (GtkAction *action,  ModestWindow *win);
 195
 196 /**
 197  * modest_ui_actions_do_send_receive_all:
 198  * @win: the window that will be used as source of the refresh mail operation
 199  *
 200  * Refreshes all the accounts
 201  **/
 202 void    modest_ui_actions_do_send_receive_all          (ModestWindow *win);
 203
 204 /**
 205  * modest_ui_actions_do_send_receive:
 206  * @account_name: the name of the Modest account or NULL
 207  * @win: the window that will be used as source of the refresh mail operation
 208  *
 209  * Refreshes the Modest account whose name is passed as argument. If
 210  * NULL is passed as #account_name then this function refreses the
 211  * active account, if no active account is defined then it picks the
 212  * default account
 213  **/
 214 void    modest_ui_actions_do_send_receive              (const gchar *account_name,
 215                                                         ModestWindow *win);
 216
 217 /**
 218  * modest_ui_actions_on_send_receive:
 219  * @action: a #GtkAction
 220  * @win: the Window that contains the action
 221  *
 222  * Handles the activation of the send receive action, for example
 223  * clicks on Send&Receive button in the main toolbar
 224  **/
 225 void    modest_ui_actions_on_send_receive              (GtkAction *action,
 226                                                         ModestWindow *win);
 227
 228 void     modest_ui_actions_on_new_folder               (GtkAction *action,
 229                                                         ModestMainWindow *main_window);
 230
 231 void     modest_ui_actions_on_rename_folder            (GtkAction *action,
 232                                                         ModestMainWindow *main_window);
 233
 234 void     modest_ui_actions_on_delete_folder            (GtkAction *action,
 235                                                          ModestMainWindow *main_window);
 236
 237 void     modest_ui_actions_on_move_folder_to_trash_folder     (GtkAction *action,
 238                                                                ModestMainWindow *main_window);
 239
 240 void     modest_ui_actions_on_password_requested (TnyAccountStore *account_store,
 241                                                   const gchar* server_account_name,
 242                                                   gchar **username, gchar **password, gboolean *cancel,
 243                                                   gboolean *remember, ModestMainWindow *main_window);
 244
 245 void     modest_ui_actions_on_undo                     (GtkAction *action,
 246                                                         ModestWindow *window);
 247
 248 void     modest_ui_actions_on_redo                     (GtkAction *action,
 249                                                         ModestWindow *window);
 250
 251 void     modest_ui_actions_on_cut                      (GtkAction *action,
 252                                                         ModestWindow *window);
 253
 254 void     modest_ui_actions_on_copy                     (GtkAction *action,
 255                                                         ModestWindow *window);
 256
 257 void     modest_ui_actions_on_zoom_plus (GtkAction *action,
 258                                          ModestWindow *window);
 259
 260 void     modest_ui_actions_on_zoom_minus (GtkAction *action,
 261                                           ModestWindow *window);
 262
 263 void     modest_ui_actions_on_toggle_fullscreen    (GtkToggleAction *toggle,
 264                                                     ModestWindow *window);
 265
 266 void     modest_ui_actions_on_change_fullscreen    (GtkAction *action,
 267                                                     ModestWindow *window);
 268
 269 void     modest_ui_actions_on_paste                    (GtkAction *action,
 270                                                         ModestWindow *window);
 271
 272 void     modest_ui_actions_on_select_all               (GtkAction *action,
 273                                                         ModestWindow *window);
 274
 275 void     modest_ui_actions_on_toggle_show_cc (GtkToggleAction *toggle,
 276                                               ModestMsgEditWindow *window);
 277
 278 void     modest_ui_actions_on_toggle_show_bcc (GtkToggleAction *toggle,
 279                                               ModestMsgEditWindow *window);
 280
 281 void     modest_ui_actions_on_change_zoom              (GtkRadioAction *action,
 282                                                         GtkRadioAction *selected,
 283                                                         ModestWindow *window);
 284
 285 void     modest_ui_actions_msg_edit_on_change_priority (GtkRadioAction *action,
 286                                                         GtkRadioAction *selected,
 287                                                         ModestWindow *window);
 288
 289 void     modest_ui_actions_msg_edit_on_change_file_format (GtkRadioAction *action,
 290                                                            GtkRadioAction *selected,
 291                                                            ModestWindow *window);
 292
 293 void     modest_ui_actions_msg_edit_on_select_font (GtkAction *action,
 294                                                     ModestMsgEditWindow *window);
 295
 296 /**
 297  * modest_ui_actions_on_toggle_toolbar:
 298  * @toggle:
 299  * @window:
 300  *
 301  * Hides/Shows the toolbars of the #ModestWindow instances
 302  **/
 303 void     modest_ui_actions_on_toggle_toolbar           (GtkToggleAction *toggle,
 304                                                         ModestWindow *window);
 305
 306 /**
 307  * modest_ui_actions_on_folder_display_name_changed:
 308  * @folder_view: a #ModestFolderView
 309  * @display_name: the new window title
 310  * @window: a #GtkWindow
 311  *
 312  * Sets the title of the window to the value specified by
 313  * display_name. This function is used typically as a callback to the
 314  * "folder-display-name-changed" signal from the #ModestFolderView
 315  **/
 316 void     modest_ui_actions_on_folder_display_name_changed (ModestFolderView *folder_view,
 317                                                            const gchar *display_name,
 318                                                            GtkWindow *window);
 319
 320 void     modest_ui_actions_view_attachment                (GtkAction *action,
 321                                                            ModestWindow *window);
 322
 323 void     modest_ui_actions_save_attachments               (GtkAction *action,
 324                                                            ModestWindow *window);
 325
 326 void     modest_ui_actions_remove_attachments             (GtkAction *action,
 327                                                            ModestWindow *window);
 328
 329 /**
 330  * modest_ui_actions_on_retrieve_msg_contents:
 331  * @action: the #GtkAction
 332  * @window: the #ModestWindow that issues the action
 333  *
 334  * Retrieve the contents of the selected messages in the header view
 335  **/
 336 void     modest_ui_actions_on_retrieve_msg_contents       (GtkAction *action,
 337                                                            ModestWindow *window);
 338
 339 void
 340 modest_ui_actions_check_window_dimming_rules (ModestWindow *window);
 341
 342 /**
 343  * modest_ui_actions_move_folder_error_handler:
 344  * @mail_op: a #ModestMailOperation
 345  * @user_data: user data
 346  *
 347  * manages an error in a mail operation that tries to move a folder
 348  **/
 349 void     modest_ui_actions_move_folder_error_handler      (ModestMailOperation *mail_op,
 350                                                            gpointer user_data);
 351 /**
 352  * modest_ui_actions_send-receive_error_handler:
 353  * @mail_op: a #ModestMailOperation
 354  * @user_data: user data
 355  *
 356  * manages an error in a mail operation that tries to execute
 357  * a send&receive operation.
 358  **/
 359 void     modest_ui_actions_send_receive_error_handler      (ModestMailOperation *mail_op,
 360                                                             gpointer user_data);
 361
 362 /**
 363  * modest_ui_actions_on_search_messages:
 364  * @action: a #GtkAction
 365  * @window: a #ModestWindow
 366  *
 367  * Shows the search messages dialog
 368  **/
 369 void     modest_ui_actions_on_search_messages             (GtkAction *action,
 370                                                            ModestWindow *window);
 371
 372 /**
 373  * modest_ui_actions_on_find_in_page:
 374  * @action: a #GtkToggleAction
 375  * @window: a #ModestWindow
 376  *
 377  * Toggles the visibility of the find in page toolbar
 378  **/
 379 void     modest_ui_actions_on_toggle_find_in_page             (GtkToggleAction *action,
 380                                                                ModestWindow *window);
 381
 382 /**
 383  * modest_ui_actions_msg_retrieval_check
 384  * @mail_op: a #ModestMailOperation
 385  * @header: a #TnyHeader
 386  * @msg: a #TnyMsg
 387  *
 388  * This function checks that the message has been retrieved
 389  * successfully. It it was not the case it unregisters the header from
 390  * the window manager because it won't do it automatically unless the
 391  * operation run fine
 392  *
 393  * Returns: TRUE if the operation was OK, otherwise FALSE
 394  **/
 395 gboolean modest_ui_actions_msg_retrieval_check                (ModestMailOperation *mail_op,
 396                                                                TnyHeader *header,
 397                                                                TnyMsg *msg);
 398
 399
 400 /**
 401  * modest_ui_actions_get_msgs_full_error_handler
 402  * @mail_op: a #ModestMailOperation
 403  *
 404  * Error handler for message retrieval operations like
 405  * modest_mail_operation_get_msg or
 406  * modest_mail_operation_get_msgs_full
 407  **/
 408 void     modest_ui_actions_get_msgs_full_error_handler         (ModestMailOperation *mail_op,
 409                                                                 gpointer user_data);
 410
 411 /* Show the account creation wizard dialog.
 412  * returns: TRUE if an account was created. FALSE if the user cancelled.
 413  */
 414 gboolean modest_ui_actions_run_account_setup_wizard (ModestWindow *win);
 415
 416 gint modest_ui_actions_msgs_move_to_confirmation (ModestWindow *win,
 417                                                   TnyFolder *dest_folder,
 418                                                   gboolean delete,
 419                                                   TnyList *headers);
 420
 421 /*
 422  * modest_ui_actions_on_send_queue_error_happened:
 423  *
 424  * Method for handling errors in send queues
 425  */
 426 void modest_ui_actions_on_send_queue_error_happened (TnySendQueue *self,
 427                                                      TnyHeader *header,
 428                                                      TnyMsg *msg,
 429                                                      GError *err,
 430                                                      gpointer user_data);
 431
 432 /*
 433  * modest_ui_actions_on_send_queue_status_changed:
 434  *
 435  * Method for handling changes in the status of the messages in the send queues
 436  */
 437 void modest_ui_actions_on_send_queue_status_changed (ModestTnySendQueue *send_queue,
 438                                                      gchar *msg_id,
 439                                                      guint status,
 440                                                      gpointer user_data);
 441
 442 /**
 443  * Opens a new message editor for composing
 444  * @param win Modest main window (can be NULL)
 445  * @param to_str "To:" header, or NULL
 446  * @param cc_str "Cc:" header, or NULL
 447  * @param bcc_str "Bcc:" header, or NULL
 448  * @param subject_str Subject of the message, or NULL
 449  * @param body_str Body of the message (without signature), or NULL
 450  * @param attachments List of file URIs to attach
 451  */
 452 void modest_ui_actions_compose_msg (ModestWindow *win,
 453                                     const gchar *to_str,
 454                                     const gchar *cc_str,
 455                                     const gchar *bcc_str,
 456                                     const gchar *subject_str,
 457                                     const gchar *body_str,
 458                                     GSList *attachments);
 459
 460 void modest_ui_actions_on_account_connection_error (GtkWindow *parent_window,
 461                                                     TnyAccount *account);
 462
 463 G_END_DECLS
 464 #endif /* __MODEST_UI_ACTIONS_H__ */