MessageList::Widget
#include <widget.h>
Signals | |
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 () |
Signals inherited from MessageList::Core::Widget | |
void | forceLostFocus () |
void | statusMessage (const QString &message) |
void | unlockTabRequested () |
Public Member Functions | |
Widget (QWidget *parent) | |
bool | canAcceptDrag (const QDropEvent *e) |
Akonadi::Collection | currentCollection () const |
QString | currentFilterSearchString () const |
QList< Akonadi::MessageStatus > | currentFilterStatus () const |
Akonadi::Item | currentItem () const |
KMime::Message::Ptr | currentMessage () const |
MessageList::Core::SearchMessageByButtons::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) |
bool | getSelectionStats (Akonadi::Item::List &selectedSernums, Akonadi::Item::List &selectedVisibleSernums, 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 | selectAll () |
bool | selectFirstMessageItem (MessageList::Core::MessageTypeFilter messageTypeFilter, bool centerItem) |
void | selectFocusedMessageItem (bool centerItem) |
QList< Akonadi::Item::Id > | selectionAsListMessageId (bool includeCollapsedChildren) const |
Akonadi::Item::List | selectionAsMessageItemList (bool includeCollapsedChildren=true) const |
QList< qlonglong > | selectionAsMessageItemListId (bool includeCollapsedChildren) const |
QList< KMime::Message::Ptr > | selectionAsMessageList (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 | setCurrentThreadExpanded (bool expand) |
void | setQuickSearchClickMessage (const QString &msg) |
void | setXmlGuiClient (KXMLGUIClient *xmlGuiClient) |
Public Member Functions inherited from MessageList::Core::Widget | |
Widget (QWidget *parent) | |
void | aggregationMenuAboutToShow (QMenu *menu) |
QString | currentFilterSearchString () const |
QList< Akonadi::MessageStatus > | currentFilterStatus () const |
QString | currentFilterTagId () const |
Akonadi::Collection | currentFolder () const |
Core::MessageItem * | currentMessageItem () const |
MessageList::Core::SearchMessageByButtons::SearchOptions | currentOptions () const |
void | focusQuickSearch (const QString &selectedText) |
bool | isThreaded () const |
QLineEdit * | quickSearch () const |
void | saveCurrentSelection () |
bool | searchEditHasFocus () const |
bool | selectionEmpty () const |
void | setCurrentFolder (const Akonadi::Collection &collection) |
void | setFilter (Filter *filter) |
void | setStorageModel (StorageModel *storageModel, PreSelectionMode preSelectionMode=PreSelectLastSelected) |
void | sortOrderMenuAboutToShow (QMenu *menu) |
StorageModel * | storageModel () const |
void | themeMenuAboutToShow (QMenu *menu) |
View * | view () 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 () |
QAction * | addAction (const QIcon &icon, const QString &text) |
QAction * | addAction (const QIcon &icon, const QString &text, Args &&... args) |
QAction * | addAction (const QIcon &icon, const QString &text, const QKeySequence &shortcut) |
QAction * | addAction (const QIcon &icon, const QString &text, const QKeySequence &shortcut, Args &&... args) |
QAction * | addAction (const QIcon &icon, const QString &text, const QKeySequence &shortcut, const QObject *receiver, const char *member, Qt::ConnectionType type) |
QAction * | addAction (const QIcon &icon, const QString &text, const QObject *receiver, const char *member, Qt::ConnectionType type) |
QAction * | addAction (const QString &text) |
QAction * | addAction (const QString &text, Args &&... args) |
QAction * | addAction (const QString &text, const QKeySequence &shortcut) |
QAction * | addAction (const QString &text, const QKeySequence &shortcut, Args &&... args) |
QAction * | addAction (const QString &text, const QKeySequence &shortcut, const QObject *receiver, const char *member, Qt::ConnectionType type) |
QAction * | addAction (const QString &text, const QObject *receiver, const char *member, Qt::ConnectionType type) |
void | addAction (QAction *action) |
void | addActions (const QList< QAction * > &actions) |
void | adjustSize () |
bool | autoFillBackground () const const |
QPalette::ColorRole | backgroundRole () const const |
QBackingStore * | backingStore () const const |
QSize | baseSize () const const |
QWidget * | childAt (const QPoint &p) const const |
QWidget * | childAt (int x, int y) 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 |
QWidget * | focusProxy () const const |
QWidget * | focusWidget () const const |
const QFont & | font () const const |
QFontInfo | fontInfo () const const |
QFontMetrics | fontMetrics () const const |
QPalette::ColorRole | foregroundRole () const const |
QRect | frameGeometry () const const |
QSize | frameSize () const const |
const QRect & | geometry () 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) |
QGraphicsEffect * | graphicsEffect () const const |
QGraphicsProxyWidget * | graphicsProxyWidget () const const |
bool | hasEditFocus () const const |
bool | hasFocus () const const |
virtual bool | hasHeightForWidth () const const |
bool | hasMouseTracking () const const |
bool | hasTabletTracking () const const |
int | height () const const |
virtual int | heightForWidth (int w) 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, const 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 | 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 |
QLayout * | layout () const const |
Qt::LayoutDirection | layoutDirection () const const |
QLocale | locale () const const |
void | lower () |
QPoint | mapFrom (const QWidget *parent, const QPoint &pos) const const |
QPointF | mapFrom (const QWidget *parent, const QPointF &pos) const const |
QPoint | mapFromGlobal (const QPoint &pos) const const |
QPointF | mapFromGlobal (const QPointF &pos) const const |
QPoint | mapFromParent (const QPoint &pos) const const |
QPointF | mapFromParent (const QPointF &pos) const const |
QPoint | mapTo (const QWidget *parent, const QPoint &pos) const const |
QPointF | mapTo (const QWidget *parent, const QPointF &pos) const const |
QPoint | mapToGlobal (const QPoint &pos) const const |
QPointF | mapToGlobal (const QPointF &pos) const const |
QPoint | mapToParent (const QPoint &pos) const const |
QPointF | mapToParent (const QPointF &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 |
virtual QSize | minimumSizeHint () const const |
int | minimumWidth () const const |
void | move (const QPoint &) |
void | move (int x, int y) |
QWidget * | nativeParentWidget () const const |
QWidget * | nextInFocusChain () const const |
QRect | normalGeometry () const const |
void | overrideWindowFlags (Qt::WindowFlags flags) |
virtual QPaintEngine * | paintEngine () const const override |
const QPalette & | palette () const const |
QWidget * | parentWidget () const const |
QPoint | pos () const const |
QWidget * | previousInFocusChain () 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, RenderFlags renderFlags) |
void | render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, RenderFlags renderFlags) |
void | repaint () |
void | repaint (const QRect &rect) |
void | repaint (const QRegion &rgn) |
void | repaint (int x, int y, int w, int h) |
void | resize (const QSize &) |
void | resize (int w, int h) |
bool | restoreGeometry (const QByteArray &geometry) |
QByteArray | saveGeometry () const const |
QScreen * | screen () 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 (const QSize &) |
void | setBaseSize (int basew, int baseh) |
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 () |
void | setFocus (Qt::FocusReason reason) |
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 ®ion) |
void | setMaximumHeight (int maxh) |
void | setMaximumSize (const QSize &) |
void | setMaximumSize (int maxw, int maxh) |
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) |
void | setParent (QWidget *parent, Qt::WindowFlags f) |
void | setScreen (QScreen *screen) |
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 |
virtual QSize | sizeHint () const const |
QSize | sizeIncrement () const const |
QSizePolicy | sizePolicy () const const |
void | stackUnder (QWidget *w) |
QString | statusTip () const const |
QStyle * | style () const const |
QString | styleSheet () const const |
bool | testAttribute (Qt::WidgetAttribute attribute) const const |
QString | toolTip () const const |
int | toolTipDuration () const const |
QWidget * | topLevelWidget () const const |
bool | underMouse () const const |
void | ungrabGesture (Qt::GestureType gesture) |
void | unsetCursor () |
void | unsetLayoutDirection () |
void | unsetLocale () |
void | update () |
void | update (const QRect &rect) |
void | update (const QRegion &rgn) |
void | update (int x, int y, int w, int h) |
void | updateGeometry () |
bool | updatesEnabled () const const |
QRegion | visibleRegion () const const |
QString | whatsThis () const const |
int | width () const const |
QWidget * | window () const const |
QString | windowFilePath () const const |
Qt::WindowFlags | windowFlags () const const |
QWindow * | windowHandle () 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) | |
QBindable< QString > | bindableObjectName () |
bool | blockSignals (bool block) |
const QObjectList & | children () 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 () const const |
void | dumpObjectTree () const const |
QList< QByteArray > | dynamicPropertyNames () const const |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
T | findChild (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (Qt::FindChildOptions options) const const |
bool | inherits (const char *className) const const |
void | installEventFilter (QObject *filterObj) |
bool | isQuickItemType () const const |
bool | isWidgetType () const const |
bool | isWindowType () const const |
void | killTimer (int id) |
virtual const QMetaObject * | metaObject () const const |
void | moveToThread (QThread *targetThread) |
QString | objectName () const const |
void | objectNameChanged (const QString &objectName) |
QObject * | parent () const const |
QVariant | property (const char *name) const const |
Q_CLASSINFO (Name, Value) | |
Q_EMIT Q_EMIT | |
Q_ENUM (...) | |
Q_ENUM_NS (...) | |
Q_ENUMS (...) | |
Q_FLAG (...) | |
Q_FLAG_NS (...) | |
Q_FLAGS (...) | |
Q_GADGET Q_GADGET | |
Q_GADGET_EXPORT (EXPORT_MACRO) | |
Q_INTERFACES (...) | |
Q_INVOKABLE Q_INVOKABLE | |
Q_MOC_INCLUDE Q_MOC_INCLUDE | |
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 | |
T | qobject_cast (const QObject *object) |
T | qobject_cast (QObject *object) |
QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT | |
void | removeEventFilter (QObject *obj) |
void | setObjectName (const QString &name) |
void | setObjectName (QAnyStringView name) |
void | setParent (QObject *parent) |
bool | setProperty (const char *name, const QVariant &value) |
bool | setProperty (const char *name, QVariant &&value) |
bool | signalsBlocked () const const |
int | startTimer (int interval, Qt::TimerType timerType) |
int | startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType) |
QThread * | thread () const const |
Public Member Functions inherited from QPaintDevice | |
int | colorCount () const const |
int | depth () const const |
qreal | 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 |
Detailed Description
The Akonadi specific implementation of the Core::Widget.
When a KXmlGuiWindow is passed to setXmlGuiClient, the XMLGUI defined context menu akonadi_messagelist_contextmenu
is used if available.
Constructor & Destructor Documentation
◆ Widget()
|
explicit |
Create a new message list widget.
Member Function Documentation
◆ canAcceptDrag()
|
nodiscard |
Returns true if this drag can be accepted by the underlying view.
◆ currentFilterSearchString()
|
nodiscard |
Returns the search term in the current quicksearch field.
◆ currentFilterStatus()
|
nodiscard |
Returns the Akonadi::MessageStatus in the current quicksearch field.
◆ currentItem()
|
nodiscard |
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.
◆ currentMessage()
|
nodiscard |
Returns the current message for the list as KMime::Message::Ptr.
May return 0 if there is no current message or no current folder.
◆ currentThreadAsMessageList()
|
nodiscard |
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().
◆ currentThreadAsPersistentSet()
|
nodiscard |
Return a persistent set from current thread.
◆ deletePersistentSet()
void MessageList::Widget::deletePersistentSet | ( | MessageList::Core::MessageItemSetReference | ref | ) |
Deletes the persistent set pointed by the specified reference.
If the set does not exist anymore, nothing happens.
◆ fillMessageTagCombo()
|
overrideprotectedvirtual |
Reimplemented from MessageList::Core::Widget.
Reimplemented from MessageList::Core::Widget.
◆ focusNextMessageItem()
|
nodiscard |
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.
◆ focusPreviousMessageItem()
|
nodiscard |
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.
◆ focusQuickSearch()
void MessageList::Widget::focusQuickSearch | ( | const QString & | selectedText | ) |
Sets the focus on the quick search line of the currently active tab.
◆ getSelectionStats()
|
nodiscard |
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
◆ isThreaded()
|
nodiscard |
Returns true if the current Aggregation is threaded, false otherwise (or if there is no current Aggregation).
◆ itemListFromPersistentSet()
|
nodiscard |
Return Akonadi::Item from messageItemReference.
◆ markMessageItemsAsAboutToBeRemoved()
void MessageList::Widget::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.
◆ messageActivated
|
signal |
Emitted when a message is doubleclicked or activated by other input means.
◆ messageSelected
|
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.
◆ messageStatusChangeRequest
|
signal |
Emitted when a message wants its status to be changed.
◆ selectAll()
void MessageList::Widget::selectAll | ( | ) |
Selects all the items in the current folder.
◆ selectFirstMessageItem()
|
nodiscard |
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.
◆ selectFocusedMessageItem()
void MessageList::Widget::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.
◆ selectionAsMessageItemList()
|
nodiscard |
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().
◆ selectionAsMessageItemListId()
|
nodiscard |
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().
◆ selectionAsMessageList()
|
nodiscard |
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().
◆ selectionAsPersistentSet()
|
nodiscard |
Return a persistent set from current selection.
◆ selectionChanged
|
signal |
Emitted when the selection in the view changes.
◆ selectionEmpty()
|
nodiscard |
Fast function that determines if the selection is empty.
◆ selectLastMessageItem()
|
nodiscard |
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.
◆ selectNextMessageItem()
|
nodiscard |
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/shrunk.
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.
◆ selectPreviousMessageItem()
|
nodiscard |
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/shrunk.
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.
◆ setAllGroupsExpanded()
void MessageList::Widget::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.
◆ setAllThreadsExpanded()
void MessageList::Widget::setAllThreadsExpanded | ( | bool | expand | ) |
If expand is true then it expands all the threads, otherwise collapses them.
◆ setCurrentThreadExpanded()
void MessageList::Widget::setCurrentThreadExpanded | ( | bool | expand | ) |
If expand is true then it expands the current thread, otherwise collapses it.
◆ setXmlGuiClient()
void MessageList::Widget::setXmlGuiClient | ( | KXMLGUIClient * | xmlGuiClient | ) |
Sets the XML GUI client which the view 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
-
xmlGuiClient The KXMLGUIClient the view is used in.
◆ viewDragEnterEvent()
|
overrideprotectedvirtual |
Reimplemented from MessageList::Core::Widget.
Reimplemented from MessageList::Core::Widget.
◆ viewDragMoveEvent()
|
overrideprotectedvirtual |
Reimplemented from MessageList::Core::Widget.
Reimplemented from MessageList::Core::Widget.
◆ viewDropEvent()
|
overrideprotectedvirtual |
Reimplemented from MessageList::Core::Widget.
Reimplemented from MessageList::Core::Widget.
◆ viewGroupHeaderContextPopupRequest()
|
overrideprotectedvirtual |
Reimplemented from MessageList::Core::Widget.
Reimplemented from MessageList::Core::Widget.
◆ viewMessageActivated()
|
overrideprotectedvirtual |
Reimplemented from MessageList::Core::Widget.
Reimplemented from MessageList::Core::Widget.
◆ viewMessageListContextPopupRequest()
|
overrideprotectedvirtual |
Reimplemented from MessageList::Core::Widget.
Reimplemented from MessageList::Core::Widget.
◆ viewMessageSelected()
|
overrideprotectedvirtual |
Reimplemented from MessageList::Core::Widget.
Reimplemented from MessageList::Core::Widget.
◆ viewMessageStatusChangeRequest()
|
overrideprotectedvirtual |
Reimplemented from MessageList::Core::Widget.
Reimplemented from MessageList::Core::Widget.
◆ viewSelectionChanged()
|
overrideprotectedvirtual |
Reimplemented from MessageList::Core::Widget.
Reimplemented from MessageList::Core::Widget.
◆ viewStartDragRequest()
|
overrideprotectedvirtual |
Reimplemented from MessageList::Core::Widget.
Reimplemented from MessageList::Core::Widget.
The documentation for this class was generated from the following file:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Mon Nov 4 2024 16:33:26 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.