QAbstractFileEngine Class Reference · PyQt4 中文文檔

# QAbstractFileEngine Class Reference ## [[QtCore](index.htm) module] 該QAbstractFileEngine類提供了訪問文件系統的抽象。[More...](#details) 通過繼承[QFSFileEngine](qfsfileengine.html)。 ### Types * `enum FileFlag { ReadOwnerPerm, WriteOwnerPerm, ExeOwnerPerm, ReadUserPerm, ..., Refresh }` * `class **[FileFlags](index.htm)**` * `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](qdir.html)，[QFile](qfile.html)和[QFileInfo](qfileinfo.html)類中的所有使用內部一個QAbstractFileEngine的。如果您創建自己的QAbstractFileEngine子類（和使用Qt創建一個注冊它[QAbstractFileEngineHandler](qabstractfileenginehandler.html)子類），當路徑是指你的文件引擎處理您的文件引擎將被使用。一個QAbstractFileEngine是指一個文件或一個目錄。如果所指的是一個文件時，[setFileName](qabstractfileengine.html#setFileName)（）[rename](qabstractfileengine.html#rename)（）和[remove](qabstractfileengine.html#remove)（）函數是適用的。如果所指的是一個目錄[mkdir](qabstractfileengine.html#mkdir)（）[rmdir](qabstractfileengine.html#rmdir)（）和[entryList](qabstractfileengine.html#entryList)（）函數是適用的。在所有情況下[caseSensitive](qabstractfileengine.html#caseSensitive)（）[isRelativePath](qabstractfileengine.html#isRelativePath)（）[fileFlags](qabstractfileengine.html#fileFlags)（）[ownerId](qabstractfileengine.html#ownerId)（）[owner](qabstractfileengine.html#owner)（）和[fileTime](qabstractfileengine.html#fileTime)（）函數是適用的。一個QAbstractFileEngine子類可以被創建來做到同步網絡I / O的文件系統操作，本地文件系統操作，或作為一個系統資源的訪問基于文件的資源。 * * * ## Type Documentation ``` QAbstractFileEngine.FileFlag ``` 的權限和類型的文件，適于中用OR在一起。 | Constant | Value | Description | | --- | --- | --- | | `QAbstractFileEngine.ReadOwnerPerm` | `0x4000` | 該文件的所有者有權讀取它。 | | `QAbstractFileEngine.WriteOwnerPerm` | `0x2000` | 該文件的所有者具有寫權限了。 | | `QAbstractFileEngine.ExeOwnerPerm` | `0x1000` | 該文件的所有者有權執行它的權限。 | | `QAbstractFileEngine.ReadUserPerm` | `0x0400` | 當前用戶有權限讀取該文件。 | | `QAbstractFileEngine.WriteUserPerm` | `0x0200` | 當前用戶有權限寫入到文件中。 | | `QAbstractFileEngine.ExeUserPerm` | `0x0100` | 當前用戶擁有執行該文件的權限。 | | `QAbstractFileEngine.ReadGroupPerm` | `0x0040` | 當前用戶組的成員有權限讀取的文件。 | | `QAbstractFileEngine.WriteGroupPerm` | `0x0020` | 當前用戶組的成員具有寫權限的文件。 | | `QAbstractFileEngine.ExeGroupPerm` | `0x0010` | 當前用戶組的成員具有執行該文件的權限。 | | `QAbstractFileEngine.ReadOtherPerm` | `0x0004` | 所有用戶有權限讀取的文件。 | | `QAbstractFileEngine.WriteOtherPerm` | `0x0002` | 所有用戶都具有寫權限的文件。 | | `QAbstractFileEngine.ExeOtherPerm` | `0x0001` | 所有的用戶都具有執行該文件的權限。 | | `QAbstractFileEngine.LinkType` | `0x10000` | 該文件是在文件系統（即不是一個文件或目錄）鏈接到另一個文件（或鏈接）。 | | `QAbstractFileEngine.FileType` | `0x20000` | 該文件是一個普通文件到文件系統（即不是鏈接或目錄） | | `QAbstractFileEngine.BundleType` | `0x80000` | 該文件是一個Mac OS X的包意味著DirectoryType | | `QAbstractFileEngine.DirectoryType` | `0x40000` | 該文件是在文件系統（即不是鏈接或文件）的目錄。 | | `QAbstractFileEngine.HiddenFlag` | `0x0100000` | 該文件是隱藏的。 | | `QAbstractFileEngine.ExistsFlag` | `0x0400000` | 該文件實際上存在于文件系統中。 | | `QAbstractFileEngine.RootFlag` | `0x0800000` | 該文件或文件指向的是文件系統的根。 | | `QAbstractFileEngine.LocalDiskFlag` | `0x0200000` | 該文件駐留在本地磁盤上，并且可以通過標準的文件的功能。 | | `QAbstractFileEngine.Refresh` | `0x1000000` | 傳遞此標志將強制文件引擎刷新所有標志。 | 該FileFlags類型是一個typedef為[QFlags](index.htm)\u003cFileFlag\u003e 。它存儲FileFlag值的或組合。 **See also** [fileFlags](qabstractfileengine.html#fileFlags)（）和[setFileName](qabstractfileengine.html#setFileName)（）。 ``` QAbstractFileEngine.FileName ``` 這些值被用來以特定的格式要求一個文件名。 | Constant | Value | Description | | --- | --- | --- | | `QAbstractFileEngine.DefaultName` | `0` | 傳遞給了相同的文件名[QAbstractFileEngine](qabstractfileengine.html)。 | | `QAbstractFileEngine.BaseName` | `1` | 不包括路徑中的文件的名稱。 | | `QAbstractFileEngine.PathName` | `2` | 的路徑，不包括基本名稱的文件。 | | `QAbstractFileEngine.AbsoluteName` | `3` | 絕對路徑文件（包括基本名稱）。 | | `QAbstractFileEngine.AbsolutePathName` | `4` | 絕對路徑文件（不包括基本名稱）。 | | `QAbstractFileEngine.LinkName` | `5` | 該文件是一個鏈接到該文件的完整文件名。（這將是空的，如果這個文件是不是鏈接。） | | `QAbstractFileEngine.CanonicalName` | `6` | 往往很相似，鏈接名稱。將返回真正的文件路徑。 | | `QAbstractFileEngine.CanonicalPathName` | `7` | 同CanonicalName ，不包括基本名稱。 | | `QAbstractFileEngine.BundleName` | `8` | 返回該包的名稱所暗示[BundleType](qabstractfileengine.html#FileFlag-enum)被設置。 | **See also** [fileName](qabstractfileengine.html#fileName)（）和[setFileName](qabstractfileengine.html#setFileName)（）。 ``` QAbstractFileEngine.FileOwner ``` | Constant | Value | Description | | --- | --- | --- | | `QAbstractFileEngine.OwnerUser` | `0` | 誰擁有該文件的用戶。 | | `QAbstractFileEngine.OwnerGroup` | `1` | 誰擁有該文件的組。 | **See also** [owner](qabstractfileengine.html#owner)（）[ownerId](qabstractfileengine.html#ownerId)（）和[setFileName](qabstractfileengine.html#setFileName)（）。 ``` QAbstractFileEngine.FileTime ``` 這些被使用的[fileTime](qabstractfileengine.html#fileTime)（）函數。 | Constant | Value | Description | | --- | --- | --- | | `QAbstractFileEngine.CreationTime` | `0` | 當創建該文件。 | | `QAbstractFileEngine.ModificationTime` | `1` | 當文件最近被修改。 | | `QAbstractFileEngine.AccessTime` | `2` | 當最近被訪問的文件（例如，讀取或寫入）。 | **See also** [setFileName](qabstractfileengine.html#setFileName)（）。 * * * ## Method Documentation ``` QAbstractFileEngine.__init__ (self) ``` 構造一個新的[QAbstractFileEngine](qabstractfileengine.html)這并不是指任何文件或目錄。 **See also** [setFileName](qabstractfileengine.html#setFileName)（）。 ``` bool QAbstractFileEngine.atEnd (self) ``` 返回True如果當前位置是在文件的末尾，否則返回False 。該功能立足于調用它的行為[extension](qabstractfileengine.html#extension)（）與[AtEndExtension](qabstractfileengine.html#Extension-enum)。如果引擎不支持此擴展，則返回False。此功能被引入Qt的4.3 。 **See also** [extension](qabstractfileengine.html#extension)（）[supportsExtension](qabstractfileengine.html#supportsExtension)（）和[QFile.atEnd](qfile.html#atEnd)（）。 ``` QAbstractFileEngineIterator QAbstractFileEngine.beginEntryList (self, QDir.Filters?filters, QStringList?filterNames) ``` [](qabstractfileengineiterator.html) [返回一個實例](qabstractfileengineiterator.html)[QAbstractFileEngineIterator](qabstractfileengineiterator.html) using _filters_入門過濾和_filterNames_對于名稱的過濾。調用此函數由[QDirIterator](qdiriterator.html)啟動目錄迭代。 [QDirIterator](qdiriterator.html)需要返回的實例的所有權，并刪除它時，它的完成。 **See also** [QDirIterator](qdiriterator.html)。 ``` 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.html) [創建并返回一個](qabstractfileengine.html)[QAbstractFileEngine](qabstractfileengine.html)適于處理_fileName_。你不應該需要調用這個函數;使用[QFile](qfile.html)，[QFileInfo](qfileinfo.html) or [QDir](qdir.html)直接代替。如果您reimplemnt這個功能，它應該只返回一個知道如何處理文件引擎_fileName_否則，它應該返回0 。 **See also** [QAbstractFileEngineHandler](qabstractfileenginehandler.html)。 ``` QStringList QAbstractFileEngine.entryList (self, QDir.Filters?filters, QStringList?filterNames) ``` 請所有文件的列表匹配_filters_基于所述列表_filterNames_在文件引擎的目錄中返回。應該返回一個空列表，如果該文件引擎指的是文件，而不是一個目錄，或者目錄是不可讀的或者不存在，或者如果沒有相匹配的規格。這個虛函數必須在子類中重新實現。 **See also** [setFileName](qabstractfileengine.html#setFileName)（）。 ``` QFile.FileError QAbstractFileEngine.error (self) ``` [](qfile.html#FileError-enum) [返回](qfile.html#FileError-enum)[QFile.FileError](qfile.html#FileError-enum)這是由于過去失敗的操作。如果[QFile.UnspecifiedError](qfile.html#FileError-enum)返回，[QFile](qfile.html)將利用自身的錯誤狀態的想法。 **See also** [setError](qabstractfileengine.html#setError)（）[QFile.FileError](qfile.html#FileError-enum)和[errorString](qabstractfileengine.html#errorString)（）。 ``` QString QAbstractFileEngine.errorString (self) ``` 返回人類可讀的消息恰當報告的當前錯誤[error](qabstractfileengine.html#error)（）。如果沒有合適的字符串是可用的，則返回一個空字符串。 **See also** [error](qabstractfileengine.html#error)（）。 ``` FileFlags QAbstractFileEngine.fileFlags (self, FileFlags?type?=?QAbstractFileEngine.FileInfoAll) ``` [ 這個函數應該返回一組邏輯與的標志，是真實的文件引擎的文件，那是在_type_的邏輯與的成員。在你重新實現可以使用_type_參數作為優化提示，并只返回或運算組成員是真實的和那場比賽中的那些_type_換句話說，您可以忽略不提及任何成員_type_，從而避免一些潛在的昂貴的查找或系統調用。這個虛函數必須在子類中重新實現。 ](index.htm) [**See also**](index.htm) [setFileName](qabstractfileengine.html#setFileName)（）。 ``` QString QAbstractFileEngine.fileName (self, FileName?file?=?QAbstractFileEngine.DefaultName) ``` 返回由指定格式的文件引擎的當前文件名_file_。如果不處理某些`FileName`可能性，返回文件名設置[setFileName](qabstractfileengine.html#setFileName)（）當未處理的格式要求。這個虛函數必須在子類中重新實現。 **See also** [setFileName](qabstractfileengine.html#setFileName)（）和[FileName](qabstractfileengine.html#FileName-enum)。 ``` QDateTime QAbstractFileEngine.fileTime (self, FileTime?time) ``` [ If _time_ is `CreationTime`，創建文件時返回。如果_time_ is `ModificationTime`，返回當文件最近被修改。如果_time_ is `AccessTime`，返回時被最近訪問的文件（如讀或寫）。如果時間無法確定返回QDateTime （）（一個無效的日期時間）。這個虛函數必須在子類中重新實現。 ](qdatetime.html) [**See also**](qdatetime.html) [setFileName](qabstractfileengine.html#setFileName)（）[QDateTime](qdatetime.html)，[QDateTime.isValid](qdatetime.html#isValid)（）和[FileTime](qabstractfileengine.html#FileTime-enum)。 ``` bool QAbstractFileEngine.flush (self) ``` 刷新打開文件，返回True，如果成功，否則返回False 。默認的實現始終返回False 。 ``` int QAbstractFileEngine.handle (self) ``` 返回本機文件句柄這個文件引擎。此句柄必須小心使用，它的價值和類型是特定的平臺，并利用它很可能會導致不可移植的代碼。 ``` bool QAbstractFileEngine.isRelativePath (self) ``` 返回True，如果該文件引擎所指的文件有一個相對路徑，否則返回False 。這個虛函數必須在子類中重新實現。 **See also** [setFileName](qabstractfileengine.html#setFileName)（）。 ``` bool QAbstractFileEngine.isSequential (self) ``` 返回True如果該文件是一個順序存取設備，如果該文件是一個直接存取設備返回False。涉及業務[size](qabstractfileengine.html#size)（）和seek（ INT）是不是在連續的設備有效。 ``` bool QAbstractFileEngine.link (self, QString?newName) ``` 從創建該文件目前由指定的鏈接[fileName](qabstractfileengine.html#fileName)（）來_newName_。什么鏈接是依賴于底層的文件系統（無論是在Windows還是Unix上符號鏈接的快捷方式）上。成功返回True ，否則返回False 。 ``` sip.voidptr QAbstractFileEngine.map (self, int?offset, int?size, QFile.MemoryMapFlags?flags) ``` 地圖_size_該文件的字節到存儲器中，起始_offset_。返回一個指向內存的指針，如果成功，如果，例如，發生錯誤，否則返回False 。該功能立足于調用它的行為[extension](qabstractfileengine.html#extension)（）與[MapExtensionOption](index.htm)。如果引擎不支持此擴展，則返回0 。 _flags_目前沒有使用，但可能在將來被使用。此功能被引入Qt的4.4 。 **See also** [unmap](qabstractfileengine.html#unmap)（）和[supportsExtension](qabstractfileengine.html#supportsExtension)（）。 ``` bool QAbstractFileEngine.mkdir (self, QString?dirName, bool?createParentDirectories) ``` 請求的目錄_dirName_被創建。如果_createParentDirectories_是真的，那么在任何子目錄_dirName_不存在必須被創建。如果_createParentDirectories_為False，則在任何子目錄_dirName_必須已經為函數成功存在。如果操作成功，返回True ，否則返回False 。這個虛函數必須在子類中重新實現。 **See also** [setFileName](qabstractfileengine.html#setFileName)（）[rmdir](qabstractfileengine.html#rmdir)（）和[isRelativePath](qabstractfileengine.html#isRelativePath)（）。 ``` bool QAbstractFileEngine.open (self, QIODevice.OpenMode?openMode) ``` 打開文件在指定的_mode_。返回True如果文件被成功打開，否則返回False 。該_mode_是一個OR組合[QIODevice.OpenMode](qiodevice.html#OpenModeFlag-enum)和QIODevice.HandlingMode值。 ``` QString QAbstractFileEngine.owner (self, FileOwner) ``` If _owner_ is `OwnerUser`返回誰擁有該文件的用戶的名稱。如果_owner_ is `OwnerGroup`返回擁有該文件的組的名稱。如果你不能確定業主回報的QString （）。這個虛函數必須在子類中重新實現。 **See also** [ownerId](qabstractfileengine.html#ownerId)（）[setFileName](qabstractfileengine.html#setFileName)（）和[FileOwner](qabstractfileengine.html#FileOwner-enum)。 ``` int QAbstractFileEngine.ownerId (self, FileOwner) ``` If _owner_ is `OwnerUser`返回誰擁有該文件的用戶的ID 。如果_owner_ is `OwnerGroup`返回擁有該文件的組ID 。如果你不能確定業主返回-2 。這個虛函數必須在子類中重新實現。 **See also** [owner](qabstractfileengine.html#owner)（）[setFileName](qabstractfileengine.html#setFileName)（）和[FileOwner](qabstractfileengine.html#FileOwner-enum)。 ``` 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](qabstractfileengine.html#setFileName)（）和[rmdir](qabstractfileengine.html#rmdir)（）。 ``` bool QAbstractFileEngine.rename (self, QString?newName) ``` 請求該文件被重命名為_newName_在文件系統中。如果操作成功，返回True ，否則返回False 。這個虛函數必須在子類中重新實現。 **See also** [setFileName](qabstractfileengine.html#setFileName)（）。 ``` bool QAbstractFileEngine.rmdir (self, QString?dirName, bool?recurseParentDirectories) ``` 請求的目錄_dirName_從文件系統中刪除。何時_recurseParentDirectories_是真的，那么任何空的父目錄中_dirName_也必須刪除。如果_recurseParentDirectories_是假的，只有_dirName_葉節點應予刪除。在大多數文件系統的目錄中不能使用該功能，如果它是一個非空被刪除。如果操作成功，返回True ，否則返回False 。這個虛函數必須在子類中重新實現。 **See also** [setFileName](qabstractfileengine.html#setFileName)（）[remove](qabstractfileengine.html#remove)（）[mkdir](qabstractfileengine.html#mkdir)（）和[isRelativePath](qabstractfileengine.html#isRelativePath)（）。 ``` bool QAbstractFileEngine.seek (self, int?pos) ``` 設置文件位置為給定的_offset_。返回True如果該位置被成功設置，否則返回False 。偏移量是從文件的開始處，除非該文件是連續的。 **See also** [isSequential](qabstractfileengine.html#isSequential)（）。 ``` QAbstractFileEngine.setError (self, QFile.FileError?error, QString?str) ``` 設置錯誤類型_error_和錯誤字符串_errorString_。調用此函數來設置由更高級別的課程返回錯誤值。 **See also** [QFile.error](qfile.html#error)（）[QIODevice.errorString](qiodevice.html#errorString)（）和[QIODevice.setErrorString](qiodevice.html#setErrorString)（）。 ``` QAbstractFileEngine.setFileName (self, QString?file) ``` 設置文件引擎的文件名_file_。這個文件名是虛函數，其馀將要操作的文件。這個虛函數必須在子類中重新實現。 **See also** [fileName](qabstractfileengine.html#fileName)（）和[rename](qabstractfileengine.html#rename)（）。 ``` bool QAbstractFileEngine.setPermissions (self, int?perms) ``` 該文件的權限設置為請求_perms_。該參數燙發將被設置為QAbstractFileEngine.FileInfo的或的結果結合在一起，只有[QAbstractFileEngine.PermsMask](qabstractfileengine.html#FileFlag-enum)的榮幸。如果操作succceeds返回True ，否則返回False ; 這個虛函數必須在子類中重新實現。 **See also** [size](qabstractfileengine.html#size)（）。 ``` bool QAbstractFileEngine.setSize (self, int?size) ``` 該文件被設置為請求的大小_size_。如果_size_比當前文件則填0的，如果小它只是截斷較大。如果操作succceeds返回True ，否則返回False ; 這個虛函數必須在子類中重新實現。 **See also** [size](qabstractfileengine.html#size)（）。 ``` int QAbstractFileEngine.size (self) ``` 返回文件的大小。 **See also** [setSize](qabstractfileengine.html#setSize)（）。 ``` bool QAbstractFileEngine.unmap (self, sip.voidptr?ptr) ``` 取消映射的內存_address_。返回True如果取消映射成功，否則返回False 。該功能立足于調用它的行為[extension](qabstractfileengine.html#extension)（）與[UnMapExtensionOption](index.htm)。如果引擎不支持此擴展，則返回False。此功能被引入Qt的4.4 。 **See also** [map](qabstractfileengine.html#map)（）和[supportsExtension](qabstractfileengine.html#supportsExtension)（）。 ``` int QAbstractFileEngine.write (self, str?data) ``` Writes _len_從字節_data_到文件中。返回寫入成功的字符數，否則返回-1 。