RiverSoftAVG Products Help

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Send Mail Feedback
Save Permalink URL

Navigation: Code Documentation > RSCommon > Structures > Classes

TGStringList Class

The TGStringList class is a complete reimplementation of the TStringList, building in the efficiencies of Structures.TSFCList as well as adding conveniences of its own. It adds the memory management of the TSFCFreeList, e.g., it can free the associated objects automatically if you want to. It allows sorting and searching case sensitive or non-case sensitive, using Windows locale information or not. The TStringList class uses a case insensitive Locale based search and sort, while this is the most general case, it is also the slowest. Finally, it also adds a private Data field so that you may leave the Objects field empty for use by the user and store your own private data in the Data property. The Data property is not part of the TStrings base class. As such, it is perfect for associating your data with the strings without worrying about the user inadvertently stomping on it. Of course, the TGStringList may also be set to manage the memory in the Data property as well.

Namespace: Structures

	Name	Description
	Assigning	Represents property Assigning.
	Data[Integer]	Represents a set of objects that are associated one with each of the strings in the Strings property. However, unlike the Objects property, this property is not available from the TStrings abstract base class, this makes it perfect for storing your own associated data without worrying about the user inadvertently stomping on it. Use the Data property to get or set the data associated with the string at the position indicated by Index. Index gives the position of the string associated with the object, where 0 is the first string, 1 is the second string, and so on.
	Duplicates	Specifies whether duplicate strings can be added to sorted lists. Set Duplicates to specify what should happen when an attempt is made to add a duplicate string to a sorted list. Set Duplicates before adding any strings to the list. Setting Duplicates to dupIgnore or dupError does nothing about duplicate strings that are already in the list. The value of Duplicates should be one of the following:
dupIgnore	Ignore attempts to add duplicate strings to the sorted list.
dupError	Raise an EStringListError exception when an attempt is made to add duplicate strings to the sorted list.
dupAccept	Permit duplicate strings in the sorted list.

public property

FreeData

Controls whether the string list frees the objects inside the Data property when an item is deleted (or the list is cleared).

public property

FreeObjects

Controls whether the string list frees the objects inside the Objects property when an item is deleted (or the list is cleared).

public property

OnChange

Occurs when the string list changes

public property

OnChanging

Occurs when the string list is about to change

public property

Owner

Specifies the Owner of this object. Whenever the list changes, the list will notify the Owner through this interface.

public property

Sorted

Specifies whether the strings in the list should be automatically sorted. Set Sorted to True to cause the strings in the list to be automatically sorted in ascending order. Set Sorted to False to allow strings to remain where they are inserted. When Sorted is False, the strings in the list can be put in ascending order at any time by calling the Sort method.

When Sorted is True, do not use Insert to add strings to the list. Instead, use Add, which will insert the new strings in the appropriate position. When Sorted is False, use Insert to add strings to an arbitrary position in the list, or Add to add strings to the end of the list.

By default, the list is not sorted.

Note
When Sorted is True, the string list sorts according to the StringOpsType property.

public property

StringOpsType

Controls how the string list is sorted when the Sort method is called or the Sorted property is set to True.

By default, the StringOpsType is soCaseInsensitiveLocale.

Top

Name

Description

public method

Add(string)

Represents method Add(string).

public method

AddObject(string,TObject,TObject)

Overloaded. Adds a string to the list, and associates an object and a hidden object with the string.

Call AddObject to add a string and its associated object and hidden object item to the list. AddObject returns the index of the new string, object, and item.

Note
If FreeObjects is false, the stringlist object does not own the objects you add this way. Objects added to the TGStringList object still exist even if the TStrings instance is destroyed. They must be explicitly destroyed by the application. Similarly, the FreeData property controls if the Data hidden object is freed.

public method

AddStrings(TStrings)

Overloaded. Represents method AddStrings(TStrings).

public method

Assign(TPersistent)

Represents method Assign(TPersistent).

protected method

Changed

Represents method Changed.

protected method

Changing

Represents method Changing.

public method

Clear

Represents method Clear.

public method

Delete(Integer)

Represents method Delete(Integer).

public method

Exchange(Integer,Integer)

Represents method Exchange(Integer,Integer).

public method

Find(string,Integer)

Locates the index for a string in a sorted list and indicates whether a string with that value already exists in the list. Use Find to obtain the index in a sorted list where the string S should be added. If the string S already exists in the list, Find returns True. If the list does not contain S, Find returns False. The index where S should go is returned in the Index parameter. The value of Index is zero-based, where the first string has the index 0, the second string has the index 1, and so on.

Note
Only use Find with sorted lists. For unsorted lists, use the IndexOf method instead.

Tip
If the S string is not found (thus return value of Find is False) then Index is set to the index of the first string in the list that sorts immediately before or after S.

public method

ForEach(TForEachObjectMethod,TForEachFilterMethod,LongInt)

Overloaded. The ForEach method will iterate over the string list calling the Proc function for every item that passes the FilterFunction (or all items if the FilterFunction is unassigned). The ForEach method allows class methods to be passed instead of regular functions and procedures.

Note
The order that the items are processed is not guaranteed, just that every item will be evaluated. In fact, this method goes through the items in reverse order so that the Proc method could delete items without affecting items not yet visited. This may change.

public method

ForEach(TForEachObjectProc,TForEachFilterProc,LongInt)

Note
The order that the items are processed is not guaranteed, just that every item will be evaluated. In fact, this method goes through the items in reverse order so that the Proc method could delete items without affecting items not yet visited. This may change.

protected method

Get(Integer)

Represents method Get(Integer).

protected method

GetCapacity

Represents method GetCapacity.

protected method

GetCount

Represents method GetCount.

protected method

GetData(Integer)

Represents method GetData(Integer).

protected method

GetObject(Integer)

Represents method GetObject(Integer).

public method

IndexOf(string)

Represents method IndexOf(string).

public method

IndexOfData(TObject)

Returns the index of the first string in the list associated with a given object contained in the Data property. Call IndexOfData to locate the first string in the list associated with the object AObject. Specify the object you want to locate as the value of the AObject parameter. IndexOfData returns the 0-based index of the string and object. If the object is not associated with any of the strings, IndexOfData returns -1.

public method

Insert(Integer,string)

Represents method Insert(Integer,string).

public method

InsertObject(Integer,string,TObject,TObject)

Overloaded. Insert the string and its associated object and data at the specified index in the list.

protected method

Put(Integer,string)

Represents method Put(Integer,string).

protected method

PutData(Integer,TObject)

Represents method PutData(Integer,TObject).

protected method

PutObject(Integer,TObject)

Represents method PutObject(Integer,TObject).

protected method

SetCapacity(Integer)

Represents method SetCapacity(Integer).

protected method

SetUpdateState(Boolean)

Represents method SetUpdateState(Boolean).

public method

Sort

Sorts the strings in the list in ascending order. Call Sort to sort the strings in a list that has the Sorted property set to False. String lists with the Sorted property set to True are automatically sorted.

Note
When Sorted is True, the string list sorts according to the StringOpsType property.

Top

RiverSoftAVG Products Help

Reference