MauiKit File Browsing

BrowserSettings.qml
1/*
2 * Copyright 2018 Camilo Higuita <milo.h@aol.com>
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU Library General Public License as
6 * published by the Free Software Foundation; either version 2, or
7 * (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details
13 *
14 * You should have received a copy of the GNU Library General Public
15 * License along with this program; if not, write to the
16 * Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 */
19
20import QtQml
21import org.mauikit.filebrowsing as FB
22
23/**
24 * @inherit QtQml.QtObject
25 * @brief A group of properties to tweak the browser in the FileBrowser component.
26 *
27 * @warning This control is private and only exposed as part of the FileBrowser implementation. Can not be instantiated.
28 */
29QtObject
30{
31 /**
32 * @brief A list of string text to filter the current location entries.
33 */
34 property var filters : []
35
36 /**
37 * @brief Filter the content by mime type.
38 * By default this is set to `FMList.NONE`, so there is not any type of mimetype filtering
39 * @see FMList::FILTER
40 */
41 property int filterType : FB.FMList.NONE
42
43 /**
44 * @brief Whether only directories should be listed.
45 * By default this is set to `false`
46 */
47 property bool onlyDirs : false
48
49 /**
50 * @brief The sorting field.
51 * By default this is set to `FMList.LABEL`, which will sort the entries alphabetically by their file names.
52 * @see FMList::SORTBY
53 */
54 property int sortBy : FB.FMList.LABEL
55
56 /**
57 * @brief Whether to show the thumbnail previews of images, videos, text files, and other supported types.
58 * By default this is set to `true`
59 */
60 property bool showThumbnails: true
61
62 /**
63 * @brief Whether to show the hidden file entries.
64 * By default this is set to `false`
65 */
66 property bool showHiddenFiles: false
67
68 /**
69 * @brief Whether to group the entries by the sort type
70 * @see sortBy
71 * By default this is set to `false`. Grouping the entries will make thew view go to the list view type.
72 */
73 property bool group : false
74
75 /**
76 * @brief The preferred view type, Can be a list or a grid.
77 * By default this is set to `FMList.ICON_VIEW`
78 * @see FMList::VIEW_TYPE
79 */
80 property int viewType : 0
82 /**
83 * @brief Whether the folders should be sorted first and then the files.
84 * By default this is set to `true`
85 */
86 property bool foldersFirst: true
87
88 /**
89 * @brief Whether the search bar should be visible
90 * By default this is set to `false`
91 */
92 property bool searchBarVisible : false
93}
94
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.