From a47f5195e7b825694ec5b039953e9db0a74a6002 Mon Sep 17 00:00:00 2001
From: dsiders
Date: Wed, 4 Jan 2023 20:02:14 +0000
Subject: [PATCH] Docs: LCL/stdctrls. Adds admonitions for macOS Carbon
widgetset.
---
docs/xml/lcl/stdctrls.xml | 51 ++++++++++++++++++++++++++++++++++++---
1 file changed, 47 insertions(+), 4 deletions(-)
diff --git a/docs/xml/lcl/stdctrls.xml b/docs/xml/lcl/stdctrls.xml
index 6aa0d26610..61c3e1cc5e 100644
--- a/docs/xml/lcl/stdctrls.xml
+++ b/docs/xml/lcl/stdctrls.xml
@@ -1621,6 +1621,11 @@ Items in the control when the drop-down list is displayed.
Do not create instances of TCustomComboBox. Use one of the descendent
classes, like TComboBox or TComboBoxEx.
+
+The Height property in TCustomComboBox / TComboBox cannot be changed for some
+platforms, like Windows and macOS Carbon. It is best to set AutoSize to
+True to ensure consistent size handling on the supported platforms.
+
@@ -3535,7 +3540,9 @@ apply key press events for the control.
-Indicates whether the drop-down list has been displayed.
+
+Indicates whether the drop-down list has been displayed.
+
DroppedDown is a Boolean property which indicates
@@ -3558,10 +3565,15 @@ control is altered, when CBN_DROPDOWN or CBN_CLOSEUP control
messages are handled, and when key down events are handled which change the
visibility of the drop-down list.
+
+For the macOS Carbon widgetset, setting DroppedDown to True does not
+cause the drop-down list to be displayed when Style is set to csDropDownList.
+
+
@@ -3820,6 +3832,10 @@ drop-down list.
The default value for the property is 8.
+
+For the macOS Carbon widgetset, changing the value in DropDownCount does not
+affect the control. This attribute is determined by the native control.
+
@@ -4024,7 +4040,9 @@ Assign a new string value to replace the selected text within the
-Appearance and behavior of the combo-box.
+
+Controls the appearance and behavior for the combo-box.
+
Style is quite Windows-centric, reflecting the evolution of combo-box styles.
@@ -4050,6 +4068,11 @@ Owner-drawn drop-down lists have been added, with the values:
csOwnerDrawVariable
Each item in the list can have a different height.
+
+For the macOS Carbon widgetset, the following style values are not recognized:
+csSimple, csOwnerDrawFixed and csOwnerDrawVariable. They are not supported in
+the native control.
+
@@ -4217,6 +4240,11 @@ If no value is selected from the drop-down list, the default text (if any)
remains, or any information typed directly into Text will be
returned, and ItemIndex takes the value of -1.
+
+The Height property in TComboBox cannot be changed for some platforms, like
+Windows and macOS Carbon. It is best to set AutoSize to True to ensure
+consistent size handling on the supported platforms.
+
@@ -5769,7 +5797,7 @@ behavior. The default value for the property is True.
-The number of visible vertical columns displayed in the control.
+The number of visible columns displayed on the control.
@@ -5780,6 +5808,9 @@ single column becomes Width/Columns. Setting a new value for Columns causes
the widgetset class to be notified when a handle has been allocated for the
control.
+
+For the macOS Carbon widgetset, the Columns property is not supported.
+
@@ -8106,6 +8137,9 @@ PasswordChar.
Typically used in password input, to hide the input from other viewers. The
value in Text is still available for the WM_GETTEXT message.
+
+For the macOS Carbon widgetset, changing the default value for the property is not supported.
+
@@ -9184,6 +9218,10 @@ When False, the display for long lines is truncated at the right
margin for the control. It can be made visible when the text can be scrolled
horizontally.
+
+For the macOS Carbon widgetset, changing the property value to False
+does not allow long text lines to be scrolled horizontally.
+
@@ -11663,7 +11701,9 @@ returned from the GetControlClassDefaultSize class method.
-Indicates the alignment for the caption text in the control.
+
+Indicates the alignment for the caption text in the control.
+
Alignment is a TLeftRight property with the horizontal
@@ -11679,6 +11719,9 @@ when its Handle has been allocated.
The value in Alignment is used to set the creation parameters for the control.
+
+For the macOS Carbon widgetset, the Alignment property is not supported.
+