paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-08-17 20:39:14 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: LCL/shellctrls. Fixes grammar in topics and tagging for True, False values.

Browse Source
This commit is contained in:
dsiders 2022-07-27 20:05:07 +01:00
parent bcf97404fa
commit 835c32c6a1
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/xml/lcl/shellctrls.xml
View File

@ -456,13 +456,13 @@
<short>Draws the Shell Icon for the specified tree node.</short>
<descr>
<p>
<var>DrawBuiltInIcon</var> is an overridden <var>TSize</var> function used draw an icon in the tree using the Shell icon for the file or folder name in <var>ANode</var>. It re-implements the method in the <var>TCustomTreeView</var> ancestor, and does <b>not</b> call the inherited method.
<var>DrawBuiltInIcon</var> is an overridden <var>TSize</var> function used to draw an icon on the tree using the Shell icon for the file or folder name in <var>ANode</var>. It re-implements the method in the <var>TCustomTreeView</var> ancestor, and does <b>not</b> call the inherited method.
</p>
<p>
When <var>UseBuiltinIcons</var> is <b>True</b>, the internal <var>GetShellIcon</var> routine is called to get the icon used for the file. The icon is drawn on the control <var>Canvas</var> using the rectangle in <var>ARect</var>. The icon is centered vertically in the specified rectangle.
When <var>UseBuiltinIcons</var> is <b>True</b>, the internal <var>GetShellIcon</var> routine is called to get the icon used for the entry. The icon is drawn on the control <var>Canvas</var> using the rectangle in <var>ARect</var>. The icon is centered vertically in the specified rectangle.
</p>
<p>
The return value contains the dimensions for the icon as a <var>TSize</var> instance. When UseBuiltinIcons is <b>False</b>, the return value always contains a TSize instance with both the <var>Width</var> (<var>CX</var>) and <var>Height</var> (<var>CY</var>) are set to <b>0</b> (<b>zero</b>). The size may also be empty (0, 0) if an icon was not found or returned for the file system entry by the widgetset class instance. This can occur when the file represented by ANode has been removed from the file system.
The return value contains the dimensions for the icon as a <var>TSize</var> instance. When UseBuiltinIcons is <b>False</b>, the return value always contains a TSize instance with both the <var>Width</var> (<var>CX</var>) and <var>Height</var> (<var>CY</var>) set to <b>0</b> (<b>zero</b>). The size may also be empty (0, 0) if an icon was not found or returned for the file system entry by the widgetset class instance. This can occur when the entry represented by ANode has been removed from the file system.
</p>
<remark>
DrawBuiltInIcon is defined for the Windows platform only; it requires use of the <var>SHGetFileInfoW</var> routine in the FPC <file>ShellApi.pp</file> unit.
@ -497,7 +497,7 @@
When <var>UseBuiltinIcons</var> is <b>True</b>, the internal member used for the icon size is checked. It is used when explicit values have been set for the Width and Height in the TSize instance. If the default values (0) are in Width and Height, the internal GetShellIcon routine is called to get the icon size used for Drive letter designations. It is assigned as the return value for the method, and stored in the internal member.
</p>
<p>
When UseBuiltinIcons is <b>False</b>, the return value always contains a TSize instance with both the <var>Width</var> (<var>CX</var>) and <var>Height</var> (<var>CY</var>) are set to <b>0</b> (<b>zero</b>).
When UseBuiltinIcons is <b>False</b>, the return value always contains a TSize instance with both the <var>Width</var> (<var>CX</var>) and <var>Height</var> (<var>CY</var>) set to <b>0</b> (<b>zero</b>). The size may also be empty (0, 0) if an icon was not found or returned for the file system entry by the widgetset class instance. This can occur when the entry represented by ANode has been removed from the file system.
</p>
<remark>
GetBuiltinIconSize is defined for the Windows platform only; it requires use of the <var>SHGetFileInfoW</var> routine in the FPC <file>ShellApi.pp</file> unit.
@ -522,7 +522,7 @@
NodeHasChildren signals the OnHasChildren event handler (when assigned) to get the return value for the method. The shell tree view class instance and the value in Node are passed as arguments to the event handler.
</p>
<p>
When an event handler has not been assigned, the return value is set to <b>True</b> when the specified Node is a Directory on the local file system.
When an event handler has not been assigned, the return value is set to <b>True</b> if the specified Node is a Directory on the local file system.
</p>
<p>
The return value is also <b>True</b> when the path to the node can be accessed as a sub-directory in Node (when ObjectTypes does not include otNonFolders objects). Include otHidden in ObjectTypes to include hidden directories in the comparison.
@ -624,7 +624,7 @@
GetPathFromNode casts the tree node in ANode to a TShellTreeNode type to access the file system-specific properties and methods for the node.
</p>
<p>
When IsDirectory returns True, the return value contains the path to the folder with a trailing path delimiter. Otherwise, the return value has the fully-qualified path for the file.
When IsDirectory returns <b>True</b>, the return value contains the path to the folder with a trailing path delimiter. Otherwise, the return value has the fully-qualified path for the file.
</p>
<p>
An absolute path in the return value includes the root directory prepended to the value.
@ -860,7 +860,7 @@
<var>OnAddItem</var> is a <var>TAddItemEvent</var> property which contains the event handler signalled when an item (tree node) is added to the shell control. OnAddItem is signalled from the <var>PopulateTreeNodeWithFiles</var> method, and allows the base path and file information for each file to be checked before it is added to the Items for the tree view control.
</p>
<p>
An application must implement and assign an object procedure using the signature in TAddItemEvent to the handler. The Sender argument is the tree view control for the event notification. ABasePath contains the value from BasePath in the tree view control. AFileInfo is a TSearchRec instance with the attributes for the file system object represented in the node. CanAdd is a variable parameter which indicates whether the file system object should be added to the Items property. Set CanAdd to False in the event handler to omit the file system object in Items.
An application must implement and assign an object procedure using the signature in TAddItemEvent to the handler. The Sender argument is the tree view control for the event notification. ABasePath contains the value from BasePath in the tree view control. AFileInfo is a TSearchRec instance with the attributes for the file system object represented in the node. CanAdd is a variable parameter which indicates whether the file system object should be added to the Items property. Set CanAdd to <b>False</b> in the event handler to omit the file system object in Items.
</p>
</descr>
<seealso>
@ -914,10 +914,10 @@
</short>
<descr>
<p>
ParentColor determines if the control should use the Color from the Parent control, when enabled. The default value for the property is False in TShellTreeView.
ParentColor determines if the control should use the Color from the Parent control, when enabled. The default value for the property is <b>False</b> in TShellTreeView.
</p>
<p>
When this property is True, all changes to the Color of the parent will also be applied to the Color of the control, ensuring that they both contain same value. If the Color of the control is changed by the application, then ParentColor will be automatically set to False.
When this property is <b>True</b>, all changes to the Color of the parent will also be applied to the Color of the control, ensuring that they both contain same value. If the Color of the control is changed by the application, then ParentColor will be automatically set to <b>False</b>.
</p>
</descr>
<seealso>
@ -1311,7 +1311,7 @@
</element>
<element name="TCustomShellListView.DoAddItem.CanAdd">
<short>
Set the argument to <b>True</b> to allow the item to be added; set to False to prevent adding the item.
Set the argument to <b>True</b> to allow the item to be added; set to <b>False</b> to prevent adding the item.
</short>
</element>
@ -1676,10 +1676,10 @@
<short>Uses the Color from the Parent control, when enabled.</short>
<descr>
<p>
ParentColor determines if the control should use the Color from the Parent control, when enabled. The default value for the property is False in TShellListView.
ParentColor determines if the control should use the Color from the Parent control, when enabled. The default value for the property is <b>False</b> in TShellListView.
</p>
<p>
When this property is True, all changes to the Color of the parent will also be applied to the Color of the control, ensuring that they both contain same value. If the Color of the control is changed by the application, then ParentColor will be automatically set to False.
When this property is <b>True</b>, all changes to the Color of the parent will also be applied to the Color of the control, ensuring that they both contain same value. If the Color of the control is changed by the application, then ParentColor will be automatically set to <b>False</b>.
</p>
<p>
Using ParentColor when the Color value is clDefault can cause problems in resolving the actual color value. To obtain the Color property of a control while taking into account clDefault and ParentColor, use the GetColorResolvingParent method. This method might return a non-RGB color, but will never return clDefault. To obtain a purely RGB result use the GetRGBColorResolvingParent method.