diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/reference/items/probe/path-probe.qdoc | 41 |
1 files changed, 39 insertions, 2 deletions
diff --git a/doc/reference/items/probe/path-probe.qdoc b/doc/reference/items/probe/path-probe.qdoc index 298ce9d95..5b0cc1bb6 100644 --- a/doc/reference/items/probe/path-probe.qdoc +++ b/doc/reference/items/probe/path-probe.qdoc @@ -58,6 +58,23 @@ */ /*! + \qmlproperty varList PathProbe::allResults + + This property contains the list of objects, each object representing a single found file: + \code + { + found: true, + candidatePaths: ["path1/to/file", "path2/to/file", ...] + filePath: "path/to/file" + fileName: "file" + path: "path/to" + } + \endcode + \sa {PathProbe::filePath}{filePath}, {PathProbe::fileName}{fileName}, + {PathProbe::path}{path} +*/ + +/*! \qmlproperty stringList PathProbe::names The list of file names to search for. @@ -69,8 +86,7 @@ \qmlproperty stringList PathProbe::nameSuffixes The list of file suffixes to search for. These suffixes are appended to every file name passed - via the \l names property. If \l names is empty, the probe looks for any file that ends with the - given suffix. + via the \l names property. \nodefaultvalue */ @@ -161,3 +177,24 @@ \nodefaultvalue */ + +/*! + \qmlproperty varList PathProbe::selectors + + This property should be used to search for multiple files. It contains the list of selectors + each of which describes a single file to search for. A selector can be either a string, a + stringList, or a dictionary. + + The following example searches for three files and illustrates different ways to specify + selectors: + \code + selectors: [ + // 1st file with a single name + "header.h", + // 2nd file with possible name variants + ["config.h", "foo-config.h", "bar-config.h"], + // 3rd file with possible name and suffix variants + {names: ["footk", "footk-version"], nameSuffixes: [".h", ".hpp"]} + ] + \endcode +*/ |