|
// ------------------------------------------------------------------------------
// <auto-generated>
// This code was generated by a tool.
//
// Changes to this file may cause incorrect behavior and will be lost if
// the code is regenerated.
// </auto-generated>
// ------------------------------------------------------------------------------
#pragma warning disable CS1591,CS1573,CS0465,CS0649,CS8019,CS1570,CS1584,CS1658,CS0436,CS8981
using global::System;
using global::System.Diagnostics;
using global::System.Diagnostics.CodeAnalysis;
using global::System.Runtime.CompilerServices;
using global::System.Runtime.InteropServices;
using global::System.Runtime.Versioning;
using winmdroot = global::Windows.Win32;
namespace Windows.Win32
{
namespace UI.Controls
{
/// <summary>Specifies or receives the attributes of a list-view item. This structure has been updated to support a new mask value (LVIF_INDENT) that enables item indenting. This structure supersedes the LV_ITEM structure. (Unicode)</summary>
/// <remarks>
/// <para>The <b>LVITEM</b> structure is used with several messages, including <a href="https://docs.microsoft.com/windows/desktop/Controls/lvm-getitem">LVM_GETITEM</a>, <a href="https://docs.microsoft.com/windows/desktop/Controls/lvm-setitem">LVM_SETITEM</a>, <a href="https://docs.microsoft.com/windows/desktop/Controls/lvm-insertitem">LVM_INSERTITEM</a>, and <a href="https://docs.microsoft.com/windows/desktop/Controls/lvm-deleteitem">LVM_DELETEITEM</a>. In tile view, the item name is displayed to the right of the icon. You can specify additional subitems (corresponding to columns in the details view), to be displayed on lines below the item name. The <b>puColumns</b> array contains the indices of subitems to be displayed. Indices should be greater than 0, because subitem 0, the item name, is already displayed. Column information can also be set in the <a href="https://docs.microsoft.com/windows/desktop/api/commctrl/ns-commctrl-lvtileinfo">LVTILEINFO</a> structure when modifying the list item. For example code, see <a href="https://docs.microsoft.com/windows/desktop/Controls/using-list-view-controls">Using List-View Controls</a>. <div class="alert"><b>Note</b> Comctl32.dll version 6 is not redistributable but it is included in Windows or later. To use Comctl32.dll version 6, specify it in a manifest. For more information on manifests, see <a href="https://docs.microsoft.com/windows/desktop/Controls/cookbook-overview">Enabling Visual Styles</a>.</div> <div> </div></para>
/// <para>> [!NOTE] > The commctrl.h header defines LVITEM as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see [Conventions for Function Prototypes](/windows/win32/intl/conventions-for-function-prototypes).</para>
/// <para><see href="https://learn.microsoft.com/windows/win32/api/commctrl/ns-commctrl-lvitemw#">Read more on docs.microsoft.com</see>.</para>
/// </remarks>
[global::System.CodeDom.Compiler.GeneratedCode("Microsoft.Windows.CsWin32", "0.3.151+58e949951d.RR")]
internal partial struct LVITEMW
{
/// <summary>
/// <para>Type: <b><a href="https://docs.microsoft.com/windows/desktop/WinProg/windows-data-types">UINT</a></b> Set of flags that specify which members of this structure contain data to be set or which members are being requested. This member can have one or more of the following flags set: </para>
/// <para>This doc was truncated.</para>
/// <para><see href="https://learn.microsoft.com/windows/win32/api/commctrl/ns-commctrl-lvitemw#members">Read more on docs.microsoft.com</see>.</para>
/// </summary>
internal winmdroot.UI.Controls.LIST_VIEW_ITEM_FLAGS mask;
/// <summary>
/// <para>Type: <b>int</b> Zero-based index of the item to which this structure refers.</para>
/// <para><see href="https://learn.microsoft.com/windows/win32/api/commctrl/ns-commctrl-lvitemw#members">Read more on docs.microsoft.com</see>.</para>
/// </summary>
internal int iItem;
/// <summary>
/// <para>Type: <b>int</b> One-based index of the subitem to which this structure refers, or zero if this structure refers to an item rather than a subitem.</para>
/// <para><see href="https://learn.microsoft.com/windows/win32/api/commctrl/ns-commctrl-lvitemw#members">Read more on docs.microsoft.com</see>.</para>
/// </summary>
internal int iSubItem;
/// <summary>
/// <para>Type: <b><a href="https://docs.microsoft.com/windows/desktop/WinProg/windows-data-types">UINT</a></b> Indicates the item's state, state image, and overlay image. The <b>stateMask</b> member indicates the valid bits of this member.</para>
/// <para>Bits 0 through 7 of this member contain the item state flags. This can be one or more of the <a href="https://docs.microsoft.com/windows/desktop/Controls/list-view-item-states">item state</a> values.</para>
/// <para>Bits 8 through 11 of this member specify the one-based overlay image index. Both the full-sized icon image list and the small icon image list can have overlay images. The overlay image is superimposed over the item's icon image. If these bits are zero, the item has no overlay image. To isolate these bits, use the <a href="https://docs.microsoft.com/windows/desktop/Controls/list-view-item-states">LVIS_OVERLAYMASK</a> mask. To set the overlay image index in this member, you should use the <a href="https://docs.microsoft.com/windows/desktop/api/commctrl/nf-commctrl-indextooverlaymask">INDEXTOOVERLAYMASK</a> macro. The image list's overlay images are set with the <a href="https://docs.microsoft.com/windows/desktop/api/commctrl/nf-commctrl-imagelist_setoverlayimage">ImageList_SetOverlayImage</a> function.</para>
/// <para>Bits 12 through 15 of this member specify the state image index. The state image is displayed next to an item's icon to indicate an application-defined state. If these bits are zero, the item has no state image. To isolate these bits, use the <a href="https://docs.microsoft.com/windows/desktop/Controls/list-view-item-states">LVIS_STATEIMAGEMASK</a> mask. To set the state image index, use the <a href="https://docs.microsoft.com/windows/desktop/api/commctrl/nf-commctrl-indextostateimagemask">INDEXTOSTATEIMAGEMASK</a> macro. The state image index specifies the index of the image in the state image list that should be drawn. The state image list is specified with the <a href="https://docs.microsoft.com/windows/desktop/Controls/lvm-setimagelist">LVM_SETIMAGELIST</a> message.</para>
/// <para><see href="https://learn.microsoft.com/windows/win32/api/commctrl/ns-commctrl-lvitemw#members">Read more on docs.microsoft.com</see>.</para>
/// </summary>
internal winmdroot.UI.Controls.LIST_VIEW_ITEM_STATE_FLAGS state;
/// <summary>
/// <para>Type: <b><a href="https://docs.microsoft.com/windows/desktop/WinProg/windows-data-types">UINT</a></b> Value specifying which bits of the <b>state</b> member will be retrieved or modified. For example, setting this member to <a href="https://docs.microsoft.com/windows/desktop/Controls/list-view-item-states">LVIS_SELECTED</a> will cause only the item's selection state to be retrieved.</para>
/// <para>This member allows you to modify one or more item states without having to retrieve all of the item states first. For example, setting this member to <b>LVIS_SELECTED</b> and <b>state</b> to zero will cause the item's selection state to be cleared, but none of the other states will be affected.</para>
/// <para>To retrieve or modify all of the states, set this member to (<b>UINT</b>)-1.</para>
/// <para>You can use the macro <a href="https://docs.microsoft.com/windows/desktop/api/commctrl/nf-commctrl-listview_setitemstate">ListView_SetItemState</a> both to set and to clear bits.</para>
/// <para><see href="https://learn.microsoft.com/windows/win32/api/commctrl/ns-commctrl-lvitemw#members">Read more on docs.microsoft.com</see>.</para>
/// </summary>
internal winmdroot.UI.Controls.LIST_VIEW_ITEM_STATE_FLAGS stateMask;
/// <summary>
/// <para>Type: <b><a href="https://docs.microsoft.com/windows/desktop/WinProg/windows-data-types">LPTSTR</a></b> If the structure specifies item attributes, <b>pszText</b> is a pointer to a null-terminated string containing the item text. When responding to an <a href="https://docs.microsoft.com/windows/desktop/Controls/lvn-getdispinfo">LVN_GETDISPINFO</a> notification, be sure that this pointer remains valid until after the next notification has been received.</para>
/// <para>If the structure receives item attributes, <b>pszText</b> is a pointer to a buffer that receives the item text. Note that although the list-view control allows any length string to be stored as item text, only the first 260 <b>TCHAR</b>s are displayed.</para>
/// <para>If the value of <b>pszText</b> is LPSTR_TEXTCALLBACK, the item is a <a href="https://docs.microsoft.com/windows/desktop/Controls/list-view-controls-overview">callback item</a>. If the callback text changes, you must explicitly set <b>pszText</b> to LPSTR_TEXTCALLBACK and notify the list-view control of the change by sending an <a href="https://docs.microsoft.com/windows/desktop/Controls/lvm-setitem">LVM_SETITEM</a> or <a href="https://docs.microsoft.com/windows/desktop/Controls/lvm-setitemtext">LVM_SETITEMTEXT</a> message.</para>
/// <para>Do not set <b>pszText</b> to LPSTR_TEXTCALLBACK if the list-view control has the <a href="https://docs.microsoft.com/windows/desktop/Controls/list-view-window-styles">LVS_SORTASCENDING</a> or <a href="https://docs.microsoft.com/windows/desktop/Controls/list-view-window-styles">LVS_SORTDESCENDING</a> style.</para>
/// <para><see href="https://learn.microsoft.com/windows/win32/api/commctrl/ns-commctrl-lvitemw#members">Read more on docs.microsoft.com</see>.</para>
/// </summary>
internal winmdroot.Foundation.PWSTR pszText;
/// <summary>
/// <para>Type: <b>int</b> Number of <b>TCHAR</b><b>s</b> in the buffer pointed to by <b>pszText</b>, including the terminating <b>NULL</b>.</para>
/// <para>This member is only used when the structure receives item attributes. It is ignored when the structure specifies item attributes. For example, <b>cchTextMax</b> is ignored during <a href="https://docs.microsoft.com/windows/desktop/Controls/lvm-setitem">LVM_SETITEM</a> and <a href="https://docs.microsoft.com/windows/desktop/Controls/lvm-insertitem">LVM_INSERTITEM</a>. It is read-only during <a href="https://docs.microsoft.com/windows/desktop/Controls/lvn-getdispinfo">LVN_GETDISPINFO</a> and other LVN_ notifications.</para>
/// <para><div class="alert"><b>Note</b> Never copy more than <b>cchTextMax</b> <b>TCHAR</b><b>s</b>—where <b>cchTextMax</b> includes the terminating <b>NULL</b>—into <b>pszText</b> during an LVN_ notification, otherwise your program can fail.</div> <div> </div></para>
/// <para><see href="https://learn.microsoft.com/windows/win32/api/commctrl/ns-commctrl-lvitemw#members">Read more on docs.microsoft.com</see>.</para>
/// </summary>
internal int cchTextMax;
/// <summary>
/// <para>Type: <b>int</b> Index of the item's icon in the control's image list. This applies to both the large and small image list. If this member is the I_IMAGECALLBACK value, the parent window is responsible for storing the index. In this case, the list-view control sends the parent an <a href="https://docs.microsoft.com/windows/desktop/Controls/lvn-getdispinfo">LVN_GETDISPINFO</a> notification code to retrieve the index when it needs to display the image.</para>
/// <para><see href="https://learn.microsoft.com/windows/win32/api/commctrl/ns-commctrl-lvitemw#members">Read more on docs.microsoft.com</see>.</para>
/// </summary>
internal int iImage;
/// <summary>
/// <para>Type: <b><a href="https://docs.microsoft.com/windows/desktop/WinProg/windows-data-types">LPARAM</a></b> Value specific to the item. If you use the <a href="https://docs.microsoft.com/windows/desktop/Controls/lvm-sortitems">LVM_SORTITEMS</a> message, the list-view control passes this value to the application-defined comparison function. You can also use the <a href="https://docs.microsoft.com/windows/desktop/Controls/lvm-finditem">LVM_FINDITEM</a> message to search a list-view control for an item with a specified <b>lParam</b> value.</para>
/// <para><see href="https://learn.microsoft.com/windows/win32/api/commctrl/ns-commctrl-lvitemw#members">Read more on docs.microsoft.com</see>.</para>
/// </summary>
internal winmdroot.Foundation.LPARAM lParam;
/// <summary>
/// <para>Type: <b>int</b></para>
/// <para><a href="https://docs.microsoft.com/windows/desktop/Controls/common-control-versions">Version 4.70</a>. Number of image widths to indent the item. A single indentation equals the width of an item image. Therefore, the value 1 indents the item by the width of one image, the value 2 indents by two images, and so on. Note that this field is supported only for items. Attempting to set subitem indentation will cause the calling function to fail.</para>
/// <para><see href="https://learn.microsoft.com/windows/win32/api/commctrl/ns-commctrl-lvitemw#members">Read more on docs.microsoft.com</see>.</para>
/// </summary>
internal int iIndent;
/// <summary>Type: <b>int</b></summary>
internal int iGroupId;
/// <summary>
/// <para>Type: <b><a href="https://docs.microsoft.com/windows/desktop/WinProg/windows-data-types">UINT</a></b></para>
/// <para><a href="https://docs.microsoft.com/windows/desktop/Controls/common-control-versions">Version 6.0 </a> Number of data columns (subitems) to display for this item in tile view. The maximum value is 20. If this value is I_COLUMNSCALLBACK, the size of the column array and the array itself (<b>puColumns</b>) are obtained by sending a <a href="https://docs.microsoft.com/windows/desktop/Controls/lvn-getdispinfo">LVN_GETDISPINFO</a> notification.</para>
/// <para><see href="https://learn.microsoft.com/windows/win32/api/commctrl/ns-commctrl-lvitemw#members">Read more on docs.microsoft.com</see>.</para>
/// </summary>
internal uint cColumns;
/// <summary>
/// <para>Type: <b><a href="https://docs.microsoft.com/windows/desktop/WinProg/windows-data-types">PUINT</a></b></para>
/// <para><a href="https://docs.microsoft.com/windows/desktop/Controls/common-control-versions">Version 6.0 </a> A pointer to an array of column indices, specifying which columns are displayed for this item, and the order of those columns.</para>
/// <para><see href="https://learn.microsoft.com/windows/win32/api/commctrl/ns-commctrl-lvitemw#members">Read more on docs.microsoft.com</see>.</para>
/// </summary>
internal unsafe uint* puColumns;
/// <summary>
/// <para>Type: <b>int*</b> <b>Windows Vista:</b> Not implemented. <b>Windows 7 and later:</b> A pointer to an array of the following flags (alone or in combination), specifying the format of each subitem in extended tile view. </para>
/// <para>This doc was truncated.</para>
/// <para><see href="https://learn.microsoft.com/windows/win32/api/commctrl/ns-commctrl-lvitemw#members">Read more on docs.microsoft.com</see>.</para>
/// </summary>
internal unsafe winmdroot.UI.Controls.LIST_VIEW_ITEM_COLUMN_FORMAT_FLAGS* piColFmt;
/// <summary>
/// <para>Type: <b>int</b></para>
/// <para><a href="https://docs.microsoft.com/windows/desktop/Controls/common-control-versions">Windows Vista</a>: Group index of the item. Valid only for owner data/callback (single item in multiple groups).</para>
/// <para><see href="https://learn.microsoft.com/windows/win32/api/commctrl/ns-commctrl-lvitemw#members">Read more on docs.microsoft.com</see>.</para>
/// </summary>
internal int iGroup;
}
}
}
|