TListView/pl

│ English (en) │ français (fr) │ polski (pl) │ русский (ru) │

TListView jest wizualnym komponentem na zakładce Common Controls Palety Komponentów, który zapewnia widok listy powiązanych z nim elementów. Elementy mogą być reprezentowane przez jeden z zestawów ikon powiązanych z TImageList: SmallImages, LargeImages i StateImages.

Uwagi

• GetNextItem() wymaga podania StartItem. Jest to niezgodne z GetNextItem() Delphi, gdzie parametr StartItem może mieć wartość nil, co spowoduje wykonanie wyszukiwania od względnego (sterowanego kierunkiem) startu.

Sorting

TODO: dodać opis, w jaki sposób OwnerData wpływa na sortowanie

Sortowanie jest (zazwyczaj) stosowane podczas korzystania z vsReport ViewStyle, ponieważ jest oparte na kolumnach (z wymaganym indeksem Sortcolumn). Sortowanie może być czasochłonne w przypadku większej ilości danych (gdy porównywanie elementów zajmuje dużo czasu).

SortType jest kluczową właściwością w celu wykonania dowolnego sortowania w TListView.

stNone - (wartość domyślna) informująca, że dla danej kontrolki sortowanie nie powinno być wykonywane.

stText - tekst komórek powinien być używany do porównania elementów. Istniejący tekst jest kontrolowany przez właściwość SortColumn. Zauważ, że domyślne porównanie sortowania w rzeczywistości traktuje tekst jako Ansi, a nie UTF8. W związku z tym wynik może być niepożądany w przypadku tekstów nieanglojęzycznych

stData - porównanie właściwości Data domyślne traktowane są jako wartości całkowite (przez rzutowanie wskaźnika na liczbę całkowitą) i sortowane według wartości. (w większości przypadków takie sortowanie jest bezużyteczne, chyba że „Dane” to rzeczywista liczba całkowita rzutowana na wskaźnik)

stBoth - domyślnie traktowane jest jak stText podczas sortowania.

Jeśli nie używasz sortowania tekstu, domyślna metoda porównania nie jest najlepszym podejściem, zamiast tego można użyć porównania niestandardowego. Porównanie niestandardowe jest przypisywane do zdarzenia OnCompare TListView, do którego przekazywane są następujące parametry:

Sender - TListview, który ma być sortowany

Item1 - pierwszy element TListItem użyty do porównania

Item2 - drugi element TListItem użyty do porównania z pierwszym

Data - nie jest używany i jest zawsze podawany jako zero. (zastosowany dla zgodności z Delphi)

Compare - wynik porównania, który musi być ustalony przez zdarzenie. Do argumentu Compare należy przypisać następujące wartości:

-1 - jeśli pozycja Item1 powinna pojawić się „wcześniej”, tj. w kolejności rosnącej, niż Item2. (Item1 jest mniejsza niż Item2)

0 - jeśli dwa elementy Item są równe

1 - jeśli pozycja Item2 powinna pojawić się „wcześniej”, tj. w kolejności rosnącej, niż Item1. (Item2 jest mniejsza niż Item1)

Normalną praktyką jest odwracanie wartości wyniku porównania, jeśli SortDirection jest malejący. tj.:

procedure TForm1.ListView1OnCompare(Sender: TObject; Item1, Item2: TListItem;
  Data: Integer; var Compare: Integer)
begin
  ... zrób porównanie ...

  if TListView(Sender).SortDirection = sdDescending then
    Compare := -Compare;
end;

Zdarzenie OnCompare powinno sprawdzać właściwości TListView SortType, SortColumn i SortDirection oraz odpowiednio dostosowywać wynik porównania tych właściwości.

Method Sort performs of items, if SortType is other than stNone and SortColumn is assigned to a valid column index.

Method CustomSort performs a one-time sorting using a provided sorting function.

ASortProc: TLVCompare - sorting function

AOptionalParam: PtrInt - sorting parameter

Sorting parameter is ignored (provided for the Delphi compatibility). If ASortProc is passed as nil, then the either sorting OnCompare is used or default sorting.

Typically the sorting can be requested by a user. Whenever a user clicks on a column header, that requires to either sort (initially ascendancy) or to switch to the opposite sorting order (either from ascendant to descendant, or back). It's not a rule, but a common expectation. For some data sets selecting sorting might not make any sense. AutoSort (default value is true)the property of TListview controls, if the listview should be sorted automatically, as soon as user clicks on a column header. AutoSort will have no effect, while SortType is set to stNone.

AlphaSort is a convenience method, that changes the settings to ascending sort (SortDirection=sdAscending) based on the text (SortType=stText) of the first column (SortColumn=0). Note that the actual properties are changed.

Sort Indicator

Originating from: https://bugs.freepascal.org/view.php?id=36281

In trunk since r62567

1) Add a new property SortIndicator to TListViewColumn. The property controls system native sort indicator.

The indicator is acting solely as a decorative feature. (Doesn't have any effect on the sorting). The indicator has 3 possible values

siNone - no sort indicator should be shown

siAscending - ascending indicator should be shown

siDescending - descending indicator should be shown

The property can work independently of other TListview sorting properties.

2) Add new property AutoSortIndicator to TListView. The property is intended to be used as a compliment to AutoSort property. If both are enabled, LCL code controls the current selection of the column sortindicator according to AutoSort rules.

Early 2021 it was noticed that if you are using Qt5 and you have TListView.SortDirection set to sdAscending (the default), then setting a column's Sort Indicator to siDescending displays an ascending indicator. This does not happen with GTK2 or GTK3. Setting SortDirection to sdDescending makes all other combinations work fine so, seems an easy solution. Logged https://bugs.freepascal.org/view.php?id=38393

Widgetset Implementation

ListView is implemented via TWSCustomListViewClassinterface.

Method	Description
SelectAll	The method provides a parameter AIsSet. If the parameter is set to true then all items should selected in the view. If it's false then, all parameters should deselected. It's important that the event shouldn't trigger any events, as LCL will call SelectChange event by itself.

See also

• Doc. TListView
• TTreeView
• TShellListView