Class TxomBaseFileSystem

Description

Hierarchy

Fields

Methods

Properties

Unit

xomFileSystem

Declaration

type TxomBaseFileSystem = class(TXOMObject)

Description

TxomBaseFileSystem

Hierarchy

TXOMObject
TxomBaseFileSystem

Overview

Methods

	`constructor Create(ACollection: TXOMCollection); override;`
	`destructor Destroy; override;`
	`procedure Initialize; virtual;`
	`procedure Finalize; virtual;`
	`function DirectorySeparator: WideString; virtual; abstract;`
	`function WideActiveFileSystem: WideString; virtual; abstract;`
	`function OpenDialogClassName: String; virtual; abstract;`
	`function SaveDialogClassName: String; virtual; abstract;`
	`function SelectDirectoryDialogClassName: String; virtual; abstract;`
	`function WideCreateOpenDialog(AOwner: TComponent): IxomFileDialog; virtual;`
	`function WideCreateSaveDialog(AOwner: TComponent): IxomFileDialog; virtual;`
	`function WideCreateSelectDirectoryDialog(AOwner: TComponent): TLCLComponent;`
	`function WideSelectFile(const ACaption: WideString; AInitialDir: WideString; AFilter: WideString; AAllowMultiSelect: Boolean; var AFileName: WideString): Boolean; virtual;`
	`function WideSpecialFolder(AType: TxomFileSystemSpecialFolder): WideString; virtual; abstract;`
	`function WideIncludeTrailingBackslash(const S: WideString): WideString; virtual; abstract;`
	`function WideExcludeTrailingBackslash(const S: WideString): WideString; virtual; abstract;`
	`function WideSelectDirectory(const ACaption, AInitialDirectory: WideString; var ADirectory: WideString): Boolean; virtual; abstract;`
	`function WideFileExists(const AFileName: WideString): Boolean; virtual; abstract;`
	`function WideHashStringForFile(const AFileName: WideString): AnsiString; virtual; abstract;`
	`function WideFileOpen (const AFileName : Widestring; Mode: Integer): System.THandle; virtual; abstract;`
	`function WideFileCreate (const AFileName : WideString; ShareMode: Integer; Rights: Integer): System.THandle; virtual; abstract;`
	`function WideFileRead (Handle : System.THandle; out Buffer; Count : longint) : Longint; virtual; abstract;`
	`function WideFileWrite (Handle : System.THandle; const Buffer; Count : Longint) : Longint; virtual; abstract;`
	`function WideFileSeek (Handle : System.THandle; AOffset: Int64; Origin: Longint) : Int64; virtual; abstract;`
	`function WideFileTruncate (Handle : System.THandle; Size: Int64): Boolean; virtual; abstract;`
	`procedure WideFileClose (AHandle: System.THandle); virtual; abstract;`
	`function WideFileGetAttr(const AFileName: WideString): Longint; virtual; abstract;`
	`function WideFileSetAttr(const AFileName: WideString; AAttr: Longint): Longint; virtual; abstract;`
	`function WideFileSetDate (const FileName: WideString; Age: Integer): Integer; virtual; abstract;`
	`function WideExpandFileName (const FileName: WideString): WideString; virtual; abstract;`
	`function WideCopyFile (const FromFile, ToFile: WideString; FailIfExists: Boolean): Boolean; virtual; abstract;`
	`function WideMoveFile (const FromFile, ToFile: WideString): Boolean; virtual; abstract;`
	`function WideMoveDir (const ADir, ATargetDir: WideString): Boolean; virtual; abstract;`
	`function WideDeleteFile(const FileName: WideString): Boolean; virtual; abstract;`
	`function WideRenameFile(const OldName, NewName: WideString): Boolean; virtual; abstract;`
	`function WideRenameDir(const OldName, NewName: WideString): Boolean; virtual; abstract;`
	`function WideRemoveDir(const ADir: WideString; AWithContent: Boolean): Boolean; virtual; abstract;`
	`function WideIsDirEmpty(const ADir: WideString): Boolean; virtual; abstract;`
	`function WideExtractFileExt(const FileName: WideString): WideString; virtual; abstract;`
	`function WideFileSetReadOnly (const FileName: WideString; ReadOnly: Boolean): Boolean; virtual; abstract;`
	`function WideDirectoryExists(const AName: WideString): Boolean; virtual; abstract;`
	`function WideDirectoryIsPackage(const ADir: WideString): Boolean; virtual; abstract;`
	`function WideChangeFileExt(const FileName, Extension: WideString): WideString; virtual; abstract;`
	`function WideExtractRelativePath(const BaseName, DestName: WideString): WideString; virtual; abstract;`
	`function WideExtractFileName(const FileName: WideString): WideString; virtual; abstract;`
	`function WideExtractFileNameOnly(const FileName: WideString): WideString; virtual; abstract;`
	`function WideExtractFilePath(const FileName: WideString): WideString; virtual; abstract;`
	`function WideExtractFileDir(const FileName: WideString): WideString; virtual; abstract;`
	`function WideExtractFileDrive(const FileName: WideString): WideString; virtual; abstract;`
	`function WideGetCurrentDir: WideString; virtual; abstract;`
	`function WideSetCurrentDir(const Dir: WideString): Boolean; virtual; abstract;`
	`function WideForceDirectories(const Dir: WideString): Boolean; virtual; abstract;`
	`function WideFindFirst(const Path: WideString; Attr: Integer; var F: TXOMSearchRec): Integer; virtual; abstract;`
	`function WideFindNext(var F: TXOMSearchRec): Integer; virtual; abstract;`
	`procedure WideFindClose(var F: TXOMSearchRec); virtual; abstract;`
	`function WideFileAge(const FileName: WideString): Integer; virtual; abstract;`
	`function WideFileIsReadOnly(const FileName: WideString): Boolean; virtual; abstract;`
	`function WideFileIsReadable(const FileName: WideString): Boolean; virtual; abstract;`
	`function WideFileIsWriteable(const FileName: WideString): Boolean; virtual; abstract;`
	`function WideDirectoryIsWritable(const AName: WideString): Boolean; virtual; abstract;`
	`function WideExtractShortPathName(const FileName: WideString): WideString; virtual; abstract;`
	`function WideMatchesMask (const FileName: WideString; const Mask: WideString): Boolean; virtual; abstract;`
	`function WideSearchFiles (const ADir: WideString; const AMask: WideString; const AFrom: TDateTime; AResult: TxomStrings; const ARecursive: Boolean = False; const ADateCheckKind: TDateCheckKind = dckModified; const AMaxResults: Integer = -1; AFiltered: TxomStrings = nil): Boolean; virtual; abstract;`
	`function WideSearchFilesExtended (const ADir: WideString; const AMask: WideString; const AFrom: TDateTime; AResult: TxomStrings; AWithSearchRecs: Boolean; var ASearchRecs: TXOMSearchRecs; const ARecursive: Boolean = False; const ADateCheckKind: TDateCheckKind = dckModified; const AMaxResults: Integer = -1; AFiltered: TxomStrings = nil): Boolean; virtual; abstract;`
	`function WideSearchFolders (const ADir: WideString; const AMask: WideString; AResult: TxomStrings; ARecursive: Boolean = False): Boolean; virtual; abstract;`
	`function WideSearchVolumes (AResult: TxomStrings): Boolean; virtual; abstract;`
	`function WideDownloadFile(const AFile, ALocalFile: WideString): Boolean; virtual; abstract;`
	`function WideDownloadFileStream(const AFile: WideString; AStream: TStream): Boolean; virtual; abstract;`
	`function WideDiffDownloadFile(const ALocalFile, AFile: WideString): Boolean; virtual; abstract;`
	`function WideDiffDownloadFileStream(const AFile: WideString; AStream: TStream): Boolean; virtual; abstract;`
	`function WideUploadFile(const ALocalFile, AFile: WideString): Boolean; virtual; abstract;`
	`function WideUploadFileStream(const AFile: WideString; AStream: TStream): Boolean; virtual; abstract;`
	`function WideDiffUploadFile(const ALocalFile, AFile: WideString): Boolean; virtual; abstract;`
	`function WideDiffUploadFileStream(const AFile: WideString; AStream: TStream): Boolean; virtual; abstract;`
	`function WideLoadExif(const AFileName: WideString; AStream: TStream): Boolean; virtual; abstract;`
	`function WideSaveExif(const AFileName: WideString; AStream: TStream): Boolean; virtual; abstract;`
	`function WideLoadFileContent(const AFileName: WideString; AStream: TStream; ADecrypt: Boolean): Boolean; virtual; abstract;`
	`function WideSaveFileContent(const AFileName: WideString; AStream: TStream; AEncrypt: Boolean): Boolean; virtual; abstract;`

Properties

property Protocol: WideString read FProtocol write FProtocol;

Description

Methods

	`constructor Create(ACollection: TXOMCollection); override;`

	`destructor Destroy; override;`

	`procedure Initialize; virtual;`

	`procedure Finalize; virtual;`

	`function DirectorySeparator: WideString; virtual; abstract;`

	`function WideActiveFileSystem: WideString; virtual; abstract;`

	`function OpenDialogClassName: String; virtual; abstract;`

	`function SaveDialogClassName: String; virtual; abstract;`

	`function SelectDirectoryDialogClassName: String; virtual; abstract;`

	`function WideCreateOpenDialog(AOwner: TComponent): IxomFileDialog; virtual;`

	`function WideCreateSaveDialog(AOwner: TComponent): IxomFileDialog; virtual;`

	`function WideCreateSelectDirectoryDialog(AOwner: TComponent): TLCLComponent;`

	`function WideSelectFile(const ACaption: WideString; AInitialDir: WideString; AFilter: WideString; AAllowMultiSelect: Boolean; var AFileName: WideString): Boolean; virtual;`

	`function WideSpecialFolder(AType: TxomFileSystemSpecialFolder): WideString; virtual; abstract;`

	`function WideIncludeTrailingBackslash(const S: WideString): WideString; virtual; abstract;`

	`function WideExcludeTrailingBackslash(const S: WideString): WideString; virtual; abstract;`

	`function WideSelectDirectory(const ACaption, AInitialDirectory: WideString; var ADirectory: WideString): Boolean; virtual; abstract;`

	`function WideFileExists(const AFileName: WideString): Boolean; virtual; abstract;`

	`function WideHashStringForFile(const AFileName: WideString): AnsiString; virtual; abstract;`

	`function WideFileOpen (const AFileName : Widestring; Mode: Integer): System.THandle; virtual; abstract;`

	`function WideFileCreate (const AFileName : WideString; ShareMode: Integer; Rights: Integer): System.THandle; virtual; abstract;`

	`function WideFileRead (Handle : System.THandle; out Buffer; Count : longint) : Longint; virtual; abstract;`

	`function WideFileWrite (Handle : System.THandle; const Buffer; Count : Longint) : Longint; virtual; abstract;`

	`function WideFileSeek (Handle : System.THandle; AOffset: Int64; Origin: Longint) : Int64; virtual; abstract;`

	`function WideFileTruncate (Handle : System.THandle; Size: Int64): Boolean; virtual; abstract;`

	`procedure WideFileClose (AHandle: System.THandle); virtual; abstract;`

	`function WideFileGetAttr(const AFileName: WideString): Longint; virtual; abstract;`

	`function WideFileSetAttr(const AFileName: WideString; AAttr: Longint): Longint; virtual; abstract;`

	`function WideFileSetDate (const FileName: WideString; Age: Integer): Integer; virtual; abstract;`

	`function WideExpandFileName (const FileName: WideString): WideString; virtual; abstract;`

	`function WideCopyFile (const FromFile, ToFile: WideString; FailIfExists: Boolean): Boolean; virtual; abstract;`

	`function WideMoveFile (const FromFile, ToFile: WideString): Boolean; virtual; abstract;`

	`function WideMoveDir (const ADir, ATargetDir: WideString): Boolean; virtual; abstract;`

	`function WideDeleteFile(const FileName: WideString): Boolean; virtual; abstract;`

	`function WideRenameFile(const OldName, NewName: WideString): Boolean; virtual; abstract;`

	`function WideRenameDir(const OldName, NewName: WideString): Boolean; virtual; abstract;`

	`function WideRemoveDir(const ADir: WideString; AWithContent: Boolean): Boolean; virtual; abstract;`

	`function WideIsDirEmpty(const ADir: WideString): Boolean; virtual; abstract;`

	`function WideExtractFileExt(const FileName: WideString): WideString; virtual; abstract;`

	`function WideFileSetReadOnly (const FileName: WideString; ReadOnly: Boolean): Boolean; virtual; abstract;`

	`function WideDirectoryExists(const AName: WideString): Boolean; virtual; abstract;`

	`function WideDirectoryIsPackage(const ADir: WideString): Boolean; virtual; abstract;`

	`function WideChangeFileExt(const FileName, Extension: WideString): WideString; virtual; abstract;`

	`function WideExtractRelativePath(const BaseName, DestName: WideString): WideString; virtual; abstract;`

	`function WideExtractFileName(const FileName: WideString): WideString; virtual; abstract;`

	`function WideExtractFileNameOnly(const FileName: WideString): WideString; virtual; abstract;`

	`function WideExtractFilePath(const FileName: WideString): WideString; virtual; abstract;`

	`function WideExtractFileDir(const FileName: WideString): WideString; virtual; abstract;`

	`function WideExtractFileDrive(const FileName: WideString): WideString; virtual; abstract;`

	`function WideGetCurrentDir: WideString; virtual; abstract;`

	`function WideSetCurrentDir(const Dir: WideString): Boolean; virtual; abstract;`

	`function WideForceDirectories(const Dir: WideString): Boolean; virtual; abstract;`

	`function WideFindFirst(const Path: WideString; Attr: Integer; var F: TXOMSearchRec): Integer; virtual; abstract;`

	`function WideFindNext(var F: TXOMSearchRec): Integer; virtual; abstract;`

	`procedure WideFindClose(var F: TXOMSearchRec); virtual; abstract;`

	`function WideFileAge(const FileName: WideString): Integer; virtual; abstract;`

	`function WideFileIsReadOnly(const FileName: WideString): Boolean; virtual; abstract;`

	`function WideFileIsReadable(const FileName: WideString): Boolean; virtual; abstract;`

	`function WideFileIsWriteable(const FileName: WideString): Boolean; virtual; abstract;`

	`function WideDirectoryIsWritable(const AName: WideString): Boolean; virtual; abstract;`

	`function WideExtractShortPathName(const FileName: WideString): WideString; virtual; abstract;`

	`function WideMatchesMask (const FileName: WideString; const Mask: WideString): Boolean; virtual; abstract;`

	`function WideSearchFiles (const ADir: WideString; const AMask: WideString; const AFrom: TDateTime; AResult: TxomStrings; const ARecursive: Boolean = False; const ADateCheckKind: TDateCheckKind = dckModified; const AMaxResults: Integer = -1; AFiltered: TxomStrings = nil): Boolean; virtual; abstract;`

	`function WideSearchFilesExtended (const ADir: WideString; const AMask: WideString; const AFrom: TDateTime; AResult: TxomStrings; AWithSearchRecs: Boolean; var ASearchRecs: TXOMSearchRecs; const ARecursive: Boolean = False; const ADateCheckKind: TDateCheckKind = dckModified; const AMaxResults: Integer = -1; AFiltered: TxomStrings = nil): Boolean; virtual; abstract;`

	`function WideSearchFolders (const ADir: WideString; const AMask: WideString; AResult: TxomStrings; ARecursive: Boolean = False): Boolean; virtual; abstract;`

	`function WideSearchVolumes (AResult: TxomStrings): Boolean; virtual; abstract;`

	`function WideDownloadFile(const AFile, ALocalFile: WideString): Boolean; virtual; abstract;`

	`function WideDownloadFileStream(const AFile: WideString; AStream: TStream): Boolean; virtual; abstract;`

	`function WideDiffDownloadFile(const ALocalFile, AFile: WideString): Boolean; virtual; abstract;`

	`function WideDiffDownloadFileStream(const AFile: WideString; AStream: TStream): Boolean; virtual; abstract;`

	`function WideUploadFile(const ALocalFile, AFile: WideString): Boolean; virtual; abstract;`

	`function WideUploadFileStream(const AFile: WideString; AStream: TStream): Boolean; virtual; abstract;`

	`function WideDiffUploadFile(const ALocalFile, AFile: WideString): Boolean; virtual; abstract;`

	`function WideDiffUploadFileStream(const AFile: WideString; AStream: TStream): Boolean; virtual; abstract;`

	`function WideLoadExif(const AFileName: WideString; AStream: TStream): Boolean; virtual; abstract;`

	`function WideSaveExif(const AFileName: WideString; AStream: TStream): Boolean; virtual; abstract;`

	`function WideLoadFileContent(const AFileName: WideString; AStream: TStream; ADecrypt: Boolean): Boolean; virtual; abstract;`

	`function WideSaveFileContent(const AFileName: WideString; AStream: TStream; AEncrypt: Boolean): Boolean; virtual; abstract;`

Properties

	`property Protocol: WideString read FProtocol write FProtocol;`

Generated by PasDoc 0.15.0.