abzipout.inc

Lazarus is a free and open source development tool for the FreePascal Compiler. The purpose of the p

    procedure PutItem(Index : Integer; Value : TAbZipItem);
    procedure SetAttributes(Value : TAbZipAttributes);
    procedure SetAutoSave(Value : Boolean);
    procedure SetBaseDirectory(Value : string);
    procedure SetBorderStyle(Value : TBorderStyle);
    procedure SetCompressionMethodToUse(Value : TAbZipSupportedMethod);
    procedure SetDeflationOption(Value : TAbZipDeflationOption);
{$IFDEF WIN32}
    procedure SetDOSMode(Value : Boolean);
{$ENDIF}
    procedure SetCursor(Value : TCursor);
{$IFNDEF UsingCLX}
    procedure SetDragCursor(Value : TCursor);
{$ENDIF}
{$IFNDEF UsingCLX}
    procedure SetDragMode(Value : TDragMode); override;
{$ENDIF}
    procedure SetExtractOptions(Value : TAbExtractOptions);
    procedure SetFileName(const aFileName : string); virtual;
    procedure SetHierarchy(Value : Boolean);
    procedure SetLogFile(Value : string);
    procedure SetLogging(Value : Boolean);
    procedure SetOnRequestImage(Value : TAbRequestImageEvent);
    procedure SetOnRequestLastDisk(Value : TAbRequestDiskEvent);
    procedure SetOnRequestNthDisk(Value : TAbRequestNthDiskEvent);
    procedure SetOnRequestBlankDisk(Value : TAbRequestDiskEvent);
    procedure SetOnWindowsDrop(Value : TWindowsDropEvent);
    procedure SetPassword(Value : string);
    procedure SetPasswordRetries(Value : Byte);
    procedure SetPictureDirectory(Value : TBitmap);                   
    procedure SetPictureFile(Value : TBitmap);
    procedure SetPictureZipAttribute(Value : TBitmap);
    procedure SetPictureDirectorySelected(Value : TBitmap);
    procedure SetPictureFileSelected(Value : TBitmap);
    procedure SetPictureZipAttributeSelected(Value : TBitmap);
    procedure SetPictureHeight(Value : Integer);
    procedure SetPictureWidth(Value : Integer);
    procedure SetSelectedItem(Value : LongInt);
    procedure SetStoreOptions(Value : TAbStoreOptions);
    procedure SetTempDirectory(Value : string);
    procedure SetSpanningThreshold(Value : Longint);
    procedure SetVersion(Value : string);
    procedure SetZipfileComment(Value : string);
    procedure TestItemProc(Sender : TObject; Item : TAbArchiveItem);
    procedure UnzipProc(Sender : TObject; Item : TAbArchiveItem;
                        const NewName : string);
    procedure UnzipToStreamProc(Sender : TObject; Item : TAbArchiveItem;
                                OutStream : TStream);
    procedure UpdateOutline;
    procedure ZipProc(Sender : TObject; Item : TAbArchiveItem;
                      OutStream : TStream);
    procedure ZipFromStreamProc(Sender : TObject; Item : TAbArchiveItem;
                                OutStream, InStream : TStream);

  protected {properties}
    property ArchiveProgressMeter : TAbMeter
             read  FArchiveProgressMeter
             write FArchiveProgressMeter;
    property Attributes : TAbZipAttributes
             read  FAttributes
             write SetAttributes
             default AbDefZipAttributes;
    property AutoSave : Boolean
             read  FAutoSave
             write SetAutoSave
             default AbDefAutoSave;
    property BaseDirectory : string
             read  FBaseDirectory
             write SetBaseDirectory;
    property BorderStyle : TBorderStyle
             read  GetBorderStyle
             write SetBorderStyle;
    property CompressionMethodToUse : TAbZipSupportedMethod
             read  FCompressionMethodToUse
             write SetCompressionMethodToUse
             default AbDefCompressionMethodToUse;
    property Cursor : TCursor
             read  GetCursor
             write SetCursor;
    property DeflationOption : TAbZipDeflationOption
             read  FDeflationOption
             write SetDeflationOption
             default AbDefDeflationOption;
{$IFDEF WIN32}
    property DOSMode : Boolean
             read FDOSMode
             write SetDOSMode;
{$ENDIF}
{$IFNDEF UsingCLX}
    property DragCursor : TCursor
             read  GetDragCursor
             write SetDragCursor;
    property DragMode : TDragMode
             read  GetDragMode
             write SetDragMode;
{$ENDIF}
    property ExtractOptions : TAbExtractOptions
             read  FExtractOptions
             write SetExtractOptions
             default AbDefExtractOptions;
    property FileName : string
             read  FFileName
             write SetFileName;
    property Hierarchy : Boolean
             read  FHierarchy
             write SetHierarchy
             default AbDefHierarchy;
    property SpanningThreshold : Longint
             read  FSpanningThreshold
             write SetSpanningThreshold
             default 0;
    property ItemProgressMeter : TAbMeter
             read  FItemProgressMeter
             write FItemProgressMeter;
    property LogFile : string
             read  FLogFile
             write SetLogFile;
    property Logging : Boolean
             read  FLogging
             write SetLogging;
    property OnWindowsDrop : TWindowsDropEvent
             read  FOnWindowsDrop
             write SetOnWindowsDrop;
    property Password : string
             read  FPassword
             write SetPassword;
    property PasswordRetries : Byte
             read  FPasswordRetries
             write SetPasswordRetries
             default AbDefPasswordRetries;
    property PictureDirectory : TBitmap
             read  GetPictureDirectory
             write SetPictureDirectory;
    property PictureFile : TBitmap
             read  GetPictureFile
             write SetPictureFile;
    property PictureZipAttribute : TBitmap
             read  GetPictureZipAttribute
             write SetPictureZipAttribute;
    property PictureDirectorySelected : TBitmap
             read  GetPictureDirectorySelected
             write SetPictureDirectorySelected;
    property PictureFileSelected : TBitmap
             read  GetPictureFileSelected
             write SetPictureFileSelected;
    property PictureZipAttributeSelected : TBitmap
             read  GetPictureZipAttributeSelected
             write SetPictureZipAttributeSelected;
    property PictureHeight : Integer
             read  GetPictureHeight
             write SetPictureHeight;
    property PictureWidth : Integer
             read  GetPictureWidth
             write SetPictureWidth;
    property StoreOptions : TAbStoreOptions
             read  FStoreOptions
             write SetStoreOptions
             default AbDefStoreOptions;
    property Version : string
             read GetVersion
             write SetVersion
             stored False;

  protected {events}
    property OnProcessItemFailure : TAbArchiveItemFailureEvent
             read  FOnProcessItemFailure
             write FOnProcessItemFailure;
    property OnArchiveItemProgress : TAbArchiveItemProgressEvent
             read  FOnArchiveItemProgress
             write FOnArchiveItemProgress;
    property OnArchiveProgress : TAbArchiveProgressEvent
             read  FOnArchiveProgress
             write FOnArchiveProgress;
    property OnChange : TNotifyEvent
             read  FOnChange
             write FOnChange;
    property OnClick : TNotifyEvent
             read  FOnClick
             write FOnClick;
    property OnConfirmProcessItem : TAbArchiveItemConfirmEvent
             read  FOnConfirmProcessItem
             write FOnConfirmProcessItem;
    property OnConfirmOverwrite : TAbConfirmOverwriteEvent
             read  FOnConfirmOverwrite
             write FOnConfirmOverwrite;
    property OnConfirmSave : TAbArchiveConfirmEvent
             read  FOnConfirmSave
             write FOnConfirmSave;
    property OnCollapse : TTVExpandedEvent
             read  FOnCollapse
             write FOnCollapse;
    property OnDblClick : TNotifyEvent
             read  FOnDblClick
             write FOnDblClick;
    property OnDragDrop : TDragDropEvent
             read FOnDragDrop
             write FOnDragDrop;
    property OnDragOver : TDragOverEvent
             read  FOnDragOver
             write FOnDragOver;
    property OnEndDrag : TEndDragEvent
             read  FOnEndDrag
             write FOnEndDrag;
    property OnEnter : TNotifyEvent
             read  FOnEnter
             write FOnEnter;
    property OnExit : TNotifyEvent
             read  FOnExit
             write FOnExit;
    property OnExpand : TTVExpandedEvent
             read  FOnExpand
             write FOnExpand;
    property OnKeyDown : TKeyEvent
             read  FOnKeyDown
             write FOnKeyDown;
    property OnKeyPress : TKeyPressEvent
             read  FOnKeyPress
             write FOnKeyPress;
    property OnKeyUp : TKeyEvent
             read  FOnKeyUp
             write FOnKeyUp;
    property OnLoad : TAbArchiveEvent
             read  FOnLoad
             write FOnLoad;
    property OnMouseDown : TMouseEvent
             read  FOnMouseDown
             write FOnMouseDown;
    property OnMouseMove : TMouseMoveEvent
             read  FOnMouseMove
             write FOnMouseMove;
    property OnMouseUp : TMouseEvent
             read  FOnMouseUp
             write FOnMouseUp;
{$IFDEF NeedMouseWheel}
    property OnMouseWheel : TMouseWheelEvent
             read  FOnMouseWheel
             write FOnMouseWheel;
{$ENDIF}
    property OnNeedPassword : TAbNeedPasswordEvent
             read  FOnNeedPassword
             write FOnNeedPassword;
    property OnRequestImage : TAbRequestImageEvent
             read  FOnRequestImage
             write SetOnRequestImage;
    property OnRequestLastDisk : TAbRequestDiskEvent
             read  FOnRequestLastDisk
             write SetOnRequestLastDisk;
    property OnRequestNthDisk : TAbRequestNthDiskEvent
             read  FOnRequestNthDisk
             write SetOnRequestNthDisk;
    property OnRequestBlankDisk : TAbRequestDiskEvent
             read  FOnRequestBlankDisk
             write SetOnRequestBlankDisk;
    property OnSave : TAbArchiveEvent
             read  FOnSave
             write FOnSave;
{$IFDEF Win32}
    property OnStartDrag : TStartDragEvent
             read  FOnStartDrag
             write FOnStartDrag;
{$ENDIF Win32}

  public {methods}
    constructor Create(AOwner : TComponent); override;
    destructor Destroy; override;

    procedure AddFiles(const FileMask : string; SearchAttr : Integer);
      {Add files to the archive where the disk filespec matches}
    procedure AddFilesEx(const FileMask, ExclusionMask : string;
                         SearchAttr : Integer);
      {Add files that match Filemask except those matching ExclusionMask}
    procedure AddFromStream(const NewName : string; FromStream : TStream);
      {Create and add a zip item directly from a stream}
    procedure ClearTags;
      {Clear all tags from the archive}
    procedure CloseArchive;
      {closes the archive by setting FileName to ''}
    procedure DeleteAt(Index : Integer);
      {delete item specified by index}
    procedure DeleteFiles(const FileMask : string);
      {Delete all files from the archive that match the file mask}
    procedure DeleteFilesEx(const FileMask, ExclusionMask : string);
      {Delete files that match Filemask except those matching ExclusionMask}
    procedure DeleteTaggedItems;
      {delete all tagged items from the archive}
    procedure ExtractAt(Index : Integer; const NewName : string);
      {extract item specified by index}
    procedure ExtractFiles(const FileMask : string);
      {extract all files from the archive that match the mask}
    procedure ExtractFilesEx(const FileMask, ExclusionMask : string);
      {Extract files that match Filemask except those matching ExclusionMask}
    procedure ExtractTaggedItems;
      {extract all tagged items from the archive}
    procedure ExtractToStream(const aFileName : string; ToStream : TStream);
      {extract an item directly to a stream}
    function FindItem(aItem : TAbArchiveItem) : Integer;
      {extract specified item}
    function FindFile(const aFileName : string) : Integer;
      {find the item with the given file name}
    procedure FreshenFiles(const FileMask : string);
      {freshen all items that match the file mask}
    procedure FreshenFilesEx(const FileMask, ExclusionMask : string);
      {freshen items matching FileMask but not ExclusionMask}
    procedure FreshenTaggedItems;
      {freshen all tagged items}
    procedure FullCollapse;
    procedure FullExpand;
    function GetTextItem(const Value: string): LongInt;
    function GetOutLineItem(X, Y : Integer): LongInt;
    procedure Move(aItem : TAbArchiveItem; NewStoredPath : string);
    procedure OpenArchive(const aFileName : String);
      {opens the archive}
    procedure Replace(aItem : TAbArchiveItem);
    procedure Save;
      {saves the archive}
    procedure TagItems(const FileMask : string);
    procedure TestTaggedItems;
    procedure UnTagItems(const FileMask : string);                   

  public {properties}
    property Count : Integer
             read GetCount;
    property Items[Index : Integer] : TAbZipItem
             read GetItem
             write PutItem; default;
    property SelectedItem: LongInt
             read GetSelectedItem
             write SetSelectedItem;
    property SelectedZipItem : TAbZipItem
             read GetSelectedZipItem;
    property Status : TAbArchiveStatus
             read GetStatus;
    property TempDirectory : string
             read FTempDirectory
             write SetTempDirectory;
    property ZipfileComment : string
             read GetZipfileComment
             write SetZipfileComment;
  end;


type
  TAbZipOutline = class(TAbCustomZipOutline)
  published
    property Align;
    property ArchiveProgressMeter;
    property ItemProgressMeter;
    property Attributes;
    property AutoSave;
    property BaseDirectory;
    property BorderStyle;
    property Color
             default AbDefColor;
    property CompressionMethodToUse;
    property Count;
{$IFNDEF UsingCLX}
    property Ctl3D;
{$ENDIF}
    property Cursor;
    property DeflationOption;
{$IFDEF WIN32}
    property DOSMode;
{$ENDIF}
{$IFNDEF UsingCLX}