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