Document using negative indices in OptionButton's set_item_*() methods
#104131
+39
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Calinou
added
enhancement
documentation
cherrypick:4.4
This also adds a code sample that shuffles items in an OptionButton, which acts as a showcase for demonstrating programmatic usage.
Calinou
force-pushed
the
doc-optionbutton-set-negative-id
branch
from
e492fa2 to
e01432e
Compare
Mickeon
reviewed
Mar 19, 2025
| [b]Note:[/b] The ID values used for items are limited to 32 bits, not full 64 bits of [int]. This has a range of [code]-2^32[/code] to [code]2^32 - 1[/code], i.e. [code]-2147483648[/code] to [code]2147483647[/code]. | ||
| [b]Note:[/b] The [member Button.text] and [member Button.icon] properties are set automatically based on the selected item. They shouldn't be changed manually. | ||
| [b]Example:[/b] Shuffle all existing items in an OptionButton by programmatically getting the items, clearing the list and re-adding the items in a different order: |
There was a problem hiding this comment.
Suggested change
| [b]Example:[/b] Shuffle all existing items in an OptionButton by programmatically getting the items, clearing the list and re-adding the items in a different order: | |
| [b]Example:[/b] Shuffle all items in an [OptionButton] by fetching the items, clearing the list, and re-adding the items in a different order: |
| @@ -6,8 +6,47 @@ | |||
| <description> | |||
| [OptionButton] is a type of button that brings up a dropdown with selectable items when pressed. The item selected becomes the "current" item and is displayed as the button text. | |||
| See also [BaseButton] which contains common properties and methods associated with this node. | |||
| Like [PopupMenu], all [code]set_item_*[/code] methods allow negative item indices, i.e. [code]-1[/code] to access the last item, [code]-2[/code] to select the second-to-last item, and so on. | |||
There was a problem hiding this comment.
Suggested change
| Like [PopupMenu], all [code]set_item_*[/code] methods allow negative item indices, i.e. [code]-1[/code] to access the last item, [code]-2[/code] to select the second-to-last item, and so on. | |
| Like [PopupMenu], all [code]set_item_*[/code] methods allow negative item indices. This means an index of [code]-1[/code] can be used to access the last item, [code]-2[/code] to access the second-to-last item, and so on. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This also adds a code sample that shuffles items in an OptionButton, which acts as a showcase for demonstrating programmatic usage.