libMVRgdtf 40bc00a
A library for GDTF and MVR
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Classes | Typedefs | Enumerations | Functions | Variables
VectorworksMVR::Filing Namespace Reference

Classes

class  CCallbackFolderContentListener
 
class  CFileIdentifier
 
class  CFolderIdentifier
 
class  CRawOSFileImpl
 
class  CZIPFileImpl
 
class  CZIPFileIOBufferImpl
 
class  IFileIdentifier
 
class  IFolderContentListener
 
class  IFolderIdentifier
 
class  IRawOSFile
 
class  IStdFile
 
class  IStdFileProgressListener
 
class  IWorkspaceFileInfoListener
 
class  IXMLFile
 
class  IXMLFileIOBuffer
 
class  IXMLFileNode
 
class  IZIPFile
 
class  IZIPFileIOBuffer
 
struct  SAttributes
 
struct  SAttributesDateTime
 
struct  SZIPArchiveInfo
 
struct  SZIPFileInfo
 
struct  TDateTimeData
 
class  TFileIdentifier
 
class  TFolderIdentifier
 
class  TStorageAccessFactory
 
class  TXBaseStorageAccess
 
class  ZIPFileBuffer
 

Typedefs

typedef VCOMPtr< IFileIdentifier > IFileIdentifierPtr
 
typedef std::vector< IFileIdentifierPtr > TVWArray_IFileIdentifier
 
typedef std::function< EFolderContentListenerResult(IFolderIdentifier *folderID)> TFolderContentCallback_Folder
 
typedef std::function< EFolderContentListenerResult(IFileIdentifier *fileID)> TFolderContentCallback_File
 
typedef VCOMPtr< IFolderIdentifier > IFolderIdentifierPtr
 
typedef VCOMPtr< IRawOSFile > IRawOSFilePtr
 
typedef VCOMPtr< IStdFile > IStdFilePtr
 
typedef VCOMPtr< IXMLFile > IXMLFilePtr
 
typedef VCOMPtr< IXMLFileNode > IXMLFileNodePtr
 
typedef VCOMPtr< IZIPFile > IZIPFilePtr
 
typedef Uint32 StorageAttributes
 
typedef std::vector< VectorworksMVR::Filing::SZIPFileInfo > TZIPFileInfoArray
 

Enumerations

enum  EAttributesTimeReference { eAttributesTimeReference_Created , eAttributesTimeReference_LastAccessed , eAttributesTimeReference_LastWritten , eAttributesTimeReference_LastBackup }
 
enum  EFolderContentListenerResult { eFolderContentListenerResult_Continue , eFolderContentListenerResult_StopNoError , eFolderContentListenerResult_StopError }
 
enum  ELineEndType { eLineEndType_Mac , eLineEndType_Win , eLineEndType_Unix , eLineEndType_Native }
 
enum  EXMLEncoding { eXMLEncoding_UTF8 , eXMLEncoding_UTF16 }
 
enum  EXMLFileError {
  eXMLFileError_NoError , eXMLFileError_UnknownError , eXMLFileError_MemoryError , eXMLFileError_Parser ,
  eXMLFileError_NoAttribute , eXMLFileError_CannotCreateNode , eXMLFileError_ElementNotFound , eXMLFileError_BadArrayIndex ,
  eXMLFileError_BadName , eXMLFileError_DOMError , eXMLFileError_XercesException
}
 
enum  EXMLFileFeature { eXMLFileFeature_FormatPrettyPrint , eXMLFileFeature_SetNewLineCRLF , eXMLFileFeature_SetNewLineCR , eXMLFileFeature_SetNewLineLF }
 

Functions

bool GetFolderWithSpecifer (EFolderSpecifier inWhichFolder, TFolderIdentifier &outFolderID, bool inCreateIfMissing=false)
 
bool GetFolderAppDataPath (TXString &outPath)
 

Variables

const VCOMError kVCOMError_BadPathSpecified = 50
 
const VCOMError kVCOMError_FileNotFound = 51
 
const VCOMError kVCOMError_AccessDenied = 52
 
const VCOMError kVCOMError_TooManyOpenFiles = 54
 
const VCOMError kVCOMError_DiskFull = 55
 
const VCOMError kVCOMError_XMLFile_UnknownError = 100
 
const VCOMError kVCOMError_XMLFile_MemoryError = 101
 
const VCOMError kVCOMError_XMLFile_Parser = 102
 
const VCOMError kVCOMError_XMLFile_NoAttribute = 103
 
const VCOMError kVCOMError_XMLFile_CannotCreateNode = 104
 
const VCOMError kVCOMError_XMLFile_ElementNotFound = 105
 
const VCOMError kVCOMError_XMLFile_BadArrayIndex = 106
 
const VCOMError kVCOMError_XMLFile_BadName = 107
 
const VCOMError kVCOMError_XMLFile_DOMError = 108
 
const VCOMError kVCOMError_XMLFile_XercesException = 109
 
const StorageAttributes kStorageAttrRead = 0x00000001
 
const StorageAttributes kStorageAttrWrite = 0x00000001 << 1
 
const StorageAttributes kStorageAttrExecute = 0x00000001 << 2
 
const StorageAttributes kStorageAttrHidden = 0x00000001 << 3
 
const StorageAttributes kStorageAttrSystem = 0x00000001 << 4
 
const StorageAttributes kStorageAttrTemporary = 0x00000001 << 5
 
const StorageAttributes kStorageAttrEncrypted = 0x00000001 << 6
 
const StorageAttributes kStorageAttrPermRead = 0x00000001 << 7
 
const StorageAttributes kStorageAttrPermWrite = 0x00000001 << 8
 
const StorageAttributes kStorageAttrPermExecute = 0x00000001 << 9
 
const StorageAttributes kStorageAttrPermBrowse = 0x00000001 << 10
 
const StorageAttributes kStorageAttrArchive = 0x00000001 << 11
 
const StorageAttributes kStorageAttrDirectory = 0x00000001 << 12
 
const StorageAttributes kStorageAttrPermFlagsValid = 0x00000001 << 24
 
const Uint64 kLocalFileInfoSignature = 0x04034b50L
 
const Uint64 kCentralDirSignature = 0x02014b50L
 
const Uint64 kEndSignature = 0x06054b50L
 
const Uint64 kExtraDataSignature = 0x08074b50L
 

Typedef Documentation

◆ IFileIdentifierPtr

typedef VCOMPtr<IFileIdentifier> VectorworksMVR::Filing::IFileIdentifierPtr

◆ IFolderIdentifierPtr

typedef VCOMPtr<IFolderIdentifier> VectorworksMVR::Filing::IFolderIdentifierPtr

◆ IRawOSFilePtr

typedef VCOMPtr<IRawOSFile> VectorworksMVR::Filing::IRawOSFilePtr

◆ IStdFilePtr

typedef VCOMPtr<IStdFile> VectorworksMVR::Filing::IStdFilePtr

◆ IXMLFileNodePtr

typedef VCOMPtr<IXMLFileNode> VectorworksMVR::Filing::IXMLFileNodePtr

◆ IXMLFilePtr

typedef VCOMPtr<IXMLFile> VectorworksMVR::Filing::IXMLFilePtr

◆ IZIPFilePtr

typedef VCOMPtr<IZIPFile> VectorworksMVR::Filing::IZIPFilePtr

◆ StorageAttributes

typedef Uint32 VectorworksMVR::Filing::StorageAttributes

◆ TFolderContentCallback_File

typedef std::function<EFolderContentListenerResult(IFileIdentifier* fileID)> VectorworksMVR::Filing::TFolderContentCallback_File

◆ TFolderContentCallback_Folder

typedef std::function<EFolderContentListenerResult(IFolderIdentifier* folderID)> VectorworksMVR::Filing::TFolderContentCallback_Folder

◆ TVWArray_IFileIdentifier

typedef std::vector<IFileIdentifierPtr> VectorworksMVR::Filing::TVWArray_IFileIdentifier

◆ TZIPFileInfoArray

typedef std::vector<VectorworksMVR::Filing::SZIPFileInfo> VectorworksMVR::Filing::TZIPFileInfoArray

Enumeration Type Documentation

◆ EAttributesTimeReference

enum VectorworksMVR::Filing::EAttributesTimeReference
Enumerator
eAttributesTimeReference_Created 
eAttributesTimeReference_LastAccessed 
eAttributesTimeReference_LastWritten 
eAttributesTimeReference_LastBackup 

◆ EFolderContentListenerResult

enum VectorworksMVR::Filing::EFolderContentListenerResult
Enumerator
eFolderContentListenerResult_Continue 
eFolderContentListenerResult_StopNoError 
eFolderContentListenerResult_StopError 

◆ ELineEndType

enum VectorworksMVR::Filing::ELineEndType
Enumerator
eLineEndType_Mac 
eLineEndType_Win 
eLineEndType_Unix 
eLineEndType_Native 

◆ EXMLEncoding

enum VectorworksMVR::Filing::EXMLEncoding
Enumerator
eXMLEncoding_UTF8 
eXMLEncoding_UTF16 

◆ EXMLFileError

enum VectorworksMVR::Filing::EXMLFileError
Enumerator
eXMLFileError_NoError 
eXMLFileError_UnknownError 
eXMLFileError_MemoryError 
eXMLFileError_Parser 
eXMLFileError_NoAttribute 
eXMLFileError_CannotCreateNode 
eXMLFileError_ElementNotFound 
eXMLFileError_BadArrayIndex 
eXMLFileError_BadName 
eXMLFileError_DOMError 
eXMLFileError_XercesException 

◆ EXMLFileFeature

enum VectorworksMVR::Filing::EXMLFileFeature
Enumerator
eXMLFileFeature_FormatPrettyPrint 
eXMLFileFeature_SetNewLineCRLF 
eXMLFileFeature_SetNewLineCR 
eXMLFileFeature_SetNewLineLF 

Function Documentation

◆ GetFolderAppDataPath()

bool VectorworksMVR::Filing::GetFolderAppDataPath ( TXString &  outPath)

◆ GetFolderWithSpecifer()

bool VectorworksMVR::Filing::GetFolderWithSpecifer ( EFolderSpecifier  inWhichFolder,
TFolderIdentifier &  outFolderID,
bool  inCreateIfMissing = false 
)

Variable Documentation

◆ kCentralDirSignature

const Uint64 VectorworksMVR::Filing::kCentralDirSignature = 0x02014b50L

◆ kEndSignature

const Uint64 VectorworksMVR::Filing::kEndSignature = 0x06054b50L

◆ kExtraDataSignature

const Uint64 VectorworksMVR::Filing::kExtraDataSignature = 0x08074b50L

◆ kLocalFileInfoSignature

const Uint64 VectorworksMVR::Filing::kLocalFileInfoSignature = 0x04034b50L

◆ kStorageAttrArchive

const StorageAttributes VectorworksMVR::Filing::kStorageAttrArchive = 0x00000001 << 11

◆ kStorageAttrDirectory

const StorageAttributes VectorworksMVR::Filing::kStorageAttrDirectory = 0x00000001 << 12

◆ kStorageAttrEncrypted

const StorageAttributes VectorworksMVR::Filing::kStorageAttrEncrypted = 0x00000001 << 6

◆ kStorageAttrExecute

const StorageAttributes VectorworksMVR::Filing::kStorageAttrExecute = 0x00000001 << 2

◆ kStorageAttrHidden

const StorageAttributes VectorworksMVR::Filing::kStorageAttrHidden = 0x00000001 << 3

◆ kStorageAttrPermBrowse

const StorageAttributes VectorworksMVR::Filing::kStorageAttrPermBrowse = 0x00000001 << 10

◆ kStorageAttrPermExecute

const StorageAttributes VectorworksMVR::Filing::kStorageAttrPermExecute = 0x00000001 << 9

◆ kStorageAttrPermFlagsValid

const StorageAttributes VectorworksMVR::Filing::kStorageAttrPermFlagsValid = 0x00000001 << 24

◆ kStorageAttrPermRead

const StorageAttributes VectorworksMVR::Filing::kStorageAttrPermRead = 0x00000001 << 7

◆ kStorageAttrPermWrite

const StorageAttributes VectorworksMVR::Filing::kStorageAttrPermWrite = 0x00000001 << 8

◆ kStorageAttrRead

const StorageAttributes VectorworksMVR::Filing::kStorageAttrRead = 0x00000001

◆ kStorageAttrSystem

const StorageAttributes VectorworksMVR::Filing::kStorageAttrSystem = 0x00000001 << 4

◆ kStorageAttrTemporary

const StorageAttributes VectorworksMVR::Filing::kStorageAttrTemporary = 0x00000001 << 5

◆ kStorageAttrWrite

const StorageAttributes VectorworksMVR::Filing::kStorageAttrWrite = 0x00000001 << 1

◆ kVCOMError_AccessDenied

const VCOMError VectorworksMVR::Filing::kVCOMError_AccessDenied = 52

◆ kVCOMError_BadPathSpecified

const VCOMError VectorworksMVR::Filing::kVCOMError_BadPathSpecified = 50

◆ kVCOMError_DiskFull

const VCOMError VectorworksMVR::Filing::kVCOMError_DiskFull = 55

◆ kVCOMError_FileNotFound

const VCOMError VectorworksMVR::Filing::kVCOMError_FileNotFound = 51

◆ kVCOMError_TooManyOpenFiles

const VCOMError VectorworksMVR::Filing::kVCOMError_TooManyOpenFiles = 54

◆ kVCOMError_XMLFile_BadArrayIndex

const VCOMError VectorworksMVR::Filing::kVCOMError_XMLFile_BadArrayIndex = 106

◆ kVCOMError_XMLFile_BadName

const VCOMError VectorworksMVR::Filing::kVCOMError_XMLFile_BadName = 107

◆ kVCOMError_XMLFile_CannotCreateNode

const VCOMError VectorworksMVR::Filing::kVCOMError_XMLFile_CannotCreateNode = 104

◆ kVCOMError_XMLFile_DOMError

const VCOMError VectorworksMVR::Filing::kVCOMError_XMLFile_DOMError = 108

◆ kVCOMError_XMLFile_ElementNotFound

const VCOMError VectorworksMVR::Filing::kVCOMError_XMLFile_ElementNotFound = 105

◆ kVCOMError_XMLFile_MemoryError

const VCOMError VectorworksMVR::Filing::kVCOMError_XMLFile_MemoryError = 101

◆ kVCOMError_XMLFile_NoAttribute

const VCOMError VectorworksMVR::Filing::kVCOMError_XMLFile_NoAttribute = 103

◆ kVCOMError_XMLFile_Parser

const VCOMError VectorworksMVR::Filing::kVCOMError_XMLFile_Parser = 102

◆ kVCOMError_XMLFile_UnknownError

const VCOMError VectorworksMVR::Filing::kVCOMError_XMLFile_UnknownError = 100

◆ kVCOMError_XMLFile_XercesException

const VCOMError VectorworksMVR::Filing::kVCOMError_XMLFile_XercesException = 109