QtQuick.Dialogs: sync the docs with the implementation

We've been using URLs instead of strings for some time now, just
forgot to change the docs until now.

Task-number: QTBUG-31847
Change-Id: I49a42282aeefb95e4d367397e2f290f4af65687e
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>

diff --git a/src/imports/dialogs/qquickcolordialog.cpp b/src/imports/dialogs/qquickcolordialog.cpp
index 39af997..d0e0e11 100644 (file)
--- a/src/imports/dialogs/qquickcolordialog.cpp
+++ b/src/imports/dialogs/qquickcolordialog.cpp
@@ -64,13 +64,13 @@ QT_BEGIN_NAMESPACE
 /*!
     \qmlsignal QtQuick::Dialogs::AbstractColorDialog::accepted
 
-    The \a accepted signal is emitted by \l accept().
+    This signal is emitted by \l accept().
 */
 
 /*!
     \qmlsignal QtQuick::Dialogs::AbstractColorDialog::rejected
 
-    The \a accepted signal is emitted by \l reject().
+    This signal is emitted by \l reject().
 */
 
 /*!
@@ -110,12 +110,6 @@ QQuickColorDialog::~QQuickColorDialog()
 */
 
 /*!
-    \qmlproperty bool AbstractColorDialog::filePaths
-
-    A list of files to be populated as the user chooses.
-*/
-
-/*!
     \qmlproperty QObject AbstractColorDialog::implementation
 
     The QML object which implements the actual file dialog. Should be either a

diff --git a/src/imports/dialogs/qquickfiledialog.cpp b/src/imports/dialogs/qquickfiledialog.cpp
index f78e8a6..f5d1a06 100644 (file)
--- a/src/imports/dialogs/qquickfiledialog.cpp
+++ b/src/imports/dialogs/qquickfiledialog.cpp
@@ -64,13 +64,13 @@ QT_BEGIN_NAMESPACE
 /*!
     \qmlsignal QtQuick::Dialogs::AbstractFileDialog::accepted
 
-    The \a accepted signal is emitted by \l accept().
+    This signal is emitted by \l accept().
 */
 
 /*!
     \qmlsignal QtQuick::Dialogs::AbstractFileDialog::rejected
 
-    The \a accepted signal is emitted by \l reject().
+    This signal is emitted by \l reject().
 */
 
 /*!
@@ -118,13 +118,13 @@ QList<QUrl> QQuickFileDialog::fileUrls()
 */
 
 /*!
-    \qmlproperty bool AbstractFileDialog::filePaths
+    \qmlproperty bool AbstractFileDialog::fileUrls
 
     A list of files to be populated as the user chooses.
 */
 
 /*!
-   \brief Clears \l filePaths
+   \brief Clears \l fileUrls
 */
 void QQuickFileDialog::clearSelection()
 {
@@ -132,7 +132,7 @@ void QQuickFileDialog::clearSelection()
 }
 
 /*!
-   \brief Adds one file to \l filePaths
+   \brief Adds one file to \l fileUrls
 
    \l path should be given as an absolute file system path. If it is given as a
    file:// URL, it will be converted to a path.  Returns true on success,

diff --git a/src/imports/dialogs/qquickplatformcolordialog.cpp b/src/imports/dialogs/qquickplatformcolordialog.cpp
index ea3114c..8dc6d09 100644 (file)
--- a/src/imports/dialogs/qquickplatformcolordialog.cpp
+++ b/src/imports/dialogs/qquickplatformcolordialog.cpp
@@ -102,8 +102,8 @@ QT_BEGIN_NAMESPACE
 /*!
     \qmlsignal QtQuick::Dialogs::ColorDialog::accepted
 
-    The \a accepted signal is emitted when the user has finished using the
-    dialog. You can then inspect the \a color property to get the selection.
+    This handler is called when the user has finished using the
+    dialog. You can then inspect the \l color property to get the selection.
 
     Example:
 
@@ -117,7 +117,7 @@ QT_BEGIN_NAMESPACE
 /*!
     \qmlsignal QtQuick::Dialogs::ColorDialog::rejected
 
-    The \a rejected signal is emitted when the user has dismissed the dialog,
+    This handler is called when the user has dismissed the dialog,
     either by closing the dialog window or by pressing the Cancel button.
 */
 

diff --git a/src/imports/dialogs/qquickplatformfiledialog.cpp b/src/imports/dialogs/qquickplatformfiledialog.cpp
index 5ae7fd0..ec9f935 100644 (file)
--- a/src/imports/dialogs/qquickplatformfiledialog.cpp
+++ b/src/imports/dialogs/qquickplatformfiledialog.cpp
@@ -73,7 +73,7 @@ QT_BEGIN_NAMESPACE
         id: fileDialog
         title: "Please choose a file"
         onAccepted: {
-            console.log("You chose: " + fileDialog.filePaths)
+            console.log("You chose: " + fileDialog.fileUrls)
             Qt.quit()
         }
         onRejected: {
@@ -103,15 +103,15 @@ QT_BEGIN_NAMESPACE
 /*!
     \qmlsignal QtQuick::Dialogs::FileDialog::accepted
 
-    The \a accepted signal is emitted when the user has finished using the
-    dialog. You can then inspect the \a filePath or \a filePaths properties to
+    This handler is called when the user has finished using the
+    dialog. You can then inspect the \l fileUrl or \l fileUrls properties to
     get the selection.
 
     Example:
 
     \qml
     FileDialog {
-        onAccepted: { console.log("Selected file: " + filePath) }
+        onAccepted: { console.log("Selected file: " + fileUrl) }
     }
     \endqml
 */
@@ -119,7 +119,7 @@ QT_BEGIN_NAMESPACE
 /*!
     \qmlsignal QtQuick::Dialogs::FileDialog::rejected
 
-    The \a rejected signal is emitted when the user has dismissed the dialog,
+    This handler is called when the user has dismissed the dialog,
     either by closing the dialog window or by pressing the Cancel button.
 */
 
@@ -191,7 +191,7 @@ QPlatformFileDialogHelper *QQuickPlatformFileDialog::helper()
     containing the dialog's parent Item, modal with respect to the whole
     application, or non-modal.
 
-    By default it is \l WindowModal.
+    By default it is \c Qt.WindowModal.
 
     Modality does not mean that there are any blocking calls to wait for the
     dialog to be accepted or rejected; it's only that the user will be
@@ -295,18 +295,18 @@ QPlatformFileDialogHelper *QQuickPlatformFileDialog::helper()
 */
 
 /*!
-    \qmlproperty string FileDialog::filePath
+    \qmlproperty url FileDialog::fileUrl
 
     The path of the file which was selected by the user.
 
     \note This property is set only if exactly one file was selected. In all
-    other cases, it will return an empty string.
+    other cases, it will be empty.
 
-    \sa filePaths
+    \sa fileUrls
 */
 
 /*!
-    \qmlproperty list<string> FileDialog::filePaths
+    \qmlproperty list<url> FileDialog::fileUrls
 
     The list of file paths which were selected by the user.
 */

diff --git a/src/imports/widgets/qquickqfiledialog.cpp b/src/imports/widgets/qquickqfiledialog.cpp
index afb150b..498e34a 100644 (file)
--- a/src/imports/widgets/qquickqfiledialog.cpp
+++ b/src/imports/widgets/qquickqfiledialog.cpp
@@ -135,14 +135,14 @@ private:
     \qmlsignal QtQuick::Dialogs::FileDialog::accepted
 
     The \a accepted signal is emitted when the user has finished using the
-    dialog. You can then inspect the \a filePath or \a filePaths properties to
+    dialog. You can then inspect the \a fileUrl or \a fileUrls properties to
     get the selection.
 
     Example:
 
     \qml
     FileDialog {
-        onAccepted: { console.log("Selected file: " + filePath) }
+        onAccepted: { console.log("Selected file: " + fileUrl) }
     }
     \endqml
 */