Mention GTK native version in wxSearchCtrl documentation

Document some of the (minor) limitations of the native implementation as
well as its existence itself.
This commit is contained in:
Vadim Zeitlin
2020-01-07 03:00:15 +01:00
parent c904e27376
commit 2635360f3c

View File

@@ -11,6 +11,9 @@
A search control is a composite control with a search button, a text A search control is a composite control with a search button, a text
control, and a cancel button. control, and a cancel button.
This control is implemented natively under macOS and GTK 3.6 or later and
generically for all the other platforms.
@beginStyleTable @beginStyleTable
@style{wxTE_PROCESS_TAB} @style{wxTE_PROCESS_TAB}
The control will receive @c wxEVT_CHAR events for TAB pressed - The control will receive @c wxEVT_CHAR events for TAB pressed -
@@ -138,13 +141,21 @@ public:
/** /**
Shows or hides the cancel button. Shows or hides the cancel button.
Note that this function does nothing in the native GTK version of the
control: "Cancel" button is always shown automatically if the control
is not empty and hidden if it is empty.
*/ */
virtual void ShowCancelButton(bool show); virtual void ShowCancelButton(bool show);
/** /**
Sets the search button visibility value on the search control. Sets the search button visibility value on the search control.
If there is a menu attached, the search button will be visible regardless of If there is a menu attached, the search button will be visible regardless of
the search button visibility value. the search button visibility value.
Note that this function does nothing in the native GTK version of the
control: "Search" button is always shown there.
*/ */
virtual void ShowSearchButton(bool show); virtual void ShowSearchButton(bool show);