SplitView

Search for usage in LXR

SplitView Class Reference
Inheritance diagram for SplitView:

Public Member Functions

void addSplit (component, properties)
 
void closeSplit (index)
 
- Public Member Functions inherited from QtQuick.Controls.SplitView
bool restoreState (state)
 
var saveState ()
 

Detailed Description

An extension to the QQC2 SplitView control, adding some extra functionality.

This controls inherits from QQC2 SplitView, to checkout its inherited properties refer to the Qt Docs. This control add a quick way to add split views and remove them.

See also
addSplit
closeSplit
Maui.SplitView
{
anchors.fill: parent
Maui.SplitViewItem
{
Rectangle
{
color: "orange"
anchors.fill: parent
}
}
Maui.SplitViewItem
{
Rectangle
{
color: "yellow"
anchors.fill: parent
}
}
}

You can find a more complete example at this link.

Definition at line 44 of file SplitView.qml.

Member Function Documentation

◆ addSplit()

void SplitView::addSplit ( component ,
properties  )

Adds a QQC2 Component as a view to the control.

Parameters
componentThe QQC2 Component wrapping the view to be added. Consider using a MauiKit SplitViewItem control as the view root element.
propertiesan optional map of properties to be applied to the created view component
Returns
the newly created object view.

◆ closeSplit()

void SplitView::closeSplit ( index )

Forces to close the split view at a given index.

If there is only one view at the time, then this method does nothing, in order to keep the control with at least one view.

Note
This function calls to the SplitView removeItem function.
Parameters
indexthe index of view to be closed

The documentation for this class was generated from the following file:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Dec 6 2024 12:06:04 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.