Sage-ST

Sage-ST ä
Btrlistclass
Documentation

Unit Documentation (Unit description) Global Declarations (Constants, Types, Variables)



  //*
  //  BtrListClass - A class wrapper around the BtrList unit.
  //
  //
  //  This unit contains a wrapper class so that the BtrList module can be
  //  used as a class.  For questions regarding details of the routines
  //  please refer to the BtrList module.
  //



  type
    TBtrListClass = class (TObject)

      private
        LastGood : boolean;

        procedure OpenList
                   (const AllowDups : boolean;
                    const InitList  : boolean);

        //*
        // OpenList - Open the list for use.
        //

        procedure CloseList
                   (const SaveList : boolean);

        //*
        // CloseList - Close the list to further use.
        //

      public
        ListHandle : BtrList.ListHandleType;

        ListFileName : string;

        property OpOk : boolean
          read LastGood
          write LastGood;

        //*
        // LastOpOk - Return boolean if last operation successful.
        //

        constructor Create
                   (const ListFileName : string);

        //*
        // Create - Create and open a list object.
        //

        destructor Destroy
                   (const SaveList : boolean); reintroduce;

        //*
        // Destroy - Close and destroy the list object.
        //

        procedure ClearList; virtual;

        //*
        // ClearList - Clear out all entries from the list.
        //

        procedure GetEntry
                   (const Operation  : BtrList.ListOperationType;
                    var EntryValue : array of char); overload; virtual;

        //*
        // GetEntry - Get the value of the current entry (last read).
        //

        procedure GetEntry
                   (const Operation  : BtrList.ListOperationType;
                    var EntryValue : string); overload; virtual;

        //*
        // STRGetEntry - See documentation of GetEntry.
        //

        procedure GetEntryWithData
                   (const Operation  : BtrList.ListOperationType;
                    var EntryValue : array of char;
                    var DataValue  : array of char); overload; virtual;

        //*
        // GetEntryWithData - Get the value of the current entry (last read).
        //

        procedure GetEntryWithData
                   (const Operation  : BtrList.ListOperationType;
                    var EntryValue : string;
                    var DataValue  : string); overload; virtual;

        //*
        // STRGetEntryWithData - See documentation of GetEntryWithData.
        //

        procedure GetEntryNumber
                   (const EntryNumber : cardinal;
                    var EntryValue  : array of char); overload; virtual;

        //*
        // GetEntryNumber - Get the value of the N'th record in the list.
        //

        procedure GetEntryNumber
                   (const EntryNumber : cardinal;
                    var EntryValue  : string); overload; virtual;

        //*
        // STRGetEntryNumber - See documentation of GetEntryNumber.
        //

        procedure GetEntryNumberWithData
                   (const EntryNumber : cardinal;
                    var EntryValue  : array of char;
                    var DataValue   : array of char); overload; virtual;

        //*
        // GetEntryNumberWithData - Get the value of the N'th record in the list.
        //

        procedure GetEntryNumberWithData
                   (const EntryNumber : cardinal;
                    var EntryValue  : string;
                    var DataValue   : string); overload; virtual;

        //*
        // STRGetEntryNumberWithData - See documentation of GetEntryNumberWithData.
        //

        procedure GetEntryPosition
                   (var EntryPos : cardinal); virtual;

        //*
        // GetEntryPosition - Get the position of the current entry (last read).
        //

        function EntryExists
                   (const EntryValue : string) : boolean; virtual;

        //*
        // EntryExists - Check if an entry with this value exists.
        //

        function EntryNumberExists
                   (const EntryNumber : cardinal) : boolean; virtual;

        //*
        // EntryNumberExists - Check if contains at least this many entries.
        //

        procedure AddEntry
                   (const EntryValue : string); virtual;

        //*
        // AddEntry - Add a new entry to the list.
        //

        procedure AddEntryWithData
                   (const EntryValue : string;
                    const DataValue  : string); overload; virtual;

        //*
        // AddEntryWithData - Add a new entry to the list.
        //

        procedure DeleteEntry
                   (const EntryValue : string); virtual;

        //*
        // DeleteEntry - Remove the entry with this value from the list.
        //

        procedure DeleteEntryNumber
                   (const EntryNumber : cardinal); virtual;

        //*
        // DeleteEntryNumber - Remove the requested N'th entry from the list.
        //

        function TotalEntries : cardinal; virtual;

        //*
        // TotalEntries - Return the count of entries in the list.
        //

        function GetHandleState : ModSys.HandleState; virtual;

        //*
        // Return the current state value of this handle.
        //
    end;