Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

StyleBox

Eredita: Resource < RefCounted < Object

Ereditato da: StyleBoxEmpty, StyleBoxFlat, StyleBoxLine, StyleBoxTexture

Classe di base astratta per definire box stilizzati per gli elementi dell'interfaccia utente.

Descrizione

StyleBox è una classe di base astratta per disegnare box stilizzati per elementi UI. È utilizzata per i pannelli, i pulsanti, gli sfondi dei LineEdit e dei Tree, ecc. e anche per testare una maschera di trasparenza per i segnali del cursore. Se il test della maschera fallisce su uno StyleBox assegnato come maschera a un controllo, i clic e i segnali di movimento gli passeranno attraverso per raggiungere il controllo sottostante.

Nota: Per i nodi di controllo che hanno Proprietà del tema, lo StyleBox focus viene visualizzato sopra lo StyleBox normal, hover o pressed. Ciò rende lo StyleBox focus più riutilizzabile su nodi diversi.

Proprietà

float

content_margin_bottom

-1.0

float

content_margin_left

-1.0

float

content_margin_right

-1.0

float

content_margin_top

-1.0

Metodi

void

_draw(to_canvas_item: RID, rect: Rect2) virtual required const

Rect2

_get_draw_rect(rect: Rect2) virtual const

Vector2

_get_minimum_size() virtual const

bool

_test_mask(point: Vector2, rect: Rect2) virtual const

void

draw(canvas_item: RID, rect: Rect2) const

float

get_content_margin(margin: Side) const

CanvasItem

get_current_item_drawn() const

float

get_margin(margin: Side) const

Vector2

get_minimum_size() const

Vector2

get_offset() const

void

set_content_margin(margin: Side, offset: float)

void

set_content_margin_all(offset: float)

bool

test_mask(point: Vector2, rect: Rect2) const


Descrizioni delle proprietà

float content_margin_bottom = -1.0 🔗

  • void set_content_margin(margin: Side, offset: float)

  • float get_content_margin(margin: Side) const

Il margine inferiore per il contenuto di questo style box. Aumentando questo valore si riduce lo spazio disponibile per il contenuto dal basso.

Se questo valore è negativo, è ignorato e al suo posto viene utilizzato un margine specifico per classe figlia. Ad esempio, per StyleBoxFlat, è utilizzato lo spessore del bordo (se presente).

Spetta al codice che utilizza questo style box di decidere quali siano questi contenuti: ad esempio, un Button rispetta questo margine di contenuto per il contenuto testuale del pulsante.

Si dovrebbe usare get_margin() per recuperare questo valore come consumatore anziché leggere direttamente queste proprietà. Questo perché rispetta correttamente i valori negativi e l'alternativa menzionata sopra.


float content_margin_left = -1.0 🔗

  • void set_content_margin(margin: Side, offset: float)

  • float get_content_margin(margin: Side) const

Il margine sinistro per il contenuto di questo style box. Aumentando questo valore si riduce lo spazio disponibile per il contenuto da sinistra.

Consulta content_margin_bottom per ulteriori considerazioni.


float content_margin_right = -1.0 🔗

  • void set_content_margin(margin: Side, offset: float)

  • float get_content_margin(margin: Side) const

Il margine destro per il contenuto di questo style box. Aumentando questo valore si riduce lo spazio disponibile per il contenuto da destra.

Consulta content_margin_bottom per ulteriori considerazioni.


float content_margin_top = -1.0 🔗

  • void set_content_margin(margin: Side, offset: float)

  • float get_content_margin(margin: Side) const

Il margine superiore per il contenuto di questo style box. Aumentando questo valore si riduce lo spazio disponibile per il contenuto dall'alto.

Consulta content_margin_bottom per ulteriori considerazioni.


Descrizioni dei metodi

void _draw(to_canvas_item: RID, rect: Rect2) virtual required const 🔗

There is currently no description for this method. Please help us by contributing one!


Rect2 _get_draw_rect(rect: Rect2) virtual const 🔗

There is currently no description for this method. Please help us by contributing one!


Vector2 _get_minimum_size() virtual const 🔗

Metodo virtuale da implementare dall'utente. Restituisce le dimensioni minime personalizzate che lo stylebox deve rispettare durante il disegno. Come predefinito, get_minimum_size() tiene conto solo dei margini del contenuto. È possibile sovrascrivere questo metodo per aggiungere un'altra restrizione sulle dimensioni. Verrà utilizzata una combinazione del comportamento predefinito e del risultato di questo metodo, compensando per entrambi.


bool _test_mask(point: Vector2, rect: Rect2) virtual const 🔗

There is currently no description for this method. Please help us by contributing one!


void draw(canvas_item: RID, rect: Rect2) const 🔗

Disegna questo stylebox utilizzando un elemento canvas identificato dal RID specificato.

Il valore RID può essere il risultato di CanvasItem.get_canvas_item() chiamato su un nodo esistente derivato da CanvasItem, oppure direttamente dalla creazione di un elemento canvas nel RenderingServer con RenderingServer.canvas_item_create().


float get_content_margin(margin: Side) const 🔗

Restituisce il margine predefinito del lato specificato con Side.


CanvasItem get_current_item_drawn() const 🔗

Restituisce l'elemento CanvasItem che gestisce il suo callback CanvasItem.NOTIFICATION_DRAW o CanvasItem._draw() in questo momento.


float get_margin(margin: Side) const 🔗

Restituisce l'offset del margine del contenuto per il lato (Side) specificato.

I valori positivi riducono le dimensioni verso l'interno, a differenza dei valori del margine di Control.


Vector2 get_minimum_size() const 🔗

Restituisce le dimensioni minime alle quali può essere ridotto questo stylebox.


Vector2 get_offset() const 🔗

Restituisce l'"offset" di uno stylebox. Questa funzione di supporto restituisce un valore equivalente a Vector2(style.get_margin(MARGIN_LEFT), style.get_margin(MARGIN_TOP)).


void set_content_margin(margin: Side, offset: float) 🔗

Imposta il valore predefinito del lato specificato con Side a offset in pixel.


void set_content_margin_all(offset: float) 🔗

Imposta il margine predefinito su offset pixel per tutti i lati.


bool test_mask(point: Vector2, rect: Rect2) const 🔗

Testa una posizione in un rettangolo, restituisce se supera il test della maschera.