MessageList::Pane

MessageList::Pane Class Reference

#include <pane.h>

Inheritance diagram for MessageList::Pane:

Signals

void currentTabChanged ()
 
void forceLostFocus ()
 
void messageActivated (const Akonadi::Item &item)
 
void messageSelected (const Akonadi::Item &item)
 
void messageStatusChangeRequest (const Akonadi::Item &item, const Akonadi::MessageStatus &set, const Akonadi::MessageStatus &clear)
 
void selectionChanged ()
 
void statusMessage (const QString &message)
 

Public Slots

void aggregationMenuAboutToShow ()
 
QItemSelectionModelcreateNewTab ()
 
void selectAll ()
 
void sortOrderMenuAboutToShow ()
 
void themeMenuAboutToShow ()
 

Public Member Functions

 Pane (bool restoreSession, QAbstractItemModel *model, QItemSelectionModel *selectionModel, QWidget *parent=nullptr)
 
virtual MessageList::StorageModelcreateStorageModel (QAbstractItemModel *model, QItemSelectionModel *selectionModel, QObject *parent)
 
QString currentFilterSearchString () const
 
QVector< Akonadi::MessageStatuscurrentFilterStatus () const
 
Akonadi::Collection currentFolder () const
 
Akonadi::Item currentItem () const
 
QItemSelectionModelcurrentItemSelectionModel ()
 
KMime::Message::Ptr currentMessage () const
 
Core::QuickSearchLine::SearchOptions currentOptions () const
 
Akonadi::Item::List currentThreadAsMessageList () const
 
MessageList::Core::MessageItemSetReference currentThreadAsPersistentSet () const
 
void deletePersistentSet (MessageList::Core::MessageItemSetReference ref)
 
bool focusNextMessageItem (MessageList::Core::MessageTypeFilter messageTypeFilter, bool centerItem, bool loop)
 
bool focusPreviousMessageItem (MessageList::Core::MessageTypeFilter messageTypeFilter, bool centerItem, bool loop)
 
void focusQuickSearch (const QString &selectedText=QString())
 
void focusView ()
 
bool getSelectionStats (Akonadi::Item::List &selectedItems, Akonadi::Item::List &selectedVisibleItems, bool *allSelectedBelongToSameThread, bool includeCollapsedChildren=true) const
 
bool isThreaded () const
 
Akonadi::Item::List itemListFromPersistentSet (MessageList::Core::MessageItemSetReference ref)
 
void markMessageItemsAsAboutToBeRemoved (MessageList::Core::MessageItemSetReference ref, bool bMark)
 
void populateStatusFilterCombo ()
 
void reloadGlobalConfiguration ()
 
void resetModelStorage ()
 
void saveCurrentSelection ()
 
bool searchEditHasFocus () const
 
bool selectFirstMessageItem (MessageList::Core::MessageTypeFilter messageTypeFilter, bool centerItem)
 
void selectFocusedMessageItem (bool centerItem)
 
QVector< Akonadi::Item::Id > selectionAsListMessageId (bool includeCollapsedChildren=true) const
 
Akonadi::Item::List selectionAsMessageItemList (bool includeCollapsedChildren=true) const
 
QVector< qlonglong > selectionAsMessageItemListId (bool includeCollapsedChildren=true) const
 
QVector< KMime::Message::PtrselectionAsMessageList (bool includeCollapsedChildren=true) const
 
MessageList::Core::MessageItemSetReference selectionAsPersistentSet (bool includeCollapsedChildren=true) const
 
bool selectionEmpty () const
 
bool selectLastMessageItem (MessageList::Core::MessageTypeFilter messageTypeFilter, bool centerItem)
 
bool selectNextMessageItem (MessageList::Core::MessageTypeFilter messageTypeFilter, MessageList::Core::ExistingSelectionBehaviour existingSelectionBehaviour, bool centerItem, bool loop)
 
bool selectPreviousMessageItem (MessageList::Core::MessageTypeFilter messageTypeFilter, MessageList::Core::ExistingSelectionBehaviour existingSelectionBehaviour, bool centerItem, bool loop)
 
void setAllGroupsExpanded (bool expand)
 
void setAllThreadsExpanded (bool expand)
 
void setCurrentFolder (const Akonadi::Collection &fld, const QModelIndex &etmIndex, bool preferEmptyTab=false, MessageList::Core::PreSelectionMode preSelectionMode=MessageList::Core::PreSelectLastSelected, const QString &overrideLabel=QString())
 
void setCurrentThreadExpanded (bool expand)
 
void setPreferEmptyTab (bool emptyTab)
 
void setQuickSearchClickMessage (const QString &msg)
 
void setXmlGuiClient (KXMLGUIClient *xmlGuiClient)
 
void updateTabIconText (const Akonadi::Collection &collection, const QString &label, const QIcon &icon)
 
void updateTagComboBox ()
 
virtual void writeConfig (bool restoreSession)
 
- Public Member Functions inherited from QTabWidget
 QTabWidget (QWidget *parent)
 
int addTab (QWidget *page, const QIcon &icon, const QString &label)
 
int addTab (QWidget *page, const QString &label)
 
void clear ()
 
QWidgetcornerWidget (Qt::Corner corner) const const
 
int count () const const
 
void currentChanged (int index)
 
int currentIndex () const const
 
QWidgetcurrentWidget () const const
 
bool documentMode () const const
 
Qt::TextElideMode elideMode () const const
 
virtual bool hasHeightForWidth () const const override
 
virtual int heightForWidth (int width) const const override
 
QSize iconSize () const const
 
int indexOf (QWidget *w) const const
 
int insertTab (int index, QWidget *page, const QString &label)
 
int insertTab (int index, QWidget *page, const QIcon &icon, const QString &label)
 
bool isMovable () const const
 
bool isTabEnabled (int index) const const
 
bool isTabVisible (int index) const const
 
virtual QSize minimumSizeHint () const const override
 
void removeTab (int index)
 
void setCornerWidget (QWidget *widget, Qt::Corner corner)
 
void setCurrentIndex (int index)
 
void setCurrentWidget (QWidget *widget)
 
void setDocumentMode (bool set)
 
void setElideMode (Qt::TextElideMode mode)
 
void setIconSize (const QSize &size)
 
void setMovable (bool movable)
 
void setTabBarAutoHide (bool enabled)
 
void setTabEnabled (int index, bool enable)
 
void setTabIcon (int index, const QIcon &icon)
 
void setTabPosition (QTabWidget::TabPosition position)
 
void setTabsClosable (bool closeable)
 
void setTabShape (QTabWidget::TabShape s)
 
void setTabText (int index, const QString &label)
 
void setTabToolTip (int index, const QString &tip)
 
void setTabVisible (int index, bool visible)
 
void setTabWhatsThis (int index, const QString &text)
 
void setUsesScrollButtons (bool useButtons)
 
virtual QSize sizeHint () const const override
 
QTabBartabBar () const const
 
bool tabBarAutoHide () const const
 
void tabBarClicked (int index)
 
void tabBarDoubleClicked (int index)
 
void tabCloseRequested (int index)
 
QIcon tabIcon (int index) const const
 
QTabWidget::TabPosition tabPosition () const const
 
bool tabsClosable () const const
 
QTabWidget::TabShape tabShape () const const
 
QString tabText (int index) const const
 
QString tabToolTip (int index) const const
 
QString tabWhatsThis (int index) const const
 
bool usesScrollButtons () const const
 
QWidgetwidget (int index) const const
 
- Public Member Functions inherited from QWidget
 QWidget (QWidget *parent, Qt::WindowFlags f)
 
bool acceptDrops () const const
 
QString accessibleDescription () const const
 
QString accessibleName () const const
 
QList< QAction * > actions () const const
 
void activateWindow ()
 
void addAction (QAction *action)
 
void addActions (QList< QAction * > actions)
 
void adjustSize ()
 
bool autoFillBackground () const const
 
QPalette::ColorRole backgroundRole () const const
 
QBackingStorebackingStore () const const
 
QSize baseSize () const const
 
QWidgetchildAt (int x, int y) const const
 
QWidgetchildAt (const QPoint &p) const const
 
QRect childrenRect () const const
 
QRegion childrenRegion () const const
 
void clearFocus ()
 
void clearMask ()
 
bool close ()
 
QMargins contentsMargins () const const
 
QRect contentsRect () const const
 
Qt::ContextMenuPolicy contextMenuPolicy () const const
 
QCursor cursor () const const
 
void customContextMenuRequested (const QPoint &pos)
 
WId effectiveWinId () const const
 
void ensurePolished () const const
 
Qt::FocusPolicy focusPolicy () const const
 
QWidgetfocusProxy () const const
 
QWidgetfocusWidget () const const
 
const QFontfont () const const
 
QFontInfo fontInfo () const const
 
QFontMetrics fontMetrics () const const
 
QPalette::ColorRole foregroundRole () const const
 
QRect frameGeometry () const const
 
QSize frameSize () const const
 
const QRectgeometry () const const
 
void getContentsMargins (int *left, int *top, int *right, int *bottom) const const
 
QPixmap grab (const QRect &rectangle)
 
void grabGesture (Qt::GestureType gesture, Qt::GestureFlags flags)
 
void grabKeyboard ()
 
void grabMouse ()
 
void grabMouse (const QCursor &cursor)
 
int grabShortcut (const QKeySequence &key, Qt::ShortcutContext context)
 
QGraphicsEffectgraphicsEffect () const const
 
QGraphicsProxyWidgetgraphicsProxyWidget () const const
 
bool hasEditFocus () const const
 
bool hasFocus () const const
 
bool hasMouseTracking () const const
 
bool hasTabletTracking () const const
 
int height () const const
 
void hide ()
 
Qt::InputMethodHints inputMethodHints () const const
 
virtual QVariant inputMethodQuery (Qt::InputMethodQuery query) const const
 
void insertAction (QAction *before, QAction *action)
 
void insertActions (QAction *before, QList< QAction * > actions)
 
bool isActiveWindow () const const
 
bool isAncestorOf (const QWidget *child) const const
 
bool isEnabled () const const
 
bool isEnabledTo (const QWidget *ancestor) const const
 
bool isEnabledToTLW () const const
 
bool isFullScreen () const const
 
bool isHidden () const const
 
bool isMaximized () const const
 
bool isMinimized () const const
 
bool isModal () const const
 
bool isTopLevel () const const
 
bool isVisible () const const
 
bool isVisibleTo (const QWidget *ancestor) const const
 
bool isWindow () const const
 
bool isWindowModified () const const
 
QLayoutlayout () const const
 
Qt::LayoutDirection layoutDirection () const const
 
QLocale locale () const const
 
void lower ()
 
QPoint mapFrom (const QWidget *parent, const QPoint &pos) const const
 
QPoint mapFromGlobal (const QPoint &pos) const const
 
QPoint mapFromParent (const QPoint &pos) const const
 
QPoint mapTo (const QWidget *parent, const QPoint &pos) const const
 
QPoint mapToGlobal (const QPoint &pos) const const
 
QPoint mapToParent (const QPoint &pos) const const
 
QRegion mask () const const
 
int maximumHeight () const const
 
QSize maximumSize () const const
 
int maximumWidth () const const
 
int minimumHeight () const const
 
QSize minimumSize () const const
 
int minimumWidth () const const
 
void move (int x, int y)
 
void move (const QPoint &)
 
QWidgetnativeParentWidget () const const
 
QWidgetnextInFocusChain () const const
 
QRect normalGeometry () const const
 
void overrideWindowFlags (Qt::WindowFlags flags)
 
virtual QPaintEnginepaintEngine () const const override
 
const QPalettepalette () const const
 
QWidgetparentWidget () const const
 
QPoint pos () const const
 
QWidgetpreviousInFocusChain () const const
 
 QWIDGETSIZE_MAX QWIDGETSIZE_MAX
 
void raise ()
 
QRect rect () const const
 
void releaseKeyboard ()
 
void releaseMouse ()
 
void releaseShortcut (int id)
 
void removeAction (QAction *action)
 
void render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags)
 
void render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags)
 
void repaint ()
 
void repaint (int x, int y, int w, int h)
 
void repaint (const QRect &rect)
 
void repaint (const QRegion &rgn)
 
void resize (int w, int h)
 
void resize (const QSize &)
 
bool restoreGeometry (const QByteArray &geometry)
 
QByteArray saveGeometry () const const
 
QScreenscreen () const const
 
void scroll (int dx, int dy)
 
void scroll (int dx, int dy, const QRect &r)
 
void setAcceptDrops (bool on)
 
void setAccessibleDescription (const QString &description)
 
void setAccessibleName (const QString &name)
 
void setAttribute (Qt::WidgetAttribute attribute, bool on)
 
void setAutoFillBackground (bool enabled)
 
void setBackgroundRole (QPalette::ColorRole role)
 
void setBaseSize (int basew, int baseh)
 
void setBaseSize (const QSize &)
 
void setContentsMargins (const QMargins &margins)
 
void setContentsMargins (int left, int top, int right, int bottom)
 
void setContextMenuPolicy (Qt::ContextMenuPolicy policy)
 
void setCursor (const QCursor &)
 
void setDisabled (bool disable)
 
void setEditFocus (bool enable)
 
void setEnabled (bool)
 
void setFixedHeight (int h)
 
void setFixedSize (const QSize &s)
 
void setFixedSize (int w, int h)
 
void setFixedWidth (int w)
 
void setFocus (Qt::FocusReason reason)
 
void setFocus ()
 
void setFocusPolicy (Qt::FocusPolicy policy)
 
void setFocusProxy (QWidget *w)
 
void setFont (const QFont &)
 
void setForegroundRole (QPalette::ColorRole role)
 
void setGeometry (const QRect &)
 
void setGeometry (int x, int y, int w, int h)
 
void setGraphicsEffect (QGraphicsEffect *effect)
 
void setHidden (bool hidden)
 
void setInputMethodHints (Qt::InputMethodHints hints)
 
void setLayout (QLayout *layout)
 
void setLayoutDirection (Qt::LayoutDirection direction)
 
void setLocale (const QLocale &locale)
 
void setMask (const QBitmap &bitmap)
 
void setMask (const QRegion &region)
 
void setMaximumHeight (int maxh)
 
void setMaximumSize (int maxw, int maxh)
 
void setMaximumSize (const QSize &)
 
void setMaximumWidth (int maxw)
 
void setMinimumHeight (int minh)
 
void setMinimumSize (const QSize &)
 
void setMinimumSize (int minw, int minh)
 
void setMinimumWidth (int minw)
 
void setMouseTracking (bool enable)
 
void setPalette (const QPalette &)
 
void setParent (QWidget *parent, Qt::WindowFlags f)
 
void setParent (QWidget *parent)
 
void setShortcutAutoRepeat (int id, bool enable)
 
void setShortcutEnabled (int id, bool enable)
 
void setSizeIncrement (const QSize &)
 
void setSizeIncrement (int w, int h)
 
void setSizePolicy (QSizePolicy)
 
void setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)
 
void setStatusTip (const QString &)
 
void setStyle (QStyle *style)
 
void setStyleSheet (const QString &styleSheet)
 
void setTabletTracking (bool enable)
 
void setToolTip (const QString &)
 
void setToolTipDuration (int msec)
 
void setUpdatesEnabled (bool enable)
 
void setupUi (QWidget *widget)
 
virtual void setVisible (bool visible)
 
void setWhatsThis (const QString &)
 
void setWindowFilePath (const QString &filePath)
 
void setWindowFlag (Qt::WindowType flag, bool on)
 
void setWindowFlags (Qt::WindowFlags type)
 
void setWindowIcon (const QIcon &icon)
 
void setWindowIconText (const QString &)
 
void setWindowModality (Qt::WindowModality windowModality)
 
void setWindowModified (bool)
 
void setWindowOpacity (qreal level)
 
void setWindowRole (const QString &role)
 
void setWindowState (Qt::WindowStates windowState)
 
void setWindowTitle (const QString &)
 
void show ()
 
void showFullScreen ()
 
void showMaximized ()
 
void showMinimized ()
 
void showNormal ()
 
QSize size () const const
 
QSize sizeIncrement () const const
 
QSizePolicy sizePolicy () const const
 
void stackUnder (QWidget *w)
 
QString statusTip () const const
 
QStylestyle () const const
 
QString styleSheet () const const
 
bool testAttribute (Qt::WidgetAttribute attribute) const const
 
QString toolTip () const const
 
int toolTipDuration () const const
 
QWidgettopLevelWidget () const const
 
bool underMouse () const const
 
void ungrabGesture (Qt::GestureType gesture)
 
void unsetCursor ()
 
void unsetLayoutDirection ()
 
void unsetLocale ()
 
void update (int x, int y, int w, int h)
 
void update (const QRect &rect)
 
void update (const QRegion &rgn)
 
void update ()
 
void updateGeometry ()
 
bool updatesEnabled () const const
 
QRegion visibleRegion () const const
 
QString whatsThis () const const
 
int width () const const
 
QWidgetwindow () const const
 
QString windowFilePath () const const
 
Qt::WindowFlags windowFlags () const const
 
QWindowwindowHandle () const const
 
QIcon windowIcon () const const
 
void windowIconChanged (const QIcon &icon)
 
QString windowIconText () const const
 
void windowIconTextChanged (const QString &iconText)
 
Qt::WindowModality windowModality () const const
 
qreal windowOpacity () const const
 
QString windowRole () const const
 
Qt::WindowStates windowState () const const
 
QString windowTitle () const const
 
void windowTitleChanged (const QString &title)
 
Qt::WindowType windowType () const const
 
WId winId () const const
 
int x () const const
 
int y () const const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 
- Public Member Functions inherited from QPaintDevice
int colorCount () const const
 
int depth () const const
 
int devicePixelRatio () const const
 
qreal devicePixelRatioF () const const
 
int height () const const
 
int heightMM () const const
 
int logicalDpiX () const const
 
int logicalDpiY () const const
 
bool paintingActive () const const
 
int physicalDpiX () const const
 
int physicalDpiY () const const
 
int width () const const
 
int widthMM () const const
 

Additional Inherited Members

- Public Types inherited from QTabWidget
enum  TabPosition
 
enum  TabShape
 
- Public Types inherited from QWidget
enum  RenderFlag
 
- Public Types inherited from QPaintDevice
enum  PaintDeviceMetric
 
- Properties inherited from QTabWidget
 count
 
 currentIndex
 
 documentMode
 
 elideMode
 
 iconSize
 
 movable
 
 tabBarAutoHide
 
 tabPosition
 
 tabsClosable
 
 tabShape
 
 usesScrollButtons
 
- Properties inherited from QWidget
 acceptDrops
 
 accessibleDescription
 
 accessibleName
 
 autoFillBackground
 
 baseSize
 
 childrenRect
 
 childrenRegion
 
 contextMenuPolicy
 
 cursor
 
 enabled
 
 focus
 
 focusPolicy
 
 font
 
 frameGeometry
 
 frameSize
 
 fullScreen
 
 geometry
 
 height
 
 inputMethodHints
 
 isActiveWindow
 
 layoutDirection
 
 locale
 
 maximized
 
 maximumHeight
 
 maximumSize
 
 maximumWidth
 
 minimized
 
 minimumHeight
 
 minimumSize
 
 minimumSizeHint
 
 minimumWidth
 
 modal
 
 mouseTracking
 
 normalGeometry
 
 palette
 
 pos
 
 rect
 
 size
 
 sizeHint
 
 sizeIncrement
 
 sizePolicy
 
 statusTip
 
 styleSheet
 
 tabletTracking
 
 toolTip
 
 toolTipDuration
 
 updatesEnabled
 
 visible
 
 whatsThis
 
 width
 
 windowFilePath
 
 windowFlags
 
 windowIcon
 
 windowIconText
 
 windowModality
 
 windowModified
 
 windowOpacity
 
 windowTitle
 
 x
 
 y
 
- Properties inherited from QObject
 objectName
 
- Static Public Member Functions inherited from QWidget
QWidgetcreateWindowContainer (QWindow *window, QWidget *parent, Qt::WindowFlags flags)
 
QWidgetfind (WId id)
 
QWidgetkeyboardGrabber ()
 
QWidgetmouseGrabber ()
 
void setTabOrder (QWidget *first, QWidget *second)
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QTabWidget
 East
 
 North
 
 Rounded
 
 South
 
 Triangular
 
 West
 
- Public Attributes inherited from QWidget
 DrawChildren
 
 DrawWindowBackground
 
 IgnoreMask
 
typedef RenderFlags
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Public Attributes inherited from QPaintDevice
 PdmDepth
 
 PdmDevicePixelRatio
 
 PdmDevicePixelRatioScaled
 
 PdmDpiX
 
 PdmDpiY
 
 PdmHeight
 
 PdmHeightMM
 
 PdmNumColors
 
 PdmPhysicalDpiX
 
 PdmPhysicalDpiY
 
 PdmWidth
 
 PdmWidthMM
 
- Protected Member Functions inherited from QTabWidget
virtual void changeEvent (QEvent *ev) override
 
virtual bool event (QEvent *ev) override
 
void initStyleOption (QStyleOptionTabWidgetFrame *option) const const
 
virtual void keyPressEvent (QKeyEvent *e) override
 
virtual void paintEvent (QPaintEvent *event) override
 
virtual void resizeEvent (QResizeEvent *e) override
 
void setTabBar (QTabBar *tb)
 
virtual void showEvent (QShowEvent *) override
 
virtual void tabInserted (int index)
 
virtual void tabRemoved (int index)
 
- Protected Member Functions inherited from QWidget
virtual void actionEvent (QActionEvent *event)
 
virtual void closeEvent (QCloseEvent *event)
 
virtual void contextMenuEvent (QContextMenuEvent *event)
 
void create (WId window, bool initializeWindow, bool destroyOldWindow)
 
void destroy (bool destroyWindow, bool destroySubWindows)
 
virtual void dragEnterEvent (QDragEnterEvent *event)
 
virtual void dragLeaveEvent (QDragLeaveEvent *event)
 
virtual void dragMoveEvent (QDragMoveEvent *event)
 
virtual void dropEvent (QDropEvent *event)
 
virtual void enterEvent (QEvent *event)
 
virtual void focusInEvent (QFocusEvent *event)
 
bool focusNextChild ()
 
virtual bool focusNextPrevChild (bool next)
 
virtual void focusOutEvent (QFocusEvent *event)
 
bool focusPreviousChild ()
 
virtual void hideEvent (QHideEvent *event)
 
virtual void initPainter (QPainter *painter) const const override
 
virtual void inputMethodEvent (QInputMethodEvent *event)
 
virtual void keyReleaseEvent (QKeyEvent *event)
 
virtual void leaveEvent (QEvent *event)
 
virtual int metric (QPaintDevice::PaintDeviceMetric m) const const override
 
virtual void mouseDoubleClickEvent (QMouseEvent *event)
 
virtual void mouseMoveEvent (QMouseEvent *event)
 
virtual void mousePressEvent (QMouseEvent *event)
 
virtual void mouseReleaseEvent (QMouseEvent *event)
 
virtual void moveEvent (QMoveEvent *event)
 
virtual bool nativeEvent (const QByteArray &eventType, void *message, long *result)
 
virtual void tabletEvent (QTabletEvent *event)
 
void updateMicroFocus ()
 
virtual void wheelEvent (QWheelEvent *event)
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

This is the main MessageList panel for Akonadi applications.

It contains multiple MessageList::Widget tabs so it can actually display multiple folder sets at once.

When a KXmlGuiWindow is passed to setXmlGuiClient, the XMLGUI defined context menu akonadi_messagelist_contextmenu is used if available.

Definition at line 44 of file pane.h.

Constructor & Destructor Documentation

Pane::Pane ( bool  restoreSession,
QAbstractItemModel model,
QItemSelectionModel selectionModel,
QWidget parent = nullptr 
)
explicit

Create a Pane wrapping the specified model and selection.

Definition at line 108 of file pane.cpp.

Member Function Documentation

QItemSelectionModel * Pane::createNewTab ( )
slot

Add a new tab to the Pane and select it.

Definition at line 788 of file pane.cpp.

QString Pane::currentFilterSearchString ( ) const

Returns the search term in the current quicksearch field.

Definition at line 994 of file pane.cpp.

QVector< Akonadi::MessageStatus > Pane::currentFilterStatus ( ) const

Returns the Akonadi::MessageStatus in the current quicksearch field.

Definition at line 976 of file pane.cpp.

Item Pane::currentItem ( ) const

Returns the current message for the list as Akonadi::Item.

May return an invalid Item if there is no current message or no current folder.

Definition at line 884 of file pane.cpp.

QItemSelectionModel * Pane::currentItemSelectionModel ( )

Returns the QItemSelectionModel for the currently displayed tab.

Definition at line 1068 of file pane.cpp.

KMime::Message::Ptr Pane::currentMessage ( ) const

Returns the current message for the list as KMime::Message::Ptr.

May return 0 if there is no current message or no current folder.

Definition at line 895 of file pane.cpp.

void MessageList::Pane::currentTabChanged ( )
signal

Emitted when the current tab has changed.

Clients using the selection model from currentItemSelectionModel() should ask for it again, as it may be different now.

Akonadi::Item::List Pane::currentThreadAsMessageList ( ) const

Returns the Akonadi::Item bound to the current StorageModel that are part of the current thread.

The current thread is the thread that contains currentMessageItem(). The list may be empty if there is no currentMessageItem() or no StorageModel.

The returned list is guaranteed to be valid only until you return control to the main even loop. Don't store it for any longer. If you need to reference this set of messages at a later stage then take a look at createPersistentSet().

Definition at line 942 of file pane.cpp.

MessageList::Core::MessageItemSetReference Pane::currentThreadAsPersistentSet ( ) const

Return a persistent set from current thread.

Definition at line 1043 of file pane.cpp.

void Pane::deletePersistentSet ( MessageList::Core::MessageItemSetReference  ref)

Deletes the persistent set pointed by the specified reference.

If the set does not exist anymore, nothing happens.

Definition at line 960 of file pane.cpp.

bool Pane::focusNextMessageItem ( MessageList::Core::MessageTypeFilter  messageTypeFilter,
bool  centerItem,
bool  loop 
)

Focuses the next message item in the view without actually selecting it.

messageTypeFilter can be used to restrict the selection to only certain message types.

If centerItem is true then the specified item will be positioned at the center of the view, if possible. If loop is true then the "next" algorithm will restart from the beginning of the list if the end is reached, otherwise it will just stop returning false.

Definition at line 357 of file pane.cpp.

bool Pane::focusPreviousMessageItem ( MessageList::Core::MessageTypeFilter  messageTypeFilter,
bool  centerItem,
bool  loop 
)

Focuses the previous message item in the view without actually selecting it.

messageTypeFilter can be used to restrict the selection to only certain message types.

If centerItem is true then the specified item will be positioned at the center of the view, if possible. If loop is true then the "previous" algorithm will restart from the end of the list if the beginning is reached, otherwise it will just stop returning false.

Definition at line 372 of file pane.cpp.

void Pane::focusQuickSearch ( const QString selectedText = QString())

Sets the focus on the quick search line of the currently active tab.

Definition at line 482 of file pane.cpp.

void Pane::focusView ( )

Sets the focus on the view of the currently active tab.

Definition at line 1052 of file pane.cpp.

bool Pane::getSelectionStats ( Akonadi::Item::List &  selectedItems,
Akonadi::Item::List &  selectedVisibleItems,
bool *  allSelectedBelongToSameThread,
bool  includeCollapsedChildren = true 
) const

Fills the lists of the selected message serial numbers and of the selected+visible ones.

Returns true if the returned stats are valid (there is a current folder after all) and false otherwise. This is called by KMMainWidget in a single place so we optimize by making it a single sweep on the selection.

If includeCollapsedChildren is true then the children of the selected but collapsed items are also included in the stats

Definition at line 1021 of file pane.cpp.

bool Pane::isThreaded ( ) const

Returns true if the current Aggregation is threaded, false otherwise (or if there is no current Aggregation).

Definition at line 1003 of file pane.cpp.

Akonadi::Item::List Pane::itemListFromPersistentSet ( MessageList::Core::MessageItemSetReference  ref)

Return Akonadi::Item from messageItemReference.

Definition at line 951 of file pane.cpp.

void Pane::markMessageItemsAsAboutToBeRemoved ( MessageList::Core::MessageItemSetReference  ref,
bool  bMark 
)

If bMark is true this function marks the messages as "about to be removed" so they appear dimmer and aren't selectable in the view.

If bMark is false then this function clears the "about to be removed" state for the specified MessageItems.

Definition at line 968 of file pane.cpp.

void MessageList::Pane::messageActivated ( const Akonadi::Item &  item)
signal

Emitted when a message is doubleclicked or activated by other input means.

void MessageList::Pane::messageSelected ( const Akonadi::Item &  item)
signal

Emitted when a message is selected (that is, single clicked and thus made current in the view) Note that this message CAN be 0 (when the current item is cleared, for example).

This signal is emitted when a SINGLE message is selected in the view, probably by clicking on it or by simple keyboard navigation. When multiple items are selected at once (by shift+clicking, for example) then you will get this signal only for the last clicked message (or at all, if the last shift+clicked thing is a group header...). You should handle selection changed in this case.

void MessageList::Pane::messageStatusChangeRequest ( const Akonadi::Item &  item,
const Akonadi::MessageStatus set,
const Akonadi::MessageStatus clear 
)
signal

Emitted when a message wants its status to be changed.

void Pane::reloadGlobalConfiguration ( )

Reloads global configuration and eventually reloads all the views.

Definition at line 1063 of file pane.cpp.

void Pane::selectAll ( )
slot

Selects all the items in the current folder.

Definition at line 430 of file pane.cpp.

bool Pane::selectFirstMessageItem ( MessageList::Core::MessageTypeFilter  messageTypeFilter,
bool  centerItem 
)

Selects the first message item in the view that matches the specified Core::MessageTypeFilter.

If centerItem is true then the specified item will be positioned at the center of the view, if possible.

If the current view is already loaded then the request will be satisfied immediately (well... if an unread message exists at all). If the current view is still loading then the selection of the first message will be scheduled to be executed when loading terminates.

So this function doesn't actually guarantee that an unread or new message was selected when the call returns. Take care :)

The function returns true if a message was selected and false otherwise.

Definition at line 400 of file pane.cpp.

void Pane::selectFocusedMessageItem ( bool  centerItem)

Selects the currently focused message item.

May do nothing if the focused message item is already selected (which is very likely). If centerItem is true then the specified item will be positioned at the center of the view, if possible.

Definition at line 387 of file pane.cpp.

Akonadi::Item::List Pane::selectionAsMessageItemList ( bool  includeCollapsedChildren = true) const

Returns the currently selected Items (bound to current StorageModel).

The list may be empty if there are no selected messages or no StorageModel.

If includeCollapsedChildren is true then the children of the selected but collapsed items are also added to the list.

The returned list is guaranteed to be valid only until you return control to the main even loop. Don't store it for any longer. If you need to reference this set of messages at a later stage then take a look at createPersistentSet().

Definition at line 915 of file pane.cpp.

QVector< qlonglong > Pane::selectionAsMessageItemListId ( bool  includeCollapsedChildren = true) const

Returns the currently selected Items id(bound to current StorageModel).

The list may be empty if there are no selected messages or no StorageModel.

If includeCollapsedChildren is true then the children of the selected but collapsed items are also added to the list.

The returned list is guaranteed to be valid only until you return control to the main even loop. Don't store it for any longer. If you need to reference this set of messages at a later stage then take a look at createPersistentSet().

Definition at line 933 of file pane.cpp.

QVector< KMime::Message::Ptr > Pane::selectionAsMessageList ( bool  includeCollapsedChildren = true) const

Returns the currently selected KMime::Message::Ptr (bound to current StorageModel).

The list may be empty if there are no selected messages or no StorageModel.

If includeCollapsedChildren is true then the children of the selected but collapsed items are also added to the list.

The returned list is guaranteed to be valid only until you return control to the main even loop. Don't store it for any longer. If you need to reference this set of messages at a later stage then take a look at createPersistentSet().

Definition at line 906 of file pane.cpp.

MessageList::Core::MessageItemSetReference Pane::selectionAsPersistentSet ( bool  includeCollapsedChildren = true) const

Return a persistent set from current selection.

Definition at line 1034 of file pane.cpp.

void MessageList::Pane::selectionChanged ( )
signal

Emitted when the selection in the view changes.

bool Pane::selectionEmpty ( ) const

Fast function that determines if the selection is empty.

Definition at line 1012 of file pane.cpp.

bool Pane::selectLastMessageItem ( MessageList::Core::MessageTypeFilter  messageTypeFilter,
bool  centerItem 
)

Selects the last message item in the view that matches the specified Core::MessageTypeFilter.

If centerItem is true then the specified item will be positioned at the center of the view, if possible.

The function returns true if a message was selected and false otherwise.

Definition at line 415 of file pane.cpp.

bool Pane::selectNextMessageItem ( MessageList::Core::MessageTypeFilter  messageTypeFilter,
MessageList::Core::ExistingSelectionBehaviour  existingSelectionBehaviour,
bool  centerItem,
bool  loop 
)

Selects the next message item in the view.

messageTypeFilter can be used to restrict the selection to only certain message types.

existingSelectionBehaviour specifies how the existing selection is manipulated. It may be cleared, expanded or grown/shrinked.

If centerItem is true then the specified item will be positioned at the center of the view, if possible. If loop is true then the "next" algorithm will restart from the beginning of the list if the end is reached, otherwise it will just stop returning false.

Definition at line 327 of file pane.cpp.

bool Pane::selectPreviousMessageItem ( MessageList::Core::MessageTypeFilter  messageTypeFilter,
MessageList::Core::ExistingSelectionBehaviour  existingSelectionBehaviour,
bool  centerItem,
bool  loop 
)

Selects the previous message item in the view.

If centerItem is true then the specified item will be positioned at the center of the view, if possible.

messageTypeFilter can be used to restrict the selection to only certain message types.

existingSelectionBehaviour specifies how the existing selection is manipulated. It may be cleared, expanded or grown/shrinked.

If loop is true then the "previous" algorithm will restart from the end of the list if the beginning is reached, otherwise it will just stop returning false.

Definition at line 342 of file pane.cpp.

void Pane::setAllGroupsExpanded ( bool  expand)

If expand is true then it expands all the groups (only the toplevel group item: inner threads are NOT expanded).

If expand is false then it collapses all the groups. If no grouping is in effect then this function does nothing.

Definition at line 469 of file pane.cpp.

void Pane::setAllThreadsExpanded ( bool  expand)

If expand is true then it expands all the threads, otherwise collapses them.

Definition at line 456 of file pane.cpp.

void Pane::setCurrentFolder ( const Akonadi::Collection fld,
const QModelIndex etmIndex,
bool  preferEmptyTab = false,
MessageList::Core::PreSelectionMode  preSelectionMode = MessageList::Core::PreSelectLastSelected,
const QString overrideLabel = QString() 
)

Sets the current folder to be displayed by this Pane.

If the specified folder is already open in one of the tabs then that tab is made current (and no reloading happens). If the specified folder is not open yet then behaviour depends on the preferEmptyTab value as follows.

Parameters
etmIndexthe index for the collection in the EntityTreeModel (source model)

If preferEmptyTab is set to false then the (new) folder is loaded in the current tab. If preferEmptyTab is set to true then the (new) folder is loaded in the first empty tab (or a new one if there are no empty ones).

Pre-selection is the action of automatically selecting a message just after the folder has finished loading. See Model::setStorageModel() for more information.

If overrideLabel is not empty then it's used as the tab text for the specified folder. This is useful to signal a particular folder state like "loading..."

Definition at line 759 of file pane.cpp.

void Pane::setCurrentThreadExpanded ( bool  expand)

If expand is true then it expands the current thread, otherwise collapses it.

Definition at line 443 of file pane.cpp.

void Pane::setXmlGuiClient ( KXMLGUIClient xmlGuiClient)

Sets the XML GUI client which the pane is used in.

This is needed if you want to use the built-in context menu. Passing 0 is ok and will disable the builtin context menu.

Parameters
xmlGuiClientThe KXMLGUIClient the view is used in.

Definition at line 215 of file pane.cpp.

void MessageList::Pane::statusMessage ( const QString message)
signal

Notify the outside when updating the status bar with a message could be useful.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sat Aug 8 2020 23:11:30 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.