Unit Utils.Interfaces

Uses
Functions and Procedures
Constants
Variables

Description

This unit contains the declaration of the interfaces used in the application.

Overview

Classes, Interfaces, Objects and Records

Name Description
Interface IPathWatcher Interface that represents an object to monitor a path, with methods to configure parameters and callback in addition to initializing the watch itself.

Types

TWatcherEvent = (...);
TWatcherRunCallback = function (const AFile: string; const AEvent: TWatcherEvent): boolean;
TIgnoreKind = (...);

Description

Types

TWatcherEvent = (...);
 
Values
  • weFirstRun
  • weFileChanged: The first run of the application
  • weTimeout: The file has changed
  • weNoChange: The file has been deleted
TWatcherRunCallback = function (const AFile: string; const AEvent: TWatcherEvent): boolean;

A procedure that will be called after a change. The file name that triggered this action will be passed as a parameter. If function returns true, watcher stops running.

No changes were detected

Parameters
AFile
The file that triggered the event. It will be empty for first run and no change.
AEvent
The event that triggered this procedure.
TIgnoreKind = (...);

Enum type to identify the type of item to be ignored by the Watcher.

Values
  • ikStartsText
  • ikFolder: itens of any kind that starts with the text specified
  • ikFile: ignore folders with the specified name
  • ikExtension: ignore files with the specified name

Generated by PasDoc 0.16.0.