#include <controls.h>

Inheritance diagram for Controls:

Public Types
enum	Level { Undefined , Primary , Secondary }

Public Types inherited from QObject
typedef	QObjectList

Properties
QString	badgeText

QString	color

QQmlComponent *	component

bool	flat

QString	iconName

QQuickItem *	item

Level	level

bool	showCSD

Status	status

QString	subtitle

QML_ELEMENTQString	title

QString	toolTipText

Properties inherited from QObject
	objectName

Signals
void	badgeTextChanged ()

void	colorChanged ()

void	componentChanged ()

void	flatChanged ()

void	iconNameChanged ()

void	itemChanged ()

void	levelChanged ()

void	showCSDChanged ()

void	statusChanged ()

void	subtitleChanged ()

void	titleChanged ()

void	toolTipTextChanged ()

Public Member Functions
QString	badgeText () const

QString	color () const

QQmlComponent *	component () const

bool	flat () const

QString	iconName () const

QQuickItem *	item () const

Controls::Level	level () const

	Q_ENUM (Level) enum Status

	Q_ENUM (Status) explicit Controls(QObject *parent

void	setBadgeText (const QString &newBadgeText)

void	setColor (const QString &newColor)

void	setComponent (QQmlComponent *component)

void	setFlat (bool value)

void	setIconName (const QString &newIconName)

void	setItem (QQuickItem *item)

void	setLevel (Level level)

void	setShowCSD (bool newShowCSD)

void	setStatus (Controls::Status status)

void	setSubtitle (const QString &subtitle)

void	setTitle (const QString &title)

void	setToolTipText (const QString &newToolTipText)

bool	showCSD () const

Controls::Status	status () const

QString	subtitle () const

QString	title () const

QString	toolTipText () 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	event (QEvent *e)

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

Static Public Member Functions
static Controls *	qmlAttachedProperties (QObject *object)

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)

Additional Inherited Members
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)

Detailed Description

The Controls class.

This object exposes a series of attached properties useful for the MauiKit controls as a sort of common set of metadata.

Note: This is mean to be used as an attached property. It can be consumed as Maui.Controls, for example, Maui.Controls.showCSD

Definition at line 17 of file controls.h.

Member Enumeration Documentation

◆ Level

enum Controls::Level

Definition at line 206 of file controls.h.

Property Documentation

◆ badgeText

QString Controls::badgeText

readwrite

The text to be used as a badge for notification purposes.

If this is left empty, then not badge will be shown.

Badge text notification on a few controls

Some of the controls that support this attached property include:

Definition at line 60 of file controls.h.

◆ color

QString Controls::color

readwrite

The color to be used as an indicator in the supported widgets.

Supported widgets include:

Definition at line 70 of file controls.h.

◆ component

QQmlComponent * Controls::component

readwrite

Some controls might depend of a custom Component to be rendered.

Some of those controls include:

Menu
ToolBar

Note: The Menu control depends on this custom property to set a custom menu header, instead of the default one that relies on a title, subtitle, and icon source.

A Menu with a custom header via `Maui.Controls.component` attached property

Definition at line 201 of file controls.h.

◆ flat

bool Controls::flat

readwrite

A property hint for UI elements to be styled as a flat surface, for example, without a background.

Although some controls have this property implicitly available, some other controls do not, and thus this is the way to set it. By default this is set to false.

Definition at line 132 of file controls.h.

◆ iconName

QString Controls::iconName

readwrite

The icon name to be used in or by the widget.

Definition at line 43 of file controls.h.

◆ item

QQuickItem * Controls::item

readwrite

Definition at line 202 of file controls.h.

◆ level

Level Controls::level

readwrite

Set a UI element hierarchy level.

For example, in a page with two toolbars one could be Level::Primary, and the other one Level::Secondary, this will allow to better style the toolbars for differentiation. By default Level::Primary is assumed.

See also: Level

A primary and secondary toolbar

    import QtQuick
     import QtQuick.Controls
     import org.mauikit.controls as Maui
 
Maui.ApplicationWindow
{
    Maui.Page
    {
        anchors.fill: parent
 
      Maui.Controls.showCSD: true
      headBar.leftContent: Label
      {
          text: "Primary"
      }
 
     headerColumn: Maui.ToolBar
     {
         width: parent.width
         Maui.Controls.level: Maui.Controls.Secondary
 
            Label
            {
                text: "Secondary"
            }
        }
    }
}

Definition at line 125 of file controls.h.

◆ showCSD

bool Controls::showCSD

readwrite

Whether a supported MauiKit control should display the window control buttons when using client side decorations.

Some of the supported controls include:

Definition at line 85 of file controls.h.

◆ status

Status Controls::status

readwrite

Mark the supported widget in one of the given status, which will alterate its look.

This can serve as a visual clue of an important state or action.

See also: Status

Suported widgets include:

Button
MenuItem

Button with different status

import QtQuick
 import QtQuick.Controls
 import org.mauikit.controls as Maui
 
     Maui.ApplicationWindow
     {
 
         Maui.Page
         {
             anchors.fill: parent
 
           Column
           {
               anchors.centerIn: parent
               spacing: Maui.Style.space.big
 
               Button
               {
                   text: "Normal"
                   Maui.Controls.status: Maui.Controls.Normal
               }
 
               Button
               {
                   text: "Positive"
                   Maui.Controls.status: Maui.Controls.Positive
               }
 
               Button
               {
                   text: "Neutral"
                   Maui.Controls.status: Maui.Controls.Neutral
               }
 
               Button
               {
                   text: "Negative"
                   Maui.Controls.status: Maui.Controls.Negative
               }
           }
       }
   }

Definition at line 190 of file controls.h.

◆ subtitle

QString Controls::subtitle

readwrite

A subtitle text that can be attached to any control.

This property can be used in the Menu type to set the subtitle in the header information.

Menu with header information: title, subtitle and icon source

Definition at line 38 of file controls.h.

◆ title

QML_ELEMENTQString Controls::title

readwrite

A title text that can be attached to any control.

Note: Some controls depend on this property to be set in order show revelant information. For example, for the SplitViewItem, when requesting to close a view, the view can be referenced by the given title.

Definition at line 30 of file controls.h.

◆ toolTipText

QString Controls::toolTipText

readwrite

The text to be shown in the tool-tip when hovering over the tab button representing the view.

Definition at line 75 of file controls.h.

Member Function Documentation

◆ badgeText()

QString Controls::badgeText ( ) const

Definition at line 72 of file controls.cpp.

◆ color()

QString Controls::color ( ) const

Definition at line 100 of file controls.cpp.

◆ component()

QQmlComponent * Controls::component ( ) const

Definition at line 157 of file controls.cpp.

◆ flat()

bool Controls::flat ( ) const

Definition at line 129 of file controls.cpp.

◆ iconName()

QString Controls::iconName ( ) const

Definition at line 58 of file controls.cpp.

◆ item()

QQuickItem * Controls::item ( ) const

Definition at line 171 of file controls.cpp.

◆ level()

Controls::Level Controls::level ( ) const

Definition at line 115 of file controls.cpp.

◆ Q_ENUM()

Controls::Q_ENUM ( Level )

inline

Definition at line 211 of file controls.h.

◆ qmlAttachedProperties()

Controls * Controls::qmlAttachedProperties ( QObject * object )

static

Definition at line 9 of file controls.cpp.

◆ setBadgeText()

void Controls::setBadgeText ( const QString & newBadgeText )

Definition at line 77 of file controls.cpp.

◆ setColor()

void Controls::setColor ( const QString & newColor )

Definition at line 105 of file controls.cpp.

◆ setComponent()

void Controls::setComponent ( QQmlComponent * component )

Definition at line 162 of file controls.cpp.

◆ setFlat()

void Controls::setFlat ( bool value )

Definition at line 134 of file controls.cpp.

◆ setIconName()

void Controls::setIconName ( const QString & newIconName )

Definition at line 63 of file controls.cpp.

◆ setItem()

void Controls::setItem ( QQuickItem * item )

Definition at line 176 of file controls.cpp.

◆ setLevel()

void Controls::setLevel ( Controls::Level level )

Definition at line 120 of file controls.cpp.

◆ setShowCSD()

void Controls::setShowCSD ( bool newShowCSD )

Definition at line 21 of file controls.cpp.

◆ setStatus()

void Controls::setStatus ( Controls::Status status )

Definition at line 148 of file controls.cpp.

◆ setSubtitle()

void Controls::setSubtitle ( const QString & subtitle )

Definition at line 49 of file controls.cpp.

◆ setTitle()

void Controls::setTitle ( const QString & title )

Definition at line 35 of file controls.cpp.

◆ setToolTipText()

void Controls::setToolTipText ( const QString & newToolTipText )

Definition at line 91 of file controls.cpp.

◆ showCSD()

bool Controls::showCSD ( ) const

Definition at line 16 of file controls.cpp.

◆ status()

Controls::Status Controls::status ( ) const

Definition at line 143 of file controls.cpp.

◆ subtitle()

QString Controls::subtitle ( ) const

Definition at line 44 of file controls.cpp.

◆ title()

QString Controls::title ( ) const

Definition at line 30 of file controls.cpp.

◆ toolTipText()

QString Controls::toolTipText ( ) const

Definition at line 86 of file controls.cpp.

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

Class Picker

Quick Links

About MauiKit Controls

Controls

Public Types

Properties

Signals

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Level

Property Documentation

◆ badgeText

◆ color

◆ component

◆ flat

◆ iconName

◆ item

◆ level

◆ showCSD

◆ status

◆ subtitle

◆ title

◆ toolTipText

Member Function Documentation

◆ badgeText()

◆ color()

◆ component()

◆ flat()

◆ iconName()

◆ item()

◆ level()

◆ Q_ENUM()

◆ qmlAttachedProperties()

◆ setBadgeText()

◆ setColor()

◆ setComponent()

◆ setFlat()

◆ setIconName()

◆ setItem()

◆ setLevel()

◆ setShowCSD()

◆ setStatus()

◆ setSubtitle()

◆ setTitle()

◆ setToolTipText()

◆ showCSD()

◆ status()

◆ subtitle()

◆ title()

◆ toolTipText()