ColumnView Class Reference

#include <columnview.h>

Inheritance diagram for ColumnView:

Public Types
enum	ColumnResizeMode { FixedColumns = 0, DynamicColumns, SingleColumn }

Properties
qreal	bottomPadding
ColumnResizeMode	columnResizeMode
qreal	columnWidth
QQmlListProperty< QQuickItem >	contentChildren
QQmlListProperty< QObject >	contentData
QQuickItem	contentItem
qreal	contentWidth
qreal	contentX
int	count
int	currentIndex
QQuickItem	currentItem
bool	dragging
QQuickItem	firstVisibleItem
bool	interactive
QQuickItem	lastVisibleItem
bool	moving
int	scrollDuration
bool	separatorVisible
qreal	topPadding
QList< QObject * >	visibleItems
Properties inherited from QQuickItem
	activeFocus
	activeFocusOnTab
	baselineOffset
	childrenRect
	clip
	enabled
	focus
	height
	opacity
	parent
	state
	visible
	width
	x
	y
	z
Properties inherited from QObject
	objectName

Signals
void	bottomPaddingChanged ()
void	columnResizeModeChanged ()
void	columnWidthChanged ()
void	contentChildrenChanged ()
void	contentWidthChanged ()
void	contentXChanged ()
void	countChanged ()
void	currentIndexChanged ()
void	currentItemChanged ()
void	draggingChanged ()
void	firstVisibleItemChanged ()
void	interactiveChanged ()
void	itemInserted (int position, QQuickItem *item)
void	itemRemoved (QQuickItem *item)
void	lastVisibleItemChanged ()
void	movingChanged ()
void	scrollDurationChanged ()
void	separatorVisibleChanged ()
void	topPaddingChanged ()
void	visibleItemsChanged ()

Public Slots
void	addItem (QQuickItem *item)
void	clear ()
bool	containsItem (QQuickItem *item)
void	insertItem (int pos, QQuickItem *item)
void	moveItem (int from, int to)
QQuickItem *	pop (QQuickItem *item)
QQuickItem *	removeItem (const QVariant &item)

Public Member Functions
	ColumnView (QQuickItem *parent=nullptr)
qreal	bottomPadding () const
ColumnResizeMode	columnResizeMode () const
qreal	columnWidth () const
QQmlListProperty< QQuickItem >	contentChildren ()
QQmlListProperty< QObject >	contentData ()
QQuickItem *	contentItem () const
qreal	contentWidth () const
qreal	contentX () const
int	count () const
int	currentIndex () const
QQuickItem *	currentItem ()
bool	dragging () const
QQuickItem *	firstVisibleItem () const
bool	interactive () const
QQuickItem *	lastVisibleItem () const
bool	moving () const
QQuickItem *	removeItem (QQuickItem *item)
QQuickItem *	removeItem (int item)
int	scrollDuration () const
bool	separatorVisible () const
void	setBottomPadding (qreal padding)
void	setColumnResizeMode (ColumnResizeMode mode)
void	setColumnWidth (qreal width)
void	setContentX (qreal x) const
void	setCurrentIndex (int index)
void	setInteractive (bool interactive)
void	setScrollDuration (int duration)
void	setSeparatorVisible (bool visible)
void	setTopPadding (qreal padding)
qreal	topPadding () const
QList< QObject * >	visibleItems () const
Public Member Functions inherited from QQuickItem
	QQuickItem (QQuickItem *parent)
Qt::MouseButtons	acceptedMouseButtons () const
bool	acceptHoverEvents () const
bool	activeFocusOnTab () const
bool	antialiasing () const
qreal	baselineOffset () const
QQuickItem *	childAt (qreal x, qreal y) const
QList< QQuickItem * >	childItems () const
QRectF	childrenRect ()
bool	clip () const
virtual bool	contains (const QPointF &point) const
QCursor	cursor () const
bool	filtersChildMouseEvents () const
Flags	flags () const
void	forceActiveFocus ()
void	forceActiveFocus (Qt::FocusReason reason)
void	grabMouse ()
void	grabTouchPoints (const QVector< int > &ids)
bool	hasActiveFocus () const
bool	hasFocus () const
qreal	height () const
qreal	implicitHeight () const
qreal	implicitWidth () const
virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const
bool	isEnabled () const
bool	isFocusScope () const
virtual bool	isTextureProvider () const
bool	isVisible () const
bool	keepMouseGrab () const
bool	keepTouchGrab () const
QPointF	mapFromItem (const QQuickItem *item, const QPointF &point) const
QPointF	mapFromScene (const QPointF &point) const
QRectF	mapRectFromItem (const QQuickItem *item, const QRectF &rect) const
QRectF	mapRectFromScene (const QRectF &rect) const
QRectF	mapRectToItem (const QQuickItem *item, const QRectF &rect) const
QRectF	mapRectToScene (const QRectF &rect) const
QPointF	mapToItem (const QQuickItem *item, const QPointF &point) const
QPointF	mapToScene (const QPointF &point) const
QQuickItem *	nextItemInFocusChain (bool forward)
qreal	opacity () const
QQuickItem *	parentItem () const
void	polish ()
void	resetHeight ()
void	resetWidth ()
qreal	rotation () const
qreal	scale () const
QQuickItem *	scopedFocusItem () const
void	setAcceptedMouseButtons (Qt::MouseButtons buttons)
void	setAcceptHoverEvents (bool enabled)
void	setActiveFocusOnTab (bool)
void	setAntialiasing (bool)
void	setBaselineOffset (qreal)
void	setClip (bool)
void	setCursor (const QCursor &cursor)
void	setEnabled (bool)
void	setFiltersChildMouseEvents (bool filter)
void	setFlag (Flag flag, bool enabled)
void	setFlags (QFlags< QQuickItem::Flag > flags)
void	setFocus (bool)
void	setFocus (bool focus, Qt::FocusReason reason)
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	setSmooth (bool)
void	setState (const QString &)
void	setTransformOrigin (TransformOrigin)
void	setVisible (bool)
void	setWidth (qreal)
void	setX (qreal)
void	setY (qreal)
void	setZ (qreal)
bool	smooth () const
void	stackAfter (const QQuickItem *sibling)
void	stackBefore (const QQuickItem *sibling)
QString	state () const
virtual QSGTextureProvider *	textureProvider () const
TransformOrigin	transformOrigin () const
void	ungrabMouse ()
void	ungrabTouchPoints ()
void	unsetCursor ()
void	update ()
qreal	width () const
QQuickWindow *	window () const
void	windowChanged (QQuickWindow *window)
qreal	x () const
qreal	y () const
qreal	z () const
Public Member Functions inherited from QObject
	QObject (QObject *parent)
bool	blockSignals (bool block)
const QObjectList &	children () const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const
bool	disconnect (const QObject *receiver, const char *method) const
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, QFlags< Qt::FindChildOption > options) const
QList< T >	findChildren (const QString &name, QFlags< Qt::FindChildOption > options) const
QList< T >	findChildren (const QRegExp &regExp, QFlags< Qt::FindChildOption > options) const
QList< T >	findChildren (const QRegularExpression &re, QFlags< Qt::FindChildOption > options) const
bool	inherits (const char *className) const
void	installEventFilter (QObject *filterObj)
bool	isWidgetType () const
bool	isWindowType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
QString	objectName () const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const
QVariant	property (const char *name) const
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval, Qt::TimerType timerType)
QThread *	thread () const
Public Member Functions inherited from QQmlParserStatus
virtual void	classBegin ()=0
virtual void	componentComplete ()=0

Static Public Member Functions
static ColumnViewAttached *	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 *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
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, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)

Protected Member Functions
bool	childMouseEventFilter (QQuickItem *item, QEvent *event) override
void	classBegin () override
void	componentComplete () override
void	geometryChanged (const QRectF &newGeometry, const QRectF &oldGeometry) override
void	itemChange (QQuickItem::ItemChange change, const QQuickItem::ItemChangeData &value) override
void	mouseMoveEvent (QMouseEvent *event) override
void	mousePressEvent (QMouseEvent *event) override
void	mouseReleaseEvent (QMouseEvent *event) override
void	mouseUngrabEvent () override
void	updatePolish () override
Protected Member Functions inherited from QQuickItem
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)
virtual void	focusInEvent (QFocusEvent *event)
virtual void	focusOutEvent (QFocusEvent *event)
bool	heightValid () const
virtual void	hoverEnterEvent (QHoverEvent *event)
virtual void	hoverLeaveEvent (QHoverEvent *event)
virtual void	hoverMoveEvent (QHoverEvent *event)
virtual void	inputMethodEvent (QInputMethodEvent *event)
bool	isComponentComplete () 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	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
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
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Public Attributes inherited from QQuickItem
typedef	Flags

Detailed Description

ColumnView is a container that lays out items horizontally in a row, when not all items fit in the ColumnView, it will behave ike a Flickable and will be a scrollable view which shows only a determined number of columns.

The columns can either all have the same fixed size (recommended), size themselves with implicitWidth, or automatically expand to take all the available width: by default the last column will always be the expanding one. Items inside the Columnview can access info of the view and set layouting hints via the Columnview attached property.

This is the base for the implementation of PageRow

Since

2.7

Definition at line 121 of file columnview.h.

Property Documentation

qreal ColumnView::bottomPadding

readwrite

The padding this will have at the bottom.

Definition at line 176 of file columnview.h.

ColumnView::ColumnResizeMode ColumnView::columnResizeMode

readwrite

The strategy to follow while automatically resizing the columns, the enum can have the following values:

• FixedColumns: every column is fixed at the same width of the columnWidth property
• DynamicColumns: columns take their width from their implicitWidth
• SingleColumn: only one column at a time is shown, as wide as the viewport, eventual reservedSpace on the column's atttached property is ignored

Definition at line 132 of file columnview.h.

qreal ColumnView::columnWidth

readwrite

The width of all columns when columnResizeMode is FixedColumns.

Definition at line 137 of file columnview.h.

QQmlListProperty< QQuickItem > ColumnView::contentChildren

read

Every column item the view contains.

Definition at line 223 of file columnview.h.

QQmlListProperty< QObject > ColumnView::contentData

read

every item declared inside the view, both visual and non-visual items

Definition at line 227 of file columnview.h.

QQuickItem * ColumnView::contentItem

read

The main content item of this view: it's the parent of the column items.

Definition at line 156 of file columnview.h.

qreal ColumnView::contentWidth

read

The compound width of all columns in the view.

Definition at line 166 of file columnview.h.

qreal ColumnView::contentX

readwrite

The value of the horizontal scroll of the view, in pixels.

Definition at line 161 of file columnview.h.

int ColumnView::count

read

How many columns this view containsItem.

Definition at line 141 of file columnview.h.

int ColumnView::currentIndex

readwrite

The position of the currently active column.

The current column will also have keyboard focus

Definition at line 146 of file columnview.h.

QQuickItem * ColumnView::currentItem

read

The currently active column.

The current column will also have keyboard focus

Definition at line 151 of file columnview.h.

bool ColumnView::dragging

read

True when the user is dragging around with touch gestures the view contents.

Definition at line 207 of file columnview.h.

QQuickItem * ColumnView::firstVisibleItem

read

The first of visibleItems provided from convenience.

Definition at line 196 of file columnview.h.

bool ColumnView::interactive

readwrite

True if it supports moving the contents by dragging.

Definition at line 217 of file columnview.h.

QQuickItem * ColumnView::lastVisibleItem

read

The last of visibleItems provided from convenience.

Definition at line 201 of file columnview.h.

bool ColumnView::moving

read

True both when the user is dragging around with touch gestures the view contents or the view is animating.

Definition at line 212 of file columnview.h.

int ColumnView::scrollDuration

readwrite

The duration for scrolling animations.

Definition at line 181 of file columnview.h.

bool ColumnView::separatorVisible

readwrite

True if columns should be visually separed by a separator line.

Definition at line 186 of file columnview.h.

qreal ColumnView::topPadding

readwrite

The padding this will have at the top.

Definition at line 171 of file columnview.h.

QList< QObject * > ColumnView::visibleItems

read

The list of all visible column items that are at least partially in the viewport at any given moment.

Definition at line 191 of file columnview.h.

Member Function Documentation

void ColumnView::addItem ( QQuickItem *  item )

slot

Pushes a new item at the end of the view.

Parameters

item	the new item which will be reparented and managed

Definition at line 821 of file columnview.cpp.

void ColumnView::clear ( )

slot

Removes every item in the view.

Items will be reparented to their old parent. If they have JavaScript ownership and they didn't have an old parent, they will be destroyed

Definition at line 943 of file columnview.cpp.

bool ColumnView::containsItem ( QQuickItem *  item )

slot

Returns

true if the view contains the given item

Definition at line 959 of file columnview.cpp.

void ColumnView::insertItem ( int  pos, QQuickItem *  item  )

slot

Inserts a new item in the view at a given position.

The current Item will not be changed, currentIndex will be adjusted accordingly if needed to keep the same current item.

Parameters

pos	the position we want the new item to be inserted in
item	the new item which will be reparented and managed

Definition at line 826 of file columnview.cpp.

void ColumnView::itemInserted ( int  position, QQuickItem *  item  )

signal

A new item has been inserted.

Parameters

position	where the page has been inserted
item	a pointer to the new item

void ColumnView::itemRemoved ( QQuickItem *  item )

signal

An item has just been removed from the view.

Parameters

item	a pointer to the item that has just been removed

void ColumnView::moveItem ( int  from, int  to  )

slot

Move an item inside the view.

The currentIndex property may be changed in order to keep currentItem the same.

Parameters

from	the old position
to	the new position

Definition at line 855 of file columnview.cpp.

QQuickItem * ColumnView::pop ( QQuickItem *  item )

slot

Removes all the items after item.

Starting from the last column, every column will be removed until item is found, which will be left in place. Items will be reparented to their old parent. If they have JavaScript ownership and they didn't have an old parent, they will be destroyed

Parameters

item	the item which will be the new last one of the row.

Returns

the last item that has been removed

Definition at line 929 of file columnview.cpp.

QQuickItem * ColumnView::removeItem ( const QVariant &  item )

slot

Removes an item from the view.

Items will be reparented to their old parent. If they have JavaScript ownership and they didn't have an old parent, they will be destroyed. CurrentIndex may be changed in order to keep the same currentItem

Parameters

item	it can either be a pointer of an item or an integer specifying the position to remove

Returns

the item that has just been removed

Definition at line 880 of file columnview.cpp.

---

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

• columnview.h
• columnview.cpp