File QML Type

Provides an interface for reading from and writing to files. More...

• List of all members, including inherited members

Properties

• atEnd : bool
• error : int
• errorString : string
• exists : bool
• isReadable : bool
• isWritable : bool
• openMode : int
• path : string
• position : int
• textEncoding : TextEncoding
• textMode : bool
• url : url

Methods

• close()
• bool flush()
• bool open()
• bool open(int openMode)
• object read(int length)
• object readAll()
• string readLine()
• bool reset()
• write(var data)
• writeLine(string text)

Detailed Description

The File component provides tools to work with text files within an app. This includes returning what state the file has been opened in, reading data either in full or in part, and writing any form of data to the file.

Note that the File component only works directly with plaintext. This means that formatted text, or non-text content like images, will not read or display correctly, although they can still be written to the file.

The following code sample demonstrates usage of the File component, reading from and writing to a text file created by the FileFolder component. This functionality is not displayed within the app, but can be observed in the text file and through console logs.

Rectangle {
anchors.fill: parent

        Column {
                spacing : 10
                anchors.fill: parent

                Text {
                        id: sampleName
                        text: "File Component Sample"
                        font.pointSize: 24
                        color: "black"
                        wrapMode: Text.WrapAtWordBoundaryOrAnywhere
                }

                FileFolder {
                        id: fileFolder
                        path: AppFramework.userHomePath+"/Samples/File"

                        Component.onCompleted: {
                                fileFolder.makeFolder()
                                fileFolder.writeFile("FileSample.txt", "File component sample")
                        }
                }

                FileInfo {
                        id: fileInfo
                        filePath: fileFolder.path + "/FileSample.txt"
                }

                File {
                        id: file
                        path:fileInfo.filePath
                }

                Row {
                        spacing : 10

                        Button {
                                text: "read"
                                onClicked: {
                                        file.open(File.OpenModeReadWrite)
                                        console.log(file.readAll())
                                        file.close()
                                }
                        }

                        Button {
                                text: "write"
                                onClicked: {
                                        file.open(File.OpenModeReadWrite)
                                        file.writeLine("AppStudio is awesome")
                                        file.close()
                                }
                        }
                }
        }
}

Enumerations

TextEncoding enumeration

OpenMode enumeration

Error enumeration

Property Documentation

Method Documentation