SideBar Class Reference

Inherits Pane.

Properties
bool	autoHide
bool	autoShow
bool	collapsed
int	constrainedWidth
alias	content
int	maximumWidth
int	minimumWidth
bool	peeking
alias	position
int	preferredWidth
bool	resizeable
bool	resizing
Item	sideBarView

Signals
void	closed ()
void	opened ()

Public Member Functions
void	close ()
void	open ()
void	toggle ()

Detailed Description

The container for the sidebar section in the SideBarView.

This is the container for the sidebar section in the SideBarView.

Warning

This control is private and can not be used independently. It exists only as part of the SideBarView implementation and can only be accessed via the exposed alias property sideBar in said control.

See also

SideBarView

Definition at line 30 of file SideBar.qml.

Property Documentation

autoHide

bool SideBar::autoHide

read

If when collapsed the sidebar should automatically be hidden or stay in place.

By default the sidebar will stay in place, and the SideBarView main area content will be displaced.

Definition at line 74 of file SideBar.qml.

autoShow

bool SideBar::autoShow

read

If when opened/un-collapsed - after have been hidden - the sidebar should automatically be shown or remain hidden.

By default the sidebar will be shown as soon as it is un-collapsed.

Definition at line 79 of file SideBar.qml.

collapsed

bool SideBar::collapsed

read

If the sidebar should be collapsed or not, this property can be used to dynamically collapse the sidebar on constrained spaces.

For example, using unit metrics to determine an appropriate size-width restriction: if the application window width is less than 400 pixels then collapse the sidebar, or if the SideBarView main content area width is less than an ideal width size, then collapse the sidebar.

Definition at line 65 of file SideBar.qml.

constrainedWidth

int SideBar::constrainedWidth

read

The actual size of the width that the sidebar will have in order to reserve a right margin to never exceed the SideBarView full width.

Most of the time this value will be the same as the sidebar preferred width

Remarks

This property is read-only

Definition at line 85 of file SideBar.qml.

content

alias SideBar::content

read

Remarks

This is the default property

Definition at line 60 of file SideBar.qml.

maximumWidth

int SideBar::maximumWidth

read

The maximum width the sidebar can have when being resized.

Definition at line 94 of file SideBar.qml.

minimumWidth

int SideBar::minimumWidth

read

The minimum width the sidebar can have when being resized.

Definition at line 98 of file SideBar.qml.

peeking

bool SideBar::peeking

read

True when the sidebar is collapse but it is still visible.

Remarks

This property is read-only

Definition at line 49 of file SideBar.qml.

position

double SideBar::position

read

The position of the sidebar.

Remarks

This property is read-only

1 means it is full opened, while 0 means it has been hidden. Values in-between can be used to determined the actual position between the open and hidden states.

Definition at line 44 of file SideBar.qml.

preferredWidth

int SideBar::preferredWidth

read

The preferred width of the sidebar in the expanded state.

This value can be changed by the user action of manually resizing the sidebar.

Definition at line 90 of file SideBar.qml.

resizeable

bool SideBar::resizeable

read

Wether the sidebar area can be resized manually by using a cursor or touch gesture.

The resizing will be stopped at reaching the minimum and/or maximum values.

Definition at line 69 of file SideBar.qml.

resizing

bool SideBar::resizing

read

True when the resizing the sidebar by the user action.

Remarks

This property is read-only

Definition at line 54 of file SideBar.qml.

sideBarView

Item SideBar::sideBarView

read

The SideBarView item to which this sidebar section belongs.

Definition at line 37 of file SideBar.qml.

Member Function Documentation

close()

void SideBar::close

(

)

Force to close the sidebar.

This will make the position of the sidebar equal to 0.

open()

void SideBar::open

(

)

Force to open the sidebar and expand it.

toggle()

void SideBar::toggle

(

)

Switch between the open and closed states.

---

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

• SideBar.qml