PlacesListBrowser

Search for usage in LXR

PlacesListBrowser Class Reference

Properties

string currentPath
 
int iconSize
 
alias itemMenu
 
alias list
 

Signals

void placeClicked (string path)
 

Detailed Description

A browsing list of the system locations, such as common standard places, bookmarks and others as removable devices and networks.

This control inherits from MauiKit ListBrowser, to checkout its inherited properties refer to docs.

Most of the properties to control the behaviour is handled via the PlacesList model, which is exposed via the list property.

See also
list
Maui.SideBarView
{
anchors.fill: parent
sideBar.content: Pane
{
Maui.Theme.colorSet: Maui.Theme.Window
anchors.fill: parent
FB.PlacesListBrowser
{
anchors.fill: parent
}
}
Maui.Page
{
Maui.Controls.showCSD: true
anchors.fill: parent
}
}

You can find a more complete example at this link.

Definition at line 42 of file PlacesListBrowser.qml.

Property Documentation

◆ currentPath

string PlacesListBrowser::currentPath
read

The path of the current place selected.

Definition at line 68 of file PlacesListBrowser.qml.

◆ iconSize

int PlacesListBrowser::iconSize
read

The preferred size of the icon for the places delegates.

By default this is set to Style.iconSizes.small

See also
Style::iconSizes

Definition at line 64 of file PlacesListBrowser.qml.

◆ itemMenu

alias PlacesListBrowser::itemMenu
read

The contextual menu for the entries.

Remarks
This property is read-only
Note
The menu has an extra property index, which refers to the index position of the entry where the menu was invoked at.

To add more entries, use the itemMenu.data property, or append/push methods.

Definition at line 58 of file PlacesListBrowser.qml.

◆ list

alias PlacesListBrowser::list
read

The model list of the places.

Remarks
This property is read-only

Definition at line 49 of file PlacesListBrowser.qml.

Member Function Documentation

◆ placeClicked

void PlacesListBrowser::placeClicked ( string path)
signal

Emitted when a entry has been clicked.

Parameters
paththe URL path of the entry

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 Mon Nov 4 2024 16:32:33 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.