SplitContainer

Hérite de : Container < Control < CanvasItem < Node < Object

Hérité par : HSplitContainer, VSplitContainer

A container that splits two child controls horizontally or vertically and provides a grabber for adjusting the split ratio.

Description

Un conteneur qui n'accepte que deux contrôles enfants, puis les arrange horizontalement ou verticalement et crée un diviseur entre eux. Le diviseur peut être déplacer pour changer la relation de taille entre les contrôles enfants.

Tutoriels

Propriétés

bool

collapsed

false

bool

drag_area_highlight_in_editor

false

int

drag_area_margin_begin

0

int

drag_area_margin_end

0

int

drag_area_offset

0

DraggerVisibility

dragger_visibility

0

bool

dragging_enabled

true

int

split_offset

0

bool

touch_dragger_enabled

false

bool

vertical

false

Méthodes

void

clamp_split_offset()

Control

get_drag_area_control()

Propriétés du thème

Color

touch_dragger_color

Color(1, 1, 1, 0.3)

Color

touch_dragger_hover_color

Color(1, 1, 1, 0.6)

Color

touch_dragger_pressed_color

Color(1, 1, 1, 1)

int

autohide

1

int

minimum_grab_thickness

6

int

separation

12

Texture2D

grabber

Texture2D

h_grabber

Texture2D

h_touch_dragger

Texture2D

touch_dragger

Texture2D

v_grabber

Texture2D

v_touch_dragger

StyleBox

split_bar_background


Signaux

drag_ended() 🔗

Émis lorsque l'utilisateur arrête le glissement.


drag_started() 🔗

Émis lorsque l'utilisateur commence un glissement.


dragged(offset: int) 🔗

Émis lorsque le dragueur est glissé par l'utilisateur.


Énumérations

enum DraggerVisibility: 🔗

DraggerVisibility DRAGGER_VISIBLE = 0

L'icône de l’ascenseur de séparation est toujours visible lorsque autohide vaut false, sinon visible seulement lorsque le curseur le survole.

La taille de l'icône de l'ascenseur détermine la séparation minimale separation.

L'icône de l'ascenseur est automatiquement cachée si la longueur de l'icône de l'ascenseur est plus longue que la barre de séparation.

DraggerVisibility DRAGGER_HIDDEN = 1

L'icône de l’ascenseur de séparation n'est jamais visible peu importe la valeur de autohide.

La taille de l'icône de l'ascenseur détermine la séparation minimale separation.

DraggerVisibility DRAGGER_HIDDEN_COLLAPSED = 2

L'icône de l’ascenseur de séparation n'est pas visible, et la barre de séparation est réduite à une épaisseur nulle.


Descriptions des propriétés

bool collapsed = false 🔗

  • void set_collapsed(value: bool)

  • bool is_collapsed()

Si true, l’ascenseur sera désactivé et les enfants seront dimensionnés comme si split_offset valait 0.


bool drag_area_highlight_in_editor = false 🔗

  • void set_drag_area_highlight_in_editor(value: bool)

  • bool is_drag_area_highlight_in_editor_enabled()

Fait ressortir le Rect2 de la zone de glissement pour que vous puissiez voir où elle est pendant le développement. La zone de glissement est en or si dragging_enabled vaut true, et rouge si false.


int drag_area_margin_begin = 0 🔗

  • void set_drag_area_margin_begin(value: int)

  • int get_drag_area_margin_begin()

Réduit la taille de la zone de glissement et de la barre de séparation split_bar_background au début du conteneur.


int drag_area_margin_end = 0 🔗

  • void set_drag_area_margin_end(value: int)

  • int get_drag_area_margin_end()

Réduit la taille de la zone de glissement et de la barre de séparation split_bar_background à la fin du conteneur.


int drag_area_offset = 0 🔗

  • void set_drag_area_offset(value: int)

  • int get_drag_area_offset()

Décale la zone de glissement dans l'axe du conteneur pour empêcher la zone de glissement de recouvrir la ScrollBar ou tout autre Control sélectionnable d'un nœud enfant.


DraggerVisibility dragger_visibility = 0 🔗

Détermine la visibilité de l’ascenseur. Cette propriété ne détermine pas si le glissement est activé ou non. Utilisez dragging_enabled pour cela.


bool dragging_enabled = true 🔗

  • void set_dragging_enabled(value: bool)

  • bool is_dragging_enabled()

Active ou désactive le glissement de la séparation.


int split_offset = 0 🔗

  • void set_split_offset(value: int)

  • int get_split_offset()

Le décalage initial de la séparation entre les deux Control, avec 0 étant la fin du premier Control.


bool touch_dragger_enabled = false 🔗

  • void set_touch_dragger_enabled(value: bool)

  • bool is_touch_dragger_enabled()

Si true, une poignée de glissement adaptée au tactile sera activée pour une meilleure utilisabilité sur les écrans plus petits. Contrairement à l'ascenseur standard, cette poignée de glissement recouvre les enfants du SplitContainer et n'affecte pas leur séparation minimale. L'ascenseur standard ne sera plus dessiné lorsque cette option sera activée.


bool vertical = false 🔗

  • void set_vertical(value: bool)

  • bool is_vertical()

Si true, le SplitContainer arrangera ses enfants verticalement, plutôt que horizontalement.

Ne peut être changé lors de l'utilisation de HSplitContainer et de VSplitContainer.


Descriptions des méthodes

void clamp_split_offset() 🔗

Borne la valeur split_offset pour rester dans l'intervalle défini entre les valeurs minimale et maximale actuellement possibles.


Control get_drag_area_control() 🔗

Returns the drag area Control. For example, you can move a pre-configured button into the drag area Control so that it rides along with the split bar. Try setting the Button anchors to center prior to the reparent() call.

$BarnacleButton.reparent($SplitContainer.get_drag_area_control())

Note: The drag area Control is drawn over the SplitContainer's children, so CanvasItem draw objects called from the Control and children added to the Control will also appear over the SplitContainer's children. Try setting Control.mouse_filter of custom children to Control.MOUSE_FILTER_IGNORE to prevent blocking the mouse from dragging if desired.

Warning: This is a required internal node, removing and freeing it may cause a crash.


Descriptions des propriétés du thème

Color touch_dragger_color = Color(1, 1, 1, 0.3) 🔗

La couleur de l’ascenseur tactile.


Color touch_dragger_hover_color = Color(1, 1, 1, 0.6) 🔗

La couleur de l’ascenseur tactile lorsque survolé.


Color touch_dragger_pressed_color = Color(1, 1, 1, 1) 🔗

La couleur de l’ascenseur tactile lorsqu'appuyé.


int autohide = 1 🔗

Valeur booléenne. Si 1 (true), l'ascenseur sera automatiquement caché quand il n'est pas sous le curseur. Si 0 (false), il sera toujours visible. dragger_visibility doit valoir DRAGGER_VISIBLE.


int minimum_grab_thickness = 6 🔗

L'épaisseur minimale de la zone dans laquelle les utilisateurs peuvent cliquer pour saisir la barre de séparation. Cela garantit que la barre de séparation peut encore être glissée si la taille de separation ou h_grabber / v_grabber est trop fine pour être sélectionnée facilement.


int separation = 12 🔗

L'épaisseur de la barre de séparation, c'est-à-dire l'écart entre les deux enfants du conteneur. Cela est redéfinie par la taille de l'icône de l'ascenseur si dragger_visibility est défini à DRAGGER_VISIBLE, ou DRAGGER_HIDDEN, et separation est plus petit que la taille de l'icône de l'ascenseur dans le même axe.

Note : Pour obtenir des valeurs de separation inférieures à la taille de l'icône de l'ascenseur, par exemple une ligne de 1 px, définissez h_grabber ou v_grabber à une nouvelle ImageTexture, ce qui fixe effectivement la taille de l'icône de l'ascenseur à 0 px.


Texture2D grabber 🔗

L'icône utilisée pour l'ascenseur dessiné dans le milieu. Ceci est utilisé uniquement dans HSplitContainer et VSplitContainer. Pour SplitContainer, voir h_grabber et v_grabber à la place.


Texture2D h_grabber 🔗

L'icône utilisée pour le séparateur dessiné dans la zone du milieu lorsque vertical vaut false.


Texture2D h_touch_dragger 🔗

L'icône utilisée pour la poignée à glisser lorsque touch_dragger_enabled vaut true et que vertical vaut false.


Texture2D touch_dragger 🔗

L'icône utilisée pour la poignée de glissement lorsque touch_dragger_enabled vaut true. Ceci est utilisé uniquement dans HSplitContainer et VSplitContainer. Pour SplitContainer, voir h_touch_dragger et v_touch_dragger à la place.


Texture2D v_grabber 🔗

L'icône utilisée pour le séparateur dessiné dans la zone du milieu lorsque vertical vaut true.


Texture2D v_touch_dragger 🔗

L'icône utilisée pour la poignée à glisser lorsque touch_dragger_enabled vaut true et que vertical vaut true.


StyleBox split_bar_background 🔗

Détermine le fond de la barre de séparation si son épaisseur est supérieure à zéro.