summaryrefslogtreecommitdiff
path: root/src/dialogs/qquickplatformfiledialog.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/dialogs/qquickplatformfiledialog.cpp')
-rw-r--r--src/dialogs/qquickplatformfiledialog.cpp63
1 files changed, 44 insertions, 19 deletions
diff --git a/src/dialogs/qquickplatformfiledialog.cpp b/src/dialogs/qquickplatformfiledialog.cpp
index c4a39060..7ed4e3fb 100644
--- a/src/dialogs/qquickplatformfiledialog.cpp
+++ b/src/dialogs/qquickplatformfiledialog.cpp
@@ -1,40 +1,32 @@
/****************************************************************************
**
-** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the QtQuick.Dialogs module of the Qt Toolkit.
**
-** $QT_BEGIN_LICENSE:LGPL$
+** $QT_BEGIN_LICENSE:LGPL21$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
-** a written agreement between you and Digia. For licensing terms and
-** conditions see http://qt.digia.com/licensing. For further information
+** a written agreement between you and Digia. For licensing terms and
+** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
-** General Public License version 2.1 as published by the Free Software
-** Foundation and appearing in the file LICENSE.LGPL included in the
-** packaging of this file. Please review the following information to
-** ensure the GNU Lesser General Public License version 2.1 requirements
-** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+** General Public License version 2.1 or version 3 as published by the Free
+** Software Foundation and appearing in the file LICENSE.LGPLv21 and
+** LICENSE.LGPLv3 included in the packaging of this file. Please review the
+** following information to ensure the GNU Lesser General Public License
+** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
+** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
-** rights. These rights are described in the Digia Qt LGPL Exception
+** rights. These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
-** GNU General Public License Usage
-** Alternatively, this file may be used under the terms of the GNU
-** General Public License version 3.0 as published by the Free Software
-** Foundation and appearing in the file LICENSE.GPL included in the
-** packaging of this file. Please review the following information to
-** ensure the GNU General Public License version 3.0 requirements will be
-** met: http://www.gnu.org/copyleft/gpl.html.
-**
-**
** $QT_END_LICENSE$
**
****************************************************************************/
@@ -98,6 +90,28 @@ QT_BEGIN_NAMESPACE
support multiple top-level windows. When the dialog becomes visible, it
will automatically be wrapped in a Window if possible, or simply reparented
on top of the main window if there can only be one window.
+
+ The QML implementation has a sidebar containing shortcuts to common
+ platform-specific locations, and user-modifiable shortcuts. It uses
+ application-specific \l {Qt.labs.settings::Settings} {settings} to store
+ these bookmarks, as well as other user-modifiable state, such as whether or
+ not the sidebar is shown, the positions of the splitters, and the dialog
+ size. The settings are stored in a section called \c QQControlsFileDialog
+ of the application-specific \l QSettings. For example when testing an
+ application with the qml tool, the \c QQControlsFileDialog section will be
+ created in the \c {Qml Runtime} settings file (or registry entry). If an
+ application is started via a custom C++ main() function, it is recommended
+ to set the
+ \l {QCoreApplication::applicationName}{name},
+ \l {QCoreApplication::organizationName}{organization} and
+ \l {QCoreApplication::organizationDomain}{domain} in order to control
+ the location of the application's settings. If you use
+ \l {Qt.labs.settings::Settings} {Settings} objects in other parts of an
+ application, they will be stored in other sections of the same file.
+
+ \l QFileDialog stores its settings globally instead of per-application.
+ Platform-native file dialogs may or may not store settings in various
+ platform-dependent ways.
*/
/*!
@@ -315,4 +329,15 @@ QPlatformFileDialogHelper *QQuickPlatformFileDialog::helper()
The list of file paths which were selected by the user.
*/
+/*!
+ \qmlproperty bool FileDialog::sidebarVisible
+
+ This property holds whether the sidebar in the dialog containing shortcuts
+ and bookmarks is visible. By default it depends on the setting stored in
+ the \c QQControlsFileDialog section of the application's
+ \l {Qt.labs.settings::Settings} {Settings}.
+
+ \since 5.4
+*/
+
QT_END_NAMESPACE