MessageList::Pane

MessageList
Pane

#include <pane.h>

Inheritance diagram for MessageList::Pane:

[legend]

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 ()

QItemSelectionModel *	createNewTab ()

void	selectAll ()

void	sortOrderMenuAboutToShow ()

void	themeMenuAboutToShow ()

Public Member Functions
	Pane (bool restoreSession, QAbstractItemModel model, QItemSelectionModel selectionModel, QWidget *parent=nullptr)

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 ()

KMime::Message::Ptr	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)

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< 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	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 ()

QWidget *	cornerWidget (Qt::Corner corner) const const

int	count () const const

void	currentChanged (int index)

int	currentIndex () const const

QWidget *	currentWidget () 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 (const QWidget *w) const const

int	insertTab (int index, QWidget *page, const QIcon &icon, const QString &label)

int	insertTab (int index, QWidget *page, 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 (TabPosition position)

void	setTabsClosable (bool closeable)

void	setTabShape (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

QTabBar *	tabBar () const const

bool	tabBarAutoHide () const const

void	tabBarClicked (int index)

void	tabBarDoubleClicked (int index)

void	tabCloseRequested (int index)

QIcon	tabIcon (int index) const const

TabPosition	tabPosition () const const

bool	tabsClosable () const const

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

QWidget *	widget (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 ()

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

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, 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

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 &region)

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

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

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

Additional Inherited Members
Public Types inherited from QTabWidget
enum	TabPosition

enum	TabShape

Public Types inherited from QWidget
enum	RenderFlag

typedef	RenderFlags

Public Types inherited from QObject
typedef	QObjectList

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
QWidget *	createWindowContainer (QWindow window, QWidget parent, Qt::WindowFlags flags)

QWidget *	find (WId id)

QWidget *	keyboardGrabber ()

QWidget *	mouseGrabber ()

void	setTabOrder (QWidget first, QWidget second)

void	setTabOrder (std::initializer_list< QWidget * > widgets)

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 context, Functor functor, 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)

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, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (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

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

virtual 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 (QEnterEvent *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 (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, qintptr result)

virtual void	tabletEvent (QTabletEvent *event)

void	updateMicroFocus (Qt::InputMethodQuery query)

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

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Protected Member Functions inherited from QPaintDevice

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 45 of file pane.h.

Constructor & Destructor Documentation

◆ Pane()

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

explicit

Create a Pane wrapping the specified model and selection.

Definition at line 94 of file pane.cpp.

◆ ~Pane()

Pane::~Pane ( )

override

Definition at line 171 of file pane.cpp.

Member Function Documentation

◆ aggregationMenuAboutToShow

void Pane::aggregationMenuAboutToShow ( )

slot

Definition at line 1232 of file pane.cpp.

◆ createNewTab

QItemSelectionModel * Pane::createNewTab ( )

slot

Add a new tab to the Pane and select it.

Definition at line 807 of file pane.cpp.

◆ createStorageModel()

MessageList::StorageModel * Pane::createStorageModel	(	QAbstractItemModel *	model,
		QItemSelectionModel *	selectionModel,
		QObject *	parent )

virtual

Definition at line 758 of file pane.cpp.

◆ currentFilterSearchString()

QString Pane::currentFilterSearchString ( ) const

nodiscard

Returns the search term in the current quicksearch field.

Definition at line 1016 of file pane.cpp.

◆ currentFilterStatus()

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

nodiscard

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

Definition at line 998 of file pane.cpp.

◆ currentFolder()

Akonadi::Collection Pane::currentFolder ( ) const

nodiscard

Definition at line 763 of file pane.cpp.

◆ currentItem()

Akonadi::Item Pane::currentItem ( ) const

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.

Definition at line 906 of file pane.cpp.

◆ currentItemSelectionModel()

QItemSelectionModel * Pane::currentItemSelectionModel ( )

Returns the QItemSelectionModel for the currently displayed tab.

Definition at line 1099 of file pane.cpp.

◆ currentMessage()

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 917 of file pane.cpp.

◆ currentOptions()

Core::SearchMessageByButtons::SearchOptions Pane::currentOptions ( ) const

Definition at line 1007 of file pane.cpp.

◆ currentTabChanged

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.

◆ currentThreadAsMessageList()

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

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().

Definition at line 964 of file pane.cpp.

◆ currentThreadAsPersistentSet()

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

nodiscard

Return a persistent set from current thread.

Definition at line 1074 of file pane.cpp.

◆ deletePersistentSet()

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 982 of file pane.cpp.

◆ focusNextMessageItem()

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

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.

Definition at line 347 of file pane.cpp.

◆ focusPreviousMessageItem()

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

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.

Definition at line 362 of file pane.cpp.

◆ focusQuickSearch()

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

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

Definition at line 472 of file pane.cpp.

◆ focusView()

void Pane::focusView ( )

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

Definition at line 1083 of file pane.cpp.

◆ getSelectionStats()

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

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

Definition at line 1052 of file pane.cpp.

◆ isThreaded()

bool Pane::isThreaded ( ) const

nodiscard

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

Definition at line 1034 of file pane.cpp.

◆ itemListFromPersistentSet()

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

nodiscard

Return Akonadi::Item from messageItemReference.

Definition at line 973 of file pane.cpp.

◆ markMessageItemsAsAboutToBeRemoved()

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 990 of file pane.cpp.

◆ messageActivated

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

signal

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

◆ messageSelected

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.

◆ messageStatusChangeRequest

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.

◆ populateStatusFilterCombo()

void Pane::populateStatusFilterCombo ( )

Definition at line 1252 of file pane.cpp.

◆ reloadGlobalConfiguration()

void Pane::reloadGlobalConfiguration ( )

Reloads global configuration and eventually reloads all the views.

Definition at line 1094 of file pane.cpp.

◆ resetModelStorage()

void Pane::resetModelStorage ( )

Definition at line 1108 of file pane.cpp.

◆ saveCurrentSelection()

void Pane::saveCurrentSelection ( )

Definition at line 1124 of file pane.cpp.

◆ searchEditHasFocus()

bool Pane::searchEditHasFocus ( ) const

Definition at line 1213 of file pane.cpp.

◆ searchLineCommands()

QList< MessageList::Core::SearchLineCommand::SearchLineInfo > Pane::searchLineCommands ( ) const

nodiscard

Definition at line 1025 of file pane.cpp.

◆ selectAll

void Pane::selectAll ( )

slot

Selects all the items in the current folder.

Definition at line 420 of file pane.cpp.

◆ selectFirstMessageItem()

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

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.

Definition at line 390 of file pane.cpp.

◆ selectFocusedMessageItem()

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 377 of file pane.cpp.

◆ selectionAsListMessageId()

QList< Akonadi::Item::Id > Pane::selectionAsListMessageId ( bool includeCollapsedChildren = true ) const

nodiscard

Definition at line 946 of file pane.cpp.

◆ selectionAsMessageItemList()

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

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.

Definition at line 937 of file pane.cpp.

◆ selectionAsMessageItemListId()

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

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.

Definition at line 955 of file pane.cpp.

◆ selectionAsMessageList()

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

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.

Definition at line 928 of file pane.cpp.

◆ selectionAsPersistentSet()

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

nodiscard

Return a persistent set from current selection.

Definition at line 1065 of file pane.cpp.

◆ selectionChanged

void MessageList::Pane::selectionChanged ( )

signal

Emitted when the selection in the view changes.

◆ selectionEmpty()

bool Pane::selectionEmpty ( ) const

nodiscard

Fast function that determines if the selection is empty.

Definition at line 1043 of file pane.cpp.

◆ selectLastMessageItem()

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

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.

Definition at line 405 of file pane.cpp.

◆ selectNextMessageItem()

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

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.

Definition at line 311 of file pane.cpp.

◆ selectPreviousMessageItem()

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

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.

Definition at line 329 of file pane.cpp.

◆ setAllGroupsExpanded()

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 459 of file pane.cpp.

◆ setAllThreadsExpanded()

void Pane::setAllThreadsExpanded ( bool expand )

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

Definition at line 446 of file pane.cpp.

◆ setCurrentFolder()

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

etmIndex the 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 772 of file pane.cpp.

◆ setCurrentThreadExpanded()

void Pane::setCurrentThreadExpanded ( bool expand )

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

Definition at line 433 of file pane.cpp.

◆ setPreferEmptyTab()

void Pane::setPreferEmptyTab ( bool emptyTab )

Definition at line 1119 of file pane.cpp.

◆ setQuickSearchClickMessage()

void Pane::setQuickSearchClickMessage ( const QString & msg )

Definition at line 481 of file pane.cpp.

◆ setXmlGuiClient()

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

xmlGuiClient The KXMLGUIClient the view is used in.

Definition at line 196 of file pane.cpp.

◆ sortOrderMenuAboutToShow

void Pane::sortOrderMenuAboutToShow ( )

slot

Definition at line 1222 of file pane.cpp.

◆ statusMessage

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

signal

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

◆ themeMenuAboutToShow

void Pane::themeMenuAboutToShow ( )

slot

Definition at line 1242 of file pane.cpp.

◆ updateTabIconText()

void Pane::updateTabIconText	(	const Akonadi::Collection &	collection,
		const QString &	label,
		const QIcon &	icon )

Definition at line 795 of file pane.cpp.

◆ updateTagComboBox()

void Pane::updateTagComboBox ( )

Definition at line 1134 of file pane.cpp.

◆ writeConfig()

void Pane::writeConfig ( bool restoreSession )

virtual

Definition at line 1144 of file pane.cpp.

The documentation for this class was generated from the following files:

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About Messagelib

MessageList::Pane

Signals

Public Slots

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Pane()

◆ ~Pane()

Member Function Documentation

◆ aggregationMenuAboutToShow

◆ createNewTab

◆ createStorageModel()

◆ currentFilterSearchString()

◆ currentFilterStatus()

◆ currentFolder()

◆ currentItem()

◆ currentItemSelectionModel()

◆ currentMessage()

◆ currentOptions()

◆ currentTabChanged

◆ currentThreadAsMessageList()

◆ currentThreadAsPersistentSet()

◆ deletePersistentSet()

◆ focusNextMessageItem()

◆ focusPreviousMessageItem()

◆ focusQuickSearch()

◆ focusView()

◆ getSelectionStats()

◆ isThreaded()

◆ itemListFromPersistentSet()

◆ markMessageItemsAsAboutToBeRemoved()

◆ messageActivated

◆ messageSelected

◆ messageStatusChangeRequest

◆ populateStatusFilterCombo()

◆ reloadGlobalConfiguration()

◆ resetModelStorage()

◆ saveCurrentSelection()

◆ searchEditHasFocus()

◆ searchLineCommands()

◆ selectAll

◆ selectFirstMessageItem()

◆ selectFocusedMessageItem()

◆ selectionAsListMessageId()

◆ selectionAsMessageItemList()

◆ selectionAsMessageItemListId()

◆ selectionAsMessageList()

◆ selectionAsPersistentSet()

◆ selectionChanged

◆ selectionEmpty()

◆ selectLastMessageItem()

◆ selectNextMessageItem()

◆ selectPreviousMessageItem()

◆ setAllGroupsExpanded()

◆ setAllThreadsExpanded()

◆ setCurrentFolder()

◆ setCurrentThreadExpanded()

◆ setPreferEmptyTab()

◆ setQuickSearchClickMessage()

◆ setXmlGuiClient()

◆ sortOrderMenuAboutToShow

◆ statusMessage

◆ themeMenuAboutToShow

◆ updateTabIconText()

◆ updateTagComboBox()

◆ writeConfig()