Home · All Classes · Modules  · QSS HELP  · QSS 案例 · VER007 HOME

QAbstractFileEngine Class Reference
^{[QtCore module]}

该QAbstractFileEngine类提供了访问文件系统的抽象。More...

通过继承QFSFileEngine。

Types

• enum FileFlag { ReadOwnerPerm, WriteOwnerPerm, ExeOwnerPerm, ReadUserPerm, ..., Refresh }
• class FileFlags
• enum FileName { DefaultName, BaseName, PathName, AbsoluteName, ..., BundleName }
• enum FileOwner { OwnerUser, OwnerGroup }
• enum FileTime { CreationTime, ModificationTime, AccessTime }

Methods

• __init__ (self)
• bool atEnd (self)
• QAbstractFileEngineIterator beginEntryList (self, QDir.Filters filters, QStringList filterNames)
• bool caseSensitive (self)
• bool close (self)
• bool copy (self, QString newName)
• QStringList entryList (self, QDir.Filters filters, QStringList filterNames)
• QFile.FileError error (self)
• QString errorString (self)
• FileFlags fileFlags (self, FileFlags type = QAbstractFileEngine.FileInfoAll)
• QString fileName (self, FileName file = QAbstractFileEngine.DefaultName)
• QDateTime fileTime (self, FileTime time)
• bool flush (self)
• int handle (self)
• bool isRelativePath (self)
• bool isSequential (self)
• bool link (self, QString newName)
• sip.voidptr map (self, int offset, int size, QFile.MemoryMapFlags flags)
• bool mkdir (self, QString dirName, bool createParentDirectories)
• bool open (self, QIODevice.OpenMode openMode)
• QString owner (self, FileOwner)
• int ownerId (self, FileOwner)
• int pos (self)
• str read (self, int maxlen)
• str readLine (self, int maxlen)
• bool remove (self)
• bool rename (self, QString newName)
• bool rmdir (self, QString dirName, bool recurseParentDirectories)
• bool seek (self, int pos)
• setError (self, QFile.FileError error, QString str)
• setFileName (self, QString file)
• bool setPermissions (self, int perms)
• bool setSize (self, int size)
• int size (self)
• bool unmap (self, sip.voidptr ptr)
• int write (self, str data)

Static Methods

• QAbstractFileEngine create (QString fileName)

Detailed Description

该QAbstractFileEngine类提供了访问文件系统的抽象。

该QDir，QFile和QFileInfo类中的所有使用内部一个QAbstractFileEngine的。如果您创建自己的QAbstractFileEngine子类（和使用Qt创建一个注册它QAbstractFileEngineHandler子类） ，当路径是指你的文件引擎处理您的文件引擎将被使用。

一个QAbstractFileEngine是指一个文件或一个目录。如果所指的是一个文件时，setFileName（ ）rename（）和remove（）函数是适用的。如果所指的是一个目录mkdir（ ）rmdir（）和entryList（）函数是适用的。在所有情况下caseSensitive（ ）isRelativePath（ ）fileFlags（ ）ownerId（ ）owner（）和fileTime（）函数是适用的。

一个QAbstractFileEngine子类可以被创建来做到同步网络I / O的文件系统操作，本地文件系统操作，或作为一个系统资源的访问基于文件的资源。

Type Documentation

QAbstractFileEngine.FileFlag

的权限和类型的文件，适于中用OR在一起。

该FileFlags类型是一个typedef为QFlags\u003cFileFlag\u003e 。它存储FileFlag值的或组合。

See also fileFlags（）和setFileName（ ） 。

QAbstractFileEngine.FileName

这些值被用来以特定的格式要求一个文件名。

See also fileName（）和setFileName（ ） 。

QAbstractFileEngine.FileOwner

See also owner（ ）ownerId（）和setFileName（ ） 。

QAbstractFileEngine.FileTime

这些被使用的fileTime（）函数。

See also setFileName（ ） 。

Method Documentation

QAbstractFileEngine.__init__ (self)

构造一个新的QAbstractFileEngine这并不是指任何文件或目录。

See also setFileName（ ） 。

bool QAbstractFileEngine.atEnd (self)

返回True如果当前位置是在文件的末尾，否则返回False 。

该功能立足于调用它的行为extension（ ）与AtEndExtension。如果引擎不支持此扩展，则返回False。

此功能被引入Qt的4.3 。

See also extension（ ）supportsExtension（）和QFile.atEnd（ ） 。

QAbstractFileEngineIterator QAbstractFileEngine.beginEntryList (self, QDir.Filters filters, QStringList filterNames)

返回一个实例QAbstractFileEngineIterator using filters入门过滤和filterNames对于名称的过滤。调用此函数由QDirIterator启动目录迭代。

QDirIterator需要返回的实例的所有权，并删除它时，它的完成。

See also QDirIterator。

bool QAbstractFileEngine.caseSensitive (self)

应返回True如果底层文件系统是大小写敏感的，否则返回False 。

这个虚函数必须在子类中重新实现。

bool QAbstractFileEngine.close (self)

关闭文件，返回True，如果成功，否则返回False 。

默认的实现始终返回False 。

bool QAbstractFileEngine.copy (self, QString newName)

复制这个文件的内容与名称的文件newName。成功时返回TRUE ，否则返回False 。

QAbstractFileEngine QAbstractFileEngine.create (QString fileName)

创建并返回一个QAbstractFileEngine适于处理fileName。

你不应该需要调用这个函数;使用QFile，QFileInfo or QDir直接代替。

如果您reimplemnt这个功能，它应该只返回一个知道如何处理文件引擎fileName否则，它应该返回0 。

See also QAbstractFileEngineHandler。

QStringList QAbstractFileEngine.entryList (self, QDir.Filters filters, QStringList filterNames)

请所有文件的列表匹配filters基于所述列表filterNames在文件引擎的目录中返回。

应该返回一个空列表，如果该文件引擎指的是文件，而不是一个目录，或者目录是不可读的或者不存在，或者如果没有相匹配的规格。

这个虚函数必须在子类中重新实现。

See also setFileName（ ） 。

QFile.FileError QAbstractFileEngine.error (self)

返回QFile.FileError这是由于过去失败的操作。如果QFile.UnspecifiedError返回，QFile将利用自身的错误状态的想法。

See also setError（ ）QFile.FileError和errorString（ ） 。

QString QAbstractFileEngine.errorString (self)

返回人类可读的消息恰当报告的当前错误error（ ） 。如果没有合适的字符串是可用的，则返回一个空字符串。

See also error（ ） 。

FileFlags QAbstractFileEngine.fileFlags (self, FileFlags type = QAbstractFileEngine.FileInfoAll)

这个函数应该返回一组逻辑与的标志，是真实的文件引擎的文件，那是在type的逻辑与的成员。

在你重新实现可以使用type参数作为优化提示，并只返回或运算组成员是真实的和那场比赛中的那些type换句话说，您可以忽略不提及任何成员type，从而避免一些潜在的昂贵的查找或系统调用。

这个虚函数必须在子类中重新实现。

See also setFileName（ ） 。

QString QAbstractFileEngine.fileName (self, FileName file = QAbstractFileEngine.DefaultName)

返回由指定格式的文件引擎的当前文件名file。

如果不处理某些FileName可能性，返回文件名设置setFileName（ ）当未处理的格式要求。

这个虚函数必须在子类中重新实现。

See also setFileName（）和FileName。

QDateTime QAbstractFileEngine.fileTime (self, FileTime time)

If time is CreationTime，创建文件时返回。如果time is ModificationTime，返回当文件最近被修改。如果time is AccessTime，返回时被最近访问的文件（如读或写） 。如果时间无法确定返回QDateTime （ ） （一个无效的日期时间） 。

这个虚函数必须在子类中重新实现。

See also setFileName（ ）QDateTime，QDateTime.isValid（）和FileTime。

bool QAbstractFileEngine.flush (self)

刷新打开文件，返回True，如果成功，否则返回False 。

默认的实现始终返回False 。

int QAbstractFileEngine.handle (self)

返回本机文件句柄这个文件引擎。此句柄必须小心使用，它的价值和类型是特定的平台，并利用它很可能会导致不可移植的代码。

bool QAbstractFileEngine.isRelativePath (self)

返回True，如果该文件引擎所指的文件有一个相对路径，否则返回False 。

这个虚函数必须在子类中重新实现。

See also setFileName（ ） 。

bool QAbstractFileEngine.isSequential (self)

返回True如果该文件是一个顺序存取设备，如果该文件是一个直接存取设备返回False。

涉及业务size（ ）和seek（ INT）是不是在连续的设备有效。

bool QAbstractFileEngine.link (self, QString newName)

从创建该文件目前由指定的链接fileName（）来newName。什么链接是依赖于底层的文件系统（无论是在Windows还是Unix上符号链接的快捷方式）上。成功返回True ，否则返回False 。

sip.voidptr QAbstractFileEngine.map (self, int offset, int size, QFile.MemoryMapFlags flags)

地图size该文件的字节到存储器中，起始offset。返回一个指向内存的指针，如果成功，如果，例如，发生错误，否则返回False 。

该功能立足于调用它的行为extension（ ）与MapExtensionOption。如果引擎不支持此扩展，则返回0 。

flags目前没有使用，但可能在将来被使用。

此功能被引入Qt的4.4 。

See also unmap（）和supportsExtension（ ） 。

bool QAbstractFileEngine.mkdir (self, QString dirName, bool createParentDirectories)

请求的目录dirName被创建。如果createParentDirectories是真的，那么在任何子目录dirName不存在必须被创建。如果createParentDirectories为False，则在任何子目录dirName必须已经为函数成功存在。如果操作成功，返回True ，否则返回False 。

这个虚函数必须在子类中重新实现。

See also setFileName（ ）rmdir（）和isRelativePath（ ） 。

bool QAbstractFileEngine.open (self, QIODevice.OpenMode openMode)

打开文件在指定的mode。返回True如果文件被成功打开，否则返回False 。

该mode是一个OR组合QIODevice.OpenMode和QIODevice.HandlingMode值。

QString QAbstractFileEngine.owner (self, FileOwner)

If owner is OwnerUser返回谁拥有该文件的用户的名称。如果owner is OwnerGroup返回拥有该文件的组的名称。如果你不能确定业主回报的QString （ ） 。

这个虚函数必须在子类中重新实现。

See also ownerId（ ）setFileName（）和FileOwner。

int QAbstractFileEngine.ownerId (self, FileOwner)

If owner is OwnerUser返回谁拥有该文件的用户的ID 。如果owner is OwnerGroup返回拥有该文件的组ID 。如果你不能确定业主返回-2 。

这个虚函数必须在子类中重新实现。

See also owner（ ）setFileName（）和FileOwner。

int QAbstractFileEngine.pos (self)

返回当前文件位置。

这是读出的文件/写头中的数据的位置。

str QAbstractFileEngine.read (self, int maxlen)

读取的字符数从文件导入data。最多maxlen字符将被读取。

如果发生致命错误，或者0，如果没有要读取的字节，则返回-1 。

str QAbstractFileEngine.readLine (self, int maxlen)

该函数读取一行，由一个'\ n“字符终止，从文件信息data。最多maxlen字符将被读取。行尾的字符被包括在内。

bool QAbstractFileEngine.remove (self)

该文件从文件系统中删除请求。如果操作成功，返回True ，否则返回False 。

这个虚函数必须在子类中重新实现。

See also setFileName（）和rmdir（ ） 。

bool QAbstractFileEngine.rename (self, QString newName)

请求该文件被重命名为newName在文件系统中。如果操作成功，返回True ，否则返回False 。

这个虚函数必须在子类中重新实现。

See also setFileName（ ） 。

bool QAbstractFileEngine.rmdir (self, QString dirName, bool recurseParentDirectories)

请求的目录dirName从文件系统中删除。何时recurseParentDirectories是真的，那么任何空的父目录中dirName也必须删除。如果recurseParentDirectories是假的，只有dirName叶节点应予删除。在大多数文件系统的目录中不能使用该功能，如果它是一个非空被删除。如果操作成功，返回True ，否则返回False 。

这个虚函数必须在子类中重新实现。

See also setFileName（ ）remove（ ）mkdir（）和isRelativePath（ ） 。

bool QAbstractFileEngine.seek (self, int pos)

设置文件位置为给定的offset。返回True如果该位置被成功设置，否则返回False 。

偏移量是从文件的开始处，除非该文件是连续的。

See also isSequential（ ） 。

QAbstractFileEngine.setError (self, QFile.FileError error, QString str)

设置错误类型error和错误字符串errorString。调用此函数来设置由更高级别的课程返回错误值。

See also QFile.error（ ）QIODevice.errorString（）和QIODevice.setErrorString（ ） 。

QAbstractFileEngine.setFileName (self, QString file)

设置文件引擎的文件名file。这个文件名是虚函数，其馀将要操作的文件。

这个虚函数必须在子类中重新实现。

See also fileName（）和rename（ ） 。

bool QAbstractFileEngine.setPermissions (self, int perms)

该文件的权限设置为请求perms。该参数烫发将被设置为QAbstractFileEngine.FileInfo的或的结果结合在一起，只有QAbstractFileEngine.PermsMask的荣幸。如果操作succceeds返回True ，否则返回False ;

这个虚函数必须在子类中重新实现。

See also size（ ） 。

bool QAbstractFileEngine.setSize (self, int size)

该文件被设置为请求的大小size。如果size比当前文件则填0的，如果小它只是截断较大。如果操作succceeds返回True ，否则返回False ;

这个虚函数必须在子类中重新实现。

See also size（ ） 。

int QAbstractFileEngine.size (self)

返回文件的大小。

See also setSize（ ） 。

bool QAbstractFileEngine.unmap (self, sip.voidptr ptr)

取消映射的内存address。返回True如果取消映射成功，否则返回False 。

该功能立足于调用它的行为extension（ ）与UnMapExtensionOption。如果引擎不支持此扩展，则返回False。

此功能被引入Qt的4.4 。

See also map（）和supportsExtension（ ） 。

int QAbstractFileEngine.write (self, str data)

Writes len从字节data到文件中。返回写入成功的字符数，否则返回-1 。