Engine.UIComp_ListElementSorter

Extends

UIComp_ListComponentBase

Modifiers

native ( inherit ) editinlinenew

Handles information about a collection of list elements are sorted. Responsible for invoking the UISortableItem on each element to allow the element to perform the comparison. Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.

Core.Object
|   
+-- Core.Component
   |   
   +-- Engine.UIComponent
      |   
      +-- Engine.UIComp_ListComponentBase
         |   
         +-- Engine.UIComp_ListElementSorter

Functions Summary
		ResetSortColumns (optional bool bResort=true)
	bool	ResortItems (optional bool bCaseSensitive)
	bool	SortItems (int ColumnIndex, optional bool bSecondarySort, optional bool bCaseSensitive)

UIComp_ListElementSorter

bAllowCompoundSorting Source code

Indicates whether sorting by multiple columns is allowed in this list

bReversePrimarySorting Source code

indicates that the primary sort column should be sorted in reverse order

bReverseSecondarySorting Source code

indicates that the secondary sort column should be sorted in reverse order

InitialSecondarySortColumn Source code

the index of the column (or row) to use for performing the initial secondary sorting of the list's elements when SecondarySortColumn is INDEX_NONE

InitialSortColumn Source code

the index of the column (or row) to use for sorting the list's elements when SortColumn is INDEX_NONE

PrimarySortColumn Source code

the index of the column (or row) being used for sorting the list's items

SecondarySortColumn Source code

the index of the column (or row) of the previous SortColumn

UIListSortingParameters Source code

Contains parameters for a list sorting operation.
bCaseSensitive:

indicates that sorting should be case sensitive

bFloatSortPrimary:

indicates that the strings should be converted into floats for sorting purposes

bIntSortPrimary:

indicates that the strings should be converted into integers for sorting purposes

bReversePrimarySorting:

indicates that the elements should be sorted in reverse for first-pass

bReverseSecondarySorting:

indicates that the elements should be sorted in reverse for second-pass

PrimaryIndex:

the index of the column/row that should be used for first-pass sorting

SecondaryIndex:

the index of the column/row that should be used when first pass sorting encounters two identical elements

ResetSortColumns Source code

Resets the PrimarySortColumn and SecondarySortColumn to the Initial* values.
@param bResort specify TRUE to re-sort the list's elements after resetting the sort columns.

ResortItems Source code

Sorts the owning list's items without modifying any sorting parameters.
@param bCaseSensitive specify TRUE to perform case-sensitive comparison
@return TRUE if the items were sorted successfully.

SortItems Source code

Sorts the owning list's items using the parameters specified.
@param ColumnIndex the column (when CellLinkType is LINKED_Columns) or row (when CellLinkType is LINKED_Rows) to use for sorting. Specify INDEX_NONE to clear sorting.
@param bSecondarySort specify TRUE to set ColumnIndex as the SecondarySortColumn. If FALSE, resets the value of SecondarySortColumn
@param bCaseSensitive specify TRUE to perform case-sensitive comparison
@return TRUE if the items were sorted successfully.

defaultproperties
{
   bAllowCompoundSorting=True
   InitialSortColumn=-1
   InitialSecondarySortColumn=-1
   PrimarySortColumn=-1
   SecondarySortColumn=-1
   Name="Default__UIComp_ListElementSorter"
   ObjectArchetype=UIComp_ListComponentBase'Engine.Default__UIComp_ListComponentBase'
}