gtksource/org.gtkkn.bindings.gtksource/File

File

open class File(pointer: <Error class: unknown class><<Error class: unknown class>>)

On-disk representation of a class@Buffer.

A GtkSourceFile object is the on-disk representation of a class@Buffer. With a GtkSourceFile, you can create and configure a class@FileLoader and class@FileSaver which take by default the values of the GtkSourceFile properties (except for the file loader which auto-detect some properties). On a successful load or save operation, the GtkSourceFile properties are updated. If an operation fails, the GtkSourceFile properties have still the previous valid values.

Skipped during bindings generation

method location: Property TypeInfo of getter and setter do not match
method read-only: Property has no getter nor setter

Constructors

File

constructor()

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

compressionType

open val compressionType: CompressionType

The compression type.

encoding

open val encoding: Encoding

The character encoding, initially null. After a successful file loading or saving operation, the encoding is non-null.

gtksourceFilePointer

val gtksourceFilePointer: <Error class: unknown class><<Error class: unknown class>>

newlineType

open val newlineType: NewlineType

The line ending type.

Functions

checkFileOnDisk

open fun checkFileOnDisk()

Checks synchronously the file on disk, to know whether the file is externally modified, or has been deleted, and whether the file is read-only.

getCompressionType

open fun getCompressionType(): CompressionType

getEncoding

open fun getEncoding(): Encoding

The encoding is initially null. After a successful file loading or saving operation, the encoding is non-null.

getLocation

open fun getLocation(): <Error class: unknown class>

getNewlineType

open fun getNewlineType(): NewlineType

isDeleted

open fun isDeleted(): Boolean

Returns whether the file has been deleted. If the property@File:location is null, returns false.

isExternallyModified

open fun isExternallyModified(): Boolean

Returns whether the file is externally modified. If the property@File:location is null, returns false.

isLocal

open fun isLocal(): Boolean

Returns whether the file is local. If the property@File:location is null, returns false.

isReadonly

open fun isReadonly(): Boolean

Returns whether the file is read-only. If the property@File:location is null, returns false.

setLocation

open fun setLocation(location: <Error class: unknown class>? = null)

Sets the location.