PopupMenu¶
Inherits: Popup < Control < CanvasItem < Node < Object
El PopupMenu muestra una lista de opciones.
Descripción¶
PopupMenu es un Control que muestra una lista de opciones. Son populares en las barras de herramientas o en los menús contextuales.
Propiedades¶
|
||
focus_mode |
|
|
|
||
|
||
|
||
|
Métodos¶
void |
add_check_item ( String label, int id=-1, int accel=0 ) |
void |
add_check_shortcut ( ShortCut shortcut, int id=-1, bool global=false ) |
void |
add_icon_check_item ( Texture texture, String label, int id=-1, int accel=0 ) |
void |
add_icon_check_shortcut ( Texture texture, ShortCut shortcut, int id=-1, bool global=false ) |
void |
add_icon_item ( Texture texture, String label, int id=-1, int accel=0 ) |
void |
add_icon_radio_check_item ( Texture texture, String label, int id=-1, int accel=0 ) |
void |
add_icon_radio_check_shortcut ( Texture texture, ShortCut shortcut, int id=-1, bool global=false ) |
void |
add_icon_shortcut ( Texture texture, ShortCut shortcut, int id=-1, bool global=false ) |
void |
|
void |
add_multistate_item ( String label, int max_states, int default_state=0, int id=-1, int accel=0 ) |
void |
add_radio_check_item ( String label, int id=-1, int accel=0 ) |
void |
add_radio_check_shortcut ( ShortCut shortcut, int id=-1, bool global=false ) |
void |
add_separator ( String label="", int id=-1 ) |
void |
add_shortcut ( ShortCut shortcut, int id=-1, bool global=false ) |
void |
add_submenu_item ( String label, String submenu, int id=-1 ) |
void |
clear ( ) |
get_current_index ( ) const |
|
get_item_accelerator ( int idx ) const |
|
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_shortcut ( int idx ) const |
|
get_item_submenu ( int idx ) const |
|
get_item_text ( int idx ) const |
|
get_item_tooltip ( int idx ) const |
|
is_hide_on_window_lose_focus ( ) const |
|
is_item_checkable ( int idx ) const |
|
is_item_checked ( int idx ) const |
|
is_item_disabled ( int idx ) const |
|
is_item_radio_checkable ( int idx ) const |
|
is_item_separator ( int idx ) const |
|
is_item_shortcut_disabled ( int idx ) const |
|
void |
remove_item ( int idx ) |
void |
set_hide_on_window_lose_focus ( bool enable ) |
void |
set_item_accelerator ( int idx, int accel ) |
void |
set_item_as_checkable ( int idx, bool enable ) |
void |
set_item_as_radio_checkable ( int idx, bool enable ) |
void |
set_item_as_separator ( int idx, bool enable ) |
void |
set_item_checked ( int idx, bool checked ) |
void |
set_item_disabled ( int idx, bool disabled ) |
void |
set_item_icon ( int idx, Texture icon ) |
void |
set_item_id ( int idx, int id ) |
void |
set_item_metadata ( int idx, Variant metadata ) |
void |
set_item_multistate ( int idx, int state ) |
void |
set_item_shortcut ( int idx, ShortCut shortcut, bool global=false ) |
void |
set_item_shortcut_disabled ( int idx, bool disabled ) |
void |
set_item_submenu ( int idx, String submenu ) |
void |
set_item_text ( int idx, String text ) |
void |
set_item_tooltip ( int idx, String tooltip ) |
void |
toggle_item_checked ( int idx ) |
void |
toggle_item_multistate ( int idx ) |
Propiedades del Theme¶
|
||
|
||
|
||
|
||
|
||
|
||
|
||
Señales¶
id_focused ( int id )
Se emite cuando el usuario navega a un elemento de algún id utilizando la acción ui_up o ui_down.
id_pressed ( int id )
Se emite cuando se pulsa un elemento de algún id o se activa su acelerador.
index_pressed ( int index )
Se emite cuando un elemento de algún index es presionado o su acelerador es activado.
Descripciones de Propiedades¶
bool allow_search
Default |
|
Setter |
set_allow_search(value) |
Getter |
get_allow_search() |
If true, allows navigating PopupMenu with letter keys.
bool hide_on_checkable_item_selection
Default |
|
Setter |
set_hide_on_checkable_item_selection(value) |
Getter |
is_hide_on_checkable_item_selection() |
Si true, oculta el PopupMenu cuando se selecciona una casilla de verificación o un botón de radio.
bool hide_on_item_selection
Default |
|
Setter |
set_hide_on_item_selection(value) |
Getter |
is_hide_on_item_selection() |
Si true, oculta el PopupMenu cuando se selecciona un elemento.
bool hide_on_state_item_selection
Default |
|
Setter |
set_hide_on_state_item_selection(value) |
Getter |
is_hide_on_state_item_selection() |
Si true, oculta el PopupMenu cuando se selecciona un elemento de estado.
float submenu_popup_delay
Default |
|
Setter |
set_submenu_popup_delay(value) |
Getter |
get_submenu_popup_delay() |
Establece el tiempo de demora en segundos para que el elemento del submenú aparezca al pasar el ratón por encima. Si el menú emergente se añade como un hijo de otro (actuando como un submenú), heredará el tiempo de retardo del elemento de menú superior.
Descripciones de Métodos¶
Añade un nuevo elemento comprobable con el texto label.
Opcionalmente se puede proporcionar un id, así como un acelerador (accel). Si no se proporciona id, se creará uno a partir del índice. Si no se proporciona ningún accel, se le asignará el 0 por defecto. Ver get_item_accelerator para más información sobre los aceleradores.
Nota: Los elementos marcables sólo muestran una marca de verificación, pero no tienen ningún comportamiento de verificación incorporado y deben ser marcados/desmarcados manualmente. Ver set_item_checked para más información sobre cómo controlarlo.
Añade un nuevo elemento comprobable y le asigna el ShortCut especificado. Establece la etiqueta de la casilla de verificación al nombre de ShortCut.
Opcionalmente se puede proporcionar un id. Si no se proporciona un id, se creará uno a partir del índice.
Nota: Los elementos marcables sólo muestran una marca de verificación, pero no tienen ningún comportamiento de verificación incorporado y deben ser marcados/desmarcados manualmente. Ver set_item_checked para más información sobre cómo controlarlo.
Añade un nuevo elemento comprobable con el texto label y el icono texture.
Opcionalmente se puede proporcionar un id, así como un acelerador (accel). Si no se proporciona un id, se creará uno a partir del índice. Si no se proporciona ningún accel, se le asignará el 0 por defecto. Ver get_item_accelerator para más información sobre los aceleradores.
Nota: Los elementos marcables sólo muestran una marca de verificación, pero no tienen ningún comportamiento de verificación incorporado y deben ser marcados/desmarcados manualmente. Ver set_item_checked para más información sobre cómo controlarlo.
Añade un nuevo elemento comprobable y le asigna la ShortCut especificada y el icono textura. Establece la etiqueta de la casilla de verificación al nombre de ShortCut.
Opcionalmente se puede proporcionar un id. Si no se proporciona un id, se creará uno a partir del índice.
Nota: Los elementos marcables sólo muestran una marca de verificación, pero no tienen ningún comportamiento de verificación incorporado y deben ser marcados/desmarcados manualmente. Ver set_item_checked para más información sobre cómo controlarlo.
Añade un nuevo elemento con el texto label y el icono texture.
Opcionalmente se puede proporcionar un id, así como un acelerador (accel). Si no se proporciona un id, se creará uno a partir del índice. Si no se proporciona ningún accel, se le asignará el 0 por defecto. Ver get_item_accelerator para más información sobre los aceleradores.
Igual que add_icon_check_item, pero utiliza un botón de comprobación de radio.
void add_icon_radio_check_shortcut ( Texture texture, ShortCut shortcut, int id=-1, bool global=false )
Igual que add_icon_check_shortcut, pero utiliza un botón de comprobación de radio.
Añade un nuevo elemento y le asigna la ShortCut especificada y el icono texture. Establece la etiqueta de la casilla de verificación al nombre de ShortCut.
Opcionalmente se puede proporcionar un id. Si no se proporciona un id, se creará uno a partir del índice.
Añade un nuevo elemento con el texto label.
Opcionalmente se puede proporcionar un id, así como un acelerador (accel). Si no se proporciona id, se creará uno a partir del índice. Si no se proporciona ningún accel, se le asignará el 0 por defecto. Ver get_item_accelerator para más información sobre los aceleradores.
void add_multistate_item ( String label, int max_states, int default_state=0, int id=-1, int accel=0 )
Añade un nuevo elemento multiestatal con el texto label.
A diferencia de los elementos binarios normales, los elementos multiestado pueden tener más de dos estados, según se define en max_states. Cada pulsación o activación del elemento aumentará el estado en uno. El valor por defecto está definido por default_state.
Opcionalmente se puede proporcionar un id, así como un acelerador (accel). Si no se proporciona id, se creará uno a partir del índice. Si no se proporciona ningún accel, se le asignará el 0 por defecto. Ver get_item_accelerator para más información sobre los aceleradores.
Añade un nuevo botón de comprobación de radio con el texto label.
Opcionalmente se puede proporcionar un id, así como un acelerador (accel). Si no se proporciona un id, se creará uno a partir del índice. Si no se proporciona ningún accel, se le asignará el 0 por defecto. Ver get_item_accelerator para más información sobre los aceleradores.
Nota: Los elementos marcables sólo muestran una marca de verificación, pero no tienen ningún comportamiento de verificación incorporado y deben ser marcados/desmarcados manualmente. Ver set_item_checked para más información sobre cómo controlarlo.
Añade un nuevo botón de comprobación de radio y le asigna un ShortCut. Establece la etiqueta de la casilla de verificación al nombre de ShortCut.
Opcionalmente se puede proporcionar un id. Si no se proporciona un id, se creará uno a partir del índice.
Nota: Los elementos marcables sólo muestran una marca de verificación, pero no tienen ningún comportamiento de verificación incorporado y deben ser marcados/desmarcados manualmente. Ver set_item_checked para más información sobre cómo controlarlo.
Adds a separator between items. Separators also occupy an index, which you can set by using the id parameter.
A label can optionally be provided, which will appear at the center of the separator.
Añade un ShortCut.
Opcionalmente se puede proporcionar un id. Si no se proporciona un id, se creará uno a partir del índice.
Añade un elemento que actuará como un submenú del nodo padre PopupMenu cuando se haga clic. El argumento submenu es el nombre del nodo hijo PopupMenu que se mostrará cuando se haga clic en el elemento.
Opcionalmente se puede proporcionar un id. Si no se proporciona un id, se creará uno a partir del índice.
void clear ( )
Elimina todos los artículos del PopupMenu.
int get_current_index ( ) const
Returns the index of the currently focused item. Returns -1 if no item is focused.
Devuelve el acelerador del artículo en el índice idx. Los aceleradores son combinaciones especiales de teclas que activan el artículo, sin importar el control que se enfoque.
int get_item_count ( ) const
Devuelve el número de objetos en el PopupMenu.
Devuelve el icono del artículo en el índice idx.
Devuelve el id del artículo en el índice idx. El id puede asignarse manualmente, mientras que el índice no puede.
Devuelve el índice del artículo que contiene el id especificado. El índice es asignado automáticamente a cada elemento por el motor. El índice no se puede establecer manualmente.
Devuelve los metadatos del elemento especificado, que pueden ser de cualquier tipo. Puede configurarlo con set_item_metadata, que proporciona una forma sencilla de asignar datos de contexto a los elementos.
Devuelve el ShortCut asociado al elemento idx especificado.
Devuelve el nombre del submenú del artículo en el índice idx. Ver add_submenu_item para más información sobre cómo añadir un submenú.
Devuelve el texto del artículo en el índice idx.
Devuelve la punta de la herramienta asociada al índice especificado idx.
bool is_hide_on_window_lose_focus ( ) const
Returns true if the popup will be hidden when the window loses focus or not.
Devuelve true si el elemento en el índice idx es comprobable de alguna manera, es decir, si tiene una casilla de verificación o un botón de radio.
Nota: Los elementos marcables sólo muestran una casilla de verificación o un botón de radio, pero no tienen ningún comportamiento de verificación incorporado y deben ser marcados/desmarcados manualmente.
Devuelve true si el elemento en el índice idx está marcado.
Devuelve true si el elemento en el índice idx está desactivado. Cuando está deshabilitado no puede ser seleccionado, o su acción invocada.
Consulta set_item_disabled para más información sobre cómo desactivar un elemento.
Devuelve true si el elemento en el índice idx tiene un control de tipo botón de radio.
Nota: Esto es puramente cosmético; debes añadir la lógica para comprobar/descomprobar los elementos en los grupos de radio.
Devuelve true si el artículo es un separador. Si lo es, se mostrará como una línea. Ver add_separator para más información sobre cómo añadir un separador.
Devuelve true si el atajo del elemento especificado está desactivado.
void remove_item ( int idx )
Elimina el elemento en el índice idx del menú.
Nota: Los índices de los ítems después del ítem removido serán desplazados por uno.
void set_hide_on_window_lose_focus ( bool enable )
Hides the PopupMenu when the window loses focus.
Establece el acelerador del objeto en el índice idx. Los aceleradores son combinaciones especiales de teclas que activan el artículo, sin importar el control que se enfoque.
Establece si el elemento en el índice idx tiene una casilla de verificación. Si false, establece el tipo del artículo en texto plano.
Nota: Los elementos marcables sólo muestran una marca de verificación, pero no tienen ningún comportamiento de verificación incorporado y deben ser marcados/desmarcados manualmente.
Establece el tipo del artículo en el índice especificado idx al botón de radio. Si false, establece el tipo del artículo en texto plano.
Marque el elemento en el índice idx como separador, lo que significa que se mostraría como una línea. Si false, establece el tipo del artículo en texto plano.
Establece el estado de verificación del artículo en el índice idx.
Activa/desactiva el elemento en el índice idx. Cuando está desactivado, no puede ser seleccionado y su acción no puede ser invocada.
Replaces the Texture icon of the specified idx.
Establece el id del artículo en el índice idx.
Establece los metadatos de un elemento, que pueden ser de cualquier tipo. Posteriormente se puede obtener con get_item_metadata, que proporciona una forma sencilla de asignar datos de contexto a los elementos.
Sets the state of a multistate item. See add_multistate_item for details.
Establece un ShortCut para el elemento especificado idx.
Desactiva el ShortCut del índice especificado idx.
Establece el submenú del artículo en el índice idx. El submenú es el nombre de un nodo hijo PopupMenu que se mostraría al hacer clic en el elemento.
Establece el texto del artículo en el índice idx.
Establece la sugerencia String del artículo en el índice especificado idx.
void toggle_item_checked ( int idx )
Cambia el estado de verificación del elemento del índice especificado idx.
void toggle_item_multistate ( int idx )
Cycle to the next state of a multistate item. See add_multistate_item for details.
Theme Property Descriptions¶
Color font_color
Default |
|
El texto predeterminado Color para los nombres de los elementos del menú.
Color font_color_accel
Default |
|
El texto Color utilizado para los atajos y aceleradores que se muestran junto al nombre del elemento de menú cuando está definido. Ver get_item_accelerator para más información sobre los aceleradores.
Color font_color_disabled
Default |
|
Color utilizado para el texto de los elementos del menú desactivados.
Color font_color_hover
Default |
|
Color usado por el texto cuando el cursor esta encima del mismo.
Color font_color_separator
Default |
|
Color used for labeled separators' text. See add_separator.
int hseparation
Default |
|
El espacio horizontal entre el nombre del elemento y el atajo del texto/flecha del submenú.
int vseparation
Default |
|
El espacio vertical entre cada elemento del menú.
Font font
Font usada para los elementos del menú.
Texture checked
Texture icon for the checked checkbox items.
Texture radio_checked
Texture icon for the checked radio button items.
Texture radio_unchecked
Texture icon for the unchecked radio button items.
Texture submenu
Texture icon for the submenu arrow.
Texture unchecked
Texture icon for the unchecked checkbox items.
StyleBox hover
StyleBox que se muestra cuando el PopupMenu elemento tiene el cursor encima.
StyleBox labeled_separator_left
StyleBox para el lado izquierdo del separador etiquetado. Ver add_separator.
StyleBox labeled_separator_right
StyleBox para el lado derecho del separador etiquetado. Ver add_separator.
StyleBox panel
El StyleBox por defecto de los elementos del PopupMenu.
StyleBox panel_disabled
StyleBox usado cuando el PopupMenu está desactivado.
StyleBox separator
StyleBox usado para los separadores. Ver add_separator.