From fa49d606348a6df44c741f40308bcd87107f82eb Mon Sep 17 00:00:00 2001 From: dsiders Date: Sat, 20 Jul 2024 21:29:11 +0100 Subject: [PATCH] Docs: LCL/stdctrls. Adds TCheckBox.Checked and TCheckBox.OnClick topics. * TCheckBox.Checked replaces the linked topic in TButtonControl. * TCheckBox.OnClick was omitted and links to the inherited topic (TControl). --- docs/xml/lcl/stdctrls.xml | 79 +++++++++++++++++++++++++++++++++++---- 1 file changed, 71 insertions(+), 8 deletions(-) diff --git a/docs/xml/lcl/stdctrls.xml b/docs/xml/lcl/stdctrls.xml index f556d0c09d..edfb06c2fc 100644 --- a/docs/xml/lcl/stdctrls.xml +++ b/docs/xml/lcl/stdctrls.xml @@ -10208,13 +10208,16 @@ instance. -Indicates the checked state for the control. + +Indicates the checked state for the control as a Boolean value. +

Checked is a Boolean property which indicates if the control is displayed using its "checked" or "unchecked" state. The value for the property is always False in TButtonControl, and is -overridden in descendent classes like TCustomCheckBox. +overridden in descendent classes like +TCustomCheckBox/TCheckBox.

@@ -10243,9 +10246,9 @@ property in a linked button action is updated. This prevents duplicate OnChange

- + @@ -10253,7 +10256,7 @@ property in a linked button action is updated. This prevents duplicate OnChange -Event handler for signalled when the button control is clicked. +Event handler signalled when the button control is clicked.

@@ -11921,7 +11924,67 @@ enables auto-sizing of the text displayed for the control instance. - + + + +Indicates the checked state for the control as a Boolean value. + + +

+Checked is a Boolean property which indicates if the +control is displayed using its "checked" or "unchecked" state. The default +value for the property is False and indicates the control uses its +unchecked state. +

+

+Checked is a published property in TCheckBox and uses the overridden read and +write access specifiers from TCustomCheckBox (GetChecked and SetChecked). The +property value is read from and written to the State property using one of +the TCheckBoxState enumeration values. For example: +

+ + + + + + + + + + + + + + + + + +
State valueChecked value
cbUncheckedFalse
cbCheckedTrue
cbGrayedThe value in Checked is not significant.
+

+Changing the value in Checked causes State to be updated with the corresponding +TCheckBoxState value, which in turn, calls either the Click method or the +OnChange event handler. +

+

+See State and +ClicksDisabled for more information. +

+ + + + + + + + + + + + + + + + @@ -11940,8 +12003,8 @@ enables auto-sizing of the text displayed for the control instance. - + Enables keyboard navigation using the Tab or Shift+Tab keys.

@@ -11958,7 +12021,7 @@ TCheckBox. - + @@ -11966,8 +12029,8 @@ TCheckBox. - +