summaryrefslogtreecommitdiffstats
path: root/kmail/kmheaders.h
diff options
context:
space:
mode:
authortoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
committertoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
commit460c52653ab0dcca6f19a4f492ed2c5e4e963ab0 (patch)
tree67208f7c145782a7e90b123b982ca78d88cc2c87 /kmail/kmheaders.h
downloadtdepim-460c52653ab0dcca6f19a4f492ed2c5e4e963ab0.tar.gz
tdepim-460c52653ab0dcca6f19a4f492ed2c5e4e963ab0.zip
Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features.
BUG:215923 git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdepim@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
Diffstat (limited to 'kmail/kmheaders.h')
-rw-r--r--kmail/kmheaders.h465
1 files changed, 465 insertions, 0 deletions
diff --git a/kmail/kmheaders.h b/kmail/kmheaders.h
new file mode 100644
index 000000000..40487f8d9
--- /dev/null
+++ b/kmail/kmheaders.h
@@ -0,0 +1,465 @@
+// -*- mode: C++ -*-
+
+#ifndef __KMHEADERS
+#define __KMHEADERS
+
+#include "kmime_util.h"
+#include "headeritem.h"
+using KMail::SortCacheItem;
+using KMail::HeaderItem;
+
+#include <klistview.h>
+#include <kfoldertree.h> // for KPaintInfo
+#include <kmmsgbase.h> // for KMMsgStatus
+
+#include <qwidget.h>
+#include <qstrlist.h>
+#include <qmemarray.h>
+#include <qmap.h>
+#include <qdragobject.h>
+#include <qdict.h>
+#include <qguardedptr.h>
+
+class KMFolder;
+class KMMessage;
+class KMMsgBase;
+class KMCommand;
+class KMMainWidget;
+class KPopupMenu;
+class QPalette;
+class QPixmap;
+class QIconSet;
+class QDateTime;
+
+typedef QPtrList<KMMsgBase> KMMessageList;
+typedef QValueList<Q_UINT32> SerNumList;
+typedef QMap<int,KMFolder*> KMMenuToFolder;
+enum NestingPolicy { AlwaysOpen = 0, DefaultOpen, DefaultClosed, OpenUnread };
+
+
+#define KMAIL_SORT_VERSION 1012
+#define KMAIL_SORT_FILE(x) x->indexLocation() + ".sorted"
+#define KMAIL_SORT_HEADER "## KMail Sort V%04d\n\t"
+#define KMAIL_MAGIC_HEADER_OFFSET 21 //strlen(KMAIL_SORT_HEADER)
+#define KMAIL_MAX_KEY_LEN 16384
+#define KMAIL_RESERVED 3
+
+/** The widget that shows the contents of folders */
+class KMHeaders : public KListView
+{
+ Q_OBJECT
+
+ friend class ::KMail::HeaderItem; // For easy access to the pixmaps
+
+public:
+ KMHeaders(KMMainWidget *owner, QWidget *parent=0, const char *name=0);
+ virtual ~KMHeaders();
+
+ /** A new folder has been selected update the list of headers shown
+ * To override the global settings for jumping to the first unread msg
+ * use @p forceJumpToUnread
+ */
+ virtual void setFolder(KMFolder *, bool forceJumpToUnread = false);
+
+ /** Return the folder whose message headers are being displayed */
+ KMFolder* folder(void) { return mFolder; }
+
+ /** read the config file and update nested state if necessary */
+ void refreshNestedState(void);
+
+ /** Set current message. If id<0 then the first message is shown,
+ if id>count() the last message is shown. */
+ virtual void setCurrentMsg(int msgId);
+
+ /** Get a list of all items in the current thread */
+ QPtrList<QListViewItem> currentThread() const;
+
+ /** Set all messages in the current thread to status @p status
+ or toggle it, if specified. */
+ virtual void setThreadStatus(KMMsgStatus status, bool toggle=false);
+
+ /* Set message status to read if it is new, or unread */
+ virtual void setMsgRead(int msgId);
+
+ /** The following methods processes all selected messages. */
+ virtual void setMsgStatus(KMMsgStatus status, bool toggle=false);
+ virtual void deleteMsg();
+ virtual void applyFiltersOnMsg();
+ virtual void undo();
+ virtual bool canUndo() const;
+ virtual HeaderItem * prepareMove( int *contentX, int *contentY );
+ virtual void finalizeMove( HeaderItem *item, int contentX, int contentY );
+
+ /** If destination is 0 then the messages are deleted, otherwise
+ they are moved to this folder. The second parameter is usefull when the
+ user has already confirmed the move/deletion. */
+ virtual void moveMsgToFolder( KMFolder* destination,
+ bool askForConfirmation=true );
+
+ /** Messages are duplicated and added to given folder.
+ If aMsg is set this one will be written to the destination folder. */
+ virtual void copyMsgToFolder(KMFolder* destination,
+ KMMessage* aMsg = 0);
+
+ /** Resets toBeDeleted and selectable status of all selected items. */
+ virtual void clearSelectableAndAboutToBeDeleted(Q_UINT32 serNum);
+ /** Returns list of selected messages. Mark the corresponding
+ header items to be deleted, if specified. */
+ virtual KMMessageList* selectedMsgs(bool toBeDeleted = false);
+
+ /** Returns the index values of currently selected items */
+ QValueList<int> selectedItems();
+
+ /** Returns the sernums of all selected items. */
+ QValueList<Q_UINT32> selectedSernums();
+
+ /** Returns the sernums of all visible (ie. items with expanded parent, not hidden by
+ eg. the quick search) selected items.
+ */
+ QValueList<Q_UINT32> selectedVisibleSernums();
+
+ /** Returns index of message returned by last getMsg() call */
+ int indexOfGetMsg (void) const { return getMsgIndex; }
+
+ /** Returns pointer to owning main window. */
+ KMMainWidget* owner(void) const { return mOwner; }
+
+ /** PaintInfo pointer */
+ const KPaintInfo *paintInfo(void) const { return &mPaintInfo; }
+
+ /** Read config options. */
+ virtual void readConfig(void);
+
+ /** Read color options and set palette. */
+ virtual void readColorConfig(void);
+
+ /** Return the current message */
+ virtual KMMessage* currentMsg();
+ /** Return the current list view item */
+ virtual HeaderItem* currentHeaderItem();
+ /** Return the index of the message corresponding to the current item */
+ virtual int currentItemIndex();
+ /** Set the current item to the one corresponding to the given msg id */
+ virtual void setCurrentItemByIndex( int msgIdx );
+ /** Set the current item to the one corresponding to the given serial number (slow!) */
+ void setCurrentItemBySerialNum( unsigned long serialNum );
+ /** Return the message id of the top most visible item */
+ virtual int topItemIndex();
+ /** Make the item corresponding to the message with the given id the
+ top most visible item. */
+ virtual void setTopItemByIndex( int aMsgIdx );
+ virtual void setNestedOverride( bool override );
+ virtual void setSubjectThreading( bool subjThreading );
+ /** Double force items to always be open */
+ virtual void setOpen ( QListViewItem *, bool );
+
+ NestingPolicy getNestingPolicy() const { return nestingPolicy; }
+ /** Returns true if the current header list is threaded. */
+ bool isThreaded() const {
+ return mNested != mNestedOverride; // xor
+ }
+
+ /** Find next/prev unread message. Starts at currentItem() if startAt
+ is unset. */
+ virtual int findUnread(bool findNext, int startAt=-1, bool onlyNew = false, bool acceptCurrent = false);
+
+ void highlightMessage(QListViewItem*, bool markitread);
+ void highlightCurrentThread();
+
+ /** return a string relativ to the current time */
+ static QString fancyDate( time_t otime );
+
+ bool noRepaint;
+
+ // filter events for popup
+ bool eventFilter ( QObject *o, QEvent *e );
+
+ /** gets the message represented by the item as a KMMsgBase. */
+ const KMMsgBase * getMsgBaseForItem( const QListViewItem *item ) const;
+
+ // accessors
+ QFont newFont() const { return mNewFont; }
+ QFont unreadFont() const { return mUnreadFont; }
+ QFont importantFont() const { return mImportantFont; }
+ QFont todoFont() const { return mTodoFont; }
+ QFont dateFont() const { return mDateFont; }
+
+ /**
+ Sets the list of copied/cutted messages.
+ @param msgs A list of serial numbers.
+ @param move if true, the messages were cutted
+ */
+ void setCopiedMessages( const QValueList<Q_UINT32> &msgs, bool move );
+
+ /**
+ Returns true if the message with the given serial number has been cut.
+ @param serNum A message serial number.
+ */
+ bool isMessageCut( Q_UINT32 serNum ) const;
+
+signals:
+ /** emitted when the list view item corresponding to this message
+ has been selected */
+ void selected(KMMessage *);
+ /** emitted when the list view item corresponding to this message
+ has been double clicked */
+ void activated(KMMessage *);
+ /** emitted when we might be about to delete messages */
+ void maybeDeleting();
+ /** emitted when the list of messages has been completely rebuilt */
+ void messageListUpdated();
+
+ /** emitted after a new item has been fully built and added to the
+ * list view. We can't use KListView::itemAdded, as that is emitted
+ * from the ctor of the item, at which point the building of the item
+ * is not yet far enough along to update the quick search, which is
+ * what is connected to this signal. */
+ void msgAddedToListView( QListViewItem* );
+
+public slots:
+ /** For when a list view item has been double clicked */
+ void selectMessage(QListViewItem*);
+ /** For when a list view item has been selected */
+ void highlightMessage(QListViewItem*);
+ /** For when righ mouse button is pressed */
+ void slotRMB();
+ /** Refresh list view item corresponding to the messae with the given id */
+ void msgHeaderChanged(KMFolder *folder, int msgId);
+ /** For when the list of messages in a folder has changed */
+ void msgChanged();
+ /** For when the folder has been cleared */
+ void folderCleared();
+ /** For when the folder has been cleared */
+ void folderClosed();
+ /** For when the message with the given message id has been added to a folder */
+ void msgAdded(int);
+ /** For when the message with the given id has been removed for a folder */
+ void msgRemoved( int, QString );
+ /** Make the next header visible scrolling if necessary */
+ void nextMessage();
+ /** Same as nextMessage() but don't clear the current selection */
+ void selectNextMessage();
+ /** Make the previous header visible scrolling if necessary */
+ void prevMessage();
+ /** Same as prevMessage() but don't clear the current selection */
+ void selectPrevMessage();
+ /** Make the nextUnread message header visible scrolling if necessary, returning
+ true if an unread message is found */
+ bool nextUnreadMessage(bool acceptCurrent = false);
+ /** Make the previous message header visible scrolling if necessary, returning
+ true if an unread message is found */
+ bool prevUnreadMessage();
+ /** Focus the next message, but don't select it. */
+ void incCurrentMessage();
+ /** Focus the previous message, but don't select it. */
+ void decCurrentMessage();
+ /** Select the message which currently has focus, if it's not already selected. */
+ void selectCurrentMessage();
+ /** Don't show a drag cursor */
+ void slotNoDrag();
+ /** timer function to set the current time regularly */
+ void resetCurrentTime();
+
+ /** Refresh the list of message headers shown */
+ void reset();
+
+ /** Expands (@p expand == true) or collapses (@p expand == false)
+ the current thread. */
+ void slotExpandOrCollapseThread( bool expand );
+ /** Expands (@p expand == true) or collapses (@p expand == false)
+ all threads */
+ void slotExpandOrCollapseAllThreads( bool expand );
+
+ virtual void ensureCurrentItemVisible();
+
+ /** Select an item and if it is the parent of a closed thread, also
+ recursively select its children. */
+ virtual void setSelected(QListViewItem *item, bool selected);
+
+ /** Select several items by message index
+ * and if they are the parent of a closed thread, also
+ * recursively select their children. */
+ void setSelectedByIndex(QValueList<int> items, bool selected);
+
+ /** switch a column with the given id (see KPaintInfo enum)
+ 1 for activate, 0 for deactivate, -1 for toggle*/
+ void slotToggleColumn(int id, int mode = -1);
+
+ /** Provide information about number of messages in a folder */
+ void setFolderInfoStatus();
+
+protected:
+ static QPixmap *pixNew, *pixUns, *pixDel, *pixRead, *pixRep, *pixSent,
+ *pixQueued, *pixFwd, *pixFlag, *pixWatched, *pixIgnored, *pixSpam, *pixHam,
+ *pixFullySigned, *pixPartiallySigned, *pixUndefinedSigned,
+ *pixFullyEncrypted, *pixPartiallyEncrypted, *pixUndefinedEncrypted,
+ *pixFiller, *pixEncryptionProblematic,
+ *pixSignatureProblematic, *pixAttachment,
+ *pixReadFwd, *pixReadReplied, *pixReadFwdReplied,*pixTodo;
+
+ /** Look for color changes */
+ virtual bool event(QEvent *e);
+
+ /** Overridden to support backing pixmap */
+ virtual void paintEmptyArea( QPainter * p, const QRect & rect );
+
+ /** Ensure the current item is visible */
+ void makeHeaderVisible();
+
+ /** Auxillary method to findUnread */
+ void findUnreadAux( HeaderItem*&, bool &, bool, bool );
+
+ /** Returns message index of first selected message of the messages
+ where the message with the given id is in. This for finding the correct
+ message that shall be the current message after move/delete of multiple
+ messages. */
+ virtual int firstSelectedMsg() const;
+
+ /** Read per-folder config options and apply them. */
+ virtual void readFolderConfig(void);
+
+ /** Write per-folder config options. */
+ virtual void writeFolderConfig(void);
+
+ /** Write global config options. */
+ virtual void writeConfig(void);
+
+ /** Handle shift and control selection */
+ virtual void contentsMousePressEvent(QMouseEvent*);
+ virtual void contentsMouseReleaseEvent(QMouseEvent* e);
+ virtual void keyPressEvent( QKeyEvent * e );
+
+ /** Called when a header is clicked */
+ virtual void setSorting( int column, bool ascending = true);
+
+ /** To initiate a drag operation */
+ void contentsMouseMoveEvent( QMouseEvent *e );
+
+ /** reimplemented in order to update the frame width in case of a changed
+ GUI style */
+ void styleChange( QStyle& oldStyle );
+
+ /** Set the width of the frame to a reasonable value for the current GUI
+ style */
+ void setStyleDependantFrameWidth();
+
+protected slots:
+ /** Move messages corresponding to the selected items to the folder
+ corresponding to the given menuId */
+ virtual void moveSelectedToFolder( int menuId );
+ /** Same thing but copy */
+ virtual void copySelectedToFolder( int menuId );
+ /** Apply the filter Rules to a single message */
+ virtual int slotFilterMsg( KMMessage * );
+ /** dirties the sort order */
+ void dirtySortOrder(int);
+ /** show context menu */
+ void rightButtonPressed( QListViewItem *, const QPoint &, int );
+
+private slots:
+ void slotMoveCompleted( KMCommand * );
+
+ void copyMessages();
+ void cutMessages();
+ void pasteMessages();
+
+ void updateActions();
+
+private:
+ /** Is equivalent to clearing the list and inserting an item for
+ each message in the current folder */
+ virtual void updateMessageList( bool set_selection=false,
+ bool forceJumpToUnread = false );
+
+ /** Currently associated folder */
+ QGuardedPtr<KMFolder> mFolder;
+ /** The KMMainWin for status bar updates */
+ KMMainWidget* mOwner;
+ /** Top most visible item */
+ int mTopItem;
+ /** Index of the current item */
+ int mCurrentItem;
+ /** Serial number of the current item */
+ unsigned long mCurrentItemSerNum;
+ /** Map messages ids into HeaderItems */
+ QMemArray<HeaderItem*> mItems;
+
+ // ===== threading and sorting ==========
+ bool mNested, mNestedOverride, mSubjThreading;
+ NestingPolicy nestingPolicy;
+ int mSortCol;
+ bool mSortDescending;
+
+ struct {
+ uint ascending : 1;
+ uint dirty : 1;
+ short column;
+ uint fakeSort : 1;
+ uint removed : 1;
+ } mSortInfo;
+
+
+ /** */
+ QDict< SortCacheItem > mSortCacheItems;
+ /** */
+ QDict< QPtrList< SortCacheItem > > mSubjectLists;
+ /** */
+ QPtrList<HeaderItem> mImperfectlyThreadedList;
+
+ /** Debugging helpers for outputting the threading data structures. */
+ void printSubjectThreadingTree( );
+ void printThreadingTree( );
+ /** Initializes the mSortCacheItems tree with the contents of the folder */
+ void buildThreadingTree( QMemArray<SortCacheItem *> sortCache );
+ /** Initializes the mSubjectLists tree with the contents of the folder */
+ void buildSubjectThreadingTree( QMemArray<SortCacheItem *> sortCache );
+ /** Find a msg to thread item below */
+ SortCacheItem* findParent(SortCacheItem *item);
+ /** Find a msg to thread item below by subject */
+ SortCacheItem* findParentBySubject(SortCacheItem *item);
+ SortCacheItem* mRoot; // used to represent the list view itself while threading
+
+ /** */
+ void appendItemToSortFile(HeaderItem *);
+ /** */
+ bool writeSortOrder();
+ /** */
+ bool readSortOrder( bool set_selection = false,
+ bool forceJumpToUnread = false );
+
+ /** Updated as side effect of KMHeaders::getMsg */
+ int getMsgIndex;
+ /** ditto */
+ bool getMsgMulti;
+ /** ditto */
+ HeaderItem* getMsgItem;
+ /** @see KMHeaders::selectedMsgs isn't reentrant */
+ KMMessageList mSelMsgBaseList;
+ HeaderItem* mPrevCurrent;
+
+ /** Current colours and backing pixmap */
+ KPaintInfo mPaintInfo;
+
+ QFont mNewFont, mUnreadFont, mImportantFont, mDateFont,mTodoFont;
+
+ /** Icons shown in header */
+ static QIconSet *up, *down;
+ /** Map menu id into a folder */
+ KMMenuToFolder mMenuToFolder;
+
+ /** Drag and drop support */
+ bool mMousePressed;
+ /** ditto */
+ QPoint mPressPos;
+
+ KMime::DateFormatter mDate;
+ bool mReaderWindowActive;
+
+ /** popup to switch columns */
+ KPopupMenu* mPopup;
+
+ // copied messages
+ QValueList<Q_UINT32> mCopiedMessages;
+ bool mMoveMessages;
+}; // class
+#endif