TabBar
Hereda: Control < CanvasItem < Node < Object
Un control que proporciona una barra horizontal con pestañas.
Descripción
Un control que proporciona una barra horizontal con pestañas. Similar a TabContainer pero sólo se encarga de dibujar pestañas, no de interactuar con los hijos.
Propiedades
|
||
|
||
|
||
|
||
|
||
focus_mode |
|
|
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
Métodos
Propiedades del Tema
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
Señales
active_tab_rearranged(idx_to: int) 🔗
Emitida cuando la pestaña activa se reorganiza mediante el arrastre del ratón. Véase drag_to_rearrange_enabled.
tab_button_pressed(tab: int) 🔗
Emitida al presionar el botón derecho de una pestaña. Véase set_tab_button_icon().
Emitida cuando se cambia a otra pestaña.
Emitida cuando se hace clic con el botón derecho del ratón en una pestaña.
Emitted when a tab's close button is pressed or when middle-clicking on a tab, if close_with_middle_mouse is enabled.
Note: Tabs are not removed automatically once the close button is pressed, this behavior needs to be programmed manually. For example:
$TabBar.tab_close_pressed.connect($TabBar.remove_tab)
GetNode<TabBar>("TabBar").TabClosePressed += GetNode<TabBar>("TabBar").RemoveTab;
Emitida cuando una pestaña tiene encima el cursor del ratón.
Emitted when a tab is right-clicked. select_with_rmb must be enabled.
Emitida cuando una pestaña es seleccionada mediante un clic, entrada direccional o script, incluso si es la pestaña actual.
Enumeraciones
enum AlignmentMode: 🔗
AlignmentMode ALIGNMENT_LEFT = 0
Coloca las pestañas a la izquierda.
AlignmentMode ALIGNMENT_CENTER = 1
Coloca las pestañas en el medio.
AlignmentMode ALIGNMENT_RIGHT = 2
Coloca las pestañas a la derecha.
AlignmentMode ALIGNMENT_MAX = 3
Representa el tamaño del enum AlignmentMode.
enum CloseButtonDisplayPolicy: 🔗
CloseButtonDisplayPolicy CLOSE_BUTTON_SHOW_NEVER = 0
Nunca muestra los botones de cerrado.
CloseButtonDisplayPolicy CLOSE_BUTTON_SHOW_ACTIVE_ONLY = 1
Sólo muestra el botón de cierre en la pestaña actualmente activa.
CloseButtonDisplayPolicy CLOSE_BUTTON_SHOW_ALWAYS = 2
Mostrar el botón de cerrado en todas las pestañas.
CloseButtonDisplayPolicy CLOSE_BUTTON_MAX = 3
Representa el tamaño del enum CloseButtonDisplayPolicy.
Descripciones de Propiedades
Si es true, las pestañas que se desborden del ancho de este nodo se ocultarán, mostrando dos botones de navegación en su lugar. De lo contrario, el tamaño mínimo de este nodo se actualiza para que todas las pestañas sean visibles.
bool close_with_middle_mouse = true 🔗
If true, middle clicking on the mouse will fire the tab_close_pressed signal.
El índice de la pestaña seleccionada actualmente. Un valor de -1 significa que no hay ninguna pestaña seleccionada y sólo se puede establecer cuando deselect_enabled es true o si todas las pestañas están ocultas o desactivadas.
bool deselect_enabled = false 🔗
Si es true, todas las pestañas pueden ser deseleccionadas de modo que ninguna pestaña sea seleccionada. Haz clic en la pestaña actual para deseleccionarla.
bool drag_to_rearrange_enabled = false 🔗
Si es true, las pestañas se pueden reorganizar con el arrastre del ratón.
Establece el ancho máximo al que deben limitarse todas las pestañas. Ilimitado si se establece en 0.
bool scroll_to_selected = true 🔗
Si es true, el desplazamiento de la pestaña se cambiará para mantener visible la pestaña seleccionada actualmente.
bool scrolling_enabled = true 🔗
Si es true, la rueda de desplazamiento del ratón se puede usar para navegar por la vista de desplazamiento.
bool select_with_rmb = false 🔗
Si es true, permite seleccionar una pestaña con el botón derecho del ratón.
AlignmentMode tab_alignment = 0 🔗
void set_tab_alignment(value: AlignmentMode)
AlignmentMode get_tab_alignment()
La posición en la que se colocarán las pestañas.
CloseButtonDisplayPolicy tab_close_display_policy = 0 🔗
void set_tab_close_display_policy(value: CloseButtonDisplayPolicy)
CloseButtonDisplayPolicy get_tab_close_display_policy()
Cuando aparezca el botón cerrar en las pestañas.
El número de pestañas que hay actualmente en la barra.
int tabs_rearrange_group = -1 🔗
Las TabBars con el mismo ID de grupo de reorganización permitirán arrastrar las pestañas entre ellas. Activa el arrastre con drag_to_rearrange_enabled.
Establecer esto como -1 desactivará la reorganización entre TabBars.
Descripciones de Métodos
void add_tab(title: String = "", icon: Texture2D = null) 🔗
Añade una nueva pestaña.
void clear_tabs() 🔗
Li todas las pestañas.
void ensure_tab_visible(idx: int) 🔗
Mueve la scroll view para hacer visible la pestaña.
bool get_offset_buttons_visible() const 🔗
Devuelve true si los botones de desplazamiento (los que aparecen cuando no hay suficiente espacio para todas las pestañas) son visibles.
int get_previous_tab() const 🔗
Devuelve la pestaña anteriormente activa.
Texture2D get_tab_button_icon(tab_idx: int) const 🔗
Devuelve el icono del botón derecho de la pestaña en el índice tab_idx o null si el botón derecho no tiene icono.
Texture2D get_tab_icon(tab_idx: int) const 🔗
Devuelve el icono de la pestaña en el índice tab_idx o null si la pestaña no tiene icono.
int get_tab_icon_max_width(tab_idx: int) const 🔗
Devuelve el ancho máximo permitido del icono para la pestaña en el índice tab_idx.
int get_tab_idx_at_point(point: Vector2) const 🔗
Devuelve el índice de la pestaña en las coordenadas locales point. Devuelve -1 si el punto está fuera de los límites del control o si no hay ninguna pestaña en la posición consultada.
String get_tab_language(tab_idx: int) const 🔗
Devuelve el código de idioma del título de la pestaña.
Variant get_tab_metadata(tab_idx: int) const 🔗
Devuelve el valor de los metadatos establecidos en la pestaña en el índice tab_idx utilizando set_tab_metadata(). Si no se han establecido metadatos previamente, devuelve null por defecto.
Devuelve el número de pestañas ocultas desplazadas a la izquierda.
Rect2 get_tab_rect(tab_idx: int) const 🔗
Devuelve la pestaña Rect2 con la posición y el tamaño local.
TextDirection get_tab_text_direction(tab_idx: int) const 🔗
Devuelve la dirección de escritura base del texto del título de la pestaña.
String get_tab_title(tab_idx: int) const 🔗
Devuelve el título de la pestaña en el índice tab_idx.
String get_tab_tooltip(tab_idx: int) const 🔗
Devuelve el texto de la información sobre herramientas de la pestaña en el índice tab_idx.
bool is_tab_disabled(tab_idx: int) const 🔗
Devuelve true si la pestaña en el índice tab_idx está desactivada.
Devuelve true si la pestaña en el índice tab_idx está oculta.
void move_tab(from: int, to: int) 🔗
Mueve una pestaña de from a to.
void remove_tab(tab_idx: int) 🔗
Elimina la pestaña en el índice tab_idx.
bool select_next_available() 🔗
Selecciona la primera pestaña disponible con un índice mayor que la actualmente seleccionada. Devuelve true si la selección de la pestaña cambió.
bool select_previous_available() 🔗
Selecciona la primera pestaña disponible con un índice menor que la actualmente seleccionada. Devuelve true si la selección de la pestaña cambió.
void set_tab_button_icon(tab_idx: int, icon: Texture2D) 🔗
Establece un icon para el botón de la pestaña en el índice tab_idx (ubicado a la derecha, antes del botón de cierre), haciéndolo visible y clicable (Véase tab_button_pressed). Darle un valor null ocultará el botón.
void set_tab_disabled(tab_idx: int, disabled: bool) 🔗
Si disabled es true, desactiva la pestaña en el índice tab_idx, haciéndola no interactiva.
Si hidden es true, oculta la pestaña en el índice tab_idx, haciéndola desaparecer del área de pestañas.
void set_tab_icon(tab_idx: int, icon: Texture2D) 🔗
Establece un icon para la pestaña en el índice tab_idx.
void set_tab_icon_max_width(tab_idx: int, width: int) 🔗
Establece el ancho máximo permitido del icono para la pestaña en el índice tab_idx. Este límite se aplica sobre el tamaño predeterminado del icono y sobre icon_max_width. La altura se ajusta según la relación del icono.
void set_tab_language(tab_idx: int, language: String) 🔗
Establece el código de idioma del título de la pestaña utilizado para los algoritmos de ajuste de línea y forma del texto, si se deja vacío se utiliza la configuración regional actual.
void set_tab_metadata(tab_idx: int, metadata: Variant) 🔗
Establece el valor de los metadatos para la pestaña en el índice tab_idx, que se puede recuperar más tarde utilizando get_tab_metadata().
void set_tab_text_direction(tab_idx: int, direction: TextDirection) 🔗
Establece la dirección de escritura base del título de la pestaña.
void set_tab_title(tab_idx: int, title: String) 🔗
Establece un title para la pestaña en el índice tab_idx.
void set_tab_tooltip(tab_idx: int, tooltip: String) 🔗
Establece una tooltip para la pestaña en el índice tab_idx.
Nota: De forma predeterminada, si el tooltip está vacío y el texto de la pestaña está truncado (no todos los caracteres caben en la pestaña), el título se mostrará como información sobre herramientas. Para ocultar la información sobre herramientas, asigna " " como el texto de la tooltip.
Descripciones de las propiedades del tema
Color drop_mark_color = Color(1, 1, 1, 1) 🔗
Color de modulación para el icono drop_mark.
Color font_disabled_color = Color(0.875, 0.875, 0.875, 0.5) 🔗
El color de la fuente de las pestañas desactivadas.
Color font_hovered_color = Color(0.95, 0.95, 0.95, 1) 🔗
Color de la fuente de la pestaña sobre la que está el cursor. No se aplica a la pestaña seleccionada.
Color font_outline_color = Color(0, 0, 0, 1) 🔗
El tinte del contorno del texto del nombre de la pestaña.
Color font_selected_color = Color(0.95, 0.95, 0.95, 1) 🔗
Color de la fuente de la pestaña actualmente seleccionada.
Color font_unselected_color = Color(0.7, 0.7, 0.7, 1) 🔗
Color de la fuente de las otras pestañas no seleccionadas.
La separación horizontal entre los elementos dentro de las pestañas.
El ancho máximo permitido para el icono de la pestaña. Este límite se aplica además del tamaño por defecto del icono, pero antes del valor establecido con set_tab_icon_max_width(). La altura se ajusta según la proporción del icono.
El tamaño del contorno del texto de la pestaña.
Nota: Si utilizas una fuente con FontFile.multichannel_signed_distance_field activado, su FontFile.msdf_pixel_range debe establecerse al menos al doble del valor de outline_size para que el renderizado del contorno se vea correctamente. De lo contrario, el contorno puede aparecer recortado antes de lo previsto.
The space between tabs in the tab bar.
La fuente usada para dibujar los nombres de las pestañas.
Tamaño de fuente de los nombres de las pestañas.
El icono para el botón de cerrado (véase tab_close_display_policy).
Icono para el botón de la flecha izquierda que aparece cuando hay demasiadas pestañas que no caben en el ancho del contenedor. Cuando el botón está desactivado (es decir, la primera pestaña es visible), aparece semi-transparente.
Texture2D decrement_highlight 🔗
Icono para el botón de la flecha izquierda que aparece cuando hay demasiadas pestañas que no caben en el ancho del contenedor. Se utiliza cuando el cursor se mantiene encima del botón.
Icono que se muestra para indicar dónde se va a soltar una pestaña arrastrada (véase drag_to_rearrange_enabled).
Icono para el botón de la flecha derecha que aparece cuando hay demasiadas pestañas que no caben en el ancho del contenedor. Cuando el botón está desactivado (es decir, la última pestaña es visible) aparece semi-transparente.
Texture2D increment_highlight 🔗
Icono para el botón de la flecha derecha que aparece cuando hay demasiadas pestañas que no caben en el ancho del contenedor. Se utiliza cuando el cursor esta encima del botón.
Fondo de la pestaña y los botones de cierre cuando se está pasando el cursor sobre ellos.
Fondo de la pestaña y los botones de cierre cuando se están presionando.
El estilo de las pestañas desactivadas.
StyleBox que se usa cuando el TabBar tiene el foco. El StyleBox de tab_focus se muestra sobre el StyleBox base de la pestaña seleccionada, por lo que se debe usar un StyleBox parcialmente transparente para garantizar que el StyleBox base permanezca visible. Un StyleBox que representa un contorno o un subrayado funciona bien para este propósito. Para deshabilitar el efecto visual de foco, asigna un recurso StyleBoxEmpty. Ten en cuenta que deshabilitar el efecto visual de foco perjudicará la usabilidad de la navegación por teclado/controlador, por lo que no se recomienda por razones de accesibilidad.
The style of the currently hovered tab. Does not apply to the selected tab.
Note: This style will be drawn with the same width as tab_unselected at minimum.
El estilo de la pestaña actualmente seleccionada.
El estilo de las otras pestañas no seleccionadas.