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