Logged out, click to login

JEDI Online help - Browsing a unit



Back to project JVCL Back Add an item Edit unit Generate DTX file Search Administration

Unit JvAppStorage.pas

Author: Marcel Bestebroer

Package: Core

Status: Completed, Incomplete

Contains the interface and generic implemention for the storage backend. <INCLUDE JVCL.UnitText.dtx>

Last changed by obones on 2009-01-04 20:48:20 CET

Items in the unit

Item
Summary
EJVCLAppStorageError The exception class for storage errors.
IJvAppStorageHandler If a class implements this interface JvAppStorage.Read/WritePersistent uses the interface methods to store object properties
IJvAppStorageHandler.ReadFromAppStorage Reads object properties/settings from the AppStorage Backend
IJvAppStorageHandler.WriteToAppStorage Writes object properties/settings to the AppStorage Backend
IJvAppStoragePublishedProps If a class implements this interface all published properties of the class will be handled by JvAppStorages.Read/WritePersistent
RegisterAppStoragePropertyEngine Write here a summary (1 line)
TFileLocation File-Location Type
TFileLocation.flCustom Filename must contain a directory
TFileLocation.flExeFile File is placed in the directory of the Exe-File
TFileLocation.flTemp File is placed in the temp directory
TFileLocation.flUserFolder File is placed in the user directory
TFileLocation.flWindows File is placed in the windows directory
TJvAppStorage Storage Component without own storage mechanism.
TJvAppStorageCryptEvent Event type used to encrypt/decrypt string values.
TJvAppStorageEnumOption Specifies enumeration options.
TJvAppStorageEnumOption.aeoFolders Enumerate folders (containers for values).
TJvAppStorageEnumOption.aeoRecursive Search sub folders.
TJvAppStorageEnumOption.aeoReportListAsValue Report lists as a single value. A list is generally a folder containing a 'Count' value and a number of items. If this option is specified such folders are reported as a single value.
TJvAppStorageEnumOption.aeoReportRelative Report all folders and values relative to the specified search path. If this option is not specified all reported folders and values are fully qualified (and start with a backslash).
TJvAppStorageEnumOption.aeoValues Enumerate values.
TJvAppStorageEnumOptions Specifies enumeration options.
TJvAppStorageErrorEvent Write here a summary (1 line)
TJvAppStorageGetFileNameEvent Write here a summary (1 line)
TJvAppStorageListDeleteEvent Event type used to delete (part of) a list.
TJvAppStorageListItemEvent Event type used to read or write a list item.
TJvAppStorageObjectListItemCreateEvent Write here a summary (1 line)
TJvAppStorageOptions Write here a summary (1 line)
TJvAppStorageOptionsClass Defines the metaclass for TJvCustomAppStorageOptions.
TJvAppStoragePropertyBaseEngine Write here a summary (1 line)
TJvAppStoragePropertyBaseEngine.ReadProperty Write here a summary (1 line)
TJvAppStoragePropertyBaseEngine.Supports Write here a summary (1 line)
TJvAppStoragePropertyBaseEngine.WriteProperty Stores a property.
TJvAppStoragePropertyBaseEngineClass Write here a summary (1 line)
TJvAppStoragePropTranslateEvent Event to translate the names under which the values were stored with the backend engine.
TJvAppSubStorage Write here a summary (1 line)
TJvAppSubStorage.AppStorage Write here a summary (1 line)
TJvAppSubStorage.OwnerStore Write here a summary (1 line)
TJvAppSubStorage.RootPath Write here a summary (1 line)
TJvAppSubStorages Write here a summary (1 line)
TJvAppSubStorages.Add Write here a summary (1 line)
TJvAppSubStorages.CheckUniqueBase Write here a summary (1 line)
TJvAppSubStorages.Delete

@Integer
Write here a summary (1 line)
TJvAppSubStorages.Delete

@string

@Boolean
Write here a summary (1 line)
TJvAppSubStorages.Delete

@TJvCustomAppStorage
Write here a summary (1 line)
TJvAppSubStorages.Items Write here a summary (1 line)
TJvAppSubStorages.MatchFor Write here a summary (1 line)
TJvAppSubStorages.RootOptionsChanged Write here a summary (1 line)
TJvAppSubStorages.RootStorage Write here a summary (1 line)
TJvCustomAppMemoryFileStorage Base class for all in memory file storage classes.
TJvCustomAppMemoryFileStorage.AsString Write here a summary (1 line)
TJvCustomAppMemoryFileStorage.FileName The name of the file that the storage represents.
TJvCustomAppMemoryFileStorage.FullFileName Indicates the path and name of the file that the storage represents.
TJvCustomAppMemoryFileStorage.Location Root folder for storage file
TJvCustomAppMemoryFileStorage.OnGetFileName Write here a summary (1 line)
TJvCustomAppStorage Abstract base class for application data storage.
TJvCustomAppStorage.ActiveTranslateStringEngine Write here a summary (1 line)
TJvCustomAppStorage.AutoFlush Determines when Flush is called.
TJvCustomAppStorage.AutoReload Determines when Reload is called.
TJvCustomAppStorage.BeginUpdate Write here a summary (1 line)
TJvCustomAppStorage.CheckDeletePathByVersion Conditionally deletes the specified folder/value and any sub folders.
TJvCustomAppStorage.ConcatPaths Combines paths into one (canonical) path.
TJvCustomAppStorage.CurrentInstanceCreateEvent Write here a summary (1 line)
TJvCustomAppStorage.DeleteSubTree Deletes the specified folder/value and any sub folders.
TJvCustomAppStorage.DeleteValue Deletes the specified value.
TJvCustomAppStorage.DisablePropertyValueCrypt Disables the encryption/decryption of string values.
TJvCustomAppStorage.EnablePropertyValueCrypt Enables the encryption/decryption of string values.
TJvCustomAppStorage.EndUpdate Write here a summary (1 line)
TJvCustomAppStorage.Flush Flushes the content of the in memory file into the file indicated by FileName.
TJvCustomAppStorage.FlushIfNeeded Write here a summary (1 line)
TJvCustomAppStorage.FlushNeeded Write here a summary (1 line)
TJvCustomAppStorage.FlushOnDestroy Write here a summary (1 line)
TJvCustomAppStorage.GetCharName Translates a char value to a (valid) key name.
TJvCustomAppStorage.GetIntName Translates an integer value to a key name.
TJvCustomAppStorage.GetStoredValues Retrieves a list of values and folders in the storage.
TJvCustomAppStorage.IsFolder Determines if the specified path is a folder.
TJvCustomAppStorage.IsPropertyValueCryptEnabled Indicates whether the encryption/decryption of values is enabled.
TJvCustomAppStorage.IsUpdating Write here a summary (1 line)
TJvCustomAppStorage.ItemNameIndexPath Write here a summary (1 line)
TJvCustomAppStorage.ListStored Determines if the specified path is a list.
TJvCustomAppStorage.OnDecryptPropertyValue Occurs when a string value needs to be decrypted.
TJvCustomAppStorage.OnEncryptPropertyValue Occurs when a string value needs to be encrypted.
TJvCustomAppStorage.OnError Write here a summary (1 line)
TJvCustomAppStorage.OnTranslatePropertyName Event to translate the names under which the values were stored with the backend engine.
TJvCustomAppStorage.Path Specifies the current path.
TJvCustomAppStorage.PathExists Determines if the specified path exists.
TJvCustomAppStorage.ReadBinary Reads a binary value.
TJvCustomAppStorage.ReadBoolean Write here a summary (1 line)
TJvCustomAppStorage.ReadCollection Write here a summary (1 line)
TJvCustomAppStorage.ReadDateTime Reads a TDateTime value.
TJvCustomAppStorage.ReadEnumeration Reads an enumeration value.
TJvCustomAppStorage.ReadFloat Reads a floating point value.
TJvCustomAppStorage.ReadInteger Reads an integer value.
TJvCustomAppStorage.ReadList Reads a list of items.
TJvCustomAppStorage.ReadObjectList

@string

@TList

@Boolean

@string
Retrieves a list of objects.
TJvCustomAppStorage.ReadObjectList

@string

@TList

@TJvAppStorageObjectListItemCreateEvent

@Boolean

@string
Retrieves a list of objects.
TJvCustomAppStorage.ReadOnly Write here a summary (1 line)
TJvCustomAppStorage.ReadPersistent Reads a TPersistent-Object with all of its published properties.
TJvCustomAppStorage.ReadProperty Reads a property.
TJvCustomAppStorage.ReadSet Reads a set.
TJvCustomAppStorage.ReadString Reads a string value.
TJvCustomAppStorage.ReadStringList Reads a list of strings.
TJvCustomAppStorage.ReadStringObjectList

@string

@TStrings

@Boolean

@string
Reads a string list with addition objects.
TJvCustomAppStorage.ReadStringObjectList

@string

@TStrings

@TJvAppStorageObjectListItemCreateEvent

@Boolean

@string
Reads a string list with addition objects.
TJvCustomAppStorage.ReadWideString Write here a summary (1 line)
TJvCustomAppStorage.Reload Reloads the data in memory file from the file indicated by FileName.
TJvCustomAppStorage.ReloadIfNeeded Write here a summary (1 line)
TJvCustomAppStorage.ReloadNeeded Write here a summary (1 line)
TJvCustomAppStorage.ResolvePath Resolves the specified path to a target storage and target path.
TJvCustomAppStorage.Root Specifies absolute root.
TJvCustomAppStorage.StorageOptions Write here a summary (1 line)
TJvCustomAppStorage.SubStorages Write here a summary (1 line)
TJvCustomAppStorage.SynchronizeFlushReload Write here a summary (1 line)
TJvCustomAppStorage.TranslatePropertyName Write here a summary (1 line)
TJvCustomAppStorage.TranslateStringEngine Write here a summary (1 line)
TJvCustomAppStorage.ValueStored Determines if the specified path is a value.
TJvCustomAppStorage.WriteBinary Stores the buffer in a binary form.
TJvCustomAppStorage.WriteBoolean Stores a Boolean value.
TJvCustomAppStorage.WriteCollection Stores a collection.
TJvCustomAppStorage.WriteDateTime Stores a date and time value.
TJvCustomAppStorage.WriteEnumeration Write here a summary (1 line)
TJvCustomAppStorage.WriteFloat Stores a floating point value.
TJvCustomAppStorage.WriteInteger Stores an integer value.
TJvCustomAppStorage.WriteList Stores a list of items.
TJvCustomAppStorage.WriteObjectList Stores a list of objects.
TJvCustomAppStorage.WritePersistent Stores a TPersistent-Object with all of its published properties.
TJvCustomAppStorage.WriteProperty Stores a property.
TJvCustomAppStorage.WriteSet Stores a set (ignores sub stores).
TJvCustomAppStorage.WriteString Stores a string value.
TJvCustomAppStorage.WriteStringList Stores a list of strings.
TJvCustomAppStorage.WriteStringObjectList Stores a list of strings.
TJvCustomAppStorage.WriteWideString Write here a summary (1 line)
TJvCustomAppStorageOptions Write here a summary (1 line)
TJvCustomAppStorageOptions.BooleanAsString Write here a summary (1 line)
TJvCustomAppStorageOptions.BooleanStringFalseValues Write here a summary (1 line)
TJvCustomAppStorageOptions.BooleanStringTrueValues Write here a summary (1 line)
TJvCustomAppStorageOptions.DateTimeAsString Specifies whether to store a datetime value as string.
TJvCustomAppStorageOptions.DefaultFalseString Write here a summary (1 line)
TJvCustomAppStorageOptions.DefaultIfReadConvertError Write here a summary (1 line)
TJvCustomAppStorageOptions.DefaultIfValueNotExists Write here a summary (1 line)
TJvCustomAppStorageOptions.DefaultTrueString Write here a summary (1 line)
TJvCustomAppStorageOptions.EnumerationAsString Specifies whether to store an enumeration as string.
TJvCustomAppStorageOptions.FloatAsString Specifies whether to store a float as string.
TJvCustomAppStorageOptions.IsValueFalseString Write here a summary (1 line)
TJvCustomAppStorageOptions.IsValueListString Write here a summary (1 line)
TJvCustomAppStorageOptions.IsValueTrueString Write here a summary (1 line)
TJvCustomAppStorageOptions.SetAsString Specifies whether to store a set as string.
TJvCustomAppStorageOptions.StoreDefaultValues Write here a summary (1 line)
TJvCustomAppStorageOptions.StoreStringListAsSingleString Write here a summary (1 line)
TJvCustomAppStorageOptions.TypedIntegerAsString Write here a summary (1 line)
TJvCustomAppStorageOptions.UseOldItemNameFormat Write here a summary (1 line)
TSynchronizeMethod Write here a summary (1 line)
UnregisterAppStoragePropertyEngine Write here a summary (1 line)

Copyright (c) 2004 by the JVCL Team; all rights reserved
Uses PclZip by phpconcept and parts of the PEAR library