HeaderFooterLayout

#include <headerfooterlayout.h>

Inheritance diagram for HeaderFooterLayout:

[legend]

Properties
QQuickItem *	contentItem

QQuickItem *	footer

QML_ELEMENTQQuickItem *	header

Properties inherited from QQuickItem
	activeFocus

	activeFocusOnTab

	antialiasing

	baselineOffset

	childrenRect

	clip

	containmentMask

	enabled

	focus

	height

	implicitHeight

	implicitWidth

	opacity

	parent

	rotation

	scale

	smooth

	state

	transformOrigin

	visible

	width

	x

	y

	z

Properties inherited from QObject
	objectName

Signals
void	contentItemChanged ()

void	footerChanged ()

void	headerChanged ()

Public Member Functions
	HeaderFooterLayout (QQuickItem *parent=nullptr)

QQuickItem *	contentItem ()

QQuickItem *	footer ()

Q_INVOKABLE void	forceLayout ()

QQuickItem *	header ()

void	setContentItem (QQuickItem *item)

void	setFooter (QQuickItem *item)

void	setHeader (QQuickItem *item)

Public Member Functions inherited from QQuickItem
	QQuickItem (QQuickItem *parent)

Qt::MouseButtons	acceptedMouseButtons () const const

bool	acceptHoverEvents () const const

bool	acceptTouchEvents () const const

void	activeFocusChanged (bool)

bool	activeFocusOnTab () const const

void	activeFocusOnTabChanged (bool)

bool	antialiasing () const const

void	antialiasingChanged (bool)

qreal	baselineOffset () const const

void	baselineOffsetChanged (qreal)

QBindable< qreal >	bindableHeight ()

QBindable< qreal >	bindableWidth ()

QBindable< qreal >	bindableX ()

QBindable< qreal >	bindableY ()

virtual QRectF	boundingRect () const const

QQuickItem *	childAt (qreal x, qreal y) const const

QList< QQuickItem * >	childItems () const const

QRectF	childrenRect ()

void	childrenRectChanged (const QRectF &)

bool	clip () const const

void	clipChanged (bool)

virtual QRectF	clipRect () const const

QObject *	containmentMask () const const

void	containmentMaskChanged ()

virtual bool	contains (const QPointF &point) const const

QCursor	cursor () const const

void	dumpItemTree () const const

void	enabledChanged ()

void	ensurePolished ()

bool	filtersChildMouseEvents () const const

Flags	flags () const const

void	focusChanged (bool)

void	forceActiveFocus ()

void	forceActiveFocus (Qt::FocusReason reason)

void	grabMouse ()

QSharedPointer< QQuickItemGrabResult >	grabToImage (const QSize &targetSize)

void	grabTouchPoints (const QList< int > &ids)

bool	hasActiveFocus () const const

bool	hasFocus () const const

qreal	height () const const

void	heightChanged ()

qreal	implicitHeight () const const

void	implicitHeightChanged ()

qreal	implicitWidth () const const

void	implicitWidthChanged ()

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const const

bool	isAncestorOf (const QQuickItem *child) const const

bool	isEnabled () const const

bool	isFocusScope () const const

virtual bool	isTextureProvider () const const

bool	isVisible () const const

bool	keepMouseGrab () const const

bool	keepTouchGrab () const const

QPointF	mapFromGlobal (const QPointF &point) const const

QPointF	mapFromItem (const QQuickItem *item, const QPointF &point) const const

QPointF	mapFromScene (const QPointF &point) const const

QRectF	mapRectFromItem (const QQuickItem *item, const QRectF &rect) const const

QRectF	mapRectFromScene (const QRectF &rect) const const

QRectF	mapRectToItem (const QQuickItem *item, const QRectF &rect) const const

QRectF	mapRectToScene (const QRectF &rect) const const

QPointF	mapToGlobal (const QPointF &point) const const

QPointF	mapToItem (const QQuickItem *item, const QPointF &point) const const

QPointF	mapToScene (const QPointF &point) const const

QQuickItem *	nextItemInFocusChain (bool forward)

qreal	opacity () const const

void	opacityChanged ()

void	parentChanged (QQuickItem *)

QQuickItem *	parentItem () const const

void	polish ()

void	resetAntialiasing ()

void	resetHeight ()

void	resetWidth ()

qreal	rotation () const const

void	rotationChanged ()

qreal	scale () const const

void	scaleChanged ()

QQuickItem *	scopedFocusItem () const const

void	setAcceptedMouseButtons (Qt::MouseButtons buttons)

void	setAcceptHoverEvents (bool enabled)

void	setAcceptTouchEvents (bool enabled)

void	setActiveFocusOnTab (bool)

void	setAntialiasing (bool)

void	setBaselineOffset (qreal)

void	setClip (bool)

void	setContainmentMask (QObject *mask)

void	setCursor (const QCursor &cursor)

void	setEnabled (bool)

void	setFiltersChildMouseEvents (bool filter)

void	setFlag (Flag flag, bool enabled)

void	setFlags (Flags flags)

void	setFocus (bool focus, Qt::FocusReason reason)

void	setFocus (bool)

void	setHeight (qreal)

void	setImplicitHeight (qreal)

void	setImplicitWidth (qreal)

void	setKeepMouseGrab (bool keep)

void	setKeepTouchGrab (bool keep)

void	setOpacity (qreal)

void	setParentItem (QQuickItem *parent)

void	setRotation (qreal)

void	setScale (qreal)

void	setSize (const QSizeF &size)

void	setSmooth (bool)

void	setState (const QString &)

void	setTransformOrigin (TransformOrigin)

void	setVisible (bool)

void	setWidth (qreal)

void	setX (qreal)

void	setY (qreal)

void	setZ (qreal)

QSizeF	size () const const

bool	smooth () const const

void	smoothChanged (bool)

void	stackAfter (const QQuickItem *sibling)

void	stackBefore (const QQuickItem *sibling)

QString	state () const const

void	stateChanged (const QString &)

virtual QSGTextureProvider *	textureProvider () const const

TransformOrigin	transformOrigin () const const

void	transformOriginChanged (TransformOrigin)

void	ungrabMouse ()

void	ungrabTouchPoints ()

void	unsetCursor ()

void	update ()

QQuickItem *	viewportItem () const const

void	visibleChanged ()

qreal	width () const const

void	widthChanged ()

QQuickWindow *	window () const const

void	windowChanged (QQuickWindow *window)

qreal	x () const const

void	xChanged ()

qreal	y () const const

void	yChanged ()

qreal	z () const const

void	zChanged ()

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 QQmlParserStatus

Protected Member Functions
void	componentComplete () override

void	geometryChange (const QRectF &newGeometry, const QRectF &oldGeometry) override

void	updatePolish () override

Protected Member Functions inherited from QQuickItem
virtual bool	childMouseEventFilter (QQuickItem item, QEvent event)

virtual void	classBegin () override

virtual void	dragEnterEvent (QDragEnterEvent *event)

virtual void	dragLeaveEvent (QDragLeaveEvent *event)

virtual void	dragMoveEvent (QDragMoveEvent *event)

virtual void	dropEvent (QDropEvent *event)

virtual bool	event (QEvent *ev) override

virtual void	focusInEvent (QFocusEvent *)

virtual void	focusOutEvent (QFocusEvent *)

bool	heightValid () const const

virtual void	hoverEnterEvent (QHoverEvent *event)

virtual void	hoverLeaveEvent (QHoverEvent *event)

virtual void	hoverMoveEvent (QHoverEvent *event)

virtual void	inputMethodEvent (QInputMethodEvent *event)

bool	isComponentComplete () const const

virtual void	itemChange (ItemChange change, const ItemChangeData &value)

virtual void	keyPressEvent (QKeyEvent *event)

virtual void	keyReleaseEvent (QKeyEvent *event)

virtual void	mouseDoubleClickEvent (QMouseEvent *event)

virtual void	mouseMoveEvent (QMouseEvent *event)

virtual void	mousePressEvent (QMouseEvent *event)

virtual void	mouseReleaseEvent (QMouseEvent *event)

virtual void	mouseUngrabEvent ()

virtual void	releaseResources ()

virtual void	touchEvent (QTouchEvent *event)

virtual void	touchUngrabEvent ()

void	updateInputMethod (Qt::InputMethodQueries queries)

virtual QSGNode *	updatePaintNode (QSGNode oldNode, UpdatePaintNodeData updatePaintNodeData)

virtual void	wheelEvent (QWheelEvent *event)

bool	widthValid () const const

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
Public Types inherited from QQuickItem
enum	Flag

typedef	Flags

enum	ItemChange

enum	TransformOrigin

Public Types inherited from QObject
typedef	QObjectList

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 QQuickItem
	Bottom

	BottomLeft

	BottomRight

	Center

	ItemAcceptsDrops

	ItemAcceptsInputMethod

	ItemActiveFocusHasChanged

	ItemAntialiasingHasChanged

	ItemChildAddedChange

	ItemChildRemovedChange

	ItemClipsChildrenToShape

	ItemDevicePixelRatioHasChanged

	ItemEnabledHasChanged

	ItemHasContents

	ItemIsFocusScope

	ItemIsViewport

	ItemObservesViewport

	ItemOpacityHasChanged

	ItemParentHasChanged

	ItemRotationHasChanged

	ItemSceneChange

	ItemVisibleHasChanged

	Left

	Right

	Top

	TopLeft

	TopRight

Detailed Description

replicates a little part of what Page does, It's a container with 3 properties, header, contentItem and footer which will be laid out oone on top of each other.

It works better than a ColumnLayout when the elements are to be defined by properties by the user, which would require ugly reparenting dances and container items to maintain the layout well behaving.

Definition at line 21 of file headerfooterlayout.h.

Property Documentation

◆ contentItem

QQuickItem * HeaderFooterLayout::contentItem

readwrite

This property holds the visual content Item.

It will be resized both in width and height with the layout resizing. Its height will be resized to still have room for the heder and footer

Definition at line 39 of file headerfooterlayout.h.

◆ footer

QQuickItem * HeaderFooterLayout::footer

readwrite

This property holds the page footer item.

The footer item is positioned to the bottom, and resized to the width of the page. The default value is null.

Definition at line 47 of file headerfooterlayout.h.

◆ header

QQuickItem * HeaderFooterLayout::header

readwrite

This property holds the page header item.

The header item is positioned to the top, and resized to the width of the page. The default value is null.

Definition at line 31 of file headerfooterlayout.h.

Constructor & Destructor Documentation

◆ HeaderFooterLayout()

HeaderFooterLayout::HeaderFooterLayout ( QQuickItem * parent = nullptr )

Definition at line 13 of file headerfooterlayout.cpp.

◆ ~HeaderFooterLayout()

HeaderFooterLayout::~HeaderFooterLayout ( )

override

Definition at line 20 of file headerfooterlayout.cpp.

Member Function Documentation

◆ componentComplete()

void HeaderFooterLayout::componentComplete ( )

overrideprotectedvirtual

Reimplemented from QQuickItem.

Definition at line 149 of file headerfooterlayout.cpp.

◆ forceLayout()

void HeaderFooterLayout::forceLayout ( )

HeaderFooterLayout normally positions its header, footer and contentItem once per frame (at polish event).

This method forces the it to recalculate the layout immediately.

Definition at line 135 of file headerfooterlayout.cpp.

◆ geometryChange()

void HeaderFooterLayout::geometryChange	(	const QRectF &	newGeometry,
		const QRectF &	oldGeometry )

overrideprotectedvirtual

Reimplemented from QQuickItem.

Definition at line 140 of file headerfooterlayout.cpp.

◆ setContentItem()

void HeaderFooterLayout::setContentItem ( QQuickItem * item )

Definition at line 66 of file headerfooterlayout.cpp.

◆ setFooter()

void HeaderFooterLayout::setFooter ( QQuickItem * item )

Definition at line 96 of file headerfooterlayout.cpp.

◆ setHeader()

void HeaderFooterLayout::setHeader ( QQuickItem * item )

Definition at line 27 of file headerfooterlayout.cpp.

◆ updatePolish()

void HeaderFooterLayout::updatePolish ( )

overrideprotectedvirtual

Reimplemented from QQuickItem.

Definition at line 157 of file headerfooterlayout.cpp.

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About Kirigami2

HeaderFooterLayout

Properties

Signals

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Property Documentation

◆ contentItem

◆ footer

◆ header

Constructor & Destructor Documentation

◆ HeaderFooterLayout()

◆ ~HeaderFooterLayout()

Member Function Documentation

◆ componentComplete()

◆ forceLayout()

◆ geometryChange()

◆ setContentItem()

◆ setFooter()

◆ setHeader()

◆ updatePolish()