TExtStartStopList class
PlusMemo Help Send comments on this topic.
TExtStartStopList class

Glossary Item Box

 

Unit

ExtHilit

 

Declaration (partial)

type

  TssOption = (ssoParStop, ssoDelStop, ssoCollapsible);

  TssOptions = set of TssOption;

 

  TExtStartStopList = class(TStartStopKeyList)

    public

      functionAddExStartStopKey(const StartKey, StopKey: string;

                                 Options         : TWordOptions;

                                 Style           : TFontStyles;

                                 ContextNumber,

                                 Scope, Priority : SmallInt;

                                 Cursor          : TCursor;

                                 Backgnd, Foregnd: TColor;

                                 ssOptions       : TssOptions): Integer;

 

      property Scope[i: Integer]: Integer;

      property Priority[i: Integer]: Integer;

    end;

 

Description

TExtStartStopList is a class to hold the start-stop key definitions of a TExtHighlighter.  It possesses all the functionality of its ancestor TStartStopKeyList, plus the ability to maintain scope, priority and termination attributes for each start-stop key.  It can also work with ini files to load or save its definitions.

 

Method AddExStartStopKey acts similarly to AddStartStopKey of TStartStopKeyList, with the addition of three parameters, Scope, Priority and ssOptions that controls the complex scoped highlighting algorithm of TExtHighlighter.  Also, array properties Scope and Priority can be read or written to control these parameters for an already defined start-stop key.  Finally former paramter ParStop is replaced by ssOptions which determines more extensive section termination conditions and whether the related section will be collapsible.

 

Note

Types TssOption and TssOptions are defined in unit PMSupport, not in ExtHilit as implied above.  You may need to add PMSupport to the uses clause of your unit to access those types.