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