Skip to content
AtlasOSFramework API
Browse the docs

AtlasPathValidator

A validator for a file path field that can require an absolute path or an existing file or folder.

Since 1.4.0

A validator for a text field's validator: a file path. ~ and ~/ stand for the home directory, even when absolute is false; ~user is Invalid. A path of more than 4096 characters is Invalid. NUL and control characters are never valid, text over a fixed length is Invalid, and it uses no regular expressions. Pair it with invalidText on AtlasTextField.

Example

AtlasTextField {
    validator: AtlasPathValidator { mustExist: true; directory: true }
    invalidText: qsTr("Choose a folder that exists")
}

Properties

Name Type Default Description
absolute bool true A path must start with / (or ~).
directory bool false With mustExist, the path must be a directory. Without it, mustExist accepts any existing file or folder.
mustExist bool false The path must exist on disk. A path that does not exist is Intermediate, not Invalid.

Note

With mustExist, every validation (so every keystroke) stats the path on disk. Leave it off for paths on slow or network file systems.