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