Contents

KTitleWidget Class

Standard title widget. More...

Header: #include <KTitleWidget>
CMake: find_package(KF6 REQUIRED COMPONENTS WidgetsAddons)
target_link_libraries(mytarget PRIVATE KF6::WidgetsAddons)
Inherits: QWidget

Public Types

enum ImageAlignment { ImageLeft, ImageRight }
enum MessageType { PlainMessage, InfoMessage, WarningMessage, ErrorMessage }

Properties

Public Functions

KTitleWidget(QWidget *parent = nullptr)
int autoHideTimeout() const
QString comment() const
(since 5.72) QIcon icon() const
(since 5.72) QSize iconSize() const
(since 5.53) int level()
void setBuddy(QWidget *buddy)
void setWidget(QWidget *widget)
QString text() const

Public Slots

void setAutoHideTimeout(int msecs)
void setComment(const QString &comment, KTitleWidget::MessageType type = PlainMessage)
(since 5.72) void setIcon(KTitleWidget::MessageType type, KTitleWidget::ImageAlignment alignment = ImageRight)
(since 5.63) void setIcon(const QIcon &icon, KTitleWidget::ImageAlignment alignment = ImageRight)
(since 5.72) void setIconSize(const QSize &iconSize)
(since 5.53) void setLevel(int level)
void setText(const QString &text, KTitleWidget::MessageType type)
void setText(const QString &text, Qt::Alignment alignment = Qt::AlignLeft | Qt::AlignVCenter)

Detailed Description

This class provides a widget often used for dialog titles.

KTitleWidget with title and icon

KTitleWidget uses the general application font at 1.4 times its size to style the text. This is a visual change from 4.x.

Usage:

KTitleWidget is very simple to use. You can either use its default text (and pixmap) properties or display your own widgets in the title widget.

A title text with a right-aligned pixmap:

KTitleWidget *titleWidget = new KTitleWidget(this);
titleWidget->setText(i18n("Title"));
titleWidget->setIcon(QIcon::fromTheme("screen"));

Use it with an own widget:

KTitleWidget *checkboxTitleWidget = new KTitleWidget(this);

QWidget *checkBoxTitleMainWidget = new QWidget(this);
QVBoxLayout *titleLayout = new QVBoxLayout(checkBoxTitleMainWidget);
titleLayout->setContentsMargins(6, 6, 6, 6);

QCheckBox *checkBox = new QCheckBox("Text Checkbox", checkBoxTitleMainWidget);
titleLayout->addWidget(checkBox);

checkboxTitleWidget->setWidget(checkBoxTitleMainWidget);

See also KPageView.

Member Type Documentation

enum KTitleWidget::ImageAlignment

Possible title pixmap alignments.

ConstantValueDescription
KTitleWidget::ImageLeft0Display the pixmap left
KTitleWidget::ImageRight1Display the pixmap right (default)

enum KTitleWidget::MessageType

Comment message types

ConstantValueDescription
KTitleWidget::PlainMessage0Normal comment
KTitleWidget::InfoMessage1Information the user should be alerted to
KTitleWidget::WarningMessage2A warning the user should be alerted to
KTitleWidget::ErrorMessage3An error message

Property Documentation

autoHideTimeout : int

Access functions:

int autoHideTimeout() const
void setAutoHideTimeout(int msecs)

comment : QString

Access functions:

QString comment() const
void setComment(const QString &comment, KTitleWidget::MessageType type = PlainMessage)

[since 5.72] icon : QIcon

This property was introduced in 5.72.

Access functions:

QIcon icon() const
void setIcon(const QIcon &icon, KTitleWidget::ImageAlignment alignment = ImageRight)
void setIcon(KTitleWidget::MessageType type, KTitleWidget::ImageAlignment alignment = ImageRight)

[since 5.72] iconSize : QSize

This property was introduced in 5.72.

Access functions:

QSize iconSize() const
void setIconSize(const QSize &iconSize)

text : QString

Access functions:

QString text() const
void setText(const QString &text, Qt::Alignment alignment = Qt::AlignLeft | Qt::AlignVCenter)
void setText(const QString &text, KTitleWidget::MessageType type)

Member Function Documentation

[explicit] KTitleWidget::KTitleWidget(QWidget *parent = nullptr)

Constructs a title widget.

int KTitleWidget::autoHideTimeout() const

Get the current timeout value in milliseconds

Returns timeout value in msecs

Note: Getter function for property autoHideTimeout.

See also setAutoHideTimeout().

QString KTitleWidget::comment() const

Returns the text displayed in the comment below the title, if any

Note: Getter function for property comment.

See also setComment().

[since 5.72] QIcon KTitleWidget::icon() const

Returns the icon displayed in the title

Note: Getter function for property icon.

This function was introduced in 5.72.

See also setIcon().

[since 5.72] QSize KTitleWidget::iconSize() const

Returns the size of the icon displayed in the title

Note: Getter function for property iconSize.

This function was introduced in 5.72.

See also setIconSize().

[since 5.53] int KTitleWidget::level()

Returns the level of this title: it influences the font size following the guidelines in the KDE HIG. It also corresponds to the level api of Kirigami Heading for QML applications

This function was introduced in 5.53.

See also setLevel().

[slot] void KTitleWidget::setAutoHideTimeout(int msecs)

Set the autohide timeout of the label

Set value to 0 to disable autohide, which is the default.

msecs timeout value in milliseconds

Note: Setter function for property autoHideTimeout.

See also autoHideTimeout().

void KTitleWidget::setBuddy(QWidget *buddy)

Sets this label's buddy to buddy.

When the user presses the shortcut key indicated by the label in this title widget, the keyboard focus is transferred to the label's buddy widget.

buddy the widget to activate when the shortcut key is activated

[slot] void KTitleWidget::setComment(const QString &comment, KTitleWidget::MessageType type = PlainMessage)

comment Text displayed beneath the main title as a comment. It can either be plain text or rich text. type The sort of message it is.

Note: Setter function for property comment.

See also comment().

[slot, since 5.72] void KTitleWidget::setIcon(KTitleWidget::MessageType type, KTitleWidget::ImageAlignment alignment = ImageRight)

type the type of message icon to display in the header

alignment alignment of the icon (default is right aligned).

Note: Setter function for property icon.

This function was introduced in 5.72.

See also icon().

[slot, since 5.63] void KTitleWidget::setIcon(const QIcon &icon, KTitleWidget::ImageAlignment alignment = ImageRight)

Set the icon to display in the header.

icon the icon to display in the header.

alignment alignment of the icon (default is right aligned).

Note: Setter function for property icon.

This function was introduced in 5.63.

[slot, since 5.72] void KTitleWidget::setIconSize(const QSize &iconSize)

Set the size of the icon to display in the header.

iconSize the size of the icon, or an invalid QSize to reset to the default

The default size is defined by the GUI style and its value for QStyle::PM_MessageBoxIconSize.

Note: Setter function for property iconSize.

This function was introduced in 5.72.

See also iconSize().

[slot, since 5.53] void KTitleWidget::setLevel(int level)

Sets the level of this title, similar to HTML's h1 h2 h3...

Follows the KDE HIG.

level the level of the title, 1 is the biggest font and most important, descending

This function was introduced in 5.53.

See also level().

[slot] void KTitleWidget::setText(const QString &text, KTitleWidget::MessageType type)

text Text displayed on the label. It can either be plain text or rich text. If it is plain text, the text is displayed as a bold title text.

type The sort of message it is; will also set the icon accordingly

Note: Setter function for property text.

See also text().

[slot] void KTitleWidget::setText(const QString &text, Qt::Alignment alignment = Qt::AlignLeft | Qt::AlignVCenter)

text Text displayed on the label. It can either be plain text or rich text. If it is plain text, the text is displayed as a bold title text.

alignment Alignment of the text. Default is left and vertical centered.

Note: Setter function for property text.

See also text().

void KTitleWidget::setWidget(QWidget *widget)

widget Widget displayed on the title widget.

QString KTitleWidget::text() const

Returns the text displayed in the title

Note: Getter function for property text.

See also setText().