Class TImageCollection

Unit

idCore

Declaration

type TImageCollection = class(TIDIObject)

Description

TImageCollection

Hierarchy

• TDBXOMObject
• TIDIObject
• TImageCollection

Overview

Fields

_Enumerated: Boolean;

Methods

	procedure AfterConstruction; override;
	procedure BeforeDestruction; override;
	procedure BaseAssign (Source: TObject; AssignClasses: Boolean); override;
	procedure BuildNewGUIDs;
	procedure FillFromDataSet (ADataSet: TDBXOMDataSet); override;
	procedure FetchAll;
	function TopCollection: TImageCollection;
	function HasImages (ARecursive: Boolean): Boolean;
	function AddFolder ( AFolderName: WideString): TImageCollection; virtual;
	function FindFileName (const AFileName: WideString; const AMediumType: TMediumType; const AMediumName: WideString; const AMediumSerial: Integer; const IncludePathName: Boolean = False; const Recursive: Boolean = False; const ACheckStacks: Boolean = False): TImageItem; virtual;
	function FindImage (AImageItem: TImageItem): TImageItem; virtual;
	function CountFileName (const AFileName: WideString; const AMediumType: TMediumType; const AMediumName: WideString; const AMediumSerial: Integer; const IncludePathName: Boolean = False; const Recursive: Boolean = False): Integer; virtual;
	function FindItem (const AItemGUID: String): TImageItem;
	function FindCollection (const ACollectionGUID: String): TImageCollection;
	function FindCollectionSource (const ASource: WideString): TImageCollection;
	function ContainsGUID (const AGUID: String): Boolean;
	function FindFile (const AFileName: WideString): TImageItem; virtual;
	procedure Clear;
	procedure ReSort;
	procedure EnumImagesForPeriod (APeriod: TPeriod; var ACollection: TImageCollection);
	procedure EnumAllImages (ACollection: TImageCollection);
	procedure Flatten (ATarget: TImageItems = nil);
	procedure ReadFromFileList (AFileList: TxomStrings);
	procedure ReadFromFolder ( AFolderName: WideString; const AMask: WideString; ASubsAlso: Boolean = False; AFlat: Boolean = False; AMax: Integer = -1; ARecursiveLevels: Integer = -1; ACurrentLevel: Integer = 1; AReadUpFolder: Boolean = True; AFromDate: TDateTime = 0.0; ADateCheckKind: TDateCheckKind = dckModified);
	procedure ReadFolder (const AFolderName: WideString; ASubsAlso: Boolean = False);
	function ParentCollection: TImageCollection;
	procedure CleanUpParentEntries;
	procedure CleanUpEmptyFolders;
	procedure UpdateFileName (AOldItem: TImageItem; const ANewFileName: WideString);
	procedure DeleteFileName (const AFileName: WideString);
	procedure UpdateFolderName ( AOldName, ANewName: WideString);

Properties

	property CollectionSourceSize: Int64 read GetCollectionSourceSize write FCollectionSourceSize;
	property _CollectionSourceSize: Int64 read FCollectionSourceSize write FCollectionSourceSize;
	property Gallery: TImageGallery read GetGallery write SetGallery;
	property IsVirtualCollection: Boolean read GetIsVirtualCollection;
	property Data: TObject read FData write FData;
	property LastActive: TObject read FLastActive write FLastActive;
	property Image: TDataMemoryStream read FImage;
	property Tag: PtrInt read FTag write FTag;
	property CreatorGUID: String read FCreatorGUID write FCreatorGUID;
	property CollectionName: WideString read FCollectionName write FCollectionName;
	property CollectionDescription: WideString read FCollectionDescription write FCollectionDescription;
	property CollectionSource: WideString read FCollectionSource write SetCollectionSource;
	property DynamicGroup: TXOMObject read FDynamicGroup write FDynamicGroup;
	property Images: Integer read GetImages stored False;
	property TotalImages: Integer read GetTotalImages stored False;
	property SubCollections: Integer read GetSubCollections stored False;
	property Items: TImageItems read FItems write FItems;
	property CollectionType: TImageCollectionType read FCollectionType write FCollectionType;
	property ParentOrder: Integer read FParentOrder write FParentOrder;
	property LastSort: TCollectionSort read FLastSort write FLastSort;
	property LastSortOrder: TSortType read FLastSortOrder write FLastSortOrder;
	property LastFilter: TCollectionFilters read FLastFilter write FLastFilter;
	property LastFilterScript: WideString read FLastFilterScript write FLastFilterScript;
	property UDF1: String read FUDF1 write FUDF1;
	property SubFolders: TImageCollections read FSubFolders write FSubFolders;
	property UpToParentEntry: Boolean read FUpToParentEntry write FUpToParentEntry;
	property _UpToParentEntry: String read Get_UpToParentEntry stored False;
	property Remark : WideString read FRemark write FRemark;
	property PhotoCount: Integer read FPhotoCount write FPhotoCount;
	property Locked: Boolean read FLocked write SetLocked;
	property Hierarchical: Boolean read FHierarchical write FHierarchical;

Description

Fields

	_Enumerated: Boolean;

Methods

	procedure AfterConstruction; override;

	procedure BeforeDestruction; override;

	procedure BaseAssign (Source: TObject; AssignClasses: Boolean); override;

	procedure BuildNewGUIDs;

	procedure FillFromDataSet (ADataSet: TDBXOMDataSet); override;

	procedure FetchAll;

	function TopCollection: TImageCollection;

	function HasImages (ARecursive: Boolean): Boolean;

	function AddFolder ( AFolderName: WideString): TImageCollection; virtual;

	function FindFileName (const AFileName: WideString; const AMediumType: TMediumType; const AMediumName: WideString; const AMediumSerial: Integer; const IncludePathName: Boolean = False; const Recursive: Boolean = False; const ACheckStacks: Boolean = False): TImageItem; virtual;

	function FindImage (AImageItem: TImageItem): TImageItem; virtual;

	function CountFileName (const AFileName: WideString; const AMediumType: TMediumType; const AMediumName: WideString; const AMediumSerial: Integer; const IncludePathName: Boolean = False; const Recursive: Boolean = False): Integer; virtual;

	function FindItem (const AItemGUID: String): TImageItem;

	function FindCollection (const ACollectionGUID: String): TImageCollection;

	function FindCollectionSource (const ASource: WideString): TImageCollection;

	function ContainsGUID (const AGUID: String): Boolean;

	function FindFile (const AFileName: WideString): TImageItem; virtual;

	procedure Clear;

	procedure ReSort;

	procedure EnumImagesForPeriod (APeriod: TPeriod; var ACollection: TImageCollection);

	procedure EnumAllImages (ACollection: TImageCollection);

	procedure Flatten (ATarget: TImageItems = nil);

	procedure ReadFromFileList (AFileList: TxomStrings);

	procedure ReadFromFolder ( AFolderName: WideString; const AMask: WideString; ASubsAlso: Boolean = False; AFlat: Boolean = False; AMax: Integer = -1; ARecursiveLevels: Integer = -1; ACurrentLevel: Integer = 1; AReadUpFolder: Boolean = True; AFromDate: TDateTime = 0.0; ADateCheckKind: TDateCheckKind = dckModified);

	procedure ReadFolder (const AFolderName: WideString; ASubsAlso: Boolean = False);

	function ParentCollection: TImageCollection;

	procedure CleanUpParentEntries;

	procedure CleanUpEmptyFolders;

	procedure UpdateFileName (AOldItem: TImageItem; const ANewFileName: WideString);

	procedure DeleteFileName (const AFileName: WideString);

	procedure UpdateFolderName ( AOldName, ANewName: WideString);

Properties

	property CollectionSourceSize: Int64 read GetCollectionSourceSize write FCollectionSourceSize;

	property _CollectionSourceSize: Int64 read FCollectionSourceSize write FCollectionSourceSize;

	property Gallery: TImageGallery read GetGallery write SetGallery;

	property IsVirtualCollection: Boolean read GetIsVirtualCollection;

	property Data: TObject read FData write FData;

	property LastActive: TObject read FLastActive write FLastActive;

	property Image: TDataMemoryStream read FImage;

	property Tag: PtrInt read FTag write FTag;

	property CreatorGUID: String read FCreatorGUID write FCreatorGUID;

	property CollectionName: WideString read FCollectionName write FCollectionName;

	property CollectionDescription: WideString read FCollectionDescription write FCollectionDescription;

	property CollectionSource: WideString read FCollectionSource write SetCollectionSource;

	property DynamicGroup: TXOMObject read FDynamicGroup write FDynamicGroup;

	property Images: Integer read GetImages stored False;

	property TotalImages: Integer read GetTotalImages stored False;

	property SubCollections: Integer read GetSubCollections stored False;

	property Items: TImageItems read FItems write FItems;

	property CollectionType: TImageCollectionType read FCollectionType write FCollectionType;

	property ParentOrder: Integer read FParentOrder write FParentOrder;

	property LastSort: TCollectionSort read FLastSort write FLastSort;

	property LastSortOrder: TSortType read FLastSortOrder write FLastSortOrder;

	property LastFilter: TCollectionFilters read FLastFilter write FLastFilter;

	property LastFilterScript: WideString read FLastFilterScript write FLastFilterScript;

	property UDF1: String read FUDF1 write FUDF1;

	property SubFolders: TImageCollections read FSubFolders write FSubFolders;

	property UpToParentEntry: Boolean read FUpToParentEntry write FUpToParentEntry;

	property _UpToParentEntry: String read Get_UpToParentEntry stored False;

	property Remark : WideString read FRemark write FRemark;

	property PhotoCount: Integer read FPhotoCount write FPhotoCount;

	property Locked: Boolean read FLocked write SetLocked;

	property Hierarchical: Boolean read FHierarchical write FHierarchical;