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.
Checking the stable version of the documentation...
AccessibilityServer
Eredita: Object
A server interface for screen reader support.
Metodi
Enumerazioni
enum AccessibilityRole: 🔗
AccessibilityRole ROLE_UNKNOWN = 0
Ruolo sconosciuto o personalizzato.
AccessibilityRole ROLE_DEFAULT_BUTTON = 1
Elemento pulsante di dialogo predefinito.
AccessibilityRole ROLE_AUDIO = 2
Elemento riproduttore audio.
AccessibilityRole ROLE_VIDEO = 3
Elemento riproduttore video.
AccessibilityRole ROLE_STATIC_TEXT = 4
Etichetta di testo non modificabile.
AccessibilityRole ROLE_CONTAINER = 5
Elemento contenitore. Gli elementi con questo ruolo sono utilizzati per la struttura interna e ignorati dai lettori dello schermo.
AccessibilityRole ROLE_PANEL = 6
Elemento contenitore di pannello.
AccessibilityRole ROLE_BUTTON = 7
Elemento pulsante.
AccessibilityRole ROLE_LINK = 8
Elemento collegamento.
AccessibilityRole ROLE_CHECK_BOX = 9
Elemento casella di spunta.
AccessibilityRole ROLE_RADIO_BUTTON = 10
Elemento pulsante di opzione (radio).
AccessibilityRole ROLE_CHECK_BUTTON = 11
Elemento pulsante di spunta.
AccessibilityRole ROLE_SCROLL_BAR = 12
Elemento barra di scorrimento.
AccessibilityRole ROLE_SCROLL_VIEW = 13
Elemento contenitore di scorrimento.
AccessibilityRole ROLE_SPLITTER = 14
Elemento maniglia di divisore di contenitore.
AccessibilityRole ROLE_SLIDER = 15
Elemento slider.
AccessibilityRole ROLE_SPIN_BUTTON = 16
Elemento casella numerica.
AccessibilityRole ROLE_PROGRESS_INDICATOR = 17
Elemento indicatore di progresso.
AccessibilityRole ROLE_TEXT_FIELD = 18
Elemento campo di testo modificabile.
AccessibilityRole ROLE_MULTILINE_TEXT_FIELD = 19
Elemento campo di testo modificabile su più righe.
AccessibilityRole ROLE_COLOR_PICKER = 20
Elemento selettore di colore.
AccessibilityRole ROLE_TABLE = 21
Elemento tabella.
AccessibilityRole ROLE_CELL = 22
Elemento cella di albero/tabella.
AccessibilityRole ROLE_ROW = 23
Elemento riga di albero/tabella.
AccessibilityRole ROLE_ROW_GROUP = 24
Elemento gruppo di righe di albero/tabella.
AccessibilityRole ROLE_ROW_HEADER = 25
Elemento intestazione di riga di tabella/albero.
AccessibilityRole ROLE_COLUMN_HEADER = 26
Elemento intestazione di colonna di tabella/albero.
AccessibilityRole ROLE_TREE = 27
Elemento vista di albero.
AccessibilityRole ROLE_TREE_ITEM = 28
Elemento elemento di vista di albero.
AccessibilityRole ROLE_LIST = 29
Elemento lista.
AccessibilityRole ROLE_LIST_ITEM = 30
Elemento elemento di lista.
AccessibilityRole ROLE_LIST_BOX = 31
Elemento vista di lista.
AccessibilityRole ROLE_LIST_BOX_OPTION = 32
Elemento elemento di vista di lista.
AccessibilityRole ROLE_TAB_BAR = 33
Elemento barra di schede.
AccessibilityRole ROLE_TAB = 34
Elemento elemento di barra di schede.
AccessibilityRole ROLE_TAB_PANEL = 35
Elemento pannello di scheda.
Elemento barra di menu.
Elemento menu popup.
Elemento voce di menu popup.
Elemento elemento di pulsante di spunta di menu popup.
Elemento elemento di pulsante di opzione (radio) di menu popup.
AccessibilityRole ROLE_IMAGE = 41
Elemento immagine.
AccessibilityRole ROLE_WINDOW = 42
Elemento finestra.
AccessibilityRole ROLE_TITLE_BAR = 43
Elemento barra del titolo incorporata nella finestra.
AccessibilityRole ROLE_DIALOG = 44
Elemento finestra di dialogo.
AccessibilityRole ROLE_TOOLTIP = 45
Elemento suggerimento.
AccessibilityRole ROLE_REGION = 46
Region/landmark element. Screen readers can navigate between regions using landmark navigation.
AccessibilityRole ROLE_TEXT_RUN = 47
Unifor text run.
Note: This role is used for internal text elements, and should not be assigned to nodes.
enum AccessibilityPopupType: 🔗
Elemento popup.
AccessibilityPopupType POPUP_LIST = 1
Lista popup.
AccessibilityPopupType POPUP_TREE = 2
Vista di albero popup.
AccessibilityPopupType POPUP_DIALOG = 3
Finestra di dialogo popup.
enum AccessibilityFlags: 🔗
L'elemento è nascosto per gli strumenti di accessibilità.
AccessibilityFlags FLAG_MULTISELECTABLE = 1
Element supports multiple item selection.
AccessibilityFlags FLAG_REQUIRED = 2
L'elemento richiede l'input dell'utente.
AccessibilityFlags FLAG_VISITED = 3
L'elemento è un link visitato.
AccessibilityFlags FLAG_BUSY = 4
Il contenuto dell'elemento non è pronto (ad esempio, in caricamento).
AccessibilityFlags FLAG_MODAL = 5
L'elemento è una finestra modale.
AccessibilityFlags FLAG_TOUCH_PASSTHROUGH = 6
L'elemento permette di trasmettere i tocchi quando un lettore dello schermo è in modalità di esplorazione tattile.
AccessibilityFlags FLAG_READONLY = 7
L'elemento è un campo di testo, con testo selezionabile ma di sola lettura.
AccessibilityFlags FLAG_DISABLED = 8
L'elemento è disabilitato.
AccessibilityFlags FLAG_CLIPS_CHILDREN = 9
L'elemento ritaglia i figli.
enum AccessibilityAction: 🔗
AccessibilityAction ACTION_CLICK = 0
Azione di solo clic, l'argomento del callback non è impostato.
AccessibilityAction ACTION_FOCUS = 1
Azione di focalizzazione, l'argomento del callback non è impostato.
AccessibilityAction ACTION_BLUR = 2
Azione di sfocatura, l'argomento del callback non è impostato.
AccessibilityAction ACTION_COLLAPSE = 3
Azione di compressione, l'argomento del callback non è impostato.
AccessibilityAction ACTION_EXPAND = 4
Azione di espansione, l'argomento del callback non è impostato.
AccessibilityAction ACTION_DECREMENT = 5
Azione di decremento, l'argomento del callback non è impostato.
AccessibilityAction ACTION_INCREMENT = 6
Azione di incremento, l'argomento del callback non è impostato.
AccessibilityAction ACTION_HIDE_TOOLTIP = 7
Azione per nascondere un suggerimento, l'argomento del callback non è impostato.
AccessibilityAction ACTION_SHOW_TOOLTIP = 8
Azione per mostrare un suggerimento, l'argomento del callback non è impostato.
AccessibilityAction ACTION_SET_TEXT_SELECTION = 9
Azione di selezione testo, l'argomento del callback è impostato su un Dictionary con le seguenti chiavi:
"start_element"elemento di accessibilità dell'inizio della selezione."start_char"offset di carattere relativo all'elemento di accessibilità dell'inizio della selezione."end_element"elemento di accessibilità della fine della selezione."end_char"offset di carattere relativo all'elemento di accessibilità della fine della selezione.
AccessibilityAction ACTION_REPLACE_SELECTED_TEXT = 10
Azione di sostituzione testo, l'argomento del callback è impostato su una String con il testo sostitutivo.
AccessibilityAction ACTION_SCROLL_BACKWARD = 11
Azione di scorrimento indietro, l'argomento del callback non è impostato.
AccessibilityAction ACTION_SCROLL_DOWN = 12
Azione di scorrimento in basso, l'argomento del callback è impostato su AccessibilityScrollUnit.
AccessibilityAction ACTION_SCROLL_FORWARD = 13
Azione di scorrimento in avanti, l'argomento del callback non è impostato.
AccessibilityAction ACTION_SCROLL_LEFT = 14
Azione di scorrimento a sinistra, l'argomento del callback è impostato su AccessibilityScrollUnit.
AccessibilityAction ACTION_SCROLL_RIGHT = 15
Azione di scorrimento a destra, l'argomento del callback è impostato su AccessibilityScrollUnit.
AccessibilityAction ACTION_SCROLL_UP = 16
Azione di scorrimento in alto, l'argomento del callback è impostato su AccessibilityScrollUnit.
AccessibilityAction ACTION_SCROLL_INTO_VIEW = 17
Azione di scorrimento in vista, l'argomento del callback è impostato su AccessibilityScrollHint.
AccessibilityAction ACTION_SCROLL_TO_POINT = 18
Azione di scorrimento fino a un punto, l'argomento del callback è impostato su un Vector2 con le coordinate relative del punto.
AccessibilityAction ACTION_SET_SCROLL_OFFSET = 19
Azione di offset dello scorrimento, l'argomento del callback è impostato su un Vector2 con l'offset.
AccessibilityAction ACTION_SET_VALUE = 20
Azione di impostazione di un valore, l'argomento del callback è impostato su una String o su un numero con il nuovo valore.
Azione per mostrare il menu contestuale, l'argomento del callback non è impostato.
AccessibilityAction ACTION_CUSTOM = 22
Azione personalizzata, l'argomento del callback è impostato sull'ID intero dell'azione.
enum AccessibilityLiveMode: 🔗
AccessibilityLiveMode LIVE_OFF = 0
Indica che gli aggiornamenti alla regione attiva non devono presentarsi.
AccessibilityLiveMode LIVE_POLITE = 1
Indica che gli aggiornamenti alla regione attiva devono presentarsi alla prossima occasione (ad esempio alla fine della frase attuale).
AccessibilityLiveMode LIVE_ASSERTIVE = 2
Indica che gli aggiornamenti alla regione attiva hanno la massima priorità e devono presentarsi immediatamente.
enum AccessibilityScrollUnit: 🔗
AccessibilityScrollUnit SCROLL_UNIT_ITEM = 0
La quantità da scorrere. Un singolo elemento di un elenco, una riga di testo.
AccessibilityScrollUnit SCROLL_UNIT_PAGE = 1
La quantità da scorrere. Una singola pagina.
enum AccessibilityScrollHint: 🔗
AccessibilityScrollHint SCROLL_HINT_TOP_LEFT = 0
Una posizione preferita per il nodo visualizzato tramite scorrimento. Il bordo superiore sinistro del contenitore di scorrimento.
AccessibilityScrollHint SCROLL_HINT_BOTTOM_RIGHT = 1
Una posizione preferita per il nodo visualizzato tramite scorrimento. Il bordo inferiore destro del contenitore di scorrimento.
AccessibilityScrollHint SCROLL_HINT_TOP_EDGE = 2
Una posizione preferita per il nodo visualizzato tramite scorrimento. Il bordo superiore del contenitore di scorrimento.
AccessibilityScrollHint SCROLL_HINT_BOTTOM_EDGE = 3
Una posizione preferita per il nodo visualizzato tramite scorrimento. Il bordo inferiore del contenitore di scorrimento.
AccessibilityScrollHint SCROLL_HINT_LEFT_EDGE = 4
Una posizione preferita per il nodo visualizzato tramite scorrimento. Il bordo sinistro del contenitore di scorrimento.
AccessibilityScrollHint SCROLL_HINT_RIGHT_EDGE = 5
Una posizione preferita per il nodo visualizzato tramite scorrimento. Il bordo destro del contenitore di scorrimento.
Descrizioni dei metodi
RID create_element(window_id: int, role: AccessibilityRole) 🔗
Crea una nuova risorsa vuota per gli elementi di accessibilità.
Nota: Un elemento di accessibilità viene creato e liberato automaticamente per ogni Node. In generale, questa funzione non si dovrebbe chiamare manualmente.
RID create_sub_element(parent_rid: RID, role: AccessibilityRole, insert_pos: int = -1) 🔗
Creates a new, empty accessibility sub-element resource. Sub-elements can be used to provide accessibility information for objects which are not Nodes, such as list items, table cells, or menu items. Sub-elements are freed automatically when the parent element is freed, or can be freed early using the free_element() method.
RID create_sub_text_edit_elements(parent_rid: RID, shaped_text: RID, min_height: float, insert_pos: int = -1, is_last_line: bool = false) 🔗
Crea un nuovo sotto-elemento di accessibilità vuoto dal buffer di testo sagomato. I sotto-elementi sono liberati automaticamente quando l'elemento padre è liberato, oppure si possono liberare in anticipo attraverso il metodo free_element().
Se is_last_line è impostato su true, non viene aggiunta alcuna nuova riga finale al contenuto del testo. Impostare su true per l'ultima riga nei campi di testo multilinea e per i campi di testo a riga singola.
Variant element_get_meta(id: RID) const 🔗
Returns the metadata of the accessibility element id.
void element_set_meta(id: RID, meta: Variant) 🔗
Sets the metadata of the accessibility element id to meta.
Frees the accessibility element id created by create_element(), create_sub_element(), or create_sub_text_edit_elements().
RID get_window_root(window_id: int) const 🔗
Restituisce l'elemento principale di accessibilità della finestra nativa del sistema operativo.
bool has_element(id: RID) const 🔗
Restituisce true se id è un elemento di accessibilità valido.
Returns true if screen reader is support by this implementation.
void set_window_focused(window_id: int, focused: bool) 🔗
Imposta lo stato di focalizzazione della finestra per le app assistive.
Nota: Questo metodo è implementato su macOS e Windows.
Nota: Questo metodo non è supportato dalle voci di menu del Dock di macOS.
void set_window_rect(window_id: int, rect_out: Rect2, rect_in: Rect2) 🔗
Imposta i limiti esterni (con decorazioni) e interni (senza decorazioni) della finestra per le applicazioni assistive.
Nota: Questo metodo è implementato su Linux, macOS e Windows.
Nota: Solo per utenti avanzati! Gli oggetti Window chiamano questo metodo automaticamente.
void update_add_action(id: RID, action: AccessibilityAction, callable: Callable) 🔗
Aggiunge un callback per l'azione di accessibilità (azione che si può effettuare attraverso un comando speciale in un lettore dello schermo o i pulsanti su un display Braille) e contrassegna questa azione come supportata. Il callback dell'azione riceve un argomento Variant, il cui valore dipende dal tipo di azione.
void update_add_child(id: RID, child_id: RID) 🔗
Aggiunge un elemento di accessibilità figlio.
Nota: I figli Node e i sotto-elementi sono aggiunti automaticamente all'elenco degli elementi figlio.
void update_add_custom_action(id: RID, action_id: int, action_description: String) 🔗
Aggiunge supporto per un'azione di accessibilità personalizzata. action_id è passato come argomento al callback dell'azione ACTION_CUSTOM.
Aggiunge un elemento che è controllato da questo elemento.
Aggiunge un elemento che descrive questo elemento.
Aggiunge un elemento che descrive in dettaglio questo elemento.
Aggiunge un elemento in cui fluisce questo elemento.
Aggiunge un elemento che etichetta questo elemento.
Aggiunge un elemento che fa parte dello stesso gruppo di opzioni (radio).
Nota: Questo metodo si dovrebbe chiamare su ogni elemento del gruppo, utilizzando tutti gli altri elementi come related_id.
void update_set_active_descendant(id: RID, other_id: RID) 🔗
Aggiunge un elemento che è un discendente attivo di questo elemento.
void update_set_background_color(id: RID, color: Color) 🔗
Imposta il colore di sfondo dell'elemento.
void update_set_bounds(id: RID, rect: Rect2) 🔗
Restituisce la bounding box dell'elemento, relativa alla posizione del nodo.
void update_set_braille_label(id: RID, name: String) 🔗
Sets element accessibility label for Braille display.
void update_set_braille_role_description(id: RID, description: String) 🔗
Sets element accessibility role description for Braille display.
void update_set_checked(id: RID, checekd: bool) 🔗
Imposta lo stato di spunta dell'elemento.
void update_set_classname(id: RID, classname: String) 🔗
Imposta il nome della classe dell'elemento.
void update_set_color_value(id: RID, color: Color) 🔗
Imposta il valore di colore dell'elemento.
void update_set_description(id: RID, description: String) 🔗
Imposta la descrizione d'accessibilità dell'elemento.
void update_set_error_message(id: RID, other_id: RID) 🔗
Imposta un elemento che contiene un messaggio di errore per questo elemento.
void update_set_extra_info(id: RID, name: String) 🔗
Imposta ulteriori informazioni d'accessibilità dell'elemento aggiunte al nome dell'elemento.
void update_set_flag(id: RID, flag: AccessibilityFlags, value: bool) 🔗
Imposta il flag dell'elemento.
void update_set_focus(id: RID) 🔗
Imposta l'elemento attualmente focalizzato.
void update_set_foreground_color(id: RID, color: Color) 🔗
Imposta il colore di primo piano dell'elemento.
void update_set_in_page_link_target(id: RID, other_id: RID) 🔗
Imposta l'elemento di destinazione per il collegamento.
void update_set_language(id: RID, language: String) 🔗
Imposta la lingua di testo dell'elemento.
void update_set_list_item_count(id: RID, size: int) 🔗
Imposta il numero di elementi nell'elenco.
void update_set_list_item_expanded(id: RID, expanded: bool) 🔗
Imposta lo stato espanso dell'elemento elenco/albero.
void update_set_list_item_index(id: RID, index: int) 🔗
Imposta la posizione dell'elemento nell'elenco.
void update_set_list_item_level(id: RID, level: int) 🔗
Imposta il livello gerarchico dell'elemento nell'elenco.
void update_set_list_item_selected(id: RID, selected: bool) 🔗
Imposta lo stato di spunta dell'elemento nell'elenco/albero.
void update_set_list_orientation(id: RID, vertical: bool) 🔗
Imposta l'orientazione degli elementi nell'elenco.
void update_set_live(id: RID, live: AccessibilityLiveMode) 🔗
Imposta la priorità degli aggiornamenti della regione attiva.
void update_set_member_of(id: RID, group_id: RID) 🔗
Imposta l'elemento come membro del gruppo.
void update_set_name(id: RID, name: String) 🔗
Imposta il nome di accessibilità dell'elemento.
void update_set_next_on_line(id: RID, other_id: RID) 🔗
Imposta l'elemento successivo sulla riga.
void update_set_num_jump(id: RID, jump: float) 🔗
Imposta il salto del valore numerico.
void update_set_num_range(id: RID, min: float, max: float) 🔗
Imposta l'intervallo del valore numerico.
void update_set_num_step(id: RID, step: float) 🔗
Imposta il passo del valore numerico.
void update_set_num_value(id: RID, position: float) 🔗
Imposta il valore numerico.
void update_set_placeholder(id: RID, placeholder: String) 🔗
Imposta il testo segnaposto.
void update_set_popup_type(id: RID, popup: AccessibilityPopupType) 🔗
Imposta il tipo di popup per i pulsanti popup.
void update_set_previous_on_line(id: RID, other_id: RID) 🔗
Imposta l'elemento precedente sulla riga.
void update_set_role(id: RID, role: AccessibilityRole) 🔗
Imposta il ruolo dell'elemento di accessibilità.
void update_set_role_description(id: RID, description: String) 🔗
Imposta il testo descrittivo per il ruolo dell'elemento di accessibilità.
void update_set_scroll_x(id: RID, position: float) 🔗
Imposta la posizione in x della barra di scorrimento.
void update_set_scroll_x_range(id: RID, min: float, max: float) 🔗
Imposta l'intervallo in x della barra di scorrimento.
void update_set_scroll_y(id: RID, position: float) 🔗
Imposta la posizione in y della barra di scorrimento.
void update_set_scroll_y_range(id: RID, min: float, max: float) 🔗
Imposta l'intervallo in y della barra di scorrimento.
void update_set_shortcut(id: RID, shortcut: String) 🔗
Imposta la lista delle scorciatoie da tastiera utilizzate dall'elemento.
void update_set_state_description(id: RID, description: String) 🔗
Imposta una descrizione leggibile in chiaro dello stato di spunta attuale.
void update_set_table_cell_position(id: RID, row_index: int, column_index: int) 🔗
Imposta la posizione nella tabella.
void update_set_table_cell_span(id: RID, row_span: int, column_span: int) 🔗
Imposta la spaziatura tra righe/colonne delle celle.
void update_set_table_column_count(id: RID, count: int) 🔗
Imposta il numero di colonne nella tabella.
void update_set_table_column_index(id: RID, index: int) 🔗
Imposta la posizione della colonna.
void update_set_table_row_count(id: RID, count: int) 🔗
Imposta il numero di righe nella tabella.
void update_set_table_row_index(id: RID, index: int) 🔗
Imposta la posizione della colonna nella tabella.
void update_set_text_align(id: RID, align: HorizontalAlignment) 🔗
Imposta l'allineamento del testo dell'elemento.
void update_set_text_decorations(id: RID, underline: bool, strikethrough: bool, overline: bool, color: Color = Color(0, 0, 0, 1)) 🔗
Imposta il testo sottolineato/sopralineato/barrato.
void update_set_text_orientation(id: RID, vertical: bool) 🔗
Imposta l'orientazione del testo.
void update_set_text_selection(id: RID, text_start_id: RID, start_char: int, text_end_id: RID, end_char: int) 🔗
Sets text selection to the text field. text_start_id and text_end_id should be elements created by create_sub_text_edit_elements(). Character offsets are relative to the corresponding element.
void update_set_tooltip(id: RID, tooltip: String) 🔗
Imposta il testo del tooltip.
void update_set_transform(id: RID, transform: Transform2D) 🔗
Imposta la trasformazione 2D dell'elemento.
void update_set_url(id: RID, url: String) 🔗
Imposta l'URL di un collegamento.
void update_set_value(id: RID, value: String) 🔗
Imposta il valore del testo dell'elemento.