paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-06-01 16:52:33 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: LCL, LazControls. Clarifies wording in Invalidate-related topics.

Browse Source
This commit is contained in:
dsiders 2022-07-17 03:03:47 +01:00
parent 54c3d26553
commit 7ea1d8851c
7 changed files with 48 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
components/lazcontrols/docs/checkboxthemed.xml
View File

@ -296,7 +296,7 @@
</short>
<descr>
<p>
<var>DoEnter</var> is an overridden method in <var>TCustomCheckBoxThemed</var>. It calls the inherited method on entry to signal the <var>OnEnter</var> event handler (when assigned). It calls <var>Invalidate</var> to force the control to be redrawn.
<var>DoEnter</var> is an overridden method in <var>TCustomCheckBoxThemed</var>. It calls the inherited method on entry to signal the <var>OnEnter</var> event handler (when assigned). It calls <var>Invalidate</var> to cause the control to be redrawn.
</p>
</descr>
<seealso>

4
docs/xml/lcl/comboex.xml
View File

@ -908,7 +908,9 @@
<element name="TComboExItems.Update">
<short>Updates the collection when the specified item has been changed.</short>
<descr>
Forces the owner of the collection (the control) to be redrawn when needed.
<p>
Causes the owner of the collection (the control) to be redrawn when needed.
</p>
</descr>
<seealso/>
</element>

26
docs/xml/lcl/comctrls.xml
View File

@ -13034,7 +13034,7 @@ end;</code>
AlphaSort updates values in the SortDirection, SortType, and SortColumn properties. Flag values for the control are updated to include lffPreparingSorting prior to setting the property values; this suppresses reordering until the changes are completed.
</p>
<p>
SortDirection is toggled to force a new sort order to be applied. The final value is sdAscending.
SortDirection is toggled to s a new sort order to be applied. The final value is sdAscending.
</p>
<p>
SortType is set to stText to use the TListItem.Caption values to determine the order for the list items. In the default comparison routine. case is significant. Use OnCompare to implement an alternate comparison routine.
@ -16062,7 +16062,7 @@ end;</code>
<var>TextChanged</var> is an overridden method in <var>TToolButton</var> used to perform actions needed when the caption text for the tool button has been changed. No actions are performed in the method if the parent tool bar has not been assigned for the tool button.
</p>
<p>
When <var>ShowCaptions</var> is enabled, the <var>Invalidate</var> method is called to force the tool button to be redrawn.
When <var>ShowCaptions</var> is enabled, the <var>Invalidate</var> method is called to cause the tool button to be redrawn.
</p>
<p>
TextChanged is called when the <var>CM_TEXTCHANGED</var> control message is handled for the control.
@ -17292,7 +17292,7 @@ end;</code>
<short>Repositions the tool button at the specified position in Buttons.</short>
<descr>
<p>
Forces the entire tool bar to be redrawn. Not used in the current implementation.
Causes the entire tool bar to be redrawn. Not used in the current implementation.
</p>
</descr>
<seealso/>
@ -17307,7 +17307,7 @@ end;</code>
</short>
<descr>
<p>
Forces the entire tool bar to be redrawn. Not used in the current implementation.
Causes the entire tool bar to be redrawn. Not used in the current implementation.
</p>
</descr>
<seealso/>
@ -19467,7 +19467,7 @@ AToolbar.ButtonHeight := 30;
<short>Ends an update process for the control.</short>
<descr>
<p>
EndUpdate is an overridden method in TCustomCoolBar. It calls the inherited method to decrement the internal update counter for the control. When the update counter reaches 0, the CalculateAndAlign method is called to size and layout the visible bands on the control. Temporarily disables auto-sizing while the control recalculates and aligns its bands. Calls Invalidate to force the control to be redrawn.
EndUpdate is an overridden method in TCustomCoolBar. It calls the inherited method to decrement the internal update counter for the control. When the update counter reaches 0, the CalculateAndAlign method is called to size and layout the visible bands on the control. Temporarily disables auto-sizing while the control recalculates and aligns its bands. Calls Invalidate to cause the control to be redrawn.
</p>
</descr>
<seealso>
@ -19479,7 +19479,7 @@ AToolbar.ButtonHeight := 30;
<short>Causes the control to be redrawn.</short>
<descr>
<p>
<var>Invalidate</var> is an overridden method in <var>TCustomCoolBar</var> which forces the control to be redrawn using the settings in the <var>EdgeInner</var>, <var>EdgeOuter</var>, and <var>EdgeBorders</var> properties. <var>CalculateAndAlign</var> is called to size and layout the visible bands on the control. The inherited <var>Invalidate</var> method is called to update the widgetset class when its <var>Handle</var> has been allocated.
<var>Invalidate</var> is an overridden method in <var>TCustomCoolBar</var> which causes the control to be redrawn using the settings in the <var>EdgeInner</var>, <var>EdgeOuter</var>, and <var>EdgeBorders</var> properties. <var>CalculateAndAlign</var> is called to size and layout the visible bands on the control. The inherited <var>Invalidate</var> method is called to update the widgetset class when its <var>Handle</var> has been allocated.
</p>
</descr>
<seealso>
@ -22423,7 +22423,7 @@ AToolbar.ButtonHeight := 30;
<var>Focused</var> is a <var>Boolean</var> property which indicates if the node has focus in the associated <var>TreeView</var> control. The value for the property is <b>True</b> when <var>nsFocused</var> has been included in the <var>States</var> property.
</p>
<p>
Setting a new value for the property causes the values in States to be updated. When set to <b>True</b>, nsFocused is included in States. When set to <b>False</b>, nsFocused is excluded from States. The <var>Update</var> method is called to force the TreeView control to be redrawn.
Setting a new value for the property causes the values in States to be updated. When set to <b>True</b>, nsFocused is included in States. When set to <b>False</b>, nsFocused is excluded from States. The <var>Update</var> method is called to redraw the TreeView control.
</p>
</descr>
<seealso/>
@ -22474,7 +22474,7 @@ AToolbar.ButtonHeight := 30;
Height uses a default value if it contains <b>0</b> (<b>zero</b>) or a negative integer value. If an associated <var>TreeView</var> control has been assigned, the value in its <var>DefaultItemHeight</var> property is used as the property value. If TreeView in unassigned, the value in the <var>DefaultTreeNodeHeight</var> constant is used.
</p>
<p>
Setting a new value for the property causes the <var>States</var> property in the associated TreeView control to be updated (when assigned). The values <var>tvsScrollbarChanged</var> and <var>tvsTopsNeedsUpdate</var> are included in the control States. The <var>Update</var> method is called to force the TreeView to be redrawn. The <var>Changed</var> method is called with the <var>ncHeightChanged</var> node change reason.
Setting a new value for the property causes the <var>States</var> property in the associated TreeView control to be updated (when assigned). The values <var>tvsScrollbarChanged</var> and <var>tvsTopsNeedsUpdate</var> are included in the control States. The <var>Update</var> method is called to redraw the TreeView. The <var>Changed</var> method is called with the <var>ncHeightChanged</var> node change reason.
</p>
<p>
Height is used along with <var>Top</var> to calculate the return value for the <var>Bottom</var> method. It is also used in the implementation of methods like <var>DisplayRect</var> and <var>DisplayExpandSignRect</var>.
@ -22647,7 +22647,7 @@ AToolbar.ButtonHeight := 30;
Setting a new value for the property causes the values in States to be updated. Similarly, the TreeView control is updated to used the node in the Selected or Selections property.
</p>
<p>
The <var>Update</var> method is called to force the TreeView control to be redrawn.
The <var>Update</var> method is called to redraw the TreeView control.
</p>
</descr>
<seealso>
@ -22811,7 +22811,7 @@ AToolbar.ButtonHeight := 30;
Setting a new value for the property causes the States property to be updated. <var>Selected</var> is set to <b>False</b> when the value in Visible is changed.
</p>
<p>
Values are included in the States property for the associated TreeView control (when assigned) to indicate that the size and layout for the tree nodes in the control have been changed. The <var>Update</var> method is called to force the control to be refreshed. The <var>Changed</var> method is called with the <var>ncVisibility</var> node change reason.
Values are included in the States property for the associated TreeView control (when assigned) to indicate that the size and layout for the tree nodes in the control have been changed. The <var>Update</var> method is called to refresh the control. The <var>Changed</var> method is called with the <var>ncVisibility</var> node change reason.
</p>
</descr>
<seealso/>
@ -25484,7 +25484,7 @@ AToolbar.ButtonHeight := 30;
The <var>OnEdited</var> event handler is signalled (when assigned) to validate or modify the new text value, and the text is stored in <var>Node</var>.
</p>
<p>
EndEditing calls the <var>Invalidate</var> method to force the control to be redrawn.
EndEditing calls the <var>Invalidate</var> method to redraw the control.
</p>
</descr>
<seealso>
@ -25913,7 +25913,7 @@ AToolbar.ButtonHeight := 30;
GetImageSize is called to get the height needed for Images or StateImages used in the control. Values in ImageSize and StateImageSize are updated with the scaled image heights including default spacing. The calculated value is enlarged for the Image sizes if needed.
</p>
<p>
UpdateDefaultItemHeight updates the States property to include values that indicate the item height for nodes has changed. The Invalidate method is called to force the control to be redrawn.
UpdateDefaultItemHeight updates the States property to include values that indicate the item height for nodes has changed. The Invalidate method is called to redraw the control.
</p>
<p>
UpdateDefaultItemHeight is called from methods like: InitializeWnd, Loaded, SetOptions, and DoPaint.
@ -26025,7 +26025,7 @@ AToolbar.ButtonHeight := 30;
<short>Handles the LM_SETFOCUS message for the control.</short>
<descr>
<p>
Calls the <var>Invalidate</var> method to force the control to be redrawn. Calls the inherited method prior to exit.
Calls the <var>Invalidate</var> method to redraw the control. Calls the inherited method prior to exit.
</p>
</descr>
<seealso>

7
docs/xml/lcl/controls.xml
View File

@ -11739,11 +11739,11 @@
<element name="TControl.Invalidate">
<short>
Force a delayed Repaint of the control, by marking its visible area of the control as invalid.
Causes a delayed Repaint of the control by marking its visible area of the control as invalid.
</short>
<descr>
<p>
Calls the <var>InvalidateControl</var> method to invalidate the bounds rectangle for the control using the clipping rectangle for the Parent.
Calls the <var>InvalidateControl</var> method to invalidate the bounds rectangle for the control using the clipping rectangle for the Parent. The control is redrawn when there are no pending messages in the message queue.
</p>
</descr>
<seealso>
@ -18578,6 +18578,9 @@ if MyControl.CanSetFocus then
<p>
<var>Invalidate</var> is an overridden method in TWinControl. It re-implements the inherited method to call the Invalidate method in the widgetset class instance when its Handle has been allocated. It does not call the inherited method.
</p>
<p>
The control is redrawn when there are no pending window messages in the message queue.
</p>
</descr>
<seealso>
<link id="TControl.Invalidate"/>

8
docs/xml/lcl/dbgrids.xml
View File

@ -920,7 +920,7 @@
<var>Clear</var> is a procedure used to remove all of the Items stored in the list. Clear calls the TDataset.FreeBookmark method for each of the TBookmark instances in Items. The length of the Bookmark is set to 0 to decrease the reference count for the memory allocation.
</p>
<p>
Clear uses the Invalidate method in the associated Grid control to force it to be redrawn.
Clear uses the Invalidate method in the associated Grid control and causes it to be redrawn.
</p>
</descr>
<seealso></seealso>
@ -2208,7 +2208,7 @@
</short>
<descr>
<p>
<var>Update</var> causes the TDBGrid control which owns the column collection to be redrawn. The value in Grid must be assigned, or no actions are performed in the method. In addition, the Grid control will not be updated if component streaming is active (csLoading in its ComponentState). Update calls TDBGrid.LayoutChanged to force the Grid control to be redrawn.
<var>Update</var> causes the TDBGrid control which owns the column collection to be redrawn. The value in Grid must be assigned, or no actions are performed in the method. In addition, the Grid control will not be updated if component streaming is active (csLoading in its ComponentState). Update calls TDBGrid.LayoutChanged to cause the Grid control to be redrawn.
</p>
</descr>
<seealso>
@ -3466,7 +3466,7 @@
</short>
<descr>
<p>
<var>InvalidateSizes</var> is a procedure used to force the grid to recalculate column sizes and to repaint its display area. InvalidateSizes updates the GridFlags for the control to include the value gfVisualChange.
<var>InvalidateSizes</var> is a procedure which causes the grid to recalculate column sizes and to repaint its display area. InvalidateSizes updates the GridFlags for the control to include the value gfVisualChange.
</p>
</descr>
<seealso></seealso>
@ -5270,7 +5270,7 @@
</short>
<descr>
<p>
<var>UpdateActive</var> forces the control to be redrawn when the active row in the linked dataset is changed. UpdateActive requires an active dataset in DataLink with a selected record. No actions are performed in the method when the dataset is closed or contains no rows. UpdateActive calls InvalidateCell when the selected row in the control has changed. InvaidateRow is called to update the selected row in the control.
<var>UpdateActive</var> causes the control to be redrawn when the active row in the linked dataset is changed. UpdateActive requires an active dataset in DataLink with a selected record. No actions are performed in the method when the dataset is closed or contains no rows. UpdateActive calls InvalidateCell when the selected row in the control has changed. InvaidateRow is called to update the selected row in the control.
</p>
</descr>
<seealso></seealso>

18
docs/xml/lcl/grids.xml
View File

@ -6749,7 +6749,7 @@
<var>OnTitleFontChanged</var> is a procedure which implements the event handler signalled when the <var>TitleFont</var> for fixed cells has been changed. OnTitleFontChanged is assigned to the <var>OnChange</var> event handler in TitleFont in the constructor for the class instance.
</p>
<p>
OnTitleFontChanged sets the value in <var>TitleFontIsDefault</var> to <b>False</b> to reflect the change in the font setting. When <var>Columns</var> have been enabled (<var>VisibleCount</var> contains a non-zero value), the <var>TitleFontChanged</var> method in Columns is called. The <var>ColumnsChanged</var> method is called to force the grid to be updated. If Columns have not been enabled, the <var>VisualChange</var> method is called to update the grid control.
OnTitleFontChanged sets the value in <var>TitleFontIsDefault</var> to <b>False</b> to reflect the change in the font setting. When <var>Columns</var> have been enabled (<var>VisibleCount</var> contains a non-zero value), the <var>TitleFontChanged</var> method in Columns is called. The <var>ColumnsChanged</var> method is called and causes the grid to be updated. If Columns have not been enabled, the <var>VisualChange</var> method is called to update the grid control.
</p>
</descr>
<seealso>
@ -8165,7 +8165,7 @@
</short>
<descr>
<p>
<var>ColWidthsChanged</var> has an empty implementation in TCustomGrid. It is not currently used in any descendent classes in the LCL. It can be overridden in custom controls to perform any actions needed when one or more of the column widths has been changed. One common use is to invalidate the grid control to force it to be redrawn.
<var>ColWidthsChanged</var> has an empty implementation in TCustomGrid. It is not currently used in any descendent classes in the LCL. It can be overridden in custom controls to perform any actions needed when one or more of the column widths has been changed. One common use is to invalidate the grid control and cause it to be redrawn.
</p>
<p>
ColWidthsChanged is called when a new value is specified for the indexed ColWidths property and Columns have been enabled for the control.
@ -8591,7 +8591,7 @@
DoEnter is an overridden method in TCustomGrid. The inherited DoEnter method is called on entry to signal the OnEnter event handler (when assigned).
</p>
<p>
It ensures that the active selection and optional editor control are restored when grid control receives focus. If the Editor is not locked for update, and is always visible, the Editor class is re-selected and it is displayed in the active cell. When the Editor is not always visible (goAlwaysShowEditor is not in Options), InvalidateFocused is called to force the active cell or row selection to be redrawn.
It ensures that the active selection and optional editor control are restored when grid control receives focus. If the Editor is not locked for update, and is always visible, the Editor class is re-selected and it is displayed in the active cell. When the Editor is not always visible (goAlwaysShowEditor is not in Options), InvalidateFocused is called to request the active cell or row selection to be redrawn.
</p>
<p>
DoEnter is called from the CMEnter method when it handles the corresponding control message.
@ -9970,7 +9970,7 @@
<var>FontChanged</var> is an overridden method used to perform actions needed when the <var>Font</var> for the control has been changed.
</p>
<p>
FontChanged ensures that the internal default heights for rows and columns are reset to <b>0</b> (<b>zero</b>). This forces the default column and row heights to be recalculated when the <var>DoAutoAdjustLayout</var> method is called.
FontChanged ensures that the internal default heights for rows and columns are reset to <b>0</b> (<b>zero</b>). This causes the default column and row heights to be recalculated when the <var>DoAutoAdjustLayout</var> method is called.
</p>
<p>
When <var>csCustomPaint</var> is included in <var>ControlState</var>, the Font is assigned to the <var>Canvas</var> for the control.
@ -12821,7 +12821,7 @@
<short>Updates the grid after changes to the visual properties in the control.</short>
<descr>
<p>
<var>VisualChange</var> is a procedure used to update the grid when visual aspects of the control have been changed. VisualChange calls <var>UpdateSizes</var> to refresh the size of cells in the grid, and calls <var>Invalidate</var> to force the control to be redrawn.
<var>VisualChange</var> is a procedure used to update the grid when visual aspects of the control have been changed. VisualChange calls <var>UpdateSizes</var> to refresh the size of cells in the grid, and calls <var>Invalidate</var> to cause the control to be redrawn.
</p>
<p>
No actions are performed in the method when <var>BeginUpdate</var> has already been called to buffer updates to the grid. VisualChange will resume updates when <var>EndUpdate</var> has been called to disable update buffering.
@ -13725,7 +13725,7 @@
<var>Flat</var> is a <var>Boolean</var> property which indicates if the cells on the control are drawn using a "flat" drawing style. This causes the cells, including fixed headers, to have a thinner single-line border without any 3D relief regardless of the setting in TitleStyle.
</p>
<p>
The default value for the property is <b>False</b>. Changing the value in Flat causes the UpdateBorderStyle method to be called when BorderStyle is set to bsSingle. Invalidate is called to force the control to be redrawn.
The default value for the property is <b>False</b>. Changing the value in Flat causes the UpdateBorderStyle method to be called when BorderStyle is set to bsSingle. Invalidate is called and causes the control to be redrawn.
</p>
<p>
Flat is used in the DrawBorder method to determine the border drawing style and Canvas settings needed for the control.
@ -15395,7 +15395,7 @@
</short>
<descr>
<p>
Calls the InvalidateRect routine to force the cells to be re-drawn. No actions are performed in the method if a Handle has not been allocated for the control.
Calls the InvalidateRect routine which causes the cells to be re-drawn. No actions are performed in the method if a Handle has not been allocated for the control.
</p>
</descr>
<seealso/>
@ -16692,7 +16692,7 @@
<short>Sets the value for the Color property.</short>
<descr>
<p>
Calls Invalidate to force the grid control to be redrawn.
Calls Invalidate to request the grid control to be redrawn.
</p>
</descr>
<seealso>
@ -16710,7 +16710,7 @@
<var>SetCheckboxState</var> is a method used to set the checked, unchecked, or grayed state for a check box in the cell specified by <var>ACol</var> and <var>ARow</var>.<var> AState</var> contains the state value applied to the cell.
</p>
<p>
SetCheckboxState signals the <var>OnSetCheckboxState</var> event handler (when assigned) to perform the actions needed to change the value in the cell. If <var>DefaultDrawing</var> is enabled for the control, the <var>InvalidateCell</var> method is called to force the cell to be redrawn.
SetCheckboxState signals the <var>OnSetCheckboxState</var> event handler (when assigned) to perform the actions needed to change the value in the cell. If <var>DefaultDrawing</var> is enabled for the control, the <var>InvalidateCell</var> method is called and causes the cell to be redrawn.
</p>
<p>
No actions are performed in the method when OnSetCheckboxState has not been assigned.

19
docs/xml/lcl/stdctrls.xml
View File

@ -5555,7 +5555,9 @@
</element>
<element name="TCustomEdit.EditingDone">
<short>Enforces the setting in the ReadOnly property when editing is finished in the control.</short>
<short>
Enforces the setting in the ReadOnly property when editing is finished in the control.
</short>
<descr>
<p>
<var>EditingDone</var> is an overridden method in <var>TCustomEdit</var>. It ensures that the inherited method is <b>NOT</b> called when the value in <var>ReadOnly</var> is <b>True</b>. EditingDone is called from the <var>KeyUpAfterInterface</var> method when the <var>VK_RETURN</var> key code is handled.
@ -8378,7 +8380,7 @@ end;
<var>TextChanged</var> is an overridden method used to performs actions needed when the <var>CM_TEXTCHANGED</var> message is handled in the control.
</p>
<p>
TextChanged calls <var>InvalidatePreferredSize</var> to force the preferred height and width for the control to be recalculated. When <var>Parent</var> has been assigned and its <var>AutoSize</var> property is set to <b>True</b>, the <var>AdjustSize</var> method in Parent is called. The AdjustSize method for the control is called to resize the control or update control flags when delayed auto-sizing is in use.
TextChanged calls <var>InvalidatePreferredSize</var> and causes the preferred height and width for the control to be recalculated. When <var>Parent</var> has been assigned and its <var>AutoSize</var> property is set to <b>True</b>, the <var>AdjustSize</var> method in Parent is called. The AdjustSize method for the control is called to resize the control or update control flags when delayed auto-sizing is in use.
</p>
<p>
TextChanged calls the inherited method prior to exit.
@ -9840,19 +9842,24 @@ end;
<short>Message examined in the method.</short>
</element>
<element name="TCustomLabel.TextChanged" link="#lcl.controls.TControl.TextChanged">
<element name="TCustomLabel.TextChanged">
<short>
Performs actions when the CM_TEXTCHANGED message is handled for the control.
</short>
<descr>
<p>
<var>TextChanged</var> is an overridden method used to perform actions needed when the <var>CM_TEXTCHANGED</var> message is handled for the control. TextChanged calls <var>Invalidate</var> to force the control to be redrawn. <var>UpdateSize</var> is called to perform auto-sizing, and recalculate the dimensions for the control and its font.
<var>TextChanged</var> is an overridden method used to perform actions needed when the <var>CM_TEXTCHANGED</var> message is handled for the control. TextChanged calls <var>Invalidate</var> to request the control to be redrawn. <var>UpdateSize</var> is called to perform auto-sizing, and recalculate the dimensions for the control. The font may be re-sized when OptimalFill is enabled.
</p>
<p>
TextChanged does <b>not</b> calls the inherited method.
TextChanged does <b>not</b> call the inherited method.
</p>
</descr>
<seealso/>
<seealso>
<link id="TCustomLabel.UpdateSize"/>
<link id="TCustomLabel.OptimalFill"/>
<link id="#lcl.controls.TControl.Invalidate">TControl.Invalidate</link>
<link id="#lcl.controls.TControl.TextChanged">TControl.TextChanged</link>
</seealso>
</element>
<element name="TCustomLabel.DoSetBounds">