MessageList::Core::Widget
#include <widgetbase.h>
Signals | |
void | forceLostFocus () |
void | statusMessage (const QString &message) |
void | unlockTabRequested () |
Public Slots | |
void | changeQuicksearchVisibility (bool) |
bool | isLocked () const |
void | populateStatusFilterCombo () |
void | setLockTab (bool lock) |
Protected Slots | |
void | aggregationMenuAboutToShow () |
void | aggregationsChanged () |
void | aggregationSelected (bool) |
void | configureThemes () |
void | groupSortDirectionSelected (QAction *action) |
void | groupSortingSelected (QAction *action) |
void | messageSortDirectionSelected (QAction *action) |
void | messageSortingSelected (QAction *action) |
void | resetFilter () |
void | searchEditClearButtonClicked () |
void | searchEditTextEdited () |
void | searchTimerFired () |
void | setPrivateSortOrderForStorage () |
void | slotSaveFilter () |
void | slotStatusButtonsClicked () |
void | slotViewHeaderSectionClicked (int logicalIndex) |
void | sortOrderMenuAboutToShow () |
void | statusSelected (int index) |
void | themeMenuAboutToShow () |
void | themesChanged () |
void | themeSelected (bool) |
Detailed Description
Provides a widget which has the messagelist and the most important helper widgets, like the search line and the comboboxes for changing status filtering, aggregation etc.
Definition at line 40 of file widgetbase.h.
Constructor & Destructor Documentation
◆ Widget()
|
explicit |
Definition at line 106 of file widgetbase.cpp.
◆ ~Widget()
|
override |
Definition at line 155 of file widgetbase.cpp.
Member Function Documentation
◆ addMessageTagItem()
|
protected |
Definition at line 227 of file widgetbase.cpp.
◆ aggregationMenuAboutToShow [1/2]
|
protectedslot |
Definition at line 485 of file widgetbase.cpp.
◆ aggregationMenuAboutToShow() [2/2]
Definition at line 494 of file widgetbase.cpp.
◆ aggregationsChanged
|
protectedslot |
This is called by Manager when the option sets stored within have changed.
Definition at line 887 of file widgetbase.cpp.
◆ aggregationSelected
|
protectedslot |
Definition at line 524 of file widgetbase.cpp.
◆ changeQuicksearchVisibility
|
slot |
Shows or hides the quicksearch field, the filter combobox and the toolbutton for advanced search.
Definition at line 190 of file widgetbase.cpp.
◆ configureThemes
|
protectedslot |
Definition at line 444 of file widgetbase.cpp.
◆ currentFilterSearchString()
QString Widget::currentFilterSearchString | ( | ) | const |
Returns the search term in the current quicksearch field.
Definition at line 259 of file widgetbase.cpp.
◆ currentFilterStatus()
QList< Akonadi::MessageStatus > Widget::currentFilterStatus | ( | ) | const |
Returns the Akonadi::MessageStatus in the current quicksearch field.
Definition at line 251 of file widgetbase.cpp.
◆ currentFilterTagId()
QString Widget::currentFilterTagId | ( | ) | const |
Returns the id of the MessageItem::Tag currently set in the quicksearch field.
Definition at line 267 of file widgetbase.cpp.
◆ currentFolder()
Akonadi::Collection Widget::currentFolder | ( | ) | const |
Definition at line 1092 of file widgetbase.cpp.
◆ currentMessageItem()
MessageItem * Widget::currentMessageItem | ( | ) | const |
Returns the current MessageItem in the current folder.
May return nullptr if there is no current message or no current folder.
Definition at line 241 of file widgetbase.cpp.
◆ currentOptions()
MessageList::Core::QuickSearchLine::SearchOptions Widget::currentOptions | ( | ) | const |
Definition at line 246 of file widgetbase.cpp.
◆ fillMessageTagCombo()
|
protectedvirtual |
Called when the "Message Status/Tag" filter menu is opened by the user.
You may override this function in order to add some "custom tag" entries to the menu. The entries should be placed in a QActionGroup which should be returned to the caller. The QAction objects associated to the entries should have the string id of the tag set as data() and the tag icon set as icon(). The default implementation does nothing.
Once the tag retrieval is complete call setCurrentStatusFilterItem()
Reimplemented in MessageList::Widget.
Definition at line 895 of file widgetbase.cpp.
◆ focusQuickSearch()
Sets the focus on the quick search line of the currently active tab.
Definition at line 1077 of file widgetbase.cpp.
◆ groupSortDirectionSelected
Definition at line 796 of file widgetbase.cpp.
◆ groupSortingSelected
Definition at line 770 of file widgetbase.cpp.
◆ isLocked
|
slot |
Definition at line 932 of file widgetbase.cpp.
◆ isThreaded()
bool Widget::isThreaded | ( | ) | const |
Returns true if the current Aggregation is threaded, false otherwise (or if there is no current Aggregation).
Definition at line 1082 of file widgetbase.cpp.
◆ messageSortDirectionSelected
Definition at line 745 of file widgetbase.cpp.
◆ messageSortingSelected
Definition at line 719 of file widgetbase.cpp.
◆ populateStatusFilterCombo
|
slot |
This is called to setup the status filter's QComboBox.
Definition at line 212 of file widgetbase.cpp.
◆ quickSearch()
QLineEdit * Widget::quickSearch | ( | ) | const |
Returns the search line of this widget.
Can be nullptr if the quick search is disabled in the global configuration.
Definition at line 381 of file widgetbase.cpp.
◆ resetFilter
|
protectedslot |
Definition at line 828 of file widgetbase.cpp.
◆ saveCurrentSelection()
void Widget::saveCurrentSelection | ( | ) |
Definition at line 330 of file widgetbase.cpp.
◆ searchEditClearButtonClicked
|
protectedslot |
Definition at line 1023 of file widgetbase.cpp.
◆ searchEditHasFocus()
bool Widget::searchEditHasFocus | ( | ) | const |
Definition at line 1105 of file widgetbase.cpp.
◆ searchEditTextEdited
|
protectedslot |
Definition at line 947 of file widgetbase.cpp.
◆ searchTimerFired
|
protectedslot |
Definition at line 994 of file widgetbase.cpp.
◆ selectionEmpty()
bool Widget::selectionEmpty | ( | ) | const |
Fast function that determines if the selection is empty.
Definition at line 1087 of file widgetbase.cpp.
◆ setCurrentFolder()
void Widget::setCurrentFolder | ( | const Akonadi::Collection & | collection | ) |
Sets the current folder.
Definition at line 1097 of file widgetbase.cpp.
◆ setCurrentStatusFilterItem()
|
protected |
Must be called by fillMessageTagCombo()
Definition at line 232 of file widgetbase.cpp.
◆ setFilter()
Definition at line 821 of file widgetbase.cpp.
◆ setLockTab
|
slot |
Definition at line 922 of file widgetbase.cpp.
◆ setPrivateSortOrderForStorage
|
protectedslot |
Definition at line 433 of file widgetbase.cpp.
◆ setStorageModel()
void Widget::setStorageModel | ( | StorageModel * | storageModel, |
PreSelectionMode | preSelectionMode = PreSelectLastSelected ) |
Sets the storage model for this Widget.
Pre-selection is the action of automatically selecting a message just after the folder has finished loading. See Model::setStorageModel() for more information.
Definition at line 341 of file widgetbase.cpp.
◆ slotSaveFilter
|
protectedslot |
Definition at line 176 of file widgetbase.cpp.
◆ slotStatusButtonsClicked
|
protectedslot |
Definition at line 965 of file widgetbase.cpp.
◆ slotViewHeaderSectionClicked
|
protectedslot |
Handles header section clicks switching the Aggregation MessageSorting on-the-fly.
Definition at line 837 of file widgetbase.cpp.
◆ sortOrderMenuAboutToShow [1/2]
|
protectedslot |
Definition at line 564 of file widgetbase.cpp.
◆ sortOrderMenuAboutToShow() [2/2]
Definition at line 577 of file widgetbase.cpp.
◆ statusMessage
Notify the outside when updating the status bar with a message could be useful.
◆ statusSelected
|
protectedslot |
Definition at line 937 of file widgetbase.cpp.
◆ storageModel()
StorageModel * Widget::storageModel | ( | ) | const |
Returns the StorageModel currently set.
May be nullptr.
Definition at line 376 of file widgetbase.cpp.
◆ tagIdSelected()
Definition at line 901 of file widgetbase.cpp.
◆ themeMenuAboutToShow [1/2]
|
protectedslot |
Definition at line 391 of file widgetbase.cpp.
◆ themeMenuAboutToShow() [2/2]
Definition at line 404 of file widgetbase.cpp.
◆ themesChanged
|
protectedslot |
This is called by Manager when the option sets stored within have changed.
Definition at line 880 of file widgetbase.cpp.
◆ themeSelected
|
protectedslot |
Definition at line 451 of file widgetbase.cpp.
◆ view()
View * Widget::view | ( | ) | const |
Returns the View attached to this Widget.
Never nullptr.
Definition at line 386 of file widgetbase.cpp.
◆ viewDragEnterEvent()
|
protectedvirtual |
This is called by View when a drag enter event is received.
Reimplemented in MessageList::Widget.
Definition at line 1054 of file widgetbase.cpp.
◆ viewDragMoveEvent()
|
protectedvirtual |
This is called by View when a drag move event is received.
Reimplemented in MessageList::Widget.
Definition at line 1058 of file widgetbase.cpp.
◆ viewDropEvent()
|
protectedvirtual |
This is called by View when a drop event is received.
Reimplemented in MessageList::Widget.
Definition at line 1062 of file widgetbase.cpp.
◆ viewGroupHeaderContextPopupRequest()
|
protectedvirtual |
This is called by View when a group header is right clicked.
Reimplemented in MessageList::Widget.
Definition at line 1050 of file widgetbase.cpp.
◆ viewMessageActivated()
|
protectedvirtual |
This is called by View when a message is double-clicked or activated by other input means.
Reimplemented in MessageList::Widget.
Definition at line 1038 of file widgetbase.cpp.
◆ viewMessageListContextPopupRequest()
|
protectedvirtual |
This is called by View when a message is right clicked.
Reimplemented in MessageList::Widget.
Definition at line 1046 of file widgetbase.cpp.
◆ viewMessageSelected()
|
protectedvirtual |
This is called by View when a message is single-clicked (thus selected and made current)
Reimplemented in MessageList::Widget.
Definition at line 1034 of file widgetbase.cpp.
◆ viewMessageStatusChangeRequest()
|
protectedvirtual |
This is called by View when a message item is manipulated by the user in a way that it's status should change.
(e.g, by clicking on a status icon, for example).
Reimplemented in MessageList::Widget.
Definition at line 1070 of file widgetbase.cpp.
◆ viewSelectionChanged()
|
protectedvirtual |
This is called by View when selection changes.
Reimplemented in MessageList::Widget.
Definition at line 1042 of file widgetbase.cpp.
◆ viewStartDragRequest()
|
protectedvirtual |
This is called by View when a drag can possibly be started.
Reimplemented in MessageList::Widget.
Definition at line 1066 of file widgetbase.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Tue Mar 26 2024 11:12:44 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.