MessageList::Pane Class
| Header: | #include <MessageList/Pane> |
| CMake: | find_package(KPim6MessageList REQUIRED)target_link_libraries(mytarget PRIVATE KPim6::MessageList) |
Public Functions
| Pane(bool restoreSession, QAbstractItemModel *model, QItemSelectionModel *selectionModel, QWidget *parent = nullptr) | |
| virtual | ~Pane() override |
| void | createNewTab() |
| virtual MessageList::StorageModel * | createStorageModel(QAbstractItemModel *model, QItemSelectionModel *selectionModel, QObject *parent) |
| QString | currentFilterSearchString() const |
| QList<Akonadi::MessageStatus> | currentFilterStatus() const |
| Akonadi::Collection | currentFolder() const |
| Akonadi::Item | currentItem() const |
| QItemSelectionModel * | currentItemSelectionModel() |
| std::shared_ptr<KMime::Message> | currentMessage() const |
| 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 = 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 |
| QList<MessageList::Core::SearchLineCommand::SearchLineInfo> | searchLineCommands() const |
| bool | selectFirstMessageItem(MessageList::Core::MessageTypeFilter messageTypeFilter, bool centerItem) |
| void | selectFocusedMessageItem(bool centerItem) |
| 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) |
| QList<Akonadi::Item::Id> | selectionAsListMessageId(bool includeCollapsedChildren = true) const |
| Akonadi::Item::List | selectionAsMessageItemList(bool includeCollapsedChildren = true) const |
| QList<qlonglong> | selectionAsMessageItemListId(bool includeCollapsedChildren = true) const |
| QList<std::shared_ptr<KMime::Message>> | selectionAsMessageList(bool includeCollapsedChildren = true) const |
| MessageList::Core::MessageItemSetReference | selectionAsPersistentSet(bool includeCollapsedChildren = true) const |
| bool | selectionEmpty() const |
| void | setAllGroupsExpanded(bool expand) |
| void | setAllThreadsExpanded(bool expand) |
| void | setCurrentFolder(const Akonadi::Collection &fld, const QModelIndex &etmIndex, 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 Slots
| void | aggregationMenuAboutToShow() |
| void | selectAll() |
| void | sortOrderMenuAboutToShow() |
| void | themeMenuAboutToShow() |
Signals
| void | currentTabChanged() |
| void | forceLostFocus() |
| void | messageActivated(const Akonadi::Item &item) |
| void | messageCollapsed(const Akonadi::Item &item) |
| void | messageExpanded(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) |
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.
Member Function Documentation
[explicit] Pane::Pane(bool restoreSession, QAbstractItemModel *model, QItemSelectionModel *selectionModel, QWidget *parent = nullptr)
Create a Pane wrapping the specified model and selection. restoreSession Whether to restore the session. model The item model. selectionModel The selection model. parent The parent widget.
[override virtual noexcept] Pane::~Pane()
Destructor.
[slot] void Pane::aggregationMenuAboutToShow()
void Pane::createNewTab()
Add a new tab to the Pane and select it.
[virtual] MessageList::StorageModel *Pane::createStorageModel(QAbstractItemModel *model, QItemSelectionModel *selectionModel, QObject *parent)
Create storage model. model The item model. selectionModel The selection model. parent The parent object. Returns The created storage model.
QString Pane::currentFilterSearchString() const
Returns the search term in the current quicksearch field.
QList<Akonadi::MessageStatus> Pane::currentFilterStatus() const
Returns the Akonadi::MessageStatus in the current quicksearch field.
Akonadi::Collection Pane::currentFolder() const
See also setCurrentFolder().
Akonadi::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.
QItemSelectionModel *Pane::currentItemSelectionModel()
Returns the QItemSelectionModel for the currently displayed tab.
std::shared_ptr<KMime::Message> Pane::currentMessage() const
Returns the current message for the list as std::shared_ptr<KMime::Message>. May return 0 if there is no current message or no current folder.
Core::SearchMessageByButtons::SearchOptions Pane::currentOptions() const
[signal] void Pane::currentTabChanged()
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().
MessageList::Core::MessageItemSetReference Pane::currentThreadAsPersistentSet() const
Return a persistent set from current thread
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.
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.
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.
void Pane::focusQuickSearch(const QString &selectedText = QString())
Sets the focus on the quick search line of the currently active tab.
void Pane::focusView()
Sets the focus on the view of the currently active tab.
[signal] void Pane::forceLostFocus()
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
bool Pane::isThreaded() const
Returns true if the current Aggregation is threaded, false otherwise (or if there is no current Aggregation).
Akonadi::Item::List Pane::itemListFromPersistentSet(MessageList::Core::MessageItemSetReference ref)
Return Akonadi::Item from messageItemReference
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.
[signal] void Pane::messageActivated(const Akonadi::Item &item)
Emitted when a message is doubleclicked or activated by other input means
[signal] void Pane::messageCollapsed(const Akonadi::Item &item)
Emitted when message is collapsed.
[signal] void Pane::messageExpanded(const Akonadi::Item &item)
Emitted when message is expanded.
[signal] void Pane::messageSelected(const Akonadi::Item &item)
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.
[signal] void Pane::messageStatusChangeRequest(const Akonadi::Item &item, const Akonadi::MessageStatus &set, const Akonadi::MessageStatus &clear)
Emitted when a message wants its status to be changed
void Pane::populateStatusFilterCombo()
void Pane::reloadGlobalConfiguration()
Reloads global configuration and eventually reloads all the views.
void Pane::resetModelStorage()
void Pane::saveCurrentSelection()
bool Pane::searchEditHasFocus() const
QList<MessageList::Core::SearchLineCommand::SearchLineInfo> Pane::searchLineCommands() const
[slot] void Pane::selectAll()
Selects all the items in the current folder.
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.
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.
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.
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/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.
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/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.
QList<Akonadi::Item::Id> Pane::selectionAsListMessageId(bool includeCollapsedChildren = true) const
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().
QList<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().
QList<std::shared_ptr<KMime::Message>> Pane::selectionAsMessageList(bool includeCollapsedChildren = true) const
Returns the currently selected std::shared_ptr<KMime::Message> (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().
MessageList::Core::MessageItemSetReference Pane::selectionAsPersistentSet(bool includeCollapsedChildren = true) const
Return a persistent set from current selection
[signal] void Pane::selectionChanged()
Emitted when the selection in the view changes.
bool Pane::selectionEmpty() const
Fast function that determines if the selection is empty
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.
void Pane::setAllThreadsExpanded(bool expand)
If expand is true then it expands all the threads, otherwise collapses them.
void Pane::setCurrentFolder(const Akonadi::Collection &fld, const QModelIndex &etmIndex, 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.
etmIndex the index for the collection in the EntityTreeModel (source model)
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..."
See also currentFolder().
void Pane::setCurrentThreadExpanded(bool expand)
If expand is true then it expands the current thread, otherwise collapses it.
void Pane::setPreferEmptyTab(bool emptyTab)
void Pane::setQuickSearchClickMessage(const QString &msg)
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.
xmlGuiClient The KXMLGUIClient the view is used in.
[slot] void Pane::sortOrderMenuAboutToShow()
[signal] void Pane::statusMessage(const QString &message)
Notify the outside when updating the status bar with a message could be useful
[slot] void Pane::themeMenuAboutToShow()
void Pane::updateTabIconText(const Akonadi::Collection &collection, const QString &label, const QIcon &icon)
void Pane::updateTagComboBox()
[virtual] void Pane::writeConfig(bool restoreSession)
Write configuration. restoreSession Whether to restore the session.