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