Docs: LCL/comctrls. Updates content in TViewStyle and TCustomListView topics.

* TViewStyle.vsIcon
* TViewStyle.vsSmallIcon
* TViewStyle.vsList
* TViewStyle.vsReport
* TCustomListView.LargeImages
* TCustomListView.LargeImagesWidth
* TCustomListView.SmallImages
This commit is contained in:
dsiders 2023-09-27 00:15:38 +01:00
parent 46e1c54d09
commit 5ba319d7f8

View File

@ -11885,28 +11885,33 @@ used for the <var>ViewStyle</var> property in <var>TCustomListView</var>.
<element name="TViewStyle.vsIcon"> <element name="TViewStyle.vsIcon">
<short> <short>
Displays a large icon and the caption for each list view item. The icon is Displays a large icon and the caption for each list view item. The icon is
centered above the caption text. centered above the caption text. List items are displayed from left to right,
and wrap to a new row when space is not available at the right edge of the
control.
</short> </short>
</element> </element>
<element name="TViewStyle.vsSmallIcon"> <element name="TViewStyle.vsSmallIcon">
<short> <short>
Displays a small icon and caption text for each list view item. Caption text Displays a small icon and caption text for each list view item. Caption text is
on the right-hand side of the icon. aligned to the right-hand side of the icon. List items are displayed from left
to right, and wrap to a new row when space is not available at the right edge
of the control.
</short> </short>
</element> </element>
<element name="TViewStyle.vsList"> <element name="TViewStyle.vsList">
<short> <short>
Displays a small icon with caption text to its right-hand side. The list Displays a small icon with caption text to its right-hand side. The list items
items are arranged in columns. are arranged in columns filled from top to bottom, and then left to right.
</short> </short>
</element> </element>
<element name="TViewStyle.vsReport"> <element name="TViewStyle.vsReport">
<short> <short>
Displays each list item as a series of columns with a small icon on the Displays each list item as a series of columns with a small icon on the
left-hand side of the row. The Caption text for the list item is displayed in left-hand side of the row. The Caption text for the list item is displayed in
the first column, with the text for additional columns coming from the Caption the first column, with the text for subsequent columns coming from the Caption
for the SubItems in the list item. Each column has a header at the top of the property in the SubItems in the list item. Each column has a header at the top
list view control. of the list view control. List items are displayed from top to bottom on the
control.
</short> </short>
</element> </element>
@ -15610,30 +15615,42 @@ class to be updated when its Handle has been allocated.
<element name="TCustomListView.LargeImages"> <element name="TCustomListView.LargeImages">
<short> <short>
ImageList object, which contains "big" icons for one if ListView layouts. Image list which contains "big" icons displayed for view styles on the control.
</short> </short>
<descr> <descr>
<p> <p>
A typical application might have two ImageLists: one of A typical application might have two ImageLists: one of <var>LargeImages</var>
<var>LargeImages</var> and one of <var>SmallImages</var> containing two and one of <var>SmallImages</var> containing two versions of the same
versions of the same collection of images, in large and small format; the collection of images, in large and small format. The index numbers for images
index positions in the first image list should correspond to those in the in the first list would correspond to the same image with another size in the
second image list. second list. LargeImages are used when the view style is set to vsIcon.
</p> </p>
<p> <p>
SmallImages could be displayed beside the text strings in the list view and The <var>TImageList</var> instance can be created and populated at design-time
the programmer would supply code to ensure that when an item with its using the editor available on the content menu in the form designer. It can
associated SmallImage was selected, the corresponding LargeImage would be also be created, populated, and assigned at run-time if needed.
displayed in another window.
</p> </p>
<p> <p>
A <var>TImageList</var> control needs to be selected and pasted on to the Use the LargeImagesWidth property to specify the width for the images in the
Form Designer and the ImageList Editor can be opened from the pop-up menu list.
obtained by right-clicking on <var>TImageList</var> icon in the Form </p>
Designer. Then in the StringList editor for <var>Items</var> the correct <p>
<var>ImageIndex</var> must be allocated to each entry in the list. Use the Items property to access and maintain the ImageIndex used for each of
the list items.
</p>
<p>
Use ViewStyle to control the layout and content for the list items on the
control.
</p> </p>
</descr> </descr>
<seealso>
<link id="TCustomListView.LargeImagesWidth"/>
<link id="TCustomListView.SmallImages"/>
<link id="TCustomListView.Items"/>
<link id="TCustomListView.ViewStyle"/>
<link id="TListItem.ImageIndex"/>
<link id="TViewStyle"/>
</seealso>
</element> </element>
<element name="TCustomListView.LargeImagesWidth"> <element name="TCustomListView.LargeImagesWidth">
@ -15720,8 +15737,8 @@ when its Handle has been assigned.
<p> <p>
<var>ShowColumnHeaders</var> is a <var>Boolean</var> property which indicates <var>ShowColumnHeaders</var> is a <var>Boolean</var> property which indicates
whether column headers are displayed for the Report view style (ViewStyle = whether column headers are displayed for the Report view style (ViewStyle =
vsReport). When enabled, the captions for the list <var>Items</var> are vsReport). When enabled, the captions for the Columns defined for the control
displayed as column headers. The default value for the property is are displayed as column headers. The default value for the property is
<b>True</b>. <b>True</b>.
</p> </p>
<p> <p>
@ -15733,10 +15750,10 @@ causes the widgetset class to be updated with the new value.
</p> </p>
</descr> </descr>
<seealso> <seealso>
<link id="TCustomListView.Items"/> <link id="TCustomListView.Columns"/>
<link id="TListItem.Caption"/>
<link id="TListViewProperties"/> <link id="TListViewProperties"/>
<link id="TListViewProperty"/> <link id="TListViewProperty"/>
<link id="TListColumn.Caption"/>
</seealso> </seealso>
</element> </element>
@ -15768,31 +15785,44 @@ Work areas are not implemented (for any platform) in the current LCL version.
<element name="TCustomListView.SmallImages"> <element name="TCustomListView.SmallImages">
<short> <short>
ImageList object, which contains "small" icons for one if ListView layouts. Image list which contains "small" icons used for view styles.
</short> </short>
<descr> <descr>
<p> <p>
A typical application might have two ImageLists: one of A typical application might have two ImageLists: one of
<var>LargeImages</var> and one of <var>SmallImages</var> containing two <var>LargeImages</var> and one of <var>SmallImages</var> containing two
versions of the same collection of images, in large and small format; the versions of the same collection of images, in large and small format. The
index numbers of the first list would correspond with those in the second index numbers for images in the first list would correspond to the same image
with another size in the second list. SmallImages are displayed beside the text
strings in the list view, and are used for the vsSmallIcon, vsList, and
vsReport view styles.
</p>
<p>
The <var>TImageList</var> instance can be created and populated at design-time
using the editor available on the content menu in the form designer. It can
also be created, populated, and assigned at run-time if needed.
</p>
<p>
Use the SmallImagesWidth property to specify the width for the images in the
list. list.
</p> </p>
<p> <p>
SmallImages could be displayed beside the text strings in the list view and Use the Items property to access and maintain the ImageIndex used for each of
the programmer would supply code to ensure that when an item with its the list items.
associated SmallImage was selected, the corresponding LargeImage would be
displayed in another window.
</p> </p>
<p> <p>
A <var>TImageList</var> control needs to be selected and pasted on to the Use ViewStyle to control the layout and content for the list items on the
Form Designer and the ImageList Editor can be opened from the pop-up menu control.
obtained by right-clicking on <var>TImageList</var> icon in the Form
Designer. Then in the StringList editor for <var>Items</var> the correct
<var>ImageIndex</var> must be allocated to each entry in the list.
</p> </p>
</descr> </descr>
<seealso/> <seealso>
<link id="TCustomListView.SmallImagesWidth"/>
<link id="TCustomListView.LargeImages"/>
<link id="TCustomListView.Items"/>
<link id="TCustomListView.ViewStyle"/>
<link id="TListItem.ImageIndex"/>
<link id="TViewStyle"/>
</seealso>
</element> </element>
<element name="TCustomListView.SmallImagesWidth"> <element name="TCustomListView.SmallImagesWidth">
@ -24269,7 +24299,9 @@ the display name for the collection item.
</seealso> </seealso>
</element> </element>
<element name="TCoolBand.GetDisplayName.Result"> <element name="TCoolBand.GetDisplayName.Result">
<short/> <short>
Display name for the Cool Band collection item.
</short>
</element> </element>
<element name="TCoolBand.Create"> <element name="TCoolBand.Create">
@ -39510,7 +39542,7 @@ The text displayed on the header section.
<descr> <descr>
<p> <p>
<var>Text</var> is a <var>TCaption</var> property which contains the textual <var>Text</var> is a <var>TCaption</var> property which contains the textual
value displayed on the header section. Along with the image specified in value displayed on the header section. Along with the image specified in
ImageIndex, it determines the content drawn for the section in the PaintSection ImageIndex, it determines the content drawn for the section in the PaintSection
method of the THeaderControl. method of the THeaderControl.
</p> </p>