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