KMessageWidget

#include <KMessageWidget>

Inheritance diagram for KMessageWidget:

[legend]

Public Types
enum	MessageType { Positive , Information , Warning , Error }

enum	Position { Inline , Header , Footer }

Public Types inherited from QFrame
enum	Shadow

enum	Shape

enum	StyleMask

Public Types inherited from QWidget
enum	RenderFlag

Public Types inherited from QPaintDevice
enum	PaintDeviceMetric

Properties
bool	closeButtonVisible

QIcon	icon

MessageType	messageType

Position	position

QString	text

Qt::TextFormat	textFormat

bool	wordWrap

Properties inherited from QFrame
	frameRect

	frameShadow

	frameShape

	frameWidth

	lineWidth

	midLineWidth

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

Signals
void	hideAnimationFinished ()

void	linkActivated (const QString &contents)

void	linkHovered (const QString &contents)

void	showAnimationFinished ()

Public Slots
void	animatedHide ()

void	animatedShow ()

void	setCloseButtonVisible (bool visible)

void	setIcon (const QIcon &icon)

void	setMessageType (KMessageWidget::MessageType type)

void	setPosition (Position position)

void	setText (const QString &text)

void	setWordWrap (bool wordWrap)

Public Member Functions
	KMessageWidget (const QString &text, QWidget *parent=nullptr)

	KMessageWidget (QWidget *parent=nullptr)

	~KMessageWidget () override

void	addAction (QAction *action)

void	clearActions ()

int	heightForWidth (int width) const override

QIcon	icon () const

bool	isCloseButtonVisible () const

bool	isHideAnimationRunning () const

bool	isShowAnimationRunning () const

MessageType	messageType () const

QSize	minimumSizeHint () const override

Position	position () const

	Q_ENUM (Position)

void	removeAction (QAction *action)

void	setTextFormat (Qt::TextFormat textFormat)

QSize	sizeHint () const override

QString	text () const

Qt::TextFormat	textFormat () const

bool	wordWrap () const

Public Member Functions inherited from QFrame
	QFrame (QWidget *parent, Qt::WindowFlags f)

QRect	frameRect () const const

Shadow	frameShadow () const const

Shape	frameShape () const const

int	frameStyle () const const

int	frameWidth () const const

int	lineWidth () const const

int	midLineWidth () const const

void	setFrameRect (const QRect &)

void	setFrameShadow (Shadow)

void	setFrameShape (Shape)

void	setFrameStyle (int style)

void	setLineWidth (int)

void	setMidLineWidth (int)

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

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

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

Protected Member Functions
bool	event (QEvent *event) override

void	paintEvent (QPaintEvent *event) override

void	resizeEvent (QResizeEvent *event) override

Protected Member Functions inherited from QFrame
virtual void	changeEvent (QEvent *ev) override

virtual void	initStyleOption (QStyleOptionFrame *option) const const

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	keyPressEvent (QKeyEvent *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	showEvent (QShowEvent *event)

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)

Additional Inherited Members
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 QFrame
	Box

	HLine

	NoFrame

	Panel

	Plain

	Raised

	Shadow_Mask

	Shape_Mask

	StyledPanel

	Sunken

	VLine

	WinPanel

Public Attributes inherited from QWidget
	DrawChildren

	DrawWindowBackground

	IgnoreMask

typedef	RenderFlags

Public Attributes inherited from QObject
typedef	QObjectList

Public Attributes inherited from QPaintDevice
	PdmDepth

	PdmDevicePixelRatio

	PdmDevicePixelRatioScaled

	PdmDpiX

	PdmDpiY

	PdmHeight

	PdmHeightMM

	PdmNumColors

	PdmPhysicalDpiX

	PdmPhysicalDpiY

	PdmWidth

	PdmWidthMM

Detailed Description

A widget to provide feedback or propose opportunistic interactions.

KMessageWidget can be used to provide inline positive or negative feedback, or to implement opportunistic interactions.

As a feedback widget, KMessageWidget provides a less intrusive alternative to "OK Only" message boxes. If you want to avoid a modal KMessageBox, consider using KMessageWidget instead.

Examples of KMessageWidget look as follows, all of them having an icon set with setIcon(), and the first three show a close button:

KMessageWidget with different message types

Negative feedback

The KMessageWidget can be used as a secondary indicator of failure: the first indicator is usually the fact the action the user expected to happen did not happen.

Example: User fills a form, clicks "Submit".

Expected feedback: form closes
First indicator of failure: form stays there
Second indicator of failure: a KMessageWidget appears on top of the form, explaining the error condition

When used to provide negative feedback, KMessageWidget should be placed close to its context. In the case of a form, it should appear on top of the form entries.

KMessageWidget should get inserted in the existing layout. Space should not be reserved for it, otherwise it becomes "dead space", ignored by the user. KMessageWidget should also not appear as an overlay to prevent blocking access to elements the user needs to interact with to fix the failure.

Positive feedback

KMessageWidget can be used for positive feedback but it shouldn't be overused. It is often enough to provide feedback by simply showing the results of an action.

Examples of acceptable uses:

Confirm success of "critical" transactions
Indicate completion of background tasks

Example of unadapted uses:

Indicate successful saving of a file
Indicate a file has been successfully removed

Opportunistic interaction

Opportunistic interaction is the situation where the application suggests to the user an action he could be interested in perform, either based on an action the user just triggered or an event which the application noticed.

Example of acceptable uses:

A browser can propose remembering a recently entered password
A music collection can propose ripping a CD which just got inserted
A chat application may notify the user a "special friend" just connected

Author: Aurélien Gâteau agate.nosp@m.au@k.nosp@m.de.or.nosp@m.g

Since: 4.7

Definition at line 87 of file kmessagewidget.h.

Member Enumeration Documentation

◆ MessageType

enum KMessageWidget::MessageType

Available message types.

The background colors are chosen depending on the message type.

Enumerator
Positive	Positive message type.
Information	Information message type.
Warning	Warning message type.
Error	Error message type.

Definition at line 103 of file kmessagewidget.h.

◆ Position

enum KMessageWidget::Position

Position of the KMessageWidget.

This will update the look of the KMessageWidget to be appropriate to the position.

Since: 6.0

Enumerator
Inline	The message widget is display inside the content.
Header	The message widget is displayed as header.
Footer	The message widget is displayed as footer.

Definition at line 117 of file kmessagewidget.h.

Property Documentation

◆ closeButtonVisible

bool KMessageWidget::closeButtonVisible

readwrite

Definition at line 94 of file kmessagewidget.h.

◆ icon

QIcon KMessageWidget::icon

readwrite

Definition at line 96 of file kmessagewidget.h.

◆ messageType

MessageType KMessageWidget::messageType

readwrite

Definition at line 95 of file kmessagewidget.h.

◆ position

Position KMessageWidget::position

readwrite

Definition at line 97 of file kmessagewidget.h.

◆ text

QString KMessageWidget::text

readwrite

Definition at line 91 of file kmessagewidget.h.

◆ textFormat

Qt::TextFormat KMessageWidget::textFormat

readwrite

Definition at line 92 of file kmessagewidget.h.

◆ wordWrap

bool KMessageWidget::wordWrap

readwrite

Definition at line 93 of file kmessagewidget.h.

Constructor & Destructor Documentation

◆ KMessageWidget() [1/2]

KMessageWidget::KMessageWidget ( QWidget * parent = nullptr )

explicit

Constructs a KMessageWidget with the specified parent.

Definition at line 231 of file kmessagewidget.cpp.

◆ KMessageWidget() [2/2]

KMessageWidget::KMessageWidget	(	const QString &	text,
		QWidget *	parent = nullptr )

explicit

Constructs a KMessageWidget with the specified parent and contents text.

Definition at line 238 of file kmessagewidget.cpp.

◆ ~KMessageWidget()

KMessageWidget::~KMessageWidget ( )

overridedefault

Destructor.

Member Function Documentation

◆ addAction()

void KMessageWidget::addAction ( QAction * action )

Add action to the message widget.

For each action a button is added to the message widget in the order the actions were added.

Parameters

action the action to add

See also: removeAction(), QWidget::actions()

Definition at line 413 of file kmessagewidget.cpp.

◆ animatedHide

void KMessageWidget::animatedHide ( )

slot

Hide the widget using an animation.

Definition at line 464 of file kmessagewidget.cpp.

◆ animatedShow

void KMessageWidget::animatedShow ( )

slot

Show the widget using an animation.

Definition at line 434 of file kmessagewidget.cpp.

◆ clearActions()

void KMessageWidget::clearActions ( )

Clears all actions from the message widget.

See also: KMessageWidget::MessageType, addAction() and removeAction()

Since: 5.100

Definition at line 425 of file kmessagewidget.cpp.

◆ event()

bool KMessageWidget::event ( QEvent * event )

overrideprotectedvirtual

Reimplemented from QFrame.

Definition at line 292 of file kmessagewidget.cpp.

◆ heightForWidth()

int KMessageWidget::heightForWidth ( int width ) const

overridevirtual

Returns the required height for width.

Parameters

width the width in pixels

Reimplemented from QWidget.

Definition at line 328 of file kmessagewidget.cpp.

◆ hideAnimationFinished

void KMessageWidget::hideAnimationFinished ( )

signal

This signal is emitted when the hide animation is finished, started by calling animatedHide().

If animations are disabled, this signal is emitted immediately after the message widget got hidden.

Note: This signal is not emitted if the widget was hidden by calling hide(), so this signal is only useful in conjunction with animatedHide().

See also: animatedHide()

Since: 5.0

◆ icon()

QIcon KMessageWidget::icon ( ) const

The icon shown on the left of the text.

By default, no icon is shown.

Since: 4.11

Definition at line 503 of file kmessagewidget.cpp.

◆ isCloseButtonVisible()

bool KMessageWidget::isCloseButtonVisible ( ) const

Check whether the close button is visible.

See also: setCloseButtonVisible()

Definition at line 402 of file kmessagewidget.cpp.

◆ isHideAnimationRunning()

bool KMessageWidget::isHideAnimationRunning ( ) const

Check whether the hide animation started by calling animatedHide() is still running.

If animations are disabled, this function always returns false.

See also: animatedHide(), hideAnimationFinished()

Since: 5.0

Definition at line 493 of file kmessagewidget.cpp.

◆ isShowAnimationRunning()

bool KMessageWidget::isShowAnimationRunning ( ) const

Check whether the show animation started by calling animatedShow() is still running.

If animations are disabled, this function always returns false.

See also: animatedShow(), showAnimationFinished()

Since: 5.0

Definition at line 498 of file kmessagewidget.cpp.

◆ linkActivated

void KMessageWidget::linkActivated ( const QString & contents )

signal

This signal is emitted when the user clicks a link in the text label.

The URL referred to by the href anchor is passed in contents.

Parameters

contents text of the href anchor

See also: QLabel::linkActivated()

Since: 4.10

◆ linkHovered

void KMessageWidget::linkHovered ( const QString & contents )

signal

This signal is emitted when the user hovers over a link in the text label.

The URL referred to by the href anchor is passed in contents.

Parameters

contents text of the href anchor

See also: QLabel::linkHovered()

Since: 4.11

◆ messageType()

KMessageWidget::MessageType KMessageWidget::messageType ( ) const

Get the type of this message.

By default, the type is set to KMessageWidget::Information.

See also: KMessageWidget::MessageType, setMessageType()

Definition at line 269 of file kmessagewidget.cpp.

◆ minimumSizeHint()

QSize KMessageWidget::minimumSizeHint ( ) const

overridevirtual

Returns the minimum size of the message widget.

Reimplemented from QWidget.

Definition at line 286 of file kmessagewidget.cpp.

◆ paintEvent()

void KMessageWidget::paintEvent ( QPaintEvent * event )

overrideprotectedvirtual

Reimplemented from QFrame.

Definition at line 334 of file kmessagewidget.cpp.

◆ position()

KMessageWidget::Position KMessageWidget::position ( ) const

Get the position of this message.

By default this is KMessageWidget::Inline.

See also: setPosition()

Since: 6.0

Definition at line 391 of file kmessagewidget.cpp.

◆ removeAction()

void KMessageWidget::removeAction ( QAction * action )

Remove action from the message widget.

Parameters

action the action to remove

See also: KMessageWidget::MessageType, addAction(), setMessageType()

Definition at line 419 of file kmessagewidget.cpp.

◆ resizeEvent()

void KMessageWidget::resizeEvent ( QResizeEvent * event )

overrideprotectedvirtual

Reimplemented from QWidget.

Definition at line 320 of file kmessagewidget.cpp.

◆ setCloseButtonVisible

void KMessageWidget::setCloseButtonVisible ( bool visible )

slot

Set the visibility of the close button.

If visible is true, a close button is shown that calls animatedHide() if clicked.

By default the close button is set to be visible.

See also: closeButtonVisible(), animatedHide()

Definition at line 407 of file kmessagewidget.cpp.

◆ setIcon

void KMessageWidget::setIcon ( const QIcon & icon )

slot

Define an icon to be shown on the left of the text.

Since: 4.11

Definition at line 508 of file kmessagewidget.cpp.

◆ setMessageType

void KMessageWidget::setMessageType ( KMessageWidget::MessageType type )

slot

Set the message type to type.

By default, the message type is set to KMessageWidget::Information. Appropriate colors are chosen to mimic the appearance of Kirigami's InlineMessage.

See also: messageType(), KMessageWidget::MessageType

Definition at line 274 of file kmessagewidget.cpp.

◆ setPosition

void KMessageWidget::setPosition ( KMessageWidget::Position position )

slot

Set the position of this message.

See also: position()

Since: 6.0

Definition at line 396 of file kmessagewidget.cpp.

◆ setText

void KMessageWidget::setText ( const QString & text )

slot

Set the text of the message widget to text.

If the message widget is already visible, the text changes on the fly.

Parameters

text	the text to display, rich text is allowed

See also: text()

Definition at line 253 of file kmessagewidget.cpp.

◆ setTextFormat()

void KMessageWidget::setTextFormat ( Qt::TextFormat textFormat )

Set the text format of the message widget's label.

See also: QLabel::setTextFormat()

Since: 6.0

Definition at line 264 of file kmessagewidget.cpp.

◆ setWordWrap

void KMessageWidget::setWordWrap ( bool wordWrap )

slot

Set word wrap to wordWrap.

If word wrap is enabled, the text() of the message widget is wrapped to fit the available width. If word wrap is disabled, the message widget's minimum size is such that the entire text fits.

By default word wrap is disabled.

Parameters

wordWrap disable/enable word wrap

See also: wordWrap()

Definition at line 375 of file kmessagewidget.cpp.

◆ showAnimationFinished

void KMessageWidget::showAnimationFinished ( )

signal

This signal is emitted when the show animation is finished, started by calling animatedShow().

If animations are disabled, this signal is emitted immediately after the message widget got shown.

Note: This signal is not emitted if the widget was shown by calling show(), so this signal is only useful in conjunction with animatedShow().

See also: animatedShow()

Since: 5.0

◆ sizeHint()

QSize KMessageWidget::sizeHint ( void ) const

overridevirtual

Returns the preferred size of the message widget.

Reimplemented from QFrame.

Definition at line 280 of file kmessagewidget.cpp.

◆ text()

QString KMessageWidget::text ( ) const

Get the text of this message widget.

See also: setText()

Definition at line 248 of file kmessagewidget.cpp.

◆ textFormat()

Qt::TextFormat KMessageWidget::textFormat ( ) const

Get the text format of the message widget's label.

See also: QLabel::textFormat()

Since: 6.0

Definition at line 259 of file kmessagewidget.cpp.

◆ wordWrap()

bool KMessageWidget::wordWrap ( ) const

Check whether word wrap is enabled.

If word wrap is enabled, the message widget wraps the displayed text as required to the available width of the widget. This is useful to avoid breaking widget layouts.

See also: setWordWrap()

Definition at line 370 of file kmessagewidget.cpp.

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KWidgetsAddons

KMessageWidget

Public Types

Properties

Signals

Public Slots

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ MessageType

◆ Position

Property Documentation

◆ closeButtonVisible

◆ icon

◆ messageType

◆ position

◆ text

◆ textFormat

◆ wordWrap

Constructor & Destructor Documentation

◆ KMessageWidget() [1/2]

◆ KMessageWidget() [2/2]

◆ ~KMessageWidget()

Member Function Documentation

◆ addAction()

◆ animatedHide

◆ animatedShow

◆ clearActions()

◆ event()

◆ heightForWidth()

◆ hideAnimationFinished

◆ icon()

◆ isCloseButtonVisible()

◆ isHideAnimationRunning()

◆ isShowAnimationRunning()

◆ linkActivated

◆ linkHovered

◆ messageType()

◆ minimumSizeHint()

◆ paintEvent()

◆ position()

◆ removeAction()

◆ resizeEvent()

◆ setCloseButtonVisible

◆ setIcon

◆ setMessageType

◆ setPosition

◆ setText

◆ setTextFormat()

◆ setWordWrap

◆ showAnimationFinished

◆ sizeHint()

◆ text()

◆ textFormat()

◆ wordWrap()