OptionButton¶
Inherits: Button < BaseButton < Control < CanvasItem < Node < Object
Control de botón que proporciona opciones seleccionables cuando se presiona.
Descripción¶
OptionButton is a type button that provides a selectable list of 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.
Propiedades¶
action_mode |
|
|
align |
|
|
|
||
toggle_mode |
|
Métodos¶
void |
add_icon_item ( Texture texture, String label, int id=-1 ) |
void |
|
void |
add_separator ( ) |
void |
clear ( ) |
get_item_count ( ) const |
|
get_item_icon ( int idx ) const |
|
get_item_id ( int idx ) const |
|
get_item_index ( int id ) const |
|
get_item_metadata ( int idx ) const |
|
get_item_text ( int idx ) const |
|
get_popup ( ) const |
|
get_selected_id ( ) const |
|
get_selected_metadata ( ) const |
|
is_item_disabled ( int idx ) const |
|
void |
remove_item ( int idx ) |
void |
|
void |
set_item_disabled ( int idx, bool disabled ) |
void |
set_item_icon ( int idx, Texture texture ) |
void |
set_item_id ( int idx, int id ) |
void |
set_item_metadata ( int idx, Variant metadata ) |
void |
set_item_text ( int idx, String text ) |
Propiedades del Theme¶
|
||
|
||
|
||
|
||
|
||
|
||
|
||
Señales¶
item_focused ( int index )
Emitted when the user navigates to an item using the ui_up or ui_down actions. The index of the item selected is passed as argument.
item_selected ( int index )
Emitido cuando el elemento actual ha sido cambiado por el usuario. El índice del elemento seleccionado se pasa como argumento.
Descripciones de Propiedades¶
int selected
Default |
|
Getter |
get_selected() |
El índice del artículo actualmente seleccionado, o -1 si no hay ningún artículo seleccionado.
Descripciones de Métodos¶
Añade un elemento, con un icono de texture, texto label y (opcionalmente) id. Si no se pasa id, el índice del artículo será utilizado como el ID del artículo. Los nuevos artículos se añaden al final.
Añade un elemento, con el texto label y (opcionalmente) id. Si no se pasa id, el índice del artículo será utilizado como el ID del artículo. Los nuevos artículos se añaden al final.
void add_separator ( )
Añade un separador a la lista de artículos. Los separadores ayudan a agrupar los elementos. El separador también ocupa un índice y se añade al final.
void clear ( )
Borra todos los elementos del OptionButton.
int get_item_count ( ) const
Devuelve la cantidad de artículos en el Botón de Opción, incluyendo los separadores.
Devuelve el icono del artículo en el índice idx.
Devuelve el ID del artículo en el índice idx.
Devuelve el índice del artículo con el id dado.
Recupera los metadatos de un elemento. Los metadatos pueden ser de cualquier tipo y pueden utilizarse para almacenar información adicional sobre un elemento, como un ID de cadena externa.
Devuelve el texto del artículo en el índice idx.
PopupMenu get_popup ( ) const
Returns the PopupMenu contained in this button.
Warning: This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their CanvasItem.visible property.
int get_selected_id ( ) const
Devuelve el ID del elemento seleccionado, o 0 si no hay ningún elemento seleccionado.
Variant get_selected_metadata ( ) const
Obtiene los metadatos del elemento seleccionado. Los metadatos de los elementos pueden establecerse utilizando set_item_metadata.
Devuelve true si el elemento en el índice idx está desactivado.
void remove_item ( int idx )
Elimina el elemento en el índice idx.
void select ( int idx )
Selecciona un elemento por índice y lo convierte en el elemento actual. Esto funcionará incluso si el elemento está desactivado.
Establece si el elemento en el índice idx está desactivado.
Los elementos desactivados se dibujan de forma diferente en el desplegable y no son seleccionables por el usuario. Si el ítem seleccionado actual se establece como deshabilitado, permanecerá seleccionado.
Establece el icono del artículo en el índice idx.
Establece el icono del artículo en el índice idx.
Establece los metadatos de un elemento. Los metadatos pueden ser de cualquier tipo y pueden utilizarse para almacenar información adicional sobre un elemento, como un string externa cod un ID.
Establece el texto del artículo en el índice idx.
Theme Property Descriptions¶
Color font_color
Default |
|
Color del texto predeterminado del OptionButton.
Color font_color_disabled
Default |
|
Color del texto utilizado cuando el OptionButton está desactivado.
Color font_color_focus
Default |
|
Text Color used when the OptionButton is focused. Only replaces the normal text color of the button. Disabled, hovered, and pressed states take precedence over this color.
Color font_color_hover
Default |
|
Color del texto usado cuando el OptionButton está siendo movido.
Color font_color_pressed
Default |
|
Color del texto utilizado cuando se pulsa el OptionButton.
int arrow_margin
Default |
|
El espacio horizontal entre el icono de la flecha y el borde derecho del botón.
int hseparation
Default |
|
El espacio horizontal entre el icono de OptionButton y el texto.
Font font
Font del texto del OptionButton.
Texture arrow
El icono de la flecha que se dibujará en el extremo derecho del botón.
StyleBox disabled
StyleBox utilizado cuando el OptionButton está desactivado.
StyleBox focus
StyleBox usado cuando el OptionButton está enfocado. Se muestra sobre el StyleBox actual, por lo que al usar StyleBoxEmpty sólo se desactivará el efecto visual de enfoque.
StyleBox hover
StyleBox usado cuando el cursor se encuentra sobre el OptionButton.
StyleBox normal
Por defecto, StyleBox para el OptionButton.
StyleBox pressed
StyleBox utilizado cuando se presiona el OptionButton.