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
  38 G_BEGIN_DECLS
  39
  40 /* Menu & toolbar actions */
  41 void     modest_ui_actions_on_about         (GtkAction *action, ModestWindow *win);
  42
  43 void     modest_ui_actions_on_delete_message     (GtkAction *action, ModestWindow *win);
  44
  45 void     modest_ui_actions_on_delete_message_or_folder (GtkAction *action, ModestWindow *win);
  46
  47 void     modest_ui_actions_on_quit          (GtkAction *action, ModestWindow *win);
  48
  49 void     modest_ui_actions_on_close_window  (GtkAction *action, ModestWindow *win);
  50
  51 void     modest_ui_actions_on_new_account      (GtkAction *action, ModestWindow *win);
  52
  53 void     modest_ui_actions_on_accounts      (GtkAction *action, ModestWindow *win);
  54
  55 void     modest_ui_actions_on_smtp_servers  (GtkAction *action, ModestWindow *win);
  56
  57 void     modest_ui_actions_on_add_to_contacts   (GtkAction *action, ModestWindow *win);
  58
  59 void     modest_ui_actions_on_select_contacts (GtkAction *action, ModestMsgEditWindow *win);
  60
  61 void     modest_ui_actions_on_open_addressbook (GtkAction *action, ModestWindow *win);
  62
  63 void     modest_ui_actions_on_check_names (GtkAction *action, ModestMsgEditWindow *win);
  64
  65 void     modest_ui_actions_on_new_msg       (GtkAction *action, ModestWindow *win);
  66
  67 void     modest_ui_actions_on_open           (GtkAction *action, ModestWindow *win);
  68
  69 void     modest_ui_actions_on_reply         (GtkAction *action, ModestWindow *win);
  70
  71 void     modest_ui_actions_on_forward       (GtkAction *action, ModestWindow *win);
  72
  73 void     modest_ui_actions_on_sort          (GtkAction *action, ModestWindow *window);
  74
  75 void     modest_ui_actions_on_reply_all     (GtkAction *action, ModestWindow *win);
  76
  77 void     modest_ui_actions_on_next          (GtkAction *action, ModestWindow *main_window);
  78
  79 void     modest_ui_actions_on_prev          (GtkAction *action, ModestWindow *main_window);
  80
  81 void     modest_ui_actions_on_details       (GtkAction *action, ModestWindow *win);
  82
  83 void     modest_ui_actions_on_move_to       (GtkAction *action, ModestWindow *win);
  84
  85 void     modest_ui_actions_on_settings      (GtkAction *action, ModestWindow *win);
  86
  87 /**
  88  * modest_ui_actions_on_help:
  89  * @action: a #GtkAction
  90  * @win: a #ModestWindow
  91  *
  92  * Shows the help dialog
  93  **/
  94 void     modest_ui_actions_on_help          (GtkAction *action, ModestWindow *win);
  95
  96 /**
  97  * modest_ui_actions_toggle_folders_view:
  98  * @action: the #GtkAction
  99  * @main_window: the #ModestMainWindow
 100  *
 101  * this action switches between split view (with a folders pane at the
 102  * left) and simple view without the left pane with the folders and
 103  * accounts. Maybe it's only useful for Maemo code, but as it uses
 104  * generic code could be used also by the GNOME UI
 105  **/
 106 void     modest_ui_actions_toggle_folders_view       (GtkAction *action,
 107                                                       ModestMainWindow *main_window);
 108
 109 /**
 110  * modest_ui_actions_toggle_folders_view:
 111  * @action: the #GtkAction
 112  * @main_window: the #ModestMainWindow
 113  *
 114  * this action shows or hides the column titles of the header list
 115  * view. It also enables the two lines rendering for the treeview rows
 116  **/
 117 void     modest_ui_actions_toggle_header_list_view    (GtkAction *action,
 118                                                        ModestMainWindow *main_window);
 119
 120 /* Widget actions */
 121 void     modest_ui_actions_on_header_selected          (ModestHeaderView *folder_view,
 122                                                         TnyHeader *header,
 123                                                         ModestMainWindow *main_window);
 124 void     modest_ui_actions_on_header_activated         (ModestHeaderView *folder_view,
 125                                                          TnyHeader *header,
 126                                                          ModestMainWindow *main_window);
 127
 128 void     modest_ui_actions_on_folder_selection_changed (ModestFolderView *folder_view,
 129                                                          TnyFolderStore *folder_store,
 130                                                          gboolean selected,
 131                                                          ModestMainWindow *main_window);
 132
 133 void     modest_ui_actions_on_item_not_found           (ModestHeaderView *header_view,
 134                                                          ModestItemType type,
 135                                                          ModestWindow *window);
 136
 137 void     modest_ui_actions_on_msg_link_hover           (ModestMsgView *msgview, const gchar* link,
 138                                                         ModestWindow *win);
 139
 140 void     modest_ui_actions_on_msg_link_clicked         (ModestMsgView *msgview, const gchar* link,
 141                                                         ModestWindow *win);
 142
 143 void     modest_ui_actions_on_msg_link_contextual      (ModestMsgView *msgview, const gchar* link,
 144                                                         ModestWindow *win);
 145
 146 void     modest_ui_actions_on_msg_attachment_clicked   (ModestMsgView *msgview, TnyMimePart *mime_part,
 147                                                         ModestWindow *win);
 148
 149 void     modest_ui_actions_on_msg_recpt_activated   (ModestMsgView *msgview, const gchar *address,
 150                                                      ModestWindow *win);
 151
 152 void     modest_ui_actions_on_send                     (GtkWidget *widget,
 153                                                         ModestMsgEditWindow *edit_window);
 154 void     modest_ui_actions_on_save_to_drafts           (GtkWidget *widget,
 155                                                         ModestMsgEditWindow *edit_window);
 156
 157
 158 void     modest_ui_actions_on_toggle_bold              (GtkToggleAction *action,
 159                                                         ModestMsgEditWindow *window);
 160
 161 void     modest_ui_actions_on_toggle_italics           (GtkToggleAction *action,
 162                                                         ModestMsgEditWindow *window);
 163
 164 void     modest_ui_actions_on_toggle_bullets           (GtkToggleAction *action,
 165                                                         ModestMsgEditWindow *window);
 166
 167 void     modest_ui_actions_on_change_justify      (GtkRadioAction *action,
 168                                                    GtkRadioAction *selected,
 169                                                    ModestMsgEditWindow *window);
 170
 171 void     modest_ui_actions_on_select_editor_color      (GtkAction *action,
 172                                                         ModestMsgEditWindow *window);
 173
 174 void     modest_ui_actions_on_select_editor_background_color      (GtkAction *action,
 175                                                                    ModestMsgEditWindow *window);
 176
 177 void     modest_ui_actions_on_insert_image             (GtkAction *action,
 178                                                         ModestMsgEditWindow *window);
 179
 180 void     modest_ui_actions_on_attach_file             (GtkAction *action,
 181                                                        ModestMsgEditWindow *window);
 182
 183 void     modest_ui_actions_on_remove_attachments      (GtkAction *action,
 184                                                        ModestMsgEditWindow *window);
 185 void     modest_ui_actions_on_mark_as_read            (GtkAction *action,
 186                                                        ModestWindow *window);
 187
 188 void     modest_ui_actions_on_mark_as_unread            (GtkAction *action,
 189                                                          ModestWindow *window);
 190
 191 void     modest_ui_actions_cancel_send (GtkAction *action,  ModestWindow *win);
 192
 193 /**
 194  * modest_ui_actions_do_send_receive_all:
 195  * @win: the window that will be used as source of the refresh mail operation
 196  *
 197  * Refreshes all the accounts
 198  **/
 199 void    modest_ui_actions_do_send_receive_all          (ModestWindow *win);
 200
 201 /**
 202  * modest_ui_actions_do_send_receive:
 203  * @account_name: the name of the Modest account or NULL
 204  * @win: the window that will be used as source of the refresh mail operation
 205  *
 206  * Refreshes the Modest account whose name is passed as argument. If
 207  * NULL is passed as #account_name then this function refreses the
 208  * active account, if no active account is defined then it picks the
 209  * default account
 210  **/
 211 void    modest_ui_actions_do_send_receive              (const gchar *account_name,
 212                                                         ModestWindow *win);
 213
 214 /**
 215  * modest_ui_actions_on_send_receive:
 216  * @action: a #GtkAction
 217  * @win: the Window that contains the action
 218  *
 219  * Handles the activation of the send receive action, for example
 220  * clicks on Send&Receive button in the main toolbar
 221  **/
 222 void    modest_ui_actions_on_send_receive              (GtkAction *action,
 223                                                         ModestWindow *win);
 224
 225 void     modest_ui_actions_on_new_folder               (GtkAction *action,
 226                                                         ModestMainWindow *main_window);
 227
 228 void     modest_ui_actions_on_rename_folder            (GtkAction *action,
 229                                                         ModestMainWindow *main_window);
 230
 231 void     modest_ui_actions_on_delete_folder            (GtkAction *action,
 232                                                          ModestMainWindow *main_window);
 233
 234 void     modest_ui_actions_on_move_folder_to_trash_folder     (GtkAction *action,
 235                                                                ModestMainWindow *main_window);
 236
 237 /*
 238 void     modest_ui_actions_on_connection_changed    (TnyDevice *device, gboolean online,
 239                                                      ModestMainWindow *main_window);
 240 */
 241
 242 void     modest_ui_actions_on_password_requested (TnyAccountStore *account_store,
 243                                                   const gchar* server_account_name,
 244                                                   gchar **username, gchar **password, gboolean *cancel,
 245                                                   gboolean *remember, ModestMainWindow *main_window);
 246
 247 void     modest_ui_actions_on_undo                     (GtkAction *action,
 248                                                         ModestWindow *window);
 249
 250 void     modest_ui_actions_on_redo                     (GtkAction *action,
 251                                                         ModestWindow *window);
 252
 253 void     modest_ui_actions_on_cut                      (GtkAction *action,
 254                                                         ModestWindow *window);
 255
 256 void     modest_ui_actions_on_copy                     (GtkAction *action,
 257                                                         ModestWindow *window);
 258
 259 void     modest_ui_actions_on_zoom_plus (GtkAction *action,
 260                                          ModestWindow *window);
 261
 262 void     modest_ui_actions_on_zoom_minus (GtkAction *action,
 263                                           ModestWindow *window);
 264
 265 void     modest_ui_actions_on_toggle_fullscreen    (GtkToggleAction *toggle,
 266                                                     ModestWindow *window);
 267
 268 void     modest_ui_actions_on_change_fullscreen    (GtkAction *action,
 269                                                     ModestWindow *window);
 270
 271 void     modest_ui_actions_on_paste                    (GtkAction *action,
 272                                                         ModestWindow *window);
 273
 274 void     modest_ui_actions_on_select_all               (GtkAction *action,
 275                                                         ModestWindow *window);
 276
 277 void     modest_ui_actions_on_toggle_show_cc (GtkToggleAction *toggle,
 278                                               ModestMsgEditWindow *window);
 279
 280 void     modest_ui_actions_on_toggle_show_bcc (GtkToggleAction *toggle,
 281                                               ModestMsgEditWindow *window);
 282
 283 void     modest_ui_actions_on_change_zoom              (GtkRadioAction *action,
 284                                                         GtkRadioAction *selected,
 285                                                         ModestWindow *window);
 286
 287 void     modest_ui_actions_msg_edit_on_change_priority (GtkRadioAction *action,
 288                                                         GtkRadioAction *selected,
 289                                                         ModestWindow *window);
 290
 291 void     modest_ui_actions_msg_edit_on_change_file_format (GtkRadioAction *action,
 292                                                            GtkRadioAction *selected,
 293                                                            ModestWindow *window);
 294
 295 void     modest_ui_actions_msg_edit_on_select_font (GtkAction *action,
 296                                                     ModestMsgEditWindow *window);
 297
 298 /**
 299  * modest_ui_actions_on_toggle_toolbar:
 300  * @toggle:
 301  * @window:
 302  *
 303  * Hides/Shows the toolbars of the #ModestWindow instances
 304  **/
 305 void     modest_ui_actions_on_toggle_toolbar           (GtkToggleAction *toggle,
 306                                                         ModestWindow *window);
 307
 308 /**
 309  * modest_ui_actions_on_folder_display_name_changed:
 310  * @folder_view: a #ModestFolderView
 311  * @display_name: the new window title
 312  * @window: a #GtkWindow
 313  *
 314  * Sets the title of the window to the value specified by
 315  * display_name. This function is used typically as a callback to the
 316  * "folder-display-name-changed" signal from the #ModestFolderView
 317  **/
 318 void     modest_ui_actions_on_folder_display_name_changed (ModestFolderView *folder_view,
 319                                                            const gchar *display_name,
 320                                                            GtkWindow *window);
 321
 322 void     modest_ui_actions_view_attachment                (GtkAction *action,
 323                                                            ModestWindow *window);
 324
 325 void     modest_ui_actions_save_attachments               (GtkAction *action,
 326                                                            ModestWindow *window);
 327
 328 void     modest_ui_actions_remove_attachments             (GtkAction *action,
 329                                                            ModestWindow *window);
 330
 331 /**
 332  * modest_ui_actions_on_retrieve_msg_contents:
 333  * @action: the #GtkAction
 334  * @window: the #ModestWindow that issues the action
 335  *
 336  * Retrieve the contents of the selected messages in the header view
 337  **/
 338 void     modest_ui_actions_on_retrieve_msg_contents       (GtkAction *action,
 339                                                            ModestWindow *window);
 340
 341 void
 342 modest_ui_actions_on_email_menu_activated (GtkAction *action,
 343                                           ModestWindow *window);
 344
 345 void
 346 modest_ui_actions_on_edit_menu_activated (GtkAction *action,
 347                                           ModestWindow *window);
 348
 349 void
 350 modest_ui_actions_on_view_menu_activated (GtkAction *action,
 351                                           ModestWindow *window);
 352
 353 void
 354 modest_ui_actions_on_tools_menu_activated (GtkAction *action,
 355                                           ModestWindow *window);
 356
 357 void
 358 modest_ui_actions_on_attachment_menu_activated (GtkAction *action,
 359                                                 ModestWindow *window);
 360
 361 void
 362 modest_ui_actions_on_toolbar_csm_menu_activated (GtkAction *action,
 363                                                  ModestWindow *window);
 364
 365 void
 366 modest_ui_actions_on_folder_view_csm_menu_activated (GtkAction *action,
 367                                                      ModestWindow *window);
 368
 369 void
 370 modest_ui_actions_on_header_view_csm_menu_activated (GtkAction *action,
 371                                                      ModestWindow *window);
 372
 373 void
 374 modest_ui_actions_check_toolbar_dimming_rules (ModestWindow *window);
 375
 376 /**
 377  * modest_ui_actions_move_folder_error_handler:
 378  * @mail_op: a #ModestMailOperation
 379  * @user_data: user data
 380  *
 381  * manages an error in a mail operation that tries to move a folder
 382  **/
 383 void     modest_ui_actions_move_folder_error_handler      (ModestMailOperation *mail_op,
 384                                                            gpointer user_data);
 385 /**
 386  * modest_ui_actions_send-receive_error_handler:
 387  * @mail_op: a #ModestMailOperation
 388  * @user_data: user data
 389  *
 390  * manages an error in a mail operation that tries to execute
 391  * a send&receive operation.
 392  **/
 393 void     modest_ui_actions_send_receive_error_handler      (ModestMailOperation *mail_op,
 394                                                             gpointer user_data);
 395
 396 /**
 397  * modest_ui_actions_on_search_messages:
 398  * @action: a #GtkAction
 399  * @window: a #ModestWindow
 400  *
 401  * Shows the search messages dialog
 402  **/
 403 void     modest_ui_actions_on_search_messages             (GtkAction *action,
 404                                                            ModestWindow *window);
 405
 406 /**
 407  * modest_ui_actions_on_find_in_page:
 408  * @action: a #GtkToggleAction
 409  * @window: a #ModestWindow
 410  *
 411  * Toggles the visibility of the find in page toolbar
 412  **/
 413 void     modest_ui_actions_on_toggle_find_in_page             (GtkToggleAction *action,
 414                                                                ModestWindow *window);
 415
 416 /**
 417  * modest_ui_actions_msg_retrieval_check
 418  * @mail_op: a #ModestMailOperation
 419  * @header: a #TnyHeader
 420  * @msg: a #TnyMsg
 421  *
 422  * This function checks that the message has been retrieved
 423  * successfully. It it was not the case it unregisters the header from
 424  * the window manager because it won't do it automatically unless the
 425  * operation run fine
 426  *
 427  * Returns: TRUE if the operation was OK, otherwise FALSE
 428  **/
 429 gboolean modest_ui_actions_msg_retrieval_check                (ModestMailOperation *mail_op,
 430                                                                TnyHeader *header,
 431                                                                TnyMsg *msg);
 432
 433
 434 /**
 435  * modest_ui_actions_get_msgs_full_error_handler
 436  * @mail_op: a #ModestMailOperation
 437  *
 438  * Error handler for message retrieval operations like
 439  * modest_mail_operation_get_msg or
 440  * modest_mail_operation_get_msgs_full
 441  **/
 442 void     modest_ui_actions_get_msgs_full_error_handler         (ModestMailOperation *mail_op,
 443                                                                 gpointer user_data);
 444
 445
 446 G_END_DECLS
 447 #endif /* __MODEST_UI_ACTIONS_H__ */