summaryrefslogtreecommitdiffstats
path: root/kmail/kmmainwidget.h
blob: f790ff0f4a4766f79e694719835e10a4bb6f17d9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
/* -*- mode: C++; c-file-style: "gnu" -*-
    This file is part of KMail, the KDE mail client.
    Copyright (c) 2002 Don Sanders <sanders@kde.org>

    Based on the work of Stefan Taferner <taferner@kde.org>

    KMail is free software; you can redistribute it and/or modify it
    under the terms of the GNU General Public License, version 2, as
    published by the Free Software Foundation.

    KMail is distributed in the hope that it will be useful, but
    WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
*/

#ifndef __KMMAINWIDGET
#define __KMMAINWIDGET

#include <kurl.h>
#include <kxmlguiclient.h>
#include <tqguardedptr.h>
#include <tqlistview.h>
#include <tqvbox.h>
#include <tqvaluevector.h>

#include "kmreaderwin.h" //for inline actions
#include "kmkernel.h" // for access to config
#include "messageactions.h"
#include <tdeaction.h>

class TQVBoxLayout;
class TQSplitter;
class TQSignalMapper;

class TDEActionMenu;
class TDEActionCollection;
class TDEConfig;
class TDERadioAction;
class TDEToggleAction;
class KMenuBar;
class KStatusBarLabel;

class KMFolder;
class KMFolderDir;
class KMFolderTree;
class KMFolderTreeItem;
class KMCommand;
class KMMetaFilterActionCommand;
class FolderShortcutCommand;
class KMMessage;
class KMFolder;
class KMAccount;
class KMSystemTray;
class KMHeaders;

template <typename T> class TQValueList;
template <typename T, typename S> class TQMap;
template <typename T> class TQGuardedPtr;

namespace TDEIO {
  class Job;
}

namespace KMail {
  class Vacation;
  class SieveDebugDialog;
  class FolderJob;
  class HeaderListQuickSearch;
  class SearchWindow;
  class ImapAccountBase;
  class FavoriteFolderView;
}

typedef TQMap<int,KMFolder*> KMMenuToFolder;


class KDE_EXPORT KMMainWidget : public TQWidget
{
  Q_OBJECT
  

public:
  KMMainWidget(TQWidget *parent, const char *name,
               KXMLGUIClient *aGUIClient,
               TDEActionCollection *actionCollection,
         TDEConfig*config = KMKernel::config() );
  virtual ~KMMainWidget();
  void destruct();

  /** Read configuration options before widgets are created. */
  virtual void readPreConfig(void);

  /** Read configuration for current folder. */
  virtual void readFolderConfig(void);

  /** Write configuration for current folder. */
  virtual void writeFolderConfig(void);

  /** Read configuration options after widgets are created. */
  virtual void readConfig(void);

  /** Write configuration options. */
  virtual void writeConfig(void);

  /** Easy access to main components of the window. */
  KMReaderWin* messageView(void) const { return mMsgView; }
  KMFolderTree* folderTree(void) const  { return mFolderTree; }
  KMail::FavoriteFolderView *favoriteFolderView() const { return mFavoriteFolderView; }

  static void cleanup();

  TDEAction *action( const char *name ) { return mActionCollection->action( name ); }
  TDEActionMenu *customReplyAction() const { return mCustomReplyActionMenu; }
  TDEActionMenu *customReplyAllAction() const { return mCustomReplyAllActionMenu; }
  TDEActionMenu *forwardMenu() const { return mForwardActionMenu; }
  TDEAction *forwardInlineAction() const { return mForwardInlineAction; }
  TDEAction *forwardAttachedAction() const { return mForwardAttachedAction; }
  TDEAction *forwardDigestAction() const { return mForwardDigestAction; }
  TDEAction *redirectAction() const { return mRedirectAction; }
  TDEActionMenu *customForwardAction() const { return mCustomForwardActionMenu; }
  TDEActionMenu *filterMenu() const { return mFilterMenu; }
  TDEAction *printAction() const { return mPrintAction; }
  TDEAction *trashAction() const { return mTrashAction; }
  TDEAction *deleteAction() const { return mDeleteAction; }
  TDEAction *trashThreadAction() const { return mTrashThreadAction; }
  TDEAction *deleteThreadAction() const { return mDeleteThreadAction; }
  TDEAction *saveAsAction() const { return mSaveAsAction; }
  TDEAction *editAction() const { return mMsgActions->editAction(); }
  TDEAction *useAction() const { return mUseAction; }
  TDEAction *sendAgainAction() const { return mSendAgainAction; }
  TDEAction *applyAllFiltersAction() const { return mApplyAllFiltersAction; }
  TDEAction *findInMessageAction() const { return mFindInMessageAction; }
  TDEAction *saveAttachmentsAction() const { return mSaveAttachmentsAction; }
  TDEAction *openAction() const { return mOpenAction; }
  TDEAction *viewSourceAction() const { return mViewSourceAction; }
  KMail::MessageActions *messageActions() const { return mMsgActions; }

  TDEActionMenu *statusMenu()  const{ return mMsgActions->messageStatusMenu(); }
  TDEActionMenu *threadStatusMenu() const { return mThreadStatusMenu; }
  TDEActionMenu *moveActionMenu() const{ return mMoveActionMenu; }
  TDEActionMenu *mopyActionMenu() const { return mCopyActionMenu; }
  TDEActionMenu *applyFilterActionsMenu() const { return mApplyFilterActionsMenu; }

  TDEToggleAction *watchThreadAction() const { return mWatchThreadAction; }
  TDEToggleAction *ignoreThreadAction() const { return mIgnoreThreadAction; }

  KMHeaders *headers() const { return mHeaders; }
  void toggleSystemTray();

  void updateListFilterAction();

  /** Returns a list of all KMMainWidgets. Warning, the list itself can be 0.
   * @return the list of all main widgets, or 0 if it is not yet initialized */
  static const TQValueList<KMMainWidget*>* mainWidgetList() { return s_mainWidgetList; }

  KMSystemTray *systray() const;

  /** Checks a shortcut against the actioncollection and returns whether it
   * is already used and therefor not valid or not. */
  bool shortcutIsValid( const TDEShortcut& ) const;


  void modifyFolder( KMFolderTreeItem* folderItem );

  /**
   * Enable or disable the global accelerators. This is useful for keyboard
   * navigation inside child widgets like combo boxes.
   */
  void setAccelsEnabled( bool enabled = true );

  /**
   * Sets up action list for forward menu.
  */
  void setupForwardingActionsList();

  KStatusBarLabel* vacationScriptIndicator() const { return mVacationScriptIndicator; }
  void updateVactionScripStatus() { updateVactionScripStatus( mVacationIndicatorActive ); }

public slots:
  void slotMoveMsgToFolder( KMFolder *dest);
  void slotTrashMsg();   // move to trash

  virtual void show();
  virtual void hide();
  /** sven: moved here as public */
  void slotCheckMail();

  /**
   * Select the given folder
   * If the folder is 0 the intro is shown
   */
  void folderSelected( KMFolder*, bool forceJumpToUnread = false );

  /** Reselect current folder */
  void folderSelected();

  /** Select the folder and jump to the next unread msg */
  void folderSelectedUnread( KMFolder* );

  void slotMsgSelected( KMMessage * );
  /**
    Open a separate viewer window containing the specified message.
  */
  void slotMsgActivated( KMMessage * );

  void slotMsgChanged();

  /** Change the current folder, select a message in the current folder */
  void slotSelectFolder(KMFolder*);
  void slotSelectMessage(KMMessage*);

  void slotReplaceMsgByUnencryptedVersion();

  /** Update message menu */
  void updateMessageMenu();
  /** Start a timer to update message actions */
  void startUpdateMessageActionsTimer();
  /** Update message actions */
  void updateMessageActions();

  /** Launch subscription-dialog (server side) */
  void slotSubscriptionDialog();

  /** Launch dialog for local (client side) subscription configuration */
  void slotLocalSubscriptionDialog();

  /** The columns of the foldertree changed */
  void slotFolderTreeColumnsChanged();

  /** Clear and create actions for marked filters */
  void clearFilterActions();
  void initializeFilterActions();

  /** Create IMAP-account-related actions if applicable */
  void initializeIMAPActions() { initializeIMAPActions( true ); }

  /** Create actions for the folder shortcuts. */
  void initializeFolderShortcutActions();

  /** Add, remove or adjust the folder's shortcut. */
  void slotShortcutChanged( KMFolder *folder );

  void updateCustomTemplateMenus();
  void slotEditVacation();

signals:
  void messagesTransfered( bool );
  void captionChangeRequest( const TQString & caption );

protected:
  void setupActions();
  void createWidgets();
  void activatePanners();
  void showMsg( KMReaderWin *win, KMMessage *msg );
  void updateFileMenu();
  void newFromTemplate( KMMessage *msg );

  TDEActionCollection * actionCollection() const { return mActionCollection; }

  /** @return the correct config dialog depending on whether the parent of the mainWidget
   *          is a KPart or a KMMainWindow. When dealing with geometries, use this pointer
   */
  TDEConfig * config();

protected slots:
  void slotCheckOneAccount(int);
  void slotMailChecked( bool newMail, bool sendOnCheck,
                        const TQMap<TQString, int> & newInFolder );
  void getAccountMenu();
  void getTransportMenu();
  void slotHelp();
  void slotFilter();
  void slotPopFilter();
  void slotManageSieveScripts();
  void slotAddrBook();
  void slotImport();
  void slotViewChange();
  void slotCompose();
  void slotPostToML();
  void slotModifyFolder();
  void slotFolderMailingListProperties();
  void slotFolderShortcutCommand();
  void slotExpireFolder();
  void slotExpireAll();
  void slotInvalidateIMAPFolders();
  void slotMarkAllAsRead();
  void slotArchiveFolder();
  void slotRemoveFolder();
  void slotEmptyFolder();
  void slotCompactFolder();
  void slotRefreshFolder();
  void slotTroubleshootFolder();
  void slotCompactAll();
  void slotOverrideHtml();
  void slotOverrideHtmlLoadExt();
  void slotOverrideThread();
  void slotToggleSubjectThreading();
  void slotMessageQueuedOrDrafted();
  void slotUseTemplate();
  //void slotTrashMsg();   // move to trash
  void slotDeleteMsg( bool confirmDelete = true );  // completely delete message
  void slotTrashThread();
  void slotDeleteThread( bool confirmDelete = true );  // completely delete thread
  void slotUndo();
  void slotReadOn();
  void slotSaveMsg();
  void slotOpenMsg();
  void slotSaveAttachments();
  void slotJumpToFolder();
  void slotMoveMsg();
  //void slotMoveMsgToFolder( KMFolder *dest);
  void slotCopyMsgToFolder( KMFolder *dest);
  void slotCopyMsg();
  void slotResendMsg();
  void slotCheckVacation();
  void slotDebugSieve();
  void slotStartCertManager();
  void slotStartWatchGnuPG();
  void slotApplyFilters();
  void slotExpandThread();
  void slotExpandAllThreads();
  void slotCollapseThread();
  void slotCollapseAllThreads();
  void slotShowMsgSrc();
  void slotSetThreadStatusNew();
  void slotSetThreadStatusUnread();
  void slotSetThreadStatusRead();
  void slotSetThreadStatusTodo();
  void slotSetThreadStatusFlag();
  void slotSetThreadStatusWatched();
  void slotSetThreadStatusIgnored();
  void slotToggleUnread();
  void slotToggleTotalColumn();
  void slotToggleSizeColumn();
  void slotSendQueued();
  void slotSendQueuedVia( int item );
  void slotOnlineStatus();
  void slotUpdateOnlineStatus( GlobalSettings::EnumNetworkState::type );
  void slotMsgPopup(KMMessage &msg, const KURL &aUrl, const TQPoint&);
  void slotMarkAll();
  void slotMemInfo();
  void slotSearch();
  void slotSearchClosed();
  void slotFind();
  void slotIntro();
  void slotShowStartupFolder();
  /** Show tip-of-the-day, forced */
  void slotShowTip();
  void slotAntiSpamWizard();
  void slotAntiVirusWizard();
  void slotFilterLogViewer();

  /** Message navigation */
  void slotNextMessage();
  void slotNextUnreadMessage();
  void slotNextImportantMessage();
  void slotNextUnreadFolder();
  void slotPrevMessage();
  void slotPrevUnreadMessage();
  void slotPrevImportantMessage();
  void slotPrevUnreadFolder();

  /** etc. */
  void slotDisplayCurrentMessage();

  void slotShowNewFromTemplate();
  void slotNewFromTemplate( int );

  /** Update the undo action */
  void slotUpdateUndo();

  /** Move selected messages to folder with corresponding to given menuid */
  virtual void moveSelectedToFolder( int menuId );
  /** Copy selected messages to folder with corresponding to given menuid */
  virtual void copySelectedToFolder( int menuId );
  /** Update html and threaded messages preferences in Folder menu. */
  void updateFolderMenu();
  /** Enable or disable the "mark all as read" action. Needs to happen more
   * often the the other updates and is therefor in its own method. */
  void updateMarkAsReadAction();

  /** Settings menu */
  void slotToggleShowQuickSearch();

  /** XML-GUI stuff */
  void slotEditNotifications();
  void slotEditKeys();

  /** changes the caption and displays the foldername */
  void slotChangeCaption(TQListViewItem*);
  void removeDuplicates();

  void slotCustomReplyToMsg( int tid );
  void slotCustomReplyAllToMsg( int tid );
  void slotForwardInlineMsg();
  void slotForwardAttachedMsg();
  void slotForwardDigestMsg();
  void slotRedirectMsg();
  void slotCustomForwardMsg( int tid );
  void slotNoQuoteReplyToMsg();
  void slotSubjectFilter();
  void slotMailingListFilter();
  void slotFromFilter();
  void slotToFilter();
  void slotPrintMsg();
  void slotCreateTodo();

  void slotConfigChanged();
  /** Remove the shortcut actions associated with a folder. */
  void slotFolderRemoved( KMFolder *folder );

  /** Show a splash screen for the longer-lasting operation */
  void slotShowBusySplash();
  /** Show a message screen explaining that we are currently offline, when
   * an online folder is selected. */
  void showOfflinePage();

private:
  /** Get override character encoding. */
  TQString overrideEncoding() const;

  void initializeIMAPActions( bool setState );

  /** Helper which finds the associated account if there is a current
   * folder and it is an imap or disconnected imap one.
   */
  KMail::ImapAccountBase* findCurrentImapAccountBase();

  /** Helper which finds the associated IMAP path if there is a current
   * folder and it is an imap or disconnected imap one.
   */
  TQString findCurrentImapPath();

  /**
   * This function adds or updates the actions of the forward action menu, taking the
   * preference whether to forward inline or as attachment by default into account.
   * This has to be called when that preference config has been changed.
   */
  void setupForwardActions();

  void setupFolderView();

private slots:
  void slotRequestFullSearchFromQuickSearch();
  void updateVactionScripStatus( bool active );

private:
  // Message actions
  TDEAction *mTrashAction, *mDeleteAction, *mTrashThreadAction,
    *mDeleteThreadAction, *mSaveAsAction, *mUseAction,
    *mSendAgainAction, *mApplyAllFiltersAction, *mFindInMessageAction,
    *mSaveAttachmentsAction, *mOpenAction, *mViewSourceAction,
    *mFavoritesCheckMailAction,
    *mMoveMsgToFolderAction;
  // Composition actions
  TDEAction *mPrintAction,
    *mForwardInlineAction, *mForwardAttachedAction, *mForwardDigestAction,
    *mRedirectAction;
  TDEActionMenu *mForwardActionMenu;
  // Filter actions
  TDEActionMenu *mFilterMenu;
  TDEAction *mSubjectFilterAction, *mFromFilterAction, *mToFilterAction,
      *mListFilterAction;
  TDEActionMenu *mTemplateMenu;

  // Custom template actions menu
  TDEActionMenu *mCustomReplyActionMenu,
              *mCustomReplyAllActionMenu,
              *mCustomForwardActionMenu;
  // Signal mappers for custom template actions
  TQSignalMapper *mCustomReplyMapper,
                *mCustomReplyAllMapper,
                *mCustomForwardMapper;

  TDEActionMenu *mThreadStatusMenu,
    *mMoveActionMenu, *mCopyActionMenu, *mApplyFilterActionsMenu;
  TDEAction *mMarkThreadAsNewAction;
  TDEAction *mMarkThreadAsReadAction;
  TDEAction *mMarkThreadAsUnreadAction;
  TDEToggleAction *mToggleThreadTodoAction;
  TDEToggleAction *mToggleThreadFlagAction;

  TDEToggleAction *mWatchThreadAction, *mIgnoreThreadAction;

  /** we need to access those TDEToggleActions from the foldertree-popup */
  TDERadioAction* mUnreadColumnToggle;
  TDERadioAction* mUnreadTextToggle;
  TDEToggleAction* mTotalColumnToggle;
  TDEToggleAction* mSizeColumnToggle;

  TDEToggleAction *mToggleShowQuickSearchAction;

  KMFolderTree *mFolderTree;
  KMail::FavoriteFolderView *mFavoriteFolderView;
  TQWidget      *mFolderView;
  TQSplitter    *mFolderViewParent;
  KMReaderWin  *mMsgView;
  TQSplitter    *mPanner1, *mPanner2;
  TQSplitter    *mFolderViewSplitter;
  KMHeaders    *mHeaders;
  TQVBox        *mSearchAndHeaders;
  TDEToolBar     *mSearchToolBar;
  KMail::HeaderListQuickSearch *mQuickSearchLine;
  TQGuardedPtr<KMFolder> mFolder;
  KMFolder     *mTemplateFolder;
  TQPopupMenu   *mViewMenu, *mBodyPartsMenu;
  TDEAction       *mlistFilterAction;
  bool		mIntegrated;
  bool          mBeepOnNew;
  bool          mConfirmEmpty;
  TQString       mStartupFolder;
  int		mMessageStatusId;
  TQValueList<int> mPanner1Sep, mPanner2Sep;
  KURL          mUrlCurrent;
  TQPopupMenu	*mActMenu;
  TQPopupMenu    *mSendMenu;
  TQPopupMenu	*mFileMenu;

  bool mLongFolderList;

  bool		mStartupDone;
  KMMenuToFolder mMenuToFolder;
  int copyId, moveId, htmlId, threadId;
  bool mHtmlPref, mHtmlLoadExtPref, mThreadPref,
       mFolderHtmlPref, mFolderHtmlLoadExtPref, mFolderThreadPref,
       mFolderThreadSubjPref, mReaderWindowActive, mReaderWindowBelow;
  bool mEnableFavoriteFolderView;

//  TQPopupMenu *mMessageMenu;
  KMail::SearchWindow *mSearchWin;

  TDEAction *mNewFolderAction, *mModifyFolderAction, *mRemoveFolderAction, *mExpireFolderAction,
      *mCompactFolderAction, *mRefreshFolderAction, *mEmptyFolderAction,
      *mMarkAllAsReadAction, *mFolderMailingListPropertiesAction,
      *mFolderShortCutCommandAction, *mTroubleshootFolderAction,
      *mRemoveDuplicatesAction, *mArchiveFolderAction;
  TDEToggleAction *mPreferHtmlAction, *mPreferHtmlLoadExtAction, *mThreadMessagesAction;
  TDEToggleAction *mThreadBySubjectAction;
  TDEToggleAction *mFolderAction, *mHeaderAction, *mMimeAction;

  TQTimer *menutimer;
  TQTimer *mShowBusySplashTimer;

  TQGuardedPtr<KMail::Vacation> mVacation;
#if !defined(NDEBUG)
  TQGuardedPtr<KMail::SieveDebugDialog> mSieveDebugDialog;
#endif
  TDEActionCollection *mActionCollection;
  TDEActionSeparator  *mToolbarActionSeparator;
  TQVBoxLayout *mTopLayout;
  bool mDestructed, mForceJumpToUnread, mShowingOfflineScreen;
  TQPtrList<TDEAction> mFilterMenuActions;
  TQPtrList<TDEAction> mFilterTBarActions;
  TQPtrList<KMMetaFilterActionCommand> mFilterCommands;
  TQDict<FolderShortcutCommand> mFolderShortcutCommands;
  TQGuardedPtr <KMail::FolderJob> mJob;

  TQValueVector<TQString> mCustomTemplates;
  TQPtrList<TDEAction> mCustomTemplateActions;

  KMSystemTray  *mSystemTray;
  TDEConfig *mConfig;
  KXMLGUIClient *mGUIClient;

  KMail::MessageActions *mMsgActions;

  static TQValueList<KMMainWidget*>* s_mainWidgetList;

  KStatusBarLabel *mVacationScriptIndicator;
  bool mVacationIndicatorActive;
};

#endif