StyleBox¶

Inherits: Resource < Reference < Object

Inherited By: StyleBoxEmpty, StyleBoxFlat, StyleBoxLine, StyleBoxTexture

Clase base para dibujar cajas estilizadas para la UI.

Descripción¶

StyleBox is Resource that provides an abstract base class for drawing stylized boxes for the UI. StyleBoxes are used for drawing the styles of buttons, line edit backgrounds, tree backgrounds, etc. and also for testing a transparency mask for pointer signals. If mask test fails on a StyleBox assigned as mask to a control, clicks and motion signals will go through it to the one below.

Note: For children of Control that have Theme Properties, the focus StyleBox is displayed over the normal, hover or pressed StyleBox. This makes the focus StyleBox more reusable across different nodes.

Propiedades¶

float	content_margin_bottom	`-1.0`
float	content_margin_left	`-1.0`
float	content_margin_right	`-1.0`
float	content_margin_top	`-1.0`

Métodos¶

void	draw ( RID canvas_item, Rect2 rect ) const
Vector2	get_center_size ( ) const
CanvasItem	get_current_item_drawn ( ) const
float	get_default_margin ( Margin margin ) const
float	get_margin ( Margin margin ) const
Vector2	get_minimum_size ( ) const
Vector2	get_offset ( ) const
void	set_default_margin ( Margin margin, float offset )
bool	test_mask ( Vector2 point, Rect2 rect ) const

Descripciones de Propiedades¶

float content_margin_bottom

Default	`-1.0`
Setter	set_default_margin(value)
Getter	get_default_margin()

El margen inferior para el contenido de esta caja de estilo. Aumentando este valor se reduce el espacio disponible para los contenidos desde la parte inferior.

Si este valor es negativo, se ignora y en su lugar se utiliza un margen específico para el niño. Por ejemplo, para StyleBoxFlat se utiliza en su lugar el grosor del borde (si lo hay).

Depende del código que utilice este cuadro de estilo decidir cuáles son estos contenidos: por ejemplo, un Button respeta este margen de contenido para el contenido textual del botón.

El get_margin debe ser usado para obtener este valor como consumidor en lugar de leer estas propiedades directamente. Esto se debe a que respeta correctamente los valores negativos y la solución alternativa mencionada anteriormente.

float content_margin_left

Default	`-1.0`
Setter	set_default_margin(value)
Getter	get_default_margin()

The left margin for the contents of this style box. Increasing this value reduces the space available to the contents from the left.

Refer to content_margin_bottom for extra considerations.

float content_margin_right

Default	`-1.0`
Setter	set_default_margin(value)
Getter	get_default_margin()

El margen derecho para el contenido de esta caja de estilo. Aumentando este valor se reduce el espacio disponible para los contenidos de la derecha.

Consulte content_margin_bottom para consideraciones adicionales.

float content_margin_top

Default	`-1.0`
Setter	set_default_margin(value)
Getter	get_default_margin()

El margen superior para el contenido de esta caja de estilo. Aumentando este valor se reduce el espacio disponible para los contenidos desde la parte superior.

Consulte content_margin_bottom para consideraciones adicionales.

Descripciones de Métodos¶

void draw ( RID canvas_item, Rect2 rect ) const

Dibuja este cuadro de estilo usando un CanvasItem con un RID dado.

Puedes obtener un valor RID usando el Object.get_instance_id en un nodo derivado de CanvasItem.

Vector2 get_center_size ( ) const

Devuelve el tamaño de este StyleBox sin los márgenes.

CanvasItem get_current_item_drawn ( ) const

Devuelve el CanvasItem que maneja su CanvasItem.NOTIFICATION_DRAW o CanvasItem._draw llamada en este momento.

float get_default_margin ( Margin margin ) const

Devuelve el valor por defecto del especificado Margin.

float get_margin ( Margin margin ) const

Devuelve el desplazamiento del margen de contenido para el especificado Margin.

Los valores positivos reducen el tamaño hacia adentro, a diferencia de los valores de margen de Control.

Vector2 get_minimum_size ( ) const

Devuelve el tamaño mínimo al que se puede reducir esta caja de estilo.

Vector2 get_offset ( ) const

Devuelve el "desplazamiento" de una caja de estilo. Esta función de ayuda devuelve un valor equivalente a Vector2(style.get_margin(MARGIN_LEFT), style.get_margin(MARGIN_TOP)).

void set_default_margin ( Margin margin, float offset )

Establece el valor por defecto del Margin especificado a un desplazamiento dado en píxeles.

bool test_mask ( Vector2 point, Rect2 rect ) const

Pruebe una posición en un rectángulo, vuelva si pasa la prueba de la máscara.