Skip to content

Commit 93946a4

Browse files
committed
docs: document ComboBox Z-order behavior
1 parent d99e833 commit 93946a4

1 file changed

Lines changed: 17 additions & 9 deletions

File tree

Asset/GUI/WND_Controls/wnd_controls_combobox.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ and appearance of the **ComboBox**.
88
In addition to the [default control tags](wnd_controls_user), the following tags are available.
99

1010
- The control does not have a `TEXT` tag. Unlike controls such as checkboxes, which include a text label,
11-
this control is self-contained and does not display or use a text label.
11+
this control is self-contained and does not display or use a text label.
1212

1313
| Tag | Description |
1414
|------------------------------------------|------------------------------------------------------------------------------|
@@ -37,21 +37,21 @@ this control is self-contained and does not display or use a text label.
3737

3838
## Default values
3939

40-
The following section list the default values and available textures for each tag
40+
The following section lists the default values and available textures for each tag.
4141

4242
<details>
4343
<summary>Click to expand</summary>
4444

4545
### COMBOBOXDATA
4646

4747
- **ISEDITABLE**: Defines whether the combobox is editable.
48-
0 = non-editable (only dropdown selection allowed), 1 = editable (user can type in the field).
48+
0 = non-editable (only dropdown selection allowed), 1 = editable (user can type in the field).
4949
- **MAXCHARS**: The maximum number of characters allowed in the edit field when the combobox is editable (e.g., 16).
5050
- **MAXDISPLAY**: The maximum number of items to display at once in the dropdown list without scrolling (e.g., 2).
51-
- **ASCIIONLY**: Defines if only ASCII characters are allowed in the edit field:
52-
0 = allows non-ASCII characters, 1 = only ASCII.
53-
- **LETTERSANDNUMBERS**: Defines if only letters and numbers are allowed in the edit field:
54-
0 = allows all characters, 1 = allows only letters and numbers.
51+
- **ASCIIONLY**: Defines whether only ASCII characters are allowed in the edit field:
52+
0 = allows non-ASCII characters, 1 = only ASCII.
53+
- **LETTERSANDNUMBERS**: Defines whether only letters and numbers are allowed in the edit field:
54+
0 = allows all characters, 1 = allows only letters and numbers.
5555

5656
### ENABLEDDRAWDATA, DISABLEDDRAWDATA, HILITEDRAWDATA
5757

@@ -96,7 +96,7 @@ The following section list the default values and available textures for each ta
9696

9797
</details>
9898

99-
## Known Issues
99+
## Known issues
100100

101101
1. **Item text color cannot be changed:**
102102
It is currently not possible to change the color of the text (for list items). By default, the text color is white.
@@ -106,9 +106,17 @@ The following section list the default values and available textures for each ta
106106
it is not possible to click on items that are outside of the visible area of the container.
107107
This may cause issues when interacting with the ComboBox.
108108

109+
3. **Dropdown menu z-order (overlap issues):**
110+
The SAGE engine renders UI elements based on their order in the `.wnd` file hierarchy. Elements defined lower
111+
down in the file are drawn on top of elements defined earlier.
112+
Because the ComboBox features a dropdown list that extends downwards, it must be rendered *over* any other UI
113+
elements that are physically located below it on the screen.
114+
To ensure the dropdown menu is not hidden behind other elements, the `COMBOBOX` must be placed **below** those
115+
underlying elements in the `.wnd` file's code hierarchy.
116+
109117
## Example
110118

111-
Here example from IP address ComboBox in the `OptionsMenu.wnd` file:
119+
Here is an example of the IP address ComboBox from the `OptionsMenu.wnd` file:
112120

113121
<details>
114122
<summary>Click to expand</summary>

0 commit comments

Comments
 (0)