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