The browsing view implementation for the FileBrowser control.
- Warning
- This control is private and only exposed for tweaking its properties. It can not be instantiated manually.
Definition at line 13 of file BrowserView.qml.
◆ currentFMList
alias BrowserView::currentFMList |
|
read |
An alias to the FMList model list and controller for listing the location contents and exposing the browsing management action methods.
- Note
- The sorting of the location contents is done via this object properties, and not using the MauiKit MauiModel wrapper.
- See also
- currentFMModel
Definition at line 82 of file BrowserView.qml.
◆ currentFMModel
alias BrowserView::currentFMModel |
|
read |
◆ delegateInjector
Component BrowserView::delegateInjector |
|
read |
It is possible to insert an arbitrary element for each entry.
The component here declared will be drawn on top of the entry delegate in the grid view, and on the far right side in the list view. The entry element model details are accessible via the model
property. For example model.name
, model.url
, etc.
Definition at line 25 of file BrowserView.qml.
◆ dialog
alias BrowserView::dialog |
|
read |
An alias to the current popup dialog being shown.
Definition at line 31 of file BrowserView.qml.
◆ filter
alias BrowserView::filter |
|
read |
◆ filters
alias BrowserView::filters |
|
read |
◆ gridItemSize
int BrowserView::gridItemSize |
|
read |
The size of the items in the grid.
This is the total sum of the thumbnail icon and the name label. The icon size is calculated to match always a standard icon size. By default this is set to 140
Definition at line 50 of file BrowserView.qml.
◆ listItemSize
int BrowserView::listItemSize |
|
read |
◆ loading
bool BrowserView::loading |
|
read |
Whether the listing of the location contents is still loading.
This can be false if the contents are ready or have failed, to check those other conditions refer to the FMList::status property.
- See also
- FMList::status::code
Definition at line 68 of file BrowserView.qml.
◆ path
◆ readOnly
alias BrowserView::readOnly |
|
read |
◆ settings
alias BrowserView::settings |
|
read |
An alias to access the grouped setting preferences for tweaking the file listing properties.
- See also
- BrowserSettings
Definition at line 62 of file BrowserView.qml.
◆ areaClicked
void BrowserView::areaClicked |
( |
var | mouse | ) |
|
|
signal |
Emitted when the background area has been clicked.
- Parameters
-
mouse | the object with the event information |
◆ areaRightClicked
void BrowserView::areaRightClicked |
( |
var | mouse | ) |
|
|
signal |
Emitted when the background area has been right clicked.
This can be consumed for launching a contextual menu.
- Parameters
-
mouse | the object with the event information |
◆ forceActiveFocus()
void BrowserView::forceActiveFocus |
( |
| ) |
|
Forces to focus the current browsing view first element.
◆ groupBy()
void BrowserView::groupBy |
( |
| ) |
|
Forces the view to re-organize the content entries into subgroups, that will depend on the current sorting key o group the entries by name, size, or date, etc.
- Note
- When this is invoked the view will go into the list mode - grouping is not supported in the grid view mode.
◆ itemClicked
void BrowserView::itemClicked |
( |
int | index | ) |
|
|
signal |
Emitted when an entry item has been clicked.
- Parameters
-
index | the index position of the item |
- Note
- To correctly map and index position to the actual item entry in the model use the
currentFMModel.get()
method, this will take care of correctly mapping the indexes in case the content has been filtered or sorted.
◆ itemDoubleClicked
void BrowserView::itemDoubleClicked |
( |
int | index | ) |
|
|
signal |
Emitted when an entry has been double clicked.
- Parameters
-
index | the index position of the item |
◆ itemRightClicked
void BrowserView::itemRightClicked |
( |
int | index | ) |
|
|
signal |
Emitted when an entry has been right clicked.
- Parameters
-
index | the index position of the item |
◆ itemsSelected
void BrowserView::itemsSelected |
( |
var | indexes | ) |
|
|
signal |
Emitted when a set of entries has been selected by using the lasso selection.
- Parameters
-
indexes | the list of indexes positions selected |
◆ itemToggled
void BrowserView::itemToggled |
( |
int | index, |
|
|
bool | state ) |
|
signal |
Emitted when an entry selection has been toggled.
- Parameters
-
index | the index position of the item |
state | the checked state |
◆ keyPress
void BrowserView::keyPress |
( |
var | event | ) |
|
|
signal |
Emitted when a keyboard key has been pressed.
- Parameters
-
event | the object with the event information |
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.