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.

FoldableContainer

Успадковує: Container < Control < CanvasItem < Node < Object

Контейнер, який можна розгортати/згортати.

Опис

Контейнер, який можна розгортати/згортати, із заголовком, який можна заповнювати елементами керування, такими як кнопки. Це також називається акордеоном.

Заголовок можна розташувати у верхній або нижній частині контейнера. Контейнер можна розгортати або згортати, клацнувши на заголовку або натиснувши ui_accept, коли він у фокусі. Дочірні вузли керування приховані, коли контейнер згорнуто. Ігнорує дочірні елементи, які не є елементами керування.

FoldableContainer можна групувати з іншими FoldableContainer, щоб одночасно можна було відкрити лише один з них; див. foldable_group та FoldableGroup.

Властивості

FocusMode

focus_mode

2 (overrides Control)

FoldableGroup

foldable_group

bool

folded

false

String

language

""

MouseFilter

mouse_filter

0 (overrides Control)

String

title

""

HorizontalAlignment

title_alignment

0

TitlePosition

title_position

0

TextDirection

title_text_direction

0

OverrunBehavior

title_text_overrun_behavior

0

Методи

void

add_title_bar_control(control: Control)

void

expand()

void

fold()

void

remove_title_bar_control(control: Control)

Властивості теми

Color

collapsed_font_color

Color(1, 1, 1, 1)

Color

font_color

Color(0.875, 0.875, 0.875, 1)

Color

font_outline_color

Color(1, 1, 1, 1)

Color

hover_font_color

Color(0.95, 0.95, 0.95, 1)

int

h_separation

2

int

outline_size

0

Font

font

int

font_size

Texture2D

expanded_arrow

Texture2D

expanded_arrow_mirrored

Texture2D

folded_arrow

Texture2D

folded_arrow_mirrored

StyleBox

focus

StyleBox

panel

StyleBox

title_collapsed_hover_panel

StyleBox

title_collapsed_panel

StyleBox

title_hover_panel

StyleBox

title_panel


Сигнали

folding_changed(is_folded: bool) 🔗

Випромінюється, коли контейнер складається/розгортається.


Переліки

enum TitlePosition: 🔗

TitlePosition POSITION_TOP = 0

Змушує заголовок відображатися у верхній частині контейнера.

TitlePosition POSITION_BOTTOM = 1

Змушує заголовок відображатися внизу контейнера. Також робить так, щоб усі StyleBox відображалися вертикально.


Описи властивостей

FoldableGroup foldable_group 🔗

FoldableGroup, пов'язаний з контейнером. Коли кілька вузлів FoldableContainer належать до однієї групи, розгорнути дозволено лише один з них.


bool folded = false 🔗

  • void set_folded(value: bool)

  • bool is_folded()

If true, the container will become folded and will hide all its children.


String language = "" 🔗

  • void set_language(value: String)

  • String get_language()

Код мови, що використовується для алгоритмів формування тексту. Якщо залишити поле порожнім, використовується поточна локалізація.


String title = "" 🔗

  • void set_title(value: String)

  • String get_title()

Текст заголовка контейнера.


HorizontalAlignment title_alignment = 0 🔗

Горизонтальне вирівнювання тексту заголовка.


TitlePosition title_position = 0 🔗

Позиція титулу.


TextDirection title_text_direction = 0 🔗

Напрямок написання заголовного тексту.


OverrunBehavior title_text_overrun_behavior = 0 🔗

  • void set_title_text_overrun_behavior(value: OverrunBehavior)

  • OverrunBehavior get_title_text_overrun_behavior()

Визначає поведінку заголовка, коли текст перевищує доступний простір.


Описи методів

void add_title_bar_control(control: Control) 🔗

Додає елемент Control, який буде розміщено поруч із заголовком контейнера, закриваючи область клікабельності. Основне використання — додавання вузлів Button, але це може бути будь-який елемент Control.

Елемент керування буде додано як дочірній елемент цього контейнера та видалено з попереднього батьківського елемента, якщо необхідно. Елементи керування будуть розміщені з вирівнюванням праворуч, причому перший доданий елемент керування буде крайнім лівим.


void expand() 🔗

Розширює контейнер та випромінює folding_changed.


void fold() 🔗

Складає контейнер та випромінює folding_changed.


void remove_title_bar_control(control: Control) 🔗

Видаляє Control, доданий за допомогою add_title_bar_control(). Вузол не звільняється автоматично, вам потрібно використовувати Node.queue_free().


Описи тематичної нерухомості

Color collapsed_font_color = Color(1, 1, 1, 1) 🔗

Колір шрифту заголовка у згорнутому вигляді.


Color font_color = Color(0.875, 0.875, 0.875, 1) 🔗

Колір шрифту заголовка після розгортання.


Color font_outline_color = Color(1, 1, 1, 1) 🔗

Колір контуру шрифту заголовка.


Color hover_font_color = Color(0.95, 0.95, 0.95, 1) 🔗

Колір шрифту заголовка при наведенні курсора.


int h_separation = 2 🔗

Горизонтальне розділення між піктограмою та текстом заголовка, а також між елементами керування рядка заголовка.


int outline_size = 0 🔗

Розмір контуру шрифту заголовка.


Font font 🔗

Шрифт заголовка.


int font_size 🔗

Розмір шрифту заголовка.


Texture2D expanded_arrow 🔗

Піктограма заголовка, що використовується в розгорнутому вигляді.


Texture2D expanded_arrow_mirrored 🔗

Піктограма заголовка, яка використовується в розгорнутому вигляді (для нижнього заголовка).


Texture2D folded_arrow 🔗

Піктограма заголовка, що використовується у згорнутому вигляді (для макетів зліва направо).


Texture2D folded_arrow_mirrored 🔗

Піктограма заголовка, що використовується у згорнутому вигляді (для макетів справа наліво).


StyleBox focus 🔗

Фон використовується, коли FoldableContainer має фокус графічного інтерфейсу. Фокус StyleBox відображається поверх базового StyleBox, тому слід використовувати частково прозорий StyleBox, щоб базовий StyleBox залишався видимим. StyleBox, який представляє контур або підкреслення, добре підходить для цієї мети. Щоб вимкнути візуальний ефект фокусування, призначте ресурс StyleBoxEmpty. Зверніть увагу, що вимкнення візуального ефекту фокусування погіршить зручність навігації клавіатурою/контролером, тому це не рекомендується з міркувань доступності.


StyleBox panel 🔗

Фон за замовчуванням для FoldableContainer.


StyleBox title_collapsed_hover_panel 🔗

Фон, який використовується, коли курсор миші потрапляє в область заголовка у згорнутому вигляді.


StyleBox title_collapsed_panel 🔗

Фон за замовчуванням для заголовка FoldableContainer у згорнутому вигляді.


StyleBox title_hover_panel 🔗

Фон, який використовується, коли курсор миші потрапляє в область заголовка після розгортання.


StyleBox title_panel 🔗

Фон за замовчуванням для заголовка FoldableContainer у розгорнутому стані.