ColumnView QML Type

The padding this will have at the bottom

The strategy to follow while automatically resizing the columns

The default is FixedColumns.

The width of all columns when columnResizeMode is FixedColumns

Every column item the view contains

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

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

The compound width of all columns in the view

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

How many columns this view contains

The position of the currently active column. The current column will also have keyboard focus

The currently active column. The current column will also have keyboard focus

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

True if it supports moving the contents by dragging

The first of visibleItems provided from convenience

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

A JSon serialization of the columns widths. When columnResizeMode is DynamicColumns, columns can be resized via mouse. When this is the case, the sizes should be saved and restored on application startup.

Example code for saving and restore, assuming that the application exposes a singleton called App that has a "columnViewState" property that reads and writes to the config file:

Component.onCompleted: pageStack.columnView.savedState = App.columnViewState;
columnView.onSavedStateChanged: {
    App.columnViewState = pageStack.columnView.savedState;
}

The duration for scrolling animations

True if columns should be visually separated by a separator line

The padding this will have at the top

The last of visibleItems provided from convenience

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

If true, the column will expand to take the whole viewport space minus reservedSpace

True if this column is at least partly visible in the ColumnView's viewport.

The index position of the column in the view, starting from 0

True if this column supports interactive resize with mouse.

If the sizes should be saved and restored on application startup, it is the application responsibility to implement this, for instance exposing and object with properties for the desired column widths which reads and writes to the config. at the main Component.onCompleted of the ApplicationWindow root Item it will apply the preferred sizes of the desired pages.

The property will be written at interactiveResizingChanged signal handler.

This property was introduced in 6.16.

True when the user is actively resizing a column with the mouse. If the application wants to write the column sizes to config, it can sync to some global object property at interactiveResizingChanged:

Kirigami.ColumnView.onInteractiveResizingChanged: {
    if (!Kirigami.ColumnView.interactiveResizing) {
        myAppObject.leftColumnWidth = page.implicitWidth;
    }
}

This property was introduced in 6.16.

When a column is interactiveResizeEnabled, when resizing manually it will bound the column size between minimumWidth and maximumWidth

This property was introduced in 6.16.

When a column is interactiveResizeEnabled, when resizing manually it will bound the column size between minimumWidth and maximumWidth

This property was introduced in 6.16.

If true the page will never go out of view, but will stay either at the right or left side of the ColumnView

When we are in DynamicColumns mode, the columns will be resized to preferredWidth. When the column are resized with the mouse, this propoerty will be updated by the drag And will always be between minimumWidth and maximumWidth

This property was introduced in 6.16.

Like the same property of MouseArea, when this is true, the column view won't try to manage events by itself when filtering from a child, not disturbing user interaction

When a column is fillWidth, it will keep reservedSpace amount of pixels from going to fill the full viewport width

The view this column belongs to

A new item has been inserted

position where the page has been inserted

item a pointer to the new item

An item has just been removed from the view

item a pointer to the item that has just been removed

This method gets the item at index, if available

Note that if an invalid index is passed (either negative or greater then depth - 1) nullptr will be returned

index The index of the item to get.

This method was introduced in 6.16.

This method removes the last item from the view and returns it.

This method calls removeItem() on the last item.

Returns the removed item

See also removeItem().

This method removes all the items after the specified item or index from the view and returns the last item that was removed.

Note that if the passed value is neither of the values said below, it will return a nullptr.

item the item to remove. It can be an item, index or not defined in which case it will pop the last item.

This method removes an item from the view.

If the argument is a number, this method dispatches to removeItem(int index) to remove an item by its index. Otherwise the argument should be the item itself to be removed itself, and this method will dispatch to removeItem(QQuickItem *item).

index the index of the item which should be removed, or the item itself

Returns the removed item