API v0.2.0
Window creation / startup configuration
mod window:
enum StyleCursor
Alias
AllScroll
Cell
ColResize
ContextMenu
Copy
Crosshair
Default
EResize
EwResize
Grab
Grabbing
Help
Move
NResize
NsResize
NeswResize
NwseResize
Pointer
Progress
RowResize
SResize
SeResize
Text
Unset
VerticalText
WResize
Wait
ZoomIn
ZoomOut
enum WindowEventFilter
MouseOver
MouseDown
LeftMouseDown
RightMouseDown
MiddleMouseDown
MouseUp
LeftMouseUp
RightMouseUp
MiddleMouseUp
MouseEnter
MouseLeave
Scroll
ScrollStart
ScrollEnd
TextInput
VirtualKeyDown
VirtualKeyUp
HoveredFile
DroppedFile
HoveredFileCancelled
Resized
Moved
TouchStart
TouchMove
TouchEnd
TouchCancel
FocusReceived
FocusLost
CloseRequested
ThemeChanged
WindowFocusReceived
WindowFocusLost
PenDown
PenMove
PenUp
PenEnter
PenLeave
PenSqueeze
PenDoubleTap
PenHover
GeolocationFix
GeolocationError
SensorChanged
GamepadInput
DragStart
Drag
DragEnd
DragEnter
DragOver
DragLeave
Drop
DoubleClick
LongPress
SwipeLeft
SwipeRight
SwipeUp
SwipeDown
PinchIn
PinchOut
RotateClockwise
RotateCounterClockwise
DpiChanged
MonitorChanged
struct HidpiAdjustedBounds
logical_size: LogicalSize
hidpi_factor: DpiScaleFactor
constructor from_bounds:
arg bounds: LayoutSize
arg hidpi_factor: DpiScaleFactor
&self
fn get_logical_size:
&self
-> LogicalSize
fn get_hidpi_factor:
&self
enum WindowTheme
DarkMode
LightMode
struct DpiScaleFactor
inner: FloatValue
enum MouseCursorType
Default
Crosshair
Hand
Arrow
Move
Text
Wait
Help
Progress
NotAllowed
ContextMenu
Cell
VerticalText
Alias
Copy
NoDrop
Grab
Grabbing
AllScroll
ZoomIn
ZoomOut
EResize
NResize
NeResize
NwResize
SResize
SeResize
SwResize
WResize
EwResize
NsResize
NeswResize
NwseResize
ColResize
RowResize
enum WindowFrame
Normal
Minimized
Maximized
Fullscreen
struct LinuxWindowOptions has destructor
wayland_theme: OptionWaylandTheme
window_icon: OptionWindowIcon
x11_gtk_theme_variant: OptionString
wayland_app_id: OptionString
x11_wm_classes: StringPairVec
x11_window_types: XWindowTypeVec
x11_visual: OptionX11Visual
x11_resize_increments: OptionLogicalSize
x11_base_size: OptionLogicalSize
x11_screen: OptionI32
request_user_attention: UserAttentionType
x11_decorations_state: OptionLinuxDecorationsState
x11_override_redirect: bool
struct WaylandTheme has destructor
title_bar_active_background_color: ColorU
title_bar_active_separator_color: ColorU
title_bar_active_text_color: ColorU
title_bar_inactive_background_color: ColorU
title_bar_inactive_separator_color: ColorU
title_bar_inactive_text_color: ColorU
maximize_idle_foreground_inactive_color: ColorU
minimize_idle_foreground_inactive_color: ColorU
close_idle_foreground_inactive_color: ColorU
maximize_hovered_foreground_inactive_color: ColorU
minimize_hovered_foreground_inactive_color: ColorU
close_hovered_foreground_inactive_color: ColorU
maximize_disabled_foreground_inactive_color: ColorU
minimize_disabled_foreground_inactive_color: ColorU
close_disabled_foreground_inactive_color: ColorU
maximize_idle_background_inactive_color: ColorU
minimize_idle_background_inactive_color: ColorU
close_idle_background_inactive_color: ColorU
maximize_hovered_background_inactive_color: ColorU
minimize_hovered_background_inactive_color: ColorU
close_hovered_background_inactive_color: ColorU
maximize_disabled_background_inactive_color: ColorU
minimize_disabled_background_inactive_color: ColorU
close_disabled_background_inactive_color: ColorU
maximize_idle_foreground_active_color: ColorU
minimize_idle_foreground_active_color: ColorU
close_idle_foreground_active_color: ColorU
maximize_hovered_foreground_active_color: ColorU
minimize_hovered_foreground_active_color: ColorU
close_hovered_foreground_active_color: ColorU
maximize_disabled_foreground_active_color: ColorU
minimize_disabled_foreground_active_color: ColorU
close_disabled_foreground_active_color: ColorU
maximize_idle_background_active_color: ColorU
minimize_idle_background_active_color: ColorU
close_idle_background_active_color: ColorU
maximize_hovered_background_active_color: ColorU
minimize_hovered_background_active_color: ColorU
close_hovered_background_active_color: ColorU
maximize_disabled_background_active_color: ColorU
minimize_disabled_background_active_color: ColorU
close_disabled_background_active_color: ColorU
title_bar_font: String
title_bar_font_size: f32
enum UserAttentionType
None
Critical
Informational
struct MonitorId
index: usize
hash: u64
struct WindowFlags
frame: WindowFrame
decorations: WindowDecorations
background_material: WindowBackgroundMaterial
window_type: WindowType
close_requested: bool
is_visible: bool
is_always_on_top: bool
is_resizable: bool
has_focus: bool
smooth_scroll_enabled: bool
autotab_enabled: bool
has_decorations: bool
use_native_menus: bool
use_native_context_menus: bool
is_top_level: bool
prevent_system_sleep: bool
fullscreen_mode: FullScreenMode
struct TaskBarIcon has destructor
key: IconKey
rgba_bytes: U8Vec
struct WasmWindowOptions
_reserved: u8
struct SmallWindowIconBytes has destructor
key: IconKey
rgba_bytes: U8Vec
struct Monitor has destructor
monitor_id: MonitorId
monitor_name: OptionString
size: LayoutSize
position: LayoutPoint
scale_factor: f64
work_area: LayoutRect
video_modes: VideoModeVec
is_primary_monitor: bool
struct IconKey
icon_id: usize
enum HwAcceleration
Enabled
Disabled
DontCare
struct MacWindowOptions
_reserved: u8
enum Vsync
Enabled
Disabled
DontCare
struct VideoMode
size: LayoutSize
bit_depth: u16
refresh_rate: u16
struct LargeWindowIconBytes has destructor
key: IconKey
rgba_bytes: U8Vec
enum XWindowType
Desktop
Dock
Toolbar
Menu
Utility
Splash
Dialog
DropdownMenu
PopupMenu
Tooltip
Notification
Combo
Dnd
Normal
struct PlatformSpecificOptions has destructor
windows_options: WindowsWindowOptions
linux_options: LinuxWindowOptions
mac_options: MacWindowOptions
wasm_options: WasmWindowOptions
union enum WindowIcon has destructor
Small(SmallWindowIconBytes)
Large(LargeWindowIconBytes)
struct WindowSize
dimensions: LogicalSize
dpi: u32
min_dimensions: OptionLogicalSize
max_dimensions: OptionLogicalSize
struct WindowsWindowOptions has destructor
allow_drag_and_drop: bool
no_redirection_bitmap: bool
window_icon: OptionWindowIcon
taskbar_icon: OptionTaskBarIcon
parent_window: OptionHwndHandle
enum WindowType
Normal
Menu
Tooltip
Dialog
struct WindowCreateOptions has destructor
window_state: FullWindowState
create_callback: OptionCallback
renderer: OptionRendererOptions
theme: OptionWindowTheme
size_to_content: bool
hot_reload: bool
constructor create:
arg layout_callback: LayoutCallbackType
Create a new WindowCreateOptions with a layout callback
struct FullWindowState has destructor
platform_specific_options: PlatformSpecificOptions
keyboard_state: KeyboardState
window_id: String
title: String
close_callback: OptionCallback
layout_callback: LayoutCallback
position: WindowPosition
touch_state: TouchState
size: WindowSize
flags: WindowFlags
mouse_state: MouseState
theme: WindowTheme
ime_position: ImePosition
renderer_options: RendererOptions
monitor_id: OptionU32
debug_state: DebugState
background_color: OptionColorU
window_focused: bool
active_route: OptionRouteMatch
struct IOSHandle
ui_window: c_void
ui_view: c_void
ui_view_controller: c_void
union enum RawWindowHandle
IOS(IOSHandle)
MacOS(MacOSHandle)
Xlib(XlibHandle)
Xcb(XcbHandle)
Wayland(WaylandHandle)
Windows(WindowsHandle)
Web(WebHandle)
Android(AndroidHandle)
Unsupported
struct MacOSHandle
ns_window: c_void
ns_view: c_void
struct XcbHandle
window: u32
connection: c_void
struct TextCursor
cluster_id: GraphemeClusterId
affinity: CursorAffinity
struct XlibHandle
window: u64
display: c_void
struct WaylandHandle
surface: c_void
display: c_void
struct WindowsHandle
hwnd: c_void
hinstance: c_void
struct WebHandle
id: u32
struct AndroidHandle
a_native_window: c_void
enum CursorAffinity
Leading
Trailing
enum CursorMovement
Left
Right
Up
Down
WordLeft
WordRight
LineStart
LineEnd
DocumentStart
DocumentEnd
Absolute
struct TextOpMoveCursor
old_position: CursorPosition
new_position: CursorPosition
movement: CursorMovement
Theme condition for light/dark mode styling
union enum ThemeCondition has destructor
Light
Dark
Custom(String)
SystemPreferred
union enum Platform has destructor
Windows
MacOs
Linux(DesktopEnvironment)
Android
Ios
Unknown
enum Theme
Light
Dark
struct IconProviderHandle
inner: c_void
constructor create:
constructor with_resolver:
arg resolver: IconResolverCallbackType
Create a new empty icon provider with the default resolver
Create with a custom resolver callback
fn set_resolver:
&mut self
arg resolver: IconResolverCallbackType
fn register_icon:
fn unregister_icon:
fn unregister_pack:
&mut self
arg pack_name: String
fn lookup:
&self
arg icon_name: String
-> OptionRefAny
fn has_icon:
&self
arg icon_name: String
-> bool
fn debug_lookup:
Set the resolver callback
Register a single icon in a pack (creates pack if needed)
Unregister a single icon from a pack
Unregister an entire icon pack
Look up an icon across all packs (first match wins)
Check if an icon exists in any pack
Register an image icon in a pack
Register a font icon in a pack
Debug lookup: returns detailed info about an icon's RefAny contents. Useful for debugging to verify icons are registered correctly.
struct MimeTypeHint has destructor
inner: String
struct VideoModeVecSlice
Pointer to the slice data
ptr: VideoMode
Number of elements in the slice
len: usize
struct MonitorVecSlice has destructor
ptr: Monitor
len: usize
struct XWindowTypeVecSlice
Pointer to the slice data
ptr: XWindowType
Number of elements in the slice
len: usize
union enum CursorParseErrorOwned has destructor
InvalidValue(InvalidValueErrOwned)
FFI-safe
(mime_type, data)pair used to build aMimeTypeDataVecforDragData.struct MimeTypeData has destructor
mime_type: String
data: U8Vec
struct MimeTypeDataVecSlice has destructor
Pointer to the slice data
ptr: MimeTypeData
Number of elements in the slice
len: usize
enum FullScreenMode
SlowFullScreen
FastFullScreen
SlowWindowed
FastWindowed
Single touch point (finger, stylus, etc.)
struct TouchPoint
Unique identifier for this touch point (persists across move events)
id: u64
Current position of the touch point in logical coordinates
position: LogicalPosition
Force / pressure of the touch (0.0 = none, 1.0 = max). Set to 0.5 if pressure is unavailable.
force: f32
struct TouchPointVecSlice
Pointer to the slice data
ptr: TouchPoint
Number of elements in the slice
len: usize
struct AudioSink
ptr: c_void
run_destructor: bool
constructor open:
arg config: AudioConfig
-> AudioSink
Open an audio output for
config(sample rate + channels). Returns an invalid handle (is_open()false) on failure. The stub engine always "opens"; the real rodio / AVAudio backend may fail (no device).fn is_open:
&self
-> bool
fn play:
&self
arg frame: AudioFrame
fn frames_played:
&self
-> u64
fn close:
&mut self
Whether the sink opened successfully.
Queue
framefor playback. Interleavedf32samples in the frame's format are sent to the output. (Stub: counts the frame; the on-device backend plays the samples.)Number of frames submitted via [
play](Self::play) so far (0if not open). Mostly a stub progress signal until the real backend lands.Stop playback + release the output. (Dropping the handle does this too;
closeis for explicit/FFI control.)Result of pinch gesture detection (scale + center + travel distances + duration).
struct DetectedPinch
Scale factor (< 1.0 for pinch in, > 1.0 for pinch out)
scale: f32
Center point of the pinch gesture
center: LogicalPosition
Distance between touch points when the pinch started, in logical px
initial_distance: f32
Current distance between touch points, in logical px
current_distance: f32
Duration of the pinch so far, in milliseconds
duration_ms: u64
HTTP client module for downloading resources (language packs, etc.)
mod http:
struct HttpHeader has destructor
name: String
value: String
struct HttpResponse has destructor
status_code: u16
body: U8Vec
content_type: String
content_length: u64
headers: HttpHeaderVec
fn is_success:
&self
-> bool
fn is_redirect:
&self
-> bool
fn is_client_error:
&self
-> bool
fn is_server_error:
&self
-> bool
fn body_as_string:
&self
-> OptionString
Check if the response was successful (2xx status)
Check if the response is a redirect (3xx status)
Check if the response is a client error (4xx status)
Check if the response is a server error (5xx status)
Try to convert the body to a UTF-8 string
struct HttpRequestConfig has destructor
timeout_secs: u64
max_response_size: u64
user_agent: String
headers: HttpHeaderVec
disable_tls_cert_verification: bool
constructor create:
Create a new config with default values
fn with_timeout:
self
arg secs: u64
fn with_max_size:
self
arg max_bytes: u64
fn with_user_agent:
self
arg ua: String
fn with_header:
fn http_get_default:
arg url: String
fn http_get:
&self
arg url: String
arg url: String
fn download_bytes:
&self
arg url: String
fn is_url_reachable:
arg url: String
-> bool
Set timeout in seconds
Set maximum response size (0 = unlimited)
Set User-Agent header
Add a header
Simple HTTP GET request with default configuration
# Arguments *url- The URL to request
# Returns *HttpResult<HttpResponse>- The response or an errorHTTP GET request using this configuration
# Arguments *url- The URL to request
# Returns *HttpResult<HttpResponse>- The response or an errorDownload URL to bytes with default configuration
# Arguments *url- The URL to download
# Returns *HttpResult<U8Vec>- The response body or an errorDownload URL to bytes using this configuration
# Arguments *url- The URL to download
# Returns *HttpResult<U8Vec>- The response body or an errorCheck if a URL is reachable (HEAD request)
# Arguments *url- The URL to check
# Returns *bool- True if reachable (2xx status)struct HttpHeaderVecSlice has destructor
ptr: HttpHeader
len: usize
Native OS dialog wrappers (message boxes, file open/save, color picker) built on
tfd.mod dialog:
Icon to display in the message box.
enum MsgBoxIcon
Info
Warning
Error
Question
Static-method namespace for
tfd-backed message-box dialogs.struct MsgBox
_reserved: u8
constructor new:
-> MsgBox
Returns a zero-initialised handle. The struct only exists so the FFI layer can hang static methods off it.
fn ok:
arg title: String
arg message: String
arg icon: MsgBoxIcon
fn ok_cancel:
arg title: String
arg message: String
arg icon: MsgBoxIcon
arg default: OkCancel
-> OkCancel
fn yes_no:
arg title: String
arg message: String
arg icon: MsgBoxIcon
arg default: YesNo
-> YesNo
fn info:
arg content: String
Show an Ok-only message box. Quotes are stripped from the message to avoid
tfdshell-escape issues on some platforms.Show an Ok/Cancel message box and return which button the user pressed.
Show a Yes/No message box and return which button the user pressed.
Convenience: Ok-only message box titled "Info" with an info icon.
Static-method namespace for
tfd-backed file dialogs.struct FileDialog
_reserved: u8
constructor new:
-> FileDialog
Returns a zero-initialised handle. The struct only exists so the FFI layer can hang static methods off it.
fn open_file:
arg title: String
arg default_path: OptionString
arg filter_list: OptionFileTypeList
-> OptionString
fn open_directory:
arg title: String
arg default_path: OptionString
-> OptionString
arg title: String
arg default_path: OptionString
arg filter_list: OptionFileTypeList
fn save_file:
arg title: String
arg default_path: OptionString
-> OptionString
Open a single file. Returns
Noneif the user cancelled.Open a directory. Returns
Noneif the user cancelled.Open multiple files. Returns
Noneif the user cancelled.Save-file dialog. Returns
Noneif the user cancelled.Static-method namespace for the
tfd-backed color picker dialog.struct ColorPickerDialog
_reserved: u8
constructor new:
Returns a zero-initialised handle. The struct only exists so the FFI layer can hang static methods off it.
fn open:
arg title: String
arg default_value: OptionColorU
-> OptionColorU
Open the system color picker. Returns
Noneif the user cancelled.Accessibility information for a
<dialog>element.struct DialogAriaInfo has destructor
label: OptionString
described_by: OptionString
description: OptionString
role: AccessibilityRole
modal: bool
fn with_modal:
self
arg modal: bool
self
arg described_by: String
fn with_role:
self
arg role: AccessibilityRole
fn with_description:
self
arg desc: String
Returns a copy with the given modality flag.
Returns a copy with
aria-describedbypointing at the given node ID.Returns a copy with the given accessibility role.
Returns a copy with the given inline description.
Callback type definitions + struct definitions of
CallbackInfosmod callbacks:
Main callback type for UI event handling
fnptr CallbackType
arg RefAny
arg CallbackInfo
-> Update
Type alias for extern "C" fn (&mut RefAny , &mut VirtualViewCallbackInfo) -> VirtualViewReturn
fnptr VirtualViewCallbackType
arg RefAny
fnptr NumberInputOnFocusLostCallbackType
arg RefAny
arg CallbackInfo
arg NumberInputState
-> Update
fnptr TextInputOnVirtualKeyDownCallbackType
arg RefAny
arg CallbackInfo
arg TextInputState
fnptr ButtonOnClickCallbackType
arg RefAny
arg CallbackInfo
-> Update
fnptr CheckBoxOnToggleCallbackType
arg RefAny
arg CallbackInfo
arg CheckBoxState
-> Update
fnptr DropDownOnChoiceChangeCallbackType
arg RefAny
arg CallbackInfo
arg usize
-> Update
fnptr NumberInputOnValueChangeCallbackType
arg RefAny
arg CallbackInfo
arg NumberInputState
-> Update
fnptr ListViewOnColumnClickCallbackType
arg RefAny
arg CallbackInfo
arg ListViewState
arg usize
-> Update
fnptr ListViewOnRowClickCallbackType
arg RefAny
arg CallbackInfo
arg ListViewState
arg usize
-> Update
fnptr ColorInputOnValueChangeCallbackType
arg RefAny
arg CallbackInfo
arg ColorInputState
-> Update
fnptr TextInputOnTextInputCallbackType
arg RefAny
arg CallbackInfo
arg TextInputState
fnptr FontRefDestructorCallbackType
arg c_void
fnptr TextInputOnFocusLostCallbackType
arg RefAny
arg CallbackInfo
arg TextInputState
-> Update
fnptr TabOnClickCallbackType
arg RefAny
arg CallbackInfo
arg TabHeaderState
-> Update
fnptr ListViewOnLazyLoadScrollCallbackType
arg RefAny
arg CallbackInfo
arg ListViewState
-> Update
fnptr FileInputOnPathChangeCallbackType
arg RefAny
arg CallbackInfo
arg FileInputState
-> Update
struct VirtualViewCallbackInfo
reason: VirtualViewCallbackReason
system_fonts: c_void
image_cache: c_void
window_theme: WindowTheme
bounds: HidpiAdjustedBounds
scroll_size: LogicalSize
scroll_offset: LogicalPosition
virtual_scroll_size: LogicalSize
virtual_scroll_offset: LogicalPosition
callable_ptr: c_void
_abi_mut: c_void
fn get_ctx:
&self
-> OptionRefAny
fn get_bounds:
&self
Get the callable for FFI language bindings (Python, etc.)
struct CallbackInfo
ref_data: c_void
hit_dom_node: DomNodeId
cursor_relative_to_item: OptionLogicalPosition
cursor_in_viewport: OptionLogicalPosition
changes: c_void
fn get_ctx:
&self
-> OptionRefAny
fn get_gl_context:
&self
fn add_timer:
fn remove_timer:
&mut self
arg timer_id: TimerId
fn add_thread:
fn remove_thread:
&mut self
arg thread_id: ThreadId
fn stop_propagation:
&mut self
fn stop_immediate_propagation:
&mut self
fn create_window:
&mut self
arg options: WindowCreateOptions
fn close_window:
&mut self
&mut self
arg state: FullWindowState
&mut self
arg id: String
&mut self
fn prevent_default:
&mut self
fn show_tooltip:
&mut self
arg text: String
fn show_tooltip_at:
&mut self
arg text: String
arg position: LogicalPosition
fn hide_tooltip:
&mut self
&self
-> WindowFlags
&self
fn get_current_keyboard_state:
&self
&self
-> MouseState
fn get_cursor_relative_to_node:
&self
fn get_cursor_relative_to_viewport:
&self
&self
fn get_cursor_position_screen:
&self
fn get_drag_delta:
&self
&self
fn get_drag_delta_screen_incremental:
&self
&mut self
fn get_monitors:
&self
-> MonitorVec
&self
fn get_current_time:
&self
-> Instant
fn is_dom_focused:
&self
arg dom_id: DomId
-> bool
&self
-> bool
fn is_pen_eraser:
&self
-> bool
fn is_pen_barrel_button_pressed:
&self
-> bool
fn focus_next:
&mut self
fn focus_previous:
&mut self
fn focus_first:
&mut self
fn focus_last:
&mut self
fn clear_focus:
&mut self
fn is_dragging:
&self
-> bool
fn is_drag_active:
&self
-> bool
&self
-> bool
&self
-> bool
fn has_sufficient_history_for_gestures:
&self
-> bool
fn change_node_text:
fn update_all_image_callbacks:
&mut self
fn get_parent_node:
fn set_css_property:
&mut self
arg node_id: DomNodeId
arg property: CssProperty
fn scroll_to:
&mut self
arg dom_id: DomId
arg node_id: NodeHierarchyItemId
arg position: LogicalPosition
fn insert_text:
fn add_cursor:
&mut self
arg dom_id: DomId
arg node_id: NodeId
arg cursor: TextCursor
-> SelectionId
&mut self
arg dom_id: DomId
arg node_id: NodeId
arg range: SelectionRange
-> SelectionId
&mut self
arg selection_id: SelectionId
-> bool
&self
arg dom_id: DomId
-> usize
fn get_node_size:
&self
arg node_id: DomNodeId
&self
arg node_id: DomNodeId
fn get_node_rect:
&self
arg node_id: DomNodeId
&self
fn get_timer:
&self
arg timer_id: TimerId
-> OptionTimer
fn get_timer_ids:
&self
-> TimerIdVec
fn get_thread:
&self
arg thread_id: ThreadId
-> OptionThread
fn get_thread_ids:
&self
-> ThreadIdVec
fn get_dom_ids:
&self
-> DomIdVec
fn get_hit_node:
&self
-> DomNodeId
fn get_parent:
&self
arg node_id: DomNodeId
&self
arg node_id: DomNodeId
fn get_next_sibling:
&self
arg node_id: DomNodeId
fn get_first_child:
&self
arg node_id: DomNodeId
fn get_last_child:
&self
arg node_id: DomNodeId
fn get_dataset:
&mut self
arg node_id: DomNodeId
-> OptionRefAny
fn get_node_id_of_root_dataset:
&mut self
arg search_key: RefAny
&self
arg node_id: DomNodeId
-> OptionString
fn get_selection:
&self
arg dom_id: DomId
fn has_selection:
&self
arg dom_id: DomId
-> bool
&self
arg dom_id: DomId
&self
arg dom_id: DomId
&self
&self
fn get_previous_keyboard_state:
&self
&self
&self
&self
&self
arg node_id: DomNodeId
arg property_type: CssPropertyType
&self
arg node_id: DomNodeId
&self
arg node_id: DomNodeId
&self
fn is_node_focused:
&self
arg node_id: DomNodeId
-> bool
fn get_pen_state:
&self
fn get_pen_pressure:
&self
-> OptionF32
fn get_pen_tilt:
&self
&self
-> OptionU64
fn get_focused_node:
&self
fn has_focus:
&self
arg node_id: DomNodeId
-> bool
fn get_hovered_file:
&self
-> OptionString
fn get_dropped_file:
&self
-> OptionString
fn get_dragged_node:
&self
fn get_dragged_file:
&self
-> OptionString
fn get_drag_state:
&self
fn get_scroll_delta:
fn get_scroll_state:
fn inspect_paste_target_range:
&self
arg target: DomNodeId
fn inspect_select_all_changeset:
&self
arg target: DomNodeId
&self
arg target: DomNodeId
arg forward: bool
&self
&self
arg target: DomNodeId
&self
arg target: DomNodeId
&mut self
arg content: ClipboardContent
fn set_copy_content:
&mut self
arg target: DomNodeId
arg content: ClipboardContent
fn set_cut_content:
&mut self
arg target: DomNodeId
arg content: ClipboardContent
&mut self
arg target: DomNodeId
arg range: SelectionRange
&self
arg target: DomNodeId
-> OptionString
&self
arg target: DomNodeId
&self
arg target: DomNodeId
&self
arg target: DomNodeId
-> bool
&self
arg target: DomNodeId
-> OptionUsize
fn can_undo:
&self
arg node_id: NodeId
-> bool
fn can_redo:
&self
arg node_id: NodeId
-> bool
fn get_undo_text:
&self
arg node_id: NodeId
-> OptionString
fn get_redo_text:
&self
arg node_id: NodeId
-> OptionString
&self
arg node_id: NodeId
&self
arg node_id: NodeId
&self
arg target: DomNodeId
&self
arg target: DomNodeId
&self
arg target: DomNodeId
&self
arg target: DomNodeId
fn inspect_move_cursor_to_line_start:
&self
arg target: DomNodeId
fn inspect_move_cursor_to_line_end:
&self
arg target: DomNodeId
fn inspect_move_cursor_to_document_start:
&self
arg target: DomNodeId
fn inspect_move_cursor_to_document_end:
&self
arg target: DomNodeId
&self
arg target: DomNodeId
fn inspect_delete:
&self
arg target: DomNodeId
fn move_cursor_left:
&mut self
arg target: DomNodeId
arg extend_selection: bool
&mut self
arg target: DomNodeId
arg extend_selection: bool
fn move_cursor_up:
&mut self
arg target: DomNodeId
arg extend_selection: bool
fn move_cursor_down:
&mut self
arg target: DomNodeId
arg extend_selection: bool
&mut self
arg target: DomNodeId
arg extend_selection: bool
&mut self
arg target: DomNodeId
arg extend_selection: bool
fn move_cursor_to_document_start:
&mut self
arg target: DomNodeId
arg extend_selection: bool
fn move_cursor_to_document_end:
&mut self
arg target: DomNodeId
arg extend_selection: bool
fn delete_backward:
&mut self
arg target: DomNodeId
fn delete_forward:
&mut self
arg target: DomNodeId
&self
arg node_id: DomNodeId
-> OptionString
&self
arg node_id: DomNodeId
arg attr_name: String
-> OptionString
fn get_node_classes:
fn get_node_id:
&self
arg node_id: DomNodeId
-> OptionString
fn take_screenshot:
&self
arg dom_id: DomId
&self
arg path: String
fn take_native_screenshot_bytes:
&self
fn take_native_screenshot_base64:
&self
&self
arg dom_id: DomId
&self
fn accept_drop:
&mut self
fn get_drag_types:
&self
-> StringVec
fn set_drag_data:
fn set_drop_effect:
&mut self
arg effect: DropEffect
&self
-> bool
&self
fn get_pinch:
&self
fn get_rotation:
&self
fn get_long_press:
&self
fn get_location_fix:
&self
&self
&self
&mut self
arg prompt: BiometricPrompt
fn keyring_store:
fn keyring_get:
&mut self
arg key: String
fn keyring_delete:
&mut self
arg key: String
&self
&self
arg kind: SensorKind
&self
arg id: GamepadId
&self
fn get_wacom_pad:
&self
&self
fn get_loaded_fonts:
&self
&self
arg font_hash: u64
-> OptionU8Vec
Get the callable for FFI language bindings (Python, etc.)
Returns the cloned OptionRefAny if a callable was set, or None if this is a native Rust callback.Returns the OpenGL context if available
Add a timer to this window (applied after callback returns)
Remove a timer from this window (applied after callback returns)
Add a thread to this window (applied after callback returns)
Remove a thread from this window (applied after callback returns)
Stop event propagation to other nodes (W3C stopPropagation).
Remaining handlers on the current node still fire, but handlers on parent/child nodes in subsequent phases are skipped. Applied after the callback returns.Stop event propagation immediately (W3C stopImmediatePropagation).
No further handlers fire, not even remaining handlers registered on the same node. Applied after the callback returns.Create a new window (applied after callback returns)
Close the current window (applied after callback returns)
Modify the window state (applied after callback returns)
Add an image to the image cache (applied after callback returns)
Remove an image from the image cache (applied after callback returns)
Reload system fonts (applied after callback returns)
Note: This is an expensive operation that rebuilds the entire font cachePrevent the default text input from being applied
When called in a TextInput callback, prevents the typed text from being inserted. Useful for custom validation, filtering, or text transformation.
# ExampleOpen a menu (context menu or dropdown)
The menu will be displayed either as a native menu or a fallback DOM-based menu depending on the window'suse_native_context_menusflag. Uses the position specified in the menu itself.
# Arguments *menu- The menu to displayOpen a menu at a specific position
# Arguments *menu- The menu to display *position- The position where the menu should appear (overrides menu's position)Show a tooltip at the current cursor position
Displays a simple text tooltip near the mouse cursor. The tooltip will be shown using platform-specific native APIs where available.
Platform implementations: - Windows: UsesTOOLTIPS_CLASSWin32 control - macOS: UsesNSPopoveror customNSWindowwith tooltip styling - X11: Creates transient window with_NET_WM_WINDOW_TYPE_TOOLTIP- Wayland: Useszwlr_layer_shell_v1with overlay layer
# Arguments *text- The tooltip text to display
# ExampleShow a tooltip at a specific position
# Arguments *text- The tooltip text to display *position- The position where the tooltip should appear (in window coordinates)
# ExampleHide the currently displayed tooltip
# ExampleOpen a menu positioned relative to the currently hit node
Convenience method for opening a menu at the element that triggered the callback. Equivalent toopen_menu_for_node(menu, info.get_hit_node()).
# Arguments *menu- The menu to display
# Returns *trueif the menu was queued for opening *falseif no node is currently hit or it has no layout informationGet current window flags
Get the current scroll offset for the hit node (if it's scrollable)
Convenience method that uses thehit_dom_nodefrom this callback. Useget_scroll_offset_for_nodeif you need to query a specific node.Get current keyboard state
Get current mouse state
Get the current cursor position in logical coordinates relative to the window
Get the current cursor position in screen (global/desktop) coordinates
Get the drag delta from drag start to current position, in window-local logical coordinates
Get the total drag delta in screen coordinates (from drag start to now)
Get the incremental screen drag delta since the last frame (robust against external position changes)
Begin an interactive window move (CSD titlebar drag). On Wayland this delegates to the compositor; on other platforms it is a no-op (use get_drag_delta instead).
Get all connected monitors (cached, no syscall). Returns the monitor list from the app-level cache. Updated automatically when monitors are added/removed.
Get the monitor the window is currently displayed on. Returns the full Monitor struct with DPI, size, position, etc. Returns None if monitor information is unavailable.
Check if any node in a specific DOM is focused
Check if pen is currently in contact with surface
Check if pen is in eraser mode
Check if pen barrel button is pressed
Set focus to a node matching a CSS path
Move focus to next focusable element in tab order
Move focus to previous focusable element in tab order
Move focus to first focusable element
Move focus to last focusable element
Remove focus from all elements
Check if a drag gesture is currently active
Convenience method that queries the gesture manager.Check if a node or file drag is currently active
Returns true if either a node drag or file drag is in progress.Check if a node drag is specifically active
Check if a file drag is specifically active
Check if there's sufficient mouse history for gesture detection (at least 2 frames)
Change the text content of a node (applied after callback returns)
This method was previously calledset_string_contentsin older API versions.
# Arguments *node_id- The text node to modify (DomNodeId containing both DOM and node IDs) *text- The new text content
# ExampleRe-render an image callback (for resize/animation updates)
This triggers re-invocation of the RenderImageCallback associated with the node. Useful for: - Responding to window resize (image needs to match new size) - Animation frames (update OpenGL texture each frame) - Interactive content (user input changes rendering)
# ExampleRe-render ALL image callbacks across all DOMs (applied after callback returns)
This is the most efficient way to update animated GL textures from a timer. Triggers only texture re-rendering - no DOM rebuild or display list resubmission.
# ExampleTrigger re-rendering of a VirtualView (applied after callback returns)
This forces the VirtualView to call its layout callback with reasonDomRecreatedand submit a new display list to WebRender. The VirtualView's pipeline will be updated without affecting other parts of the window.
Useful for: - Live preview panes (update when source code changes) - Dynamic content that needs manual refresh - Editor previews (re-parse and display new DOM)
# ExampleFind a node by ID attribute in the layout tree
Returns the NodeId of the first node with the given ID attribute, or None if not found.
# ExampleGet the parent node of the given node
Returns None if the node has no parent (i.e., it's the root node)Get the next sibling of the given node
Returns None if the node has no next siblingGet the previous sibling of the given node
Returns None if the node has no previous siblingGet the first child of the given node
Returns None if the node has no childrenGet the last child of the given node
Returns None if the node has no childrenChange the image mask of a node (applied after callback returns)
Set a single CSS property on a node (convenience method for widgets)
This is a helper method that wrapschange_node_css_propertiesfor the common case of setting a single property. It uses the hit node's DOM ID automatically.
# Arguments *node_id- The node to set the property on (uses hit node's DOM ID) *property- The CSS property to set
# ExampleScroll a node to a specific position (applied after callback returns)
Insert text at the current cursor position in a text node
This operation is transactional - the text will be inserted after the callback returns. If there's a selection, it will be replaced with the inserted text.
# Arguments *dom_id- The DOM containing the text node *node_id- The node to insert text into *text- The text to insert
# ExampleAdd an additional cursor at the specified position (multi-cursor editing).
Returns the SelectionId of the new cursor.Add an additional selection range (multi-cursor editing).
Returns the SelectionId of the new selection.Remove a specific selection/cursor by its stable SelectionId.
Get the number of active cursors/selections in the MultiCursorState.
Open a menu positioned relative to a specific DOM node
This is useful for dropdowns, combo boxes, and context menus that should appear near a specific UI element. The menu will be positioned below the node by default.
# Arguments *menu- The menu to display *node_id- The DOM node to position the menu relative to
# Returns *trueif the menu was queued for opening *falseif the node doesn't exist or has no layout informationGet the bounding rectangle of a node (position + size)
This is particularly useful for menu positioning, where you need to know where a UI element is to popup a menu relative to it.Get the bounding rectangle of the hit node
Convenience method that combines get_hit_node() and get_node_rect(). Useful for menu positioning based on the clicked element.Get a reference to a timer
Get all timer IDs
Get a reference to a thread
Get all thread IDs
Get all DOM IDs that have layout results
Get the current selection state for a DOM
Check if a DOM has any selection
Get the primary cursor for a DOM (first in selection list)
Get all selection ranges (excludes plain cursors)
Get full current window state (immutable reference)
Get previous window flags
Get previous keyboard state
Get previous mouse state
Get the layout rectangle of the currently hit node (in logical coordinates)
Get the computed CSS property for a specific DOM node
This queries the CSS property cache and returns the resolved property value for the given node, taking into account: - User overrides (from callbacks) - Node state (:hover, :active, :focus) - CSS rules from stylesheets - Cascaded properties from parents - Inline styles
# Arguments *node_id- The DOM node to query *property_type- The CSS property type to retrieve
# Returns *Some(CssProperty)if the property is set on this node *Noneif the property is not set (will use default value)Get the computed width of a node from CSS
Convenience method for getting the CSS width property.Get the computed height of a node from CSS
Convenience method for getting the CSS height property.Check if a specific node is currently focused
Get current pen/stylus state if a pen is active
Get current pen pressure (0.0 to 1.0) Returns None if no pen is active, Some(0.5) for mouse
Get current pen tilt angles (x_tilt, y_tilt) in degrees Returns None if no pen is active
Get the event ID of the current event
Set focus to a specific DOM node by ID
Get the currently focused node (if any)
Returns None if no node has focus.Check if a specific node has focus
Get the currently hovered file (if drag-drop is in progress)
Returns None if no file is being hovered over the window.Get the currently dropped file (if a file was just dropped)
This is a one-shot value that is cleared after event processing. Returns None if no file was dropped this frame.Get the node being dragged (if any)
Get the file path being dragged (if any)
Get the current drag/drop state (if any)
Returns None if no drag is active, or Some with drag details.Get the current scroll offset for a specific node (if it's scrollable)
Get the scroll delta for a node in the current frame (for scroll event detection)
Check if a node had scroll activity this frame
Get the scroll state (container rect, content rect, current offset) for a node
Inspect the current selection range that would be affected by paste
Returns the selection range that will be replaced when pasting. Returns None if no selection exists (paste will insert at cursor).Inspect what text would be selected by Select All operation
Returns the full text content and the range that would be selected.Inspect what would be deleted by a backspace/delete operation
Uses the pure functions fromtext3::edit::inspect_delete()to determine what would be deleted without actually performing the deletion.
Returns (range_to_delete, deleted_text). - forward=true: Delete key (delete character after cursor) - forward=false: Backspace key (delete character before cursor)
# ExampleGet clipboard content from system clipboard (available during paste operations)
This returns content that was read from the system clipboard when Ctrl+V was pressed. It's only available in On::Paste callbacks or similar clipboard-related callbacks.
Use this to inspect what will be pasted before allowing or modifying the paste operation.Inspect a pending copy operation
Returns the clipboard content that would be copied from the current selection. Use this to validate or transform content before copying.Inspect a pending cut operation
Returns the clipboard content that would be cut (copied + deleted). Use this to validate or transform content before cutting.Override clipboard content for copy/cut operations
This sets custom content that will be written to the system clipboard. Use this in On::Copy or On::Cut callbacks to modify what gets copied.
# Arguments *content- The clipboard content to write to system clipboard
# ExampleSet/modify the clipboard content before a copy operation
Use this to transform clipboard content before copying. The change is queued and will be applied after the callback returns, if preventDefault() was not called.
# ExampleSet/modify the clipboard content before a cut operation
Similar to set_copy_content but for cut operations. The change is queued and will be applied after the callback returns.Override the selection range for select-all operation
Use this to limit what gets selected (e.g., only select visible text). The change is queued and will be applied after the callback returns.Get the current text content of a node
Helper for inspecting text before operations.Get the current cursor position in a node
Returns the text cursor position if the node is focused.Get the current selection ranges in a node
Returns all active selection ranges for the specified DOM.Check if a specific node has an active selection
This checks if the specific node (identified by DomNodeId) has a selection, as opposed to has_selection(DomId) which checks the entire DOM.Get the length of text in a node
Useful for bounds checking in custom operations.Check if undo is available for a specific node
Returns true if there is at least one undoable operation in the stack.Check if redo is available for a specific node
Returns true if there is at least one redoable operation in the stack.Get the text that would be restored by undo for a specific node
Returns the pre-state text content that would be restored if undo is performed. Returns None if no undo operation is available.Get the text that would be restored by redo for a specific node
Returns the pre-state text content that would be restored if redo is performed. Returns None if no redo operation is available.Inspect a pending undo operation
Returns the full UndoableOperation that would be undone. Use this to inspect the changeset and pre-state before allowing undo.Inspect a pending redo operation
Returns the full UndoableOperation that would be redone. Use this to inspect the changeset and pre-state before allowing redo.Inspect where the cursor would move when pressing left arrow
Returns the new cursor position that would result from moving left. Returns None if the cursor is already at the start of the document.
# Arguments *target- The node containing the cursor
# ExampleInspect where the cursor would move when pressing right arrow
Returns the new cursor position that would result from moving right. Returns None if the cursor is already at the end of the document.Inspect where the cursor would move when pressing up arrow
Returns the new cursor position that would result from moving up one line. Returns None if the cursor is already on the first line.Inspect where the cursor would move when pressing down arrow
Returns the new cursor position that would result from moving down one line. Returns None if the cursor is already on the last line.Inspect where the cursor would move when pressing Home key
Returns the cursor position at the start of the current line.Inspect where the cursor would move when pressing End key
Returns the cursor position at the end of the current line.Inspect where the cursor would move when pressing Ctrl+Home
Returns the cursor position at the start of the document.Inspect where the cursor would move when pressing Ctrl+End
Returns the cursor position at the end of the document.Inspect what text would be deleted by backspace (including Shift+Backspace)
Returns (range_to_delete, deleted_text). This is a convenience wrapper around inspect_delete_changeset(target, false).Inspect what text would be deleted by delete key
Returns (range_to_delete, deleted_text). This is a convenience wrapper around inspect_delete_changeset(target, true).Move cursor left (arrow left key)
# Arguments *target- The node containing the cursor *extend_selection- If true, extends selection (Shift+Left); if false, moves cursor
# ExampleMove cursor right (arrow right key)
Move cursor up (arrow up key)
Move cursor down (arrow down key)
Move cursor to line start (Home key)
Move cursor to line end (End key)
Move cursor to document start (Ctrl+Home)
Move cursor to document end (Ctrl+End)
Delete text backward (backspace or Shift+Backspace)
Queues a backspace operation to be applied after the callback. Use inspect_backspace() to see what would be deleted.Delete text forward (delete key)
Queues a delete operation to be applied after the callback. Use inspect_delete() to see what would be deleted.Get all direct children of a node
Returns a vector of NodeIds for all direct children of the specified node. Does not recurse into children of children (non-recursive).Get the number of direct children of a node
Returns the count of direct children for the specified node. This is more efficient than get_all_children_nodes().len() when you only need the count.Get the HTML tag name of a node
Returns the tag name (e.g., 'div', 'body', 'p', 'input') of the specified node. Returns None if the node doesn't exist.Get a specific attribute value of a node
Returns the value of the specified attribute on the node. Supports standard HTML attributes like 'id', 'class', 'href', 'src', 'alt', etc. Also supports custom data-* attributes and aria-* attributes.
# Arguments *node_id- The DOM node to query *attr_name- The attribute name to look up (e.g., 'id', 'class', 'href')
# Returns *Some(String)if the attribute exists *Noneif the attribute doesn't exist or the node doesn't existGet all CSS classes of a node
Returns a vector of all CSS class names applied to the node.Get the ID attribute of a node
Convenience method for getting the 'id' attribute. Equivalent to get_node_attribute(node_id, 'id').Take a CPU-rendered screenshot of a DOM
Renders the specified DOM to a PNG image using the CPU renderer. This captures only the DOM content without window decorations. Useful for visual regression testing (reftest) and documentation.
# Arguments *dom_id- The DOM to screenshot
# Returns *Ok(Vec<u8>)- PNG-encoded image data *Err(String)- Error message if rendering failedTake a CPU-rendered screenshot and save it to a file
Convenience method that combines take_screenshot with file writing.
# Arguments *dom_id- The DOM to screenshot *path- The file path to save the PNG toTake a native OS-level screenshot of the window including decorations
Captures the actual window as it appears on screen, including the title bar, window borders, and any OS-provided window decorations. This is useful for documentation, tutorials, or visual testing.
# Platform Support - macOS: Uses screencapture command with window ID - Windows: Uses PrintWindow API - Linux: Uses XGetImage (X11)
# Arguments *path- The file path to save the PNG screenshot to
# Returns *Ok(())- Screenshot saved successfully *Err(String)- Error message if screenshot failedTake a native OS-level screenshot and return the PNG data as bytes
Same as take_native_screenshot but returns the PNG data directly instead of saving to a file.
# Returns *Ok(Vec<u8>)- PNG-encoded image data *Err(String)- Error message if screenshot failedTake a native OS-level screenshot and return as a Base64 data URI
Returns the screenshot as a 'data:image/png;base64,...' string that can be directly used in HTML img tags or JSON responses.
# Returns *Ok(String)- Base64 data URI string *Err(String)- Error message if screenshot failedTake a CPU-rendered screenshot and return as a Base64 data URI
Returns the screenshot as a 'data:image/png;base64,...' string. This is the software-rendered version without window decorations.
# Returns *Ok(String)- Base64 data URI string *Err(String)- Error message if rendering failedGet the current text changeset being processed (if any)
This allows callbacks to inspect what text input is about to be applied. Returns None if no text input is currently being processed.
Useset_text_changeset()to modify the text that will be inserted, andprevent_default()to block the text input entirely.Accept the current drop operation on this node.
W3C equivalent: callingevent.preventDefault()in a DragOver handler. This signals that the current drop target can accept the dragged data. Must be called from a DragOver or DragEnter callback for the Drop event to fire on this node.Get the list of MIME types available on the current drag operation.
W3C equivalent:dataTransfer.typesReturns an empty vec if no drag is active or no data is set.Set drag data for a MIME type on the active drag operation.
W3C equivalent:dataTransfer.setData(type, data)Should be called from a DragStart callback to populate the drag data.Set the drop effect for the current drag operation.
W3C equivalent:dataTransfer.dropEffect = "none" | "copy" | "link" | "move". Should be called from a DragOver or DragEnter callback on the drop target.True iff the gesture manager classified the current event sequence as a double-click / double-tap.
Returns the dominant direction of the current swipe gesture, if any. Detection uses the touch / pointer trajectory and a velocity threshold; on iOS / Android the platform backend may override the in-process detector with a native gesture-recognizer result.
Returns the active pinch gesture (scale + center + distances), if any.
Returns the active rotation gesture (radians + center), if any.
Returns the active long-press, if the user is currently holding a pointer in place beyond the configured threshold.
Get the most recent geolocation fix, or
Noneif noGeolocationProbeis mounted or no platform backend has delivered a fix yet. The fix is kept live by the platform backends (AndroidFusedLocationProvider, iOS/macOSCLLocationManager) via the async fix channel that the layout pass folds into the manager - so a callback can read the user's position to, e.g., place a "you are here" marker on a map.Get the most recent biometric-auth result, or
Noneif norequest_biometric_authhas completed yet. Kept live by the platform backends (iOS/macOSLAContext, AndroidBiometricPrompt, WindowsUserConsentVerifier) via the async result channel the layout pass folds into the manager - so a callback can unlock a vault / settings panel once the user authenticates.Get the device's biometric capability (sync probe):
Face,Fingerprint,Iris, orNotAvailable. Lets a callback decide whether to even offer a biometric unlock before requesting one (no OS prompt is shown - this just reads the cached probe).Request a biometric-auth prompt (Face ID / Touch ID / Android
BiometricPrompt/ Windows Hello). Returns immediately - the OS draws its own modal asynchronously; the outcome arrives on a later frame and is read via [CallbackInfo::get_biometric_result]. Call this from, e.g., an unlock button'son_click. Thepromptconfigures the reason text, cancel label, and whether the OS passcode fallback is allowed. (No platform backend reports a real outcome yet - the request currently resolves toBiometricResult::Unavailable; the iOS/macOS/Android backends land in a later tick.)Store
secretunderkeyin the OS keyring (Keychain / KeyStore / libsecret / CredentialLocker). Whenrequire_biometryis set, a laterkeyring_getof this key triggers the OS biometric prompt. Returns immediately; the outcome arrives viaget_keyring_result()on a later frame.Read the secret stored under
key. A biometry-bound item shows the OS prompt first; the secret (or a denial) arrives viaget_keyring_result()on a later frame.Remove the item stored under
keyfrom the OS keyring (no-op if absent). The outcome arrives viaget_keyring_result().Get the most recent keyring outcome, or
Noneuntil the first op completes. Read after akeyring_store/get/deleteto observe the result - e.g. the revealed secret from akeyring_get(KeyringResult::Retrieved).Get the latest motion-sensor reading for
kind(Accelerometer / Gyroscope / Magnetometer), orNoneif no platform backend has delivered one. Kept live by the sensor backends (iOS CoreMotion, AndroidSensorManager) via the async channel the layout pass folds into the manager - so a callback can drive tilt / shake / compass UI.Get the latest state of the gamepad
id(button bitset + analog axes), orNoneif no pad with that id has connected. Kept live by the controller backend (gilrs / iOSGCController/ AndroidInputDevice) via the async channel the layout pass folds into the manager - so a callback can drive movement / menu UI. For the common single-controller case, [CallbackInfo::get_primary_gamepad] skips the id bookkeeping.Get the first currently-connected gamepad, or
Noneif none is connected - the convenient single-controller accessor.Get the current Wacom tablet-pad state (ExpressKeys + touch-ring), or
Noneif no pad backend has delivered one. (The pen's own wacom features - eraser / barrel button / barrel roll / tilt / pressure - are in [CallbackInfo::get_pen_state].) Kept live by the platform pad backend (Wintab / libwacom+libinput / macOS tabletNSEvents).The safe-area insets (notch / system-UI margins) for this window, in logical px - lay out interactive content within them so it isn't hidden by a notch / rounded corners / status bar. Zero where the platform or window has no inset. Set by the platform shell (macOS
NSScreennotch, iOSUIView.safeAreaInsets, AndroidWindowInsets).Enumerate every font the layout engine currently has loaded in its font cache.
Returns one [LoadedFont](azul_core::resources::LoadedFont) descriptor per loaded face. Thefont_hashfield of each descriptor is identical to thefont_hashcarried byDisplayListItem::Textglyph runs, so a callback can correlate a loaded font with the text that uses it and then pull the raw bytes via [get_loaded_font_bytes](Self::get_loaded_font_bytes).
The list includes fallback faces that were resolved during layout, not just the families named in the source CSS.Retrieve the raw source bytes (TTF / OTF / TTC, etc.) for a loaded font, looked up by the
font_hashreturned from [get_loaded_fonts](Self::get_loaded_fonts) (or carried on aDisplayListItem::Textglyph run).
ReturnsNoneif no loaded font matchesfont_hash, or if the matching font did not retain its source bytes (e.g. a test-only font; production fonts loaded from disk retain an mmap-backed handle and always succeed). The returned bytes can be embedded directly into a generated document.fnptr InstantPtrCloneCallbackType
arg InstantPtr
-> InstantPtr
fnptr InstantPtrDestructorCallbackType
arg InstantPtr
fnptr LayoutCallbackType
arg RefAny
-> Dom
Wrapper around the layout callback function pointer. For FFI languages (Python, Java, etc.), the RefAny passed to the callback contains both the user data and the callback function object.
struct LayoutCallback
ctx: OptionRefAny
constructor create:
arg cb: LayoutCallbackType
struct LayoutCallbackInfo
ref_data: c_void
window_size: WindowSize
theme: WindowTheme
relayout_reason: RelayoutReason
callable_ptr: c_void
_abi_mut: c_void
fn relayout_reason:
&self
fn get_ctx:
&self
-> OptionRefAny
fn get_gl_context:
&self
&self
arg px: f32
-> bool
&self
arg px: f32
-> bool
&self
arg min_px: f32
arg max_px: f32
-> bool
&self
arg px: f32
-> bool
fn window_height_greater_than:
&self
arg px: f32
-> bool
&self
arg min_px: f32
arg max_px: f32
-> bool
fn get_window_width:
&self
-> f32
&self
-> f32
fn get_dpi_factor:
&self
-> f32
Returns what triggered the current
layout()invocation.Get the callable for FFI language bindings (Python, etc.)
Returns true if the window width is less than the given pixel value
# ExampleReturns true if the window width is greater than the given pixel value
Returns true if the window width is between min and max (inclusive)
Returns true if the window height is less than the given pixel value
Returns true if the window height is greater than the given pixel value
Returns true if the window height is between min and max (inclusive)
Returns the current window width in pixels
Returns the current window height in pixels
Returns the current window DPI factor
struct TimerCallback
ctx: OptionRefAny
fnptr TimerCallbackType
arg RefAny
struct TimerCallbackInfo
callback_info: CallbackInfo
node_id: OptionDomNodeId
frame_start: Instant
call_count: usize
is_about_to_finish: bool
_abi_ref: c_void
_abi_mut: c_void
constructor create:
arg callback_info: CallbackInfo
arg node_id: OptionDomNodeId
arg frame_start: Instant
arg call_count: usize
arg is_about_to_finish: bool
&self
fn get_attached_node_position:
&self
fn update_all_image_callbacks:
&mut self
Re-render ALL image callbacks across all DOMs (applied after callback returns)
This is the most efficient way to update animated GL textures from a timer. Triggers only texture re-rendering - no DOM rebuild or display list resubmission.
# ExampleTrigger re-rendering of a VirtualView (applied after callback returns)
This forces the VirtualView to call its layout callback with reasonDomRecreatedand submit a new display list to WebRender.struct TimerCallbackReturn
should_update: Update
should_terminate: TerminateTimer
constructor create:
arg should_update: Update
arg should_terminate: TerminateTimer
constructor continue_unchanged:
constructor continue_and_refresh_dom:
constructor terminate_unchanged:
constructor terminate_and_refresh_dom:
Creates a new TimerCallbackReturn with the given update and terminate flags.
Timer continues running, no DOM update needed.
Timer continues running and DOM should be refreshed.
Timer should stop, no DOM update needed.
Timer should stop and DOM should be refreshed.
fnptr WriteBackCallbackType
arg RefAny
arg RefAny
arg CallbackInfo
-> Update
fnptr GetSystemTimeCallbackType
-> Instant
struct WriteBackCallback
ctx: OptionRefAny
fnptr ThreadCallbackType
arg RefAny
arg ThreadSender
arg ThreadReceiver
struct ThreadCallback
ctx: OptionRefAny
Destructor callback for RefAny - called when the last reference is dropped
fnptr RefAnyDestructorType
arg c_void
enum Update
DoNothing
RefreshDom
RefreshDomAllWindows
struct RefAny
sharing_info: RefCount
instance_id: u64
constructor new_c:
arg ptr: GlVoidPtrConst
arg len: usize
arg align: usize
arg type_id: u64
arg type_name: String
arg destructor: RefAnyDestructorType
arg serialize_fn: usize
arg deserialize_fn: usize
-> RefAny
Creates a new RefAny from a raw pointer wrapper, size, alignment, type_id, type_name, destructor, and optional JSON serialization function pointers
fn get_data_ptr:
&self
-> c_void
fn get_type_id:
&self
-> u64
fn is_type:
&self
arg type_id: u64
-> bool
fn set_serialize_fn:
&mut self
arg serialize_fn: usize
&mut self
arg deserialize_fn: usize
fn replace_contents:
&mut self
arg new_value: RefAny
-> bool
fn can_serialize:
&self
-> bool
fn can_deserialize:
&self
-> bool
fn get_serialize_fn:
&self
-> usize
&self
-> usize
&self
-> OptionJson
Returns the internal data pointer. Used by AZ_REFLECT macros for downcasting.
Returns the type ID of this RefAny
Returns true if this RefAny is of the given type ID
Sets the serialization function pointer for JSON export
Sets the deserialization function pointer for JSON import
Replaces the contents of this RefAny with a new value. This properly destroys the old value and updates all metadata. Since all clones share the same internal data, this change is visible to ALL clones. Returns true if successful, false if there are active borrows.
Returns true if this RefAny has a serialization function set
Returns true if this RefAny has a deserialization function set
Returns the serialization function pointer (0 if not set)
Returns the deserialization function pointer (0 if not set)
Serialize this RefAny to JSON using its registered serialize function.
Returns Some(Json) on success, or None if serialization is not supported.struct RefCount
ptr: c_void
run_destructor: bool
fn increase_ref:
&self
fn decrease_ref:
&self
fn increase_refmut:
&self
fn decrease_refmut:
&self
Returns true if this RefCount can be shared (no mutable borrows active)
Returns true if this RefCount can be mutably shared (no borrows active)
Increases the shared reference count
Decreases the shared reference count
Increases the mutable reference count
Decreases the mutable reference count
Information passed to image rendering callbacks
struct RenderImageCallbackInfo
callback_node_id: DomNodeId
bounds: HidpiAdjustedBounds
gl_context: c_void
image_cache: c_void
system_fonts: c_void
callable_ptr: c_void
_abi_mut: c_void
fn get_bounds:
&self
&self
-> DomNodeId
fn get_gl_context:
&self
fn get_ctx:
&self
-> OptionRefAny
Returns the bounds of the laid-out node
Returns the DOM node ID that the callback is attached to
Returns the OpenGL context if available
Returns the context RefAny for FFI callbacks
fnptr RenderImageCallbackType
arg RefAny
-> ImageRef
struct PenState
position: LogicalPosition
pressure: f32
tilt: PenTilt
in_contact: bool
is_eraser: bool
barrel_button_pressed: bool
device_id: u64
tangential_pressure: f32
barrel_roll_rad: f32
tool_id: u32
struct UndoableOperation has destructor
changeset: TextChangeset
pre_state: NodeStateSnapshot
struct GraphemeClusterId
source_run: u32
start_byte_in_run: u32
struct PenTilt
x_tilt: f32
y_tilt: f32
struct ScrollState
scroll_position: LogicalPosition
struct TextChangeset has destructor
id: ChangesetId
target: DomNodeId
operation: TextOperation
timestamp: Instant
enum EdgeType
Top
Bottom
Left
Right
fnptr IconResolverCallbackType
arg OptionRefAny
arg & StyledDom
arg & SystemStyle
-> StyledDom
fnptr DatasetMergeCallbackType
-> RefAny
Return value for a VirtualView rendering callback. # Dual Size Model VirtualView callbacks return two size/offset pairs that enable lazy loading and virtualization: ## Actual Content (
scroll_size+scroll_offset) The size and position of content that has actually been rendered. This is the content currently present in the returned DOM. Example: A table view might render only 20 visible rows out of 1000 total rows. ## Virtual Content (virtual_scroll_size+virtual_scroll_offset) The size and position of content that the VirtualView pretends to have. This is used for scrollbar sizing and positioning, allowing the scrollbar to represent the full dataset even when only a subset is rendered. Example: The same table might pretend to have all 1000 rows for scrollbar sizing. # Conditional Re-invocation The VirtualView callback will be re-invoked only when necessary to avoid performance overhead: 1. Initial render - First time the VirtualView appears in the layout 2. Parent DOM recreated - The parent DOM was rebuilt from scratch (not just re-laid-out) 3. Window resize (expansion only) - Window grows and VirtualView bounds exceedscroll_size- [OK] Only triggers ONCE per expansion (when bounds become uncovered) - Does NOT trigger when window shrinks (content is clipped, not re-rendered) - Does NOT trigger if expanded area is still within existingscroll_size4. Scroll near edge - User scrolls within threshold (default 200px) of content edge - [OK] Only triggers ONCE per edge approach (prevents repeated calls) - Flag resets when: scroll moves away from edge, or callback returns expanded content 5. Programmatic scroll -set_scroll_position()scrolls beyond renderedscroll_size- Same constraints as rule #4 (threshold and once-per-edge) ## Window Resize Example text Frame 0: VirtualView bounds = 800x600, scroll_size = 800x600 (perfectly covered) Frame 1: Window resizes to 1000x700 (larger) -> VirtualView bounds = 1000x700 -> Bounds no longer fully covered by scroll_size (800x600) -> [OK] RE-INVOKE callback once Frame 2: Window resizes to 1100x800 (even larger) -> If callback returned scroll_size = 1100x800, fully covered again -> Do NOT re-invoke (content covers new bounds) -> If callback returned scroll_size = 1000x700, not fully covered -> [OK] RE-INVOKE again (new uncovered area) Frame 3: Window resizes to 900x650 (smaller) -> Bounds now smaller than scroll_size -> Do NOT re-invoke (content is just clipped by scrollbars) ## Scroll Near Edge Example text scroll_size = 1000x2000 (width x height) Container = 800x600 Threshold = 200px Current scroll_offset = 0x0 User scrolls to scroll_offset = 0x1500: -> Bottom edge at 1500 + 600 = 2100 -> Within 200px of scroll_size.height (2000) -> Distance from edge: 2100 - 2000 = 100px < 200px -> [OK] RE-INVOKE callback to load more content Callback returns: -> New scroll_size = 1000x4000 (doubled) -> Flag reset (edge no longer near) -> User continues scrolling without re-invoke until near new edge # Optimization: Returning None If the callback determines that no new content is needed (e.g., sufficient content has already been rendered ahead of the scroll position), it can returnOptionDom::Nonefor thedomfield. This signals the layout engine to keep using the current DOM and only update the scroll bounds. ,ignore fn my_virtual_view_callback(data: &mut MyData, info: &mut VirtualViewCallbackInfo) -> VirtualViewReturn { let current_scroll = info.scroll_offset; // Check if we've already rendered content that covers this scroll position if data.already_rendered_area_covers(current_scroll, info.bounds.size) { return VirtualViewReturn { dom: OptionDom::None, // Keep current DOM scroll_size: data.current_scroll_size, scroll_offset: data.current_scroll_offset, virtual_scroll_size: data.virtual_size, virtual_scroll_offset: LogicalPosition::zero(), }; } // Otherwise, render new content let new_dom = data.render_more_content(...); VirtualViewReturn { dom: OptionDom::Some(new_dom), ... } } # Example: Basic VirtualView ,ignore fn my_virtual_view_callback(data: &mut MyData, info: &mut VirtualViewCallbackInfo) -> VirtualViewReturn { let dom = Dom::body() .with_child(Dom::text("Hello from VirtualView!")); let styled_dom = dom; VirtualViewReturn { // The rendered content dom: OptionDom::Some(styled_dom), // Size of actual rendered content (matches container) scroll_size: info.bounds.size, // Content starts at top-left scroll_offset: LogicalPosition::zero(), // Virtual size same as actual (no virtualization needed) virtual_scroll_size: info.bounds.size, virtual_scroll_offset: LogicalPosition::zero(), } } # Example: Virtualized Table (Lazy Loading) ,ignore struct TableData { total_rows: usize, // 1000 rows in full dataset row_height: f32, // 30px per row visible_rows: Vec<Row>, // Currently rendered rows (e.g., rows 0-29) first_visible_row: usize, // Index of first rendered row } fn table_virtual_view_callback(data: &mut TableData, info: &mut VirtualViewCallbackInfo) -> VirtualViewReturn { let container_height = info.bounds.size.height; let scroll_y = info.scroll_offset.y; // Calculate which rows should be visible based on scroll position let first_row = (scroll_y / data.row_height) as usize; let visible_count = (container_height / data.row_height).ceil() as usize + 2; // +2 for buffer // Fetch and render only the visible rows data.visible_rows = data.fetch_rows(first_row, visible_count); data.first_visible_row = first_row; let dom = Dom::body() .with_children( data.visible_rows.iter().map(|row| { Dom::div() .with_child(Dom::text(row.text.clone())) .with_inline_css_props(css_property_vec![ ("height", format!("{}px", data.row_height)), ]) }).collect() ); VirtualViewReturn { dom: OptionDom::Some(dom), // ACTUAL: Size of the ~30 rendered rows (e.g., 900px tall) scroll_size: LogicalSize::new( info.bounds.size.width, data.visible_rows.len() as f32 * data.row_height, ), // ACTUAL: Where these rows start in virtual space (e.g., y=300 if showing rows 10-30) scroll_offset: LogicalPosition::new( 0.0, first_row as f32 * data.row_height, ), // VIRTUAL: Size if all 1000 rows were rendered (30,000px tall) virtual_scroll_size: LogicalSize::new( info.bounds.size.width, data.total_rows as f32 * data.row_height, ), // VIRTUAL: Usually starts at origin virtual_scroll_offset: LogicalPosition::zero(), } } In this example: - Only 20-30 rows are rendered at a time (~600-900px of DOM nodes) - The scrollbar represents all 1000 rows (30,000px virtual height) - When user scrolls near the bottom of rendered content, callback is re-invoked - New rows are rendered, andscroll_size/scroll_offsetare updated - User experiences seamless scrolling through the full dataset # How the Layout Engine Uses These Values ## For Rendering - Usesscroll_sizeto determine the actual size of the VirtualView's content box - Usesscroll_offsetto position the content within the virtual space - Clips rendering to the visible viewport ## For Scrollbars - Usesvirtual_scroll_sizeto calculate scrollbar thumb size and track length - Usesvirtual_scroll_offsetas the base for scroll position calculations - User sees scrollbar representing full virtual size, not just rendered content ## For Re-invocation Checks - Compares viewport bounds againstscroll_sizeto detect edge proximity - Compares current scroll position againstscroll_offset + scroll_sizebounds - Triggers callback when user scrolls beyond the rendered content thresholdstruct VirtualViewReturn has destructor
The DOM with actual rendered content, or None to keep current DOM. -
OptionDom::Some(dom)- Replace current content with this new DOM -OptionDom::None- Keep using the previous DOM, only update scroll bounds ReturningNoneis an optimization when the callback determines that the current content is sufficient (e.g., already rendered ahead of scroll position).dom: OptionDom
Size of the actual rendered content rectangle. This is the size of the content in the
domfield (if Some). It may be smaller thanvirtual_scroll_sizeif only a subset of content is rendered (virtualization). Example: For a table showing rows 10-30, this might be 600px tall (20 rows x 30px each).scroll_size: LogicalSize
Offset of the actual rendered content within the virtual coordinate space. This positions the rendered content within the larger virtual space. For virtualized content, this will be non-zero to indicate where the rendered "window" starts. Example: For a table showing rows 10-30, this might be y=300 (row 10 starts 300px from the top).
scroll_offset: LogicalPosition
Size of the virtual content rectangle (for scrollbar sizing). This is the size the scrollbar will represent. It can be much larger than
scroll_sizeto enable lazy loading and virtualization. Example: For a 1000-row table, this might be 30,000px tall (1000 rows x 30px each), even though only 20 rows are actually rendered.virtual_scroll_size: LogicalSize
Offset of the virtual content (usually zero). This is typically
(0, 0)since the virtual space usually starts at the origin. Advanced use cases might use this for complex virtualization scenarios.virtual_scroll_offset: LogicalPosition
constructor with_dom:
arg dom: Dom
arg scroll_size: LogicalSize
arg scroll_offset: LogicalPosition
arg virtual_scroll_size: LogicalSize
arg virtual_scroll_offset: LogicalPosition
constructor keep_current:
arg scroll_size: LogicalSize
arg scroll_offset: LogicalPosition
arg virtual_scroll_size: LogicalSize
arg virtual_scroll_offset: LogicalPosition
Creates a new VirtualViewReturn with updated DOM content.
Use this when the callback has rendered new content to display.
# Arguments -dom- The new DOM to render -scroll_size- Size of the actual rendered content -scroll_offset- Position of rendered content in virtual space -virtual_scroll_size- Size for scrollbar representation -virtual_scroll_offset- UsuallyLogicalPosition::zero()Creates a return value that keeps the current DOM unchanged.
Use this when the callback determines that the existing content is sufficient (e.g., already rendered ahead of scroll position). This is an optimization to avoid rebuilding the DOM unnecessarily.
# Arguments -scroll_size- Size of the current rendered content -scroll_offset- Position of current content in virtual space -virtual_scroll_size- Size for scrollbar representation -virtual_scroll_offset- UsuallyLogicalPosition::zero()fnptr RibbonOnTabClickCallbackType
arg RefAny
arg CallbackInfo
arg usize
-> Update
fnptr TreeViewOnNodeClickCallbackType
arg RefAny
arg CallbackInfo
arg usize
-> Update
fnptr OnVideoFrameCallbackType
arg RefAny
arg CallbackInfo
arg VideoFrame
-> Update
fnptr MapViewportChangedCallbackType
arg RefAny
arg CallbackInfo
arg MapViewport
-> Update
fnptr MapPinTapCallbackType
arg RefAny
arg CallbackInfo
arg MapLatLon
-> Update
fnptr OnAudioFrameCallbackType
arg RefAny
arg CallbackInfo
arg AudioFrame
-> Update
Domconstruction and configurationmod dom:
The document model, similar to HTML. This is a create-only structure, you don't actually read anything back from it. It's designed for ease of construction.
struct Dom has destructor
The data for the root node of this DOM (or sub-DOM).
root: NodeData
The children of this DOM node.
children: DomVec
Ordered list of CSS stylesheets to apply to this DOM subtree. Stylesheets are applied in push order during the single deferred cascade pass. Later entries override earlier ones (higher cascade priority).
css: CssVec
estimated_total_children: usize
constructor create_body:
-> Dom
constructor create_div:
-> Dom
constructor create_br:
-> Dom
constructor create_text:
constructor create_image:
constructor create_icon:
constructor create_virtual_view:
arg data: RefAny
arg callback: VirtualViewCallback
-> Dom
constructor create_node:
constructor create_from_data:
constructor create_from_parsed_xml:
constructor create_html:
-> Dom
constructor create_head:
-> Dom
constructor create_article:
-> Dom
constructor create_section:
-> Dom
constructor create_aside:
-> Dom
constructor create_header:
-> Dom
constructor create_main:
-> Dom
constructor create_figure:
-> Dom
constructor create_figcaption:
-> Dom
constructor create_details:
arg aria: SmallAriaInfo
-> Dom
constructor create_details_no_a11y:
-> Dom
constructor create_summary:
arg aria: SmallAriaInfo
-> Dom
constructor create_summary_no_a11y:
-> Dom
constructor create_summary_with_text:
arg text: String
arg aria: SmallAriaInfo
-> Dom
constructor create_summary_with_text_no_a11y:
constructor create_dialog:
arg aria: DialogAriaInfo
-> Dom
constructor create_dialog_no_a11y:
-> Dom
constructor create_p:
-> Dom
constructor create_h1:
-> Dom
constructor create_h1_with_text:
constructor create_h2:
-> Dom
constructor create_h2_with_text:
constructor create_h3:
-> Dom
constructor create_h3_with_text:
constructor create_h4:
-> Dom
constructor create_h4_with_text:
constructor create_h5:
-> Dom
constructor create_h5_with_text:
constructor create_h6:
-> Dom
constructor create_h6_with_text:
constructor create_span:
-> Dom
constructor create_span_with_text:
constructor create_strong:
-> Dom
constructor create_strong_with_text:
constructor create_em:
-> Dom
constructor create_em_with_text:
constructor create_code:
-> Dom
constructor create_code_with_text:
constructor create_pre:
-> Dom
constructor create_pre_with_text:
constructor create_blockquote:
-> Dom
constructor create_blockquote_with_text:
constructor create_cite:
-> Dom
constructor create_cite_with_text:
constructor create_abbr:
-> Dom
constructor create_abbr_with_title:
constructor create_kbd:
-> Dom
constructor create_kbd_with_text:
constructor create_samp:
-> Dom
constructor create_samp_with_text:
constructor create_var:
-> Dom
constructor create_var_with_text:
constructor create_sub:
-> Dom
constructor create_sub_with_text:
constructor create_sup:
-> Dom
constructor create_sup_with_text:
constructor create_u:
-> Dom
constructor create_u_with_text:
constructor create_s:
-> Dom
constructor create_s_with_text:
constructor create_mark:
-> Dom
constructor create_mark_with_text:
constructor create_del:
-> Dom
constructor create_del_with_text:
constructor create_ins:
-> Dom
constructor create_ins_with_text:
constructor create_dfn:
-> Dom
constructor create_dfn_with_text:
constructor create_time:
arg text: String
arg datetime: OptionString
-> Dom
constructor create_bdo:
-> Dom
constructor create_bdo_with_text:
constructor create_a:
arg href: String
arg text: String
arg aria: SmallAriaInfo
-> Dom
constructor create_a_no_a11y:
arg href: String
arg label: OptionString
-> Dom
constructor create_button:
arg text: String
arg aria: SmallAriaInfo
-> Dom
constructor create_button_no_a11y:
constructor create_label:
arg for_id: String
arg text: String
arg aria: SmallAriaInfo
-> Dom
constructor create_label_no_a11y:
constructor create_input:
arg input_type: String
arg name: String
arg label: String
arg aria: SmallAriaInfo
-> Dom
constructor create_input_no_a11y:
constructor create_textarea:
arg name: String
arg label: String
arg aria: SmallAriaInfo
-> Dom
constructor create_textarea_no_a11y:
constructor create_select:
arg name: String
arg label: String
arg aria: SmallAriaInfo
-> Dom
constructor create_select_no_a11y:
constructor create_option:
arg value: String
arg text: String
arg aria: SmallAriaInfo
-> Dom
constructor create_option_no_a11y:
constructor create_ul:
-> Dom
constructor create_ol:
-> Dom
constructor create_li:
-> Dom
constructor create_table:
arg caption: String
arg aria: SmallAriaInfo
-> Dom
constructor create_table_no_a11y:
-> Dom
constructor create_caption:
-> Dom
constructor create_thead:
-> Dom
constructor create_tbody:
-> Dom
constructor create_tfoot:
-> Dom
constructor create_tr:
-> Dom
constructor create_th:
-> Dom
constructor create_td:
-> Dom
constructor create_form:
arg aria: SmallAriaInfo
-> Dom
constructor create_form_no_a11y:
-> Dom
constructor create_fieldset:
arg aria: SmallAriaInfo
-> Dom
constructor create_fieldset_no_a11y:
-> Dom
constructor create_legend:
arg aria: SmallAriaInfo
-> Dom
constructor create_legend_no_a11y:
-> Dom
constructor create_hr:
-> Dom
constructor create_address:
-> Dom
constructor create_dl:
-> Dom
constructor create_dt:
-> Dom
constructor create_dd:
-> Dom
constructor create_colgroup:
-> Dom
constructor create_col:
arg span: i32
-> Dom
constructor create_optgroup:
arg label: String
arg aria: SmallAriaInfo
-> Dom
constructor create_optgroup_no_a11y:
constructor create_q:
-> Dom
constructor create_acronym:
-> Dom
constructor create_acronym_with_text:
constructor create_output:
arg aria: SmallAriaInfo
-> Dom
constructor create_output_no_a11y:
-> Dom
constructor create_progress:
arg aria: ProgressAriaInfo
-> Dom
constructor create_progress_no_a11y:
arg value: f32
arg max: f32
-> Dom
constructor create_meter:
arg aria: MeterAriaInfo
-> Dom
constructor create_meter_no_a11y:
arg value: f32
arg min: f32
arg max: f32
-> Dom
constructor create_datalist:
arg aria: SmallAriaInfo
-> Dom
constructor create_datalist_no_a11y:
-> Dom
constructor create_canvas:
arg aria: SmallAriaInfo
-> Dom
constructor create_canvas_no_a11y:
-> Dom
constructor create_object:
-> Dom
constructor create_param:
constructor create_embed:
-> Dom
constructor create_audio:
arg aria: SmallAriaInfo
-> Dom
constructor create_audio_no_a11y:
-> Dom
constructor create_video:
arg aria: SmallAriaInfo
-> Dom
constructor create_video_no_a11y:
-> Dom
constructor create_source:
constructor create_track:
constructor create_map:
-> Dom
constructor create_area:
arg aria: SmallAriaInfo
-> Dom
constructor create_area_no_a11y:
-> Dom
constructor create_title:
-> Dom
constructor create_title_with_text:
constructor create_meta:
-> Dom
constructor create_link:
-> Dom
constructor create_script:
-> Dom
constructor create_style:
-> Dom
constructor create_style_with_text:
constructor create_base:
constructor create_b:
-> Dom
constructor create_b_with_text:
constructor create_i:
-> Dom
constructor create_i_with_text:
constructor create_small:
-> Dom
constructor create_small_with_text:
constructor create_big:
-> Dom
constructor create_big_with_text:
constructor create_bdi:
-> Dom
constructor create_bdi_with_text:
constructor create_wbr:
-> Dom
constructor create_ruby:
-> Dom
constructor create_rt:
-> Dom
constructor create_rt_with_text:
constructor create_rtc:
-> Dom
constructor create_rp:
-> Dom
constructor create_rp_with_text:
constructor create_data:
constructor create_data_with_text:
constructor create_dir:
-> Dom
constructor create_svg:
-> Dom
constructor create_th_with_scope:
constructor create_td_with_text:
constructor create_th_with_text:
constructor create_li_with_text:
constructor create_p_with_text:
constructor create_geolocation_probe:
arg config: GeolocationProbeConfig
-> Dom
Creates a generic block-level container.
Accessibility: Prefer semantic elements like<article>,<section>,<nav>when applicable.Creates an icon element that will be resolved by the icon provider.
Accessibility: Icons are resolved to images or font glyphs with automatic aria-label generation. The icon name is used to generate the accessibility label.
The icon resolution happens during the StyledDom creation phase, before layout. The icon provider returns a StyledDom subtree that replaces the icon node.Creates an empty DOM with a give
NodeType. Note: This is aconst fnand doesn't allocate, it only allocates once you add at least one child node.Creates a Dom from an already-parsed Xml structure. CSS from <style> tags is attached to the Dom.css field and will be applied during the cascade pass. This is the correct function for layout callbacks that return Dom.
Creates the root HTML element.
Accessibility: The<html>element is the root of an HTML document and should have alangattribute.Creates the document head element.
Accessibility: The<head>contains metadata. Use<title>for page titles.Creates an article element.
Accessibility: Represents self-contained content that could be distributed independently. Screen readers can navigate by articles. Consider adding aria-label for multiple articles.Creates a section element.
Accessibility: Represents a thematic grouping of content with a heading. Should typically have a heading (h1-h6) as a child. Consider aria-labelledby.Creates a navigation element.
Accessibility: Represents navigation links. Screen readers can jump to navigation. Use aria-label to distinguish multiple nav elements (e.g., "Main navigation", "Footer links").Creates an aside element.
Accessibility: Represents content tangentially related to main content (sidebars, callouts). Screen readers announce this as complementary content.Creates a header element.
Accessibility: Represents introductory content or navigational aids. Can be used for page headers or section headers.Creates a footer element.
Accessibility: Represents footer for nearest section or page. Typically contains copyright, author info, or related links.Creates a main content element.
Accessibility: Represents the dominant content. There should be only ONE main per page. Screen readers can jump directly to main content. Do not nest inside article/aside/footer/header/nav.Creates a figure element.
Accessibility: Represents self-contained content like diagrams, photos, code listings. Use with<figcaption>to provide a caption. Screen readers associate caption with figure.Creates a figure caption element.
Accessibility: Provides a caption for<figure>. Screen readers announce this as the figure description.Creates a details disclosure element with accessibility information.
Usecreate_details_no_a11yonly as a deliberate escape hatch.
Accessibility: Creates a disclosure widget. Screen readers announce expanded/collapsed state. Must contain a<summary>element. Keyboard accessible by default.Creates a details disclosure element without accessibility information.
Prefercreate_detailsso that screen readers announce the disclosure widget's purpose.Creates an empty summary element for details with accessibility information.
Usecreate_summary_no_a11yonly as a deliberate escape hatch.
Accessibility: The visible heading/label for<details>. Must be the first child of details. Keyboard accessible (Enter/Space to toggle).Creates an empty summary element for details without accessibility information.
Prefercreate_summaryso that screen readers can announce the disclosure heading.Creates a summary element with text and accessibility information for details.
Usecreate_summary_with_text_no_a11yonly as a deliberate escape hatch.
Accessibility: The visible heading/label for<details>. Must be the first child of details. Keyboard accessible (Enter/Space to toggle).Creates a summary element with text without accessibility information.
Prefercreate_summary_with_textso that screen readers announce the disclosure heading.Creates a dialog element with accessibility information.
Usecreate_dialog_no_a11yonly as a deliberate escape hatch.
Accessibility: Represents a modal or non-modal dialog. When opened as modal, focus is trapped. Use aria-label or aria-labelledby. Escape key should close modal dialogs.Creates a dialog element without accessibility information.
Prefercreate_dialogso that the dialog's modality and purpose are announced.Creates a paragraph element.
Accessibility: Paragraphs provide semantic structure for screen readers.Creates an empty heading level 1 element.
Accessibility: Useh1for the main page title. There should typically be only oneh1per page.Creates a heading level 1 element with text.
Accessibility: Useh1for the main page title. There should typically be only oneh1per page.
Parameters: -text: Heading textCreates an empty heading level 2 element.
Accessibility: Useh2for major section headings underh1.Creates a heading level 2 element with text.
Accessibility: Useh2for major section headings underh1.
Parameters: -text: Heading textCreates an empty heading level 3 element.
Accessibility: Useh3for subsections underh2.Creates a heading level 3 element with text.
Accessibility: Useh3for subsections underh2.
Parameters: -text: Heading textCreates an empty heading level 4 element.
Creates a heading level 4 element with text.
Parameters: -text: Heading textCreates an empty heading level 5 element.
Creates a heading level 5 element with text.
Parameters: -text: Heading textCreates an empty heading level 6 element.
Creates a heading level 6 element with text.
Parameters: -text: Heading textCreates an empty generic inline container (span).
Accessibility: Prefer semantic elements likestrong,em,code, etc. when applicable.Creates a generic inline container (span) with text.
Accessibility: Prefer semantic elements likestrong,em,code, etc. when applicable.
Parameters: -text: Span contentCreates an empty strong importance element.
Accessibility: Usestronginstead ofbfor semantic meaning.Creates a strongly emphasized text element with text (strong importance).
Accessibility: Usestronginstead ofbfor semantic meaning. Screen readers can convey the importance. Use for text that has strong importance, seriousness, or urgency.
Parameters: -text: Text to emphasizeCreates an empty emphasis element (stress emphasis).
Accessibility: Useeminstead ofifor semantic meaning.Creates an emphasized text element with text (stress emphasis).
Accessibility: Useeminstead ofifor semantic meaning. Screen readers can convey the emphasis. Use for text that has stress emphasis.
Parameters: -text: Text to emphasizeCreates an empty code element.
Accessibility: Represents a fragment of computer code.Creates a code/computer code element with text.
Accessibility: Represents a fragment of computer code. Screen readers can identify this as code content.
Parameters: -code: Code contentCreates an empty preformatted text element.
Accessibility: Preserves whitespace and line breaks.Creates a preformatted text element with text.
Accessibility: Preserves whitespace and line breaks. Useful for code blocks or ASCII art. Screen readers will read the content as-is.
Parameters: -text: Preformatted contentCreates an empty blockquote element.
Accessibility: Represents a section quoted from another source.Creates a blockquote element with text.
Accessibility: Represents a section quoted from another source. Screen readers can identify quoted content. Consider adding aciteattribute.
Parameters: -text: Quote contentCreates an empty citation element.
Accessibility: Represents a reference to a creative work.Creates a citation element with text.
Accessibility: Represents a reference to a creative work. Screen readers can identify citations.
Parameters: -text: Citation textCreates an empty abbreviation element.
Accessibility: Represents an abbreviation or acronym. Use with atitleattribute to provide the full expansion for screen readers.Creates an abbreviation element with abbreviated text and a
titleexpansion.
Accessibility: Represents an abbreviation or acronym. Thetitleattribute provides the full expansion for screen readers.
Parameters: -abbr_text: Abbreviated text -title: Full expansionCreates an empty keyboard input element.
Accessibility: Represents keyboard input or key combinations.Creates a keyboard input element with text.
Accessibility: Represents keyboard input or key combinations. Screen readers can identify keyboard instructions.
Parameters: -text: Keyboard instructionCreates an empty sample output element.
Accessibility: Represents sample output from a program or computing system.Creates a sample output element with text.
Accessibility: Represents sample output from a program or computing system.
Parameters: -text: Sample textCreates an empty variable element.
Accessibility: Represents a variable in mathematical expressions or programming.Creates a variable element with text.
Accessibility: Represents a variable in mathematical expressions or programming.
Parameters: -text: Variable nameCreates an empty subscript element.
Creates a subscript element with text.
Accessibility: Screen readers may announce subscript formatting.
Parameters: -text: Subscript contentCreates an empty superscript element.
Creates a superscript element with text.
Accessibility: Screen readers may announce superscript formatting.
Parameters: -text: Superscript contentCreates an empty underline element.
Creates an underline text element with text.
Accessibility: Screen readers typically don't announce underline formatting. Use semantic elements when possible (e.g.,<em>for emphasis).Creates an empty strikethrough element.
Creates a strikethrough text element with text.
Accessibility: Represents text that is no longer accurate or relevant. Consider using<del>for deleted content with datetime attribute.Creates an empty mark element.
Creates a marked/highlighted text element with text.
Accessibility: Represents text marked for reference or notation purposes. Screen readers may announce this as "highlighted".Creates an empty deleted text element.
Creates a deleted text element with text.
Accessibility: Represents deleted content in document edits. Use withdatetimeandciteattributes for edit tracking.Creates an empty inserted text element.
Creates an inserted text element with text.
Accessibility: Represents inserted content in document edits. Use withdatetimeandciteattributes for edit tracking.Creates an empty definition element.
Creates a definition element with text.
Accessibility: Represents the defining instance of a term. Often used within a definition list or with<abbr>.Creates a time element.
Accessibility: Represents a specific time or date. Usedatetimeattribute for machine-readable format.
Parameters: -text: Human-readable time/date -datetime: Optional machine-readable datetimeCreates an empty bi-directional override element.
Accessibility: Overrides text direction. Usedirattribute (ltr/rtl).Creates a bi-directional override element with text.
Accessibility: Overrides text direction. Usedirattribute (ltr/rtl).Creates an anchor (hyperlink) with href, visible text, and accessibility information.
Usecreate_a_no_a11yonly as a deliberate escape hatch (for example, image-only links whose accessible name comes from an<img alt>).
Parameters: -href: Link destination URL -text: Visible link text -aria: Accessibility information (expanded description, etc.)Creates an anchor/hyperlink element without accessibility information.
Prefercreate_aso that screen readers get a meaningful label.
Parameters: -href: Link destination URL -label: Link text (passNonefor image-only links with alt text)Creates a button element with text content and accessibility information.
Usecreate_button_no_a11yonly as a deliberate escape hatch.
Parameters: -text: Button label text -aria: Accessibility information (role, description, etc.)Creates a button element without accessibility information.
Prefercreate_buttonso that the element has a meaningful accessible name for screen readers.
Parameters: -text: Button label textCreates a label element for form controls with accessibility information.
Usecreate_label_no_a11yonly as a deliberate escape hatch.
Parameters: -for_id: ID of the associated form control -text: Label text -aria: Accessibility information (description, etc.)Creates a label element for form controls without accessibility information.
Prefercreate_labelso that screen readers get a descriptive label.
Parameters: -for_id: ID of the associated form control -text: Label textCreates an input element with type, name, and accessibility information.
Usecreate_input_no_a11yonly as a deliberate escape hatch.
Parameters: -input_type: Input type (text, password, email, etc.) -name: Form field name -label: Accessibility label -aria: Accessibility information (description, etc.)Creates an input element without accessibility information.
Prefercreate_inputso that screen readers get a descriptive label beyond the HTMLaria-labelattribute.
Parameters: -input_type: Input type (text, password, email, etc.) -name: Form field name -label: Accessibility label (required)Creates a textarea element with name and accessibility information.
Usecreate_textarea_no_a11yonly as a deliberate escape hatch.
Parameters: -name: Form field name -label: Accessibility label -aria: Accessibility information (description, etc.)Creates a textarea element without accessibility information.
Prefercreate_textareaso that screen readers get an accurate description of the control.
Parameters: -name: Form field name -label: Accessibility label (required)Creates a select dropdown with name and accessibility information.
Usecreate_select_no_a11yonly as a deliberate escape hatch.
Parameters: -name: Form field name -label: Accessibility label -aria: Accessibility information (description, etc.)Creates a select dropdown without accessibility information.
Prefercreate_selectso that screen readers announce the control appropriately.
Parameters: -name: Form field name -label: Accessibility label (required)Creates an option element for select dropdowns with accessibility information.
Usecreate_option_no_a11yonly as a deliberate escape hatch.
Parameters: -value: Option value -text: Display text -aria: Accessibility information (description, etc.)Creates an option element for select dropdowns without accessibility information.
Prefercreate_optionso that screen readers can announce a description.
Parameters: -value: Option value -text: Display textCreates an unordered list element.
Accessibility: Screen readers announce lists and item counts, helping users understand content structure.Creates an ordered list element.
Accessibility: Screen readers announce lists and item counts, helping users understand content structure and numbering.Creates a list item element.
Accessibility: Must be a child oful,ol, ormenu. Screen readers announce list item position (e.g., "2 of 5").Creates a table element with a caption and accessibility information.
Usecreate_table_no_a11yonly as a deliberate escape hatch.
Parameters: -caption: Visible caption text for the table -aria: Accessibility information describing table purposeCreates a table element without accessibility information.
Prefercreate_tableso that screen readers can announce the table's purpose alongside its caption.Creates a table caption element.
Accessibility: Describes the purpose of the table. Screen readers announce this first.Creates a table header element.
Accessibility: Groups header rows. Screen readers can navigate table structure.Creates a table body element.
Accessibility: Groups body rows. Screen readers can navigate table structure.Creates a table footer element.
Accessibility: Groups footer rows. Screen readers can navigate table structure.Creates a table row element.
Creates a table header cell element.
Accessibility: Usescopeattribute ("col" or "row") to associate headers with data cells. Screen readers use this to announce cell context.Creates a table data cell element.
Creates a form element with accessibility information.
Usecreate_form_no_a11yonly as a deliberate escape hatch.
Accessibility: Group related form controls withfieldsetandlegend. Provide clear labels for all inputs. Consideraria-describedbyfor instructions.Creates a form element without accessibility information.
Prefercreate_formso that screen readers can announce the form's purpose.Creates a fieldset element with accessibility information.
Usecreate_fieldset_no_a11yonly as a deliberate escape hatch.
Accessibility: Groups related form controls. Always include alegendas the first child to describe the group. Screen readers announce the legend when entering the fieldset.Creates a fieldset element for grouping form controls without accessibility info.
Prefercreate_fieldsetso that screen readers can announce the group's purpose.Creates a legend element with accessibility information.
Usecreate_legend_no_a11yonly as a deliberate escape hatch.
Accessibility: Describes the purpose of a fieldset. Must be the first child of a fieldset. Screen readers announce this when entering the fieldset.Creates a legend element without accessibility information.
Prefercreate_legendso that the legend's accessible name is explicit.Creates a horizontal rule element.
Accessibility: Represents a thematic break. Screen readers may announce this as a separator. Consider using CSS borders for purely decorative lines.Creates an address element.
Accessibility: Represents contact information. Screen readers identify this as address content.Creates a definition list element.
Accessibility: Screen readers announce definition lists and their structure.Creates a definition term element.
Accessibility: Must be a child ofdl. Represents the term being defined.Creates a definition description element.
Accessibility: Must be a child ofdl. Provides the definition for the term.Creates a table column group element.
Creates a table column element.
Creates an optgroup element for grouping select options with accessibility information.
Usecreate_optgroup_no_a11yonly as a deliberate escape hatch.
Parameters: -label: Label for the option group (visible) -aria: Additional accessibility information (description, etc.)Creates an optgroup element for grouping select options without accessibility info.
Prefercreate_optgroupso that screen readers can announce the group's purpose.
Parameters: -label: Label for the option groupCreates a quotation element.
Accessibility: Represents an inline quotation.Creates an empty acronym element.
Note: Deprecated in HTML5. Consider usingcreate_abbr()instead.Creates an acronym element with text.
Note: Deprecated in HTML5. Consider usingcreate_abbr_with_title()instead.Creates a menu element with accessibility information.
Usecreate_menu_no_a11yonly as a deliberate escape hatch.
Accessibility: Represents a list of commands. Similar to<ul>but semantic for toolbars/menus.Creates a menu element without accessibility information.
Prefercreate_menuso that the menu's purpose is announced.Creates an empty menu item element with accessibility information.
Usecreate_menuitem_no_a11yonly as a deliberate escape hatch.
Accessibility: Represents a command in a menu. Use with appropriate role/aria attributes.Creates an empty menu item element without accessibility information.
Prefercreate_menuitemso that the menu item's purpose is announced.Creates a menu item element with text and accessibility information.
Usecreate_menuitem_with_text_no_a11yonly as a deliberate escape hatch.
Accessibility: Represents a command in a menu. Use with appropriate role/aria attributes.Creates a menu item element with text but without accessibility information.
Prefercreate_menuitem_with_textso that screen readers get a distinct accessible name.Creates an output element with accessibility information.
Usecreate_output_no_a11yonly as a deliberate escape hatch.
Accessibility: Represents the result of a calculation or user action. Useforattribute to associate with input elements. Screen readers announce updates.Creates an output element without accessibility information.
Prefercreate_outputso that screen readers can announce the computed value's purpose.Creates a progress indicator element with accessibility information.
Usecreate_progress_no_a11yonly as a deliberate escape hatch.
Accessibility: Represents task progress. Screen readers announce progress percentage. Theariavalue carries the label, current value, max, and an indeterminate flag for spinners with no known endpoint.Creates a progress indicator element without accessibility information.
Prefercreate_progressso that the task being measured is announced.
Parameters: -value: Current progress value -max: Maximum valueCreates a meter gauge element with accessibility information.
Usecreate_meter_no_a11yonly as a deliberate escape hatch.
Accessibility: Represents a scalar measurement within a known range. Screen readers announce the measurement. Theariavalue carries the label plus value/min/max/low/high/optimum metadata.Creates a meter gauge element without accessibility information.
Prefercreate_meterso that the measurement's purpose is announced.
Parameters: -value: Current meter value -min: Minimum value -max: Maximum valueCreates a datalist element for input suggestions with accessibility information.
Usecreate_datalist_no_a11yonly as a deliberate escape hatch.
Accessibility: Provides autocomplete options for inputs. Associate with input usinglistattribute. Screen readers announce available options.Creates a datalist element for input suggestions without accessibility information.
Prefercreate_datalistso that the suggestion list's purpose is announced.Creates a canvas element for graphics with accessibility information.
Usecreate_canvas_no_a11yonly as a deliberate escape hatch.
Accessibility: Canvas content is not accessible by default. Always provide fallback content as children and/or detailed aria-label. Consider using SVG for accessible graphics when possible.Creates a canvas element for graphics without accessibility information.
Prefercreate_canvasso that the canvas's purpose is announced; canvas content is otherwise opaque to assistive technologies.Creates an object element for embedded content.
Accessibility: Provide fallback content as children. Use aria-label to describe content.Creates a param element for object parameters.
Parameters: -name: Parameter name -value: Parameter valueCreates an embed element.
Accessibility: Provide alternative content or link. Use aria-label to describe embedded content.Creates an audio element with accessibility information.
Usecreate_audio_no_a11yonly as a deliberate escape hatch.
Accessibility: Always provide controls. Use<track>for captions/subtitles. Provide fallback text for unsupported browsers.Creates an audio element without accessibility information.
Prefercreate_audioso that screen readers announce the audio's purpose.Creates a video element with accessibility information.
Usecreate_video_no_a11yonly as a deliberate escape hatch.
Accessibility: Always provide controls. Use<track>for captions/subtitles/descriptions. Provide fallback text. Consider providing transcript.Creates a video element without accessibility information.
Prefercreate_videoso that screen readers announce the video's purpose.Creates a source element for media.
Parameters: -src: Media source URL -media_type: MIME type (e.g., "video/mp4", "audio/ogg")Creates a track element for media captions/subtitles.
Accessibility: Essential for deaf/hard-of-hearing users and non-native speakers. Usekind(subtitles/captions/descriptions),srclang, andlabelattributes.
Parameters: -src: Track file URL (WebVTT format) -kind: Track kind ("subtitles", "captions", "descriptions", "chapters", "metadata")Creates a map element for image maps.
Accessibility: Provide text alternatives. Ensure all areas have alt text.Creates an area element for image map regions with accessibility information.
Usecreate_area_no_a11yonly as a deliberate escape hatch.
Accessibility: Always providealttext describing the region/link purpose. Keyboard users should be able to navigate areas.Creates an area element for image map regions without accessibility information.
Prefercreate_areaso that screen readers can announce the region's purpose.Creates an empty title element for document title.
Accessibility: Required for all pages. Screen readers announce this first.Creates a title element for document title with text.
Accessibility: Required for all pages. Screen readers announce this first. Should be unique and descriptive. Keep under 60 characters.Creates a meta element.
Accessibility: Use for charset, viewport, description. Crucial for proper text display.Creates a link element for external resources.
Accessibility: Use for stylesheets, icons, alternate versions. Provide meaningfultitleattribute for alternate stylesheets.Creates a script element.
Accessibility: Ensure scripted content is accessible. Provide noscript fallbacks for critical functionality.Creates an empty style element for embedded CSS.
Note: In Azul, use.with_component_css()instead for styling. This creates a<style>HTML element for embedded stylesheets.Creates a style element for embedded CSS with the given stylesheet text.
Note: In Azul, use.with_component_css()instead for styling. This creates a<style>HTML element for embedded stylesheets.Creates a base element for document base URL.
Parameters: -href: Base URL for relative URLs in the documentCreates an empty bold element.
Accessibility: Prefer<strong>for semantic emphasis.<b>is purely stylistic.Creates a bold element with text.
Accessibility: Prefer<strong>for semantic emphasis.<b>is purely stylistic.
Parameters: -text: Bold text contentCreates an empty italic element.
Accessibility: Prefer<em>for stress emphasis.<i>is purely stylistic.Creates an italic element with text.
Accessibility: Prefer<em>for stress emphasis.<i>is purely stylistic.
Parameters: -text: Italic text contentCreates an empty small text element.
Accessibility: Represents side-comments and small print like copyright/legal text.Creates a small text element with text.
Parameters: -text: Small text contentCreates an empty
<big>element.
Note: Deprecated in HTML5. Prefer CSSfont-size.Creates a
<big>element with text.
Note: Deprecated in HTML5. Prefer CSSfont-size.Creates an empty bi-directional isolate element.
Accessibility: Used to isolate text whose direction is unknown, keeping it from affecting surrounding bidi layout.Creates a bi-directional isolate element with text.
Accessibility: Used to isolate text whose direction is unknown, keeping it from affecting surrounding bidi layout.Creates an empty word break opportunity element.
Note:<wbr>is a self-closing element that suggests a line-break opportunity. It does not take text content.Creates an empty ruby annotation element.
Accessibility: Used for East Asian typography to provide pronunciation/translation annotations. Wraps<rt>/<rp>children.Creates an empty ruby text element.
Accessibility: Pronunciation/translation annotation inside<ruby>.Creates a ruby text element with text.
Parameters: -text: Ruby annotation contentCreates an empty ruby text container element.
Accessibility: Container for ruby text annotations.Creates an empty ruby fallback parenthesis element.
Accessibility: Provides parentheses around<rt>for browsers without ruby support.Creates a ruby fallback parenthesis element with text.
Parameters: -text: Parenthesis text (typically "(" or ")")Creates a
<data>element binding a machine-readable value to its content.
Parameters: -value: Machine-readable value for thevalueattribute.Creates a
<data>element with both a machine-readable value and visible text.
Parameters: -value: Machine-readable value for thevalueattribute. -text: Human-readable text content.Creates an empty directory list element.
Note: Deprecated in HTML5. Use<ul>instead.Creates an empty SVG container element.
Accessibility: Providearia-labelor<title>child for assistive tech.Creates a table header cell with scope.
Parameters: -scope: "col", "row", "colgroup", or "rowgroup" -text: Header text
Accessibility: The scope attribute is crucial for associating headers with data cells.Creates a table data cell with text.
Parameters: -text: Cell contentCreates a table header cell with text.
Parameters: -text: Header textCreates a list item with text.
Parameters: -text: List item contentCreates a paragraph with text.
Parameters: -text: Paragraph contentCreates an invisible
NodeType::GeolocationProbenode that signals "this subtree needs the user's location". Lays out as zero-size and is skipped in the display list - the framework scans for it at end-of-layout and starts / stops the nativeCLLocationManager/LocationManager/geocluesubscription. SeeSUPER_PLAN_2.mdsection 1.5.fn with_dataset:
self
arg data: OptionRefAny
-> Dom
self
arg ids_and_classes: IdOrClassVec
-> Dom
fn with_callbacks:
self
arg callbacks: CoreCallbackDataVec
-> Dom
fn with_callback:
self
arg event: EventFilter
arg data: RefAny
arg callback: CallbackType
-> Dom
fn add_child:
&mut self
arg child: Dom
fn with_child:
fn set_children:
&mut self
arg children: DomVec
fn with_children:
fn with_id:
fn with_class:
fn add_css_property:
&mut self
arg prop: CssPropertyWithConditions
self
arg prop: CssPropertyWithConditions
-> Dom
fn with_clip_mask:
fn with_tab_index:
self
arg contenteditable: bool
-> Dom
self
arg accessibility_info: AccessibilityInfo
-> Dom
fn node_count:
&self
-> usize
&mut self
arg css: Css
&mut self
arg css: CssVec
&mut self
-> Dom
&mut self
-> Dom
fn with_attribute:
self
arg attr: AttributeType
-> Dom
fn with_attributes:
self
arg attributes: AttributeTypeVec
-> Dom
&mut self
-> usize
self
arg callback: DatasetMergeCallback
-> Dom
fn with_css:
fn with_css_props:
self
arg css_props: CssPropertyWithConditionsVec
-> Dom
fn with_node_type:
fn set_css:
&mut self
arg style: String
fn add_class:
&mut self
arg class: String
fn add_callback:
&mut self
arg event: EventFilter
arg data: RefAny
arg callback: CallbackType
fn set_tab_index:
&mut self
arg tab_index: TabIndex
&mut self
arg contenteditable: bool
Adds a CSS property with optional conditions (hover, focus, active, etc.) to the root node.
Builder method to add a CSS property with optional conditions (hover, focus, active, etc.) to the root node.
Sets the menu bar for the root node
Sets the context menu for the root node
Push a component-level CSS stylesheet onto this Dom subtree's stylesheet list. The cascade pass merges every component-level
Csstogether with the inline rules. Later.with_component_css(...)calls have higher cascade priority (override earlier ones at equal specificity).Mutating form of
with_component_css. Pushes a stylesheet onto the subtree's component-level CSS list in place.Replace the subtree's entire component-level CSS list with the provided one. Use
add_component_css/with_component_cssfor stacking; this is the wholesale-replace form.Adds an attribute to this DOM element.
Example:Adds multiple attributes to this DOM element.
Registers a callback to merge dataset state from the previous frame.
This is used for components that maintain heavy internal state (video players, WebGL contexts, network connections) that should not be destroyed and recreated on every render frame.
The callback receives both datasets asRefAny(cheap shallow clones) and returns theRefAnythat should be used for the new node.Builder method for
set_cssParse and set CSS styles with full selector support.
This is the unified API for setting inline CSS on a DOM node. It supports: - Simple properties:color: red; font-size: 14px;- Pseudo-selectors::hover { background: blue; }- @-rules:@os linux { font-size: 14px; }- Nesting:@os linux { font-size: 14px; :hover { color: red; }}
# ExamplesRepresents all data associated with a single DOM node, such as its type, classes, IDs, callbacks, and inline styles.
struct NodeData has destructor
node_type: NodeType
callbacks: CoreCallbackDataVec
style: Css
flags: NodeFlags
accessibility: c_void
extra: c_void
constructor create:
constructor create_body:
-> NodeData
constructor create_div:
-> NodeData
constructor create_br:
-> NodeData
constructor create_text:
constructor create_image:
constructor create_virtual_view:
arg data: RefAny
arg callback: VirtualViewCallback
-> NodeData
constructor create_node:
constructor create_button:
arg aria: SmallAriaInfo
-> NodeData
constructor create_button_no_a11y:
-> NodeData
constructor create_a:
arg href: String
arg aria: SmallAriaInfo
-> NodeData
constructor create_a_no_a11y:
constructor create_input:
arg input_type: String
arg name: String
arg label: String
arg aria: SmallAriaInfo
-> NodeData
constructor create_input_no_a11y:
constructor create_textarea:
arg name: String
arg label: String
arg aria: SmallAriaInfo
-> NodeData
constructor create_textarea_no_a11y:
constructor create_select:
arg name: String
arg label: String
arg aria: SmallAriaInfo
-> NodeData
constructor create_select_no_a11y:
constructor create_table:
arg aria: SmallAriaInfo
-> NodeData
constructor create_table_no_a11y:
-> NodeData
constructor create_label:
arg for_id: String
arg aria: SmallAriaInfo
-> NodeData
constructor create_label_no_a11y:
Creates an new, empty
NodeDatastructShorthand for
NodeData::create_node(NodeType::Body).Shorthand for
NodeData::create_node(NodeType::Div).Shorthand for
NodeData::create_node(NodeType::Br).Shorthand for
NodeData::create_node(NodeType::Text(value.into())).Shorthand for
NodeData::create_node(NodeType::Image(image_id)).Creates a new
NodeDatainstance from a givenNodeType.Creates a button
NodeDatawith accessibility information.Creates a button
NodeDatawithout accessibility information.Creates an anchor
NodeDatawith an href and accessibility information.Creates an anchor
NodeDatawith an href but no accessibility information.Creates an input
NodeDatawith accessibility information.Creates an input
NodeDatawithout accessibility information.Creates a textarea
NodeDatawith accessibility information.Creates a textarea
NodeDatawithout accessibility information.Creates a select
NodeDatawith accessibility information.Creates a select
NodeDatawithout accessibility information.Creates a table
NodeDatawith accessibility information.Creates a table
NodeDatawithout accessibility information.Creates a label
NodeDatawith an associated control ID and accessibility information.Creates a label
NodeDatawith an associated control ID but no accessibility information.fn set_dataset:
&mut self
arg data: OptionRefAny
&mut self
arg ids_and_classes: IdOrClassVec
fn add_callback:
&mut self
arg event: EventFilter
arg data: RefAny
arg callback: CallbackType
fn set_callbacks:
&mut self
arg callbacks: CoreCallbackDataVec
fn set_clip_mask:
&mut self
arg clip_mask: ImageMask
fn set_tab_index:
&mut self
arg tab_index: TabIndex
&mut self
arg contenteditable: bool
&self
-> bool
self
arg contenteditable: bool
-> NodeData
&mut self
arg accessibility_info: AccessibilityInfo
fn is_text_node:
&self
-> bool
&self
-> bool
fn is_anonymous:
&self
-> bool
fn set_anonymous:
&mut self
arg is_anonymous: bool
fn add_id:
&mut self
arg s: String
fn add_class:
&mut self
arg s: String
fn add_css_property:
&mut self
arg p: CssPropertyWithConditions
fn is_focusable:
&self
-> bool
fn debug_print_end:
&self
-> String
&mut self
arg callback: DatasetMergeCallback
&self
self
arg callback: DatasetMergeCallback
-> NodeData
fn get_tab_index:
&self
fn has_id:
&self
arg id: String
-> bool
fn has_class:
&self
arg class: String
-> bool
&self
-> IdOrClassVec
Sets the contenteditable flag for this node, enabling inline text editing.
Returns whether this node is marked as contenteditable.
Builder method to set contenteditable and return self.
Returns whether this node is an anonymous box generated for table layout.
Marks this node as an anonymous box (generated for table layout).
Adds a CSS property with optional conditions (hover, focus, active, etc.).
Sets a dataset merge callback for this node.
The merge callback is invoked during reconciliation when a node from the previous frame is matched with a node in the new frame. It allows heavy resources (video decoders, GL textures, network connections) to be transferred from the old node to the new node instead of being destroyed.
# Type Safety
The callback stores theTypeIdofT. During execution, both the old and new datasets must match this type, otherwise the merge is skipped.
# ExampleGets the merge callback for this node, if set.
Registers a callback to merge dataset state from the previous frame.
This is used for components that maintain heavy internal state (video players, WebGL contexts, network connections) that should not be destroyed and recreated on every render frame.
The callback receives both datasets asRefAny(cheap shallow clones) and returns theRefAnythat should be used for the new node.
# ExampleChecks whether this node has the searched ID attached.
Checks whether this node has the searched class attached.
Returns IDs and classes as a computed
IdOrClassVec. Note: this allocates a new vec each time, preferhas_id()/has_class()for checks.List of core DOM node types built into
azul. This enum defines the building blocks of the UI, similar to HTML tags.union enum NodeType has destructor
Html
Head
Body
Div
P
Article
Section
Nav
Aside
Header
Footer
Main
Figure
FigCaption
H1
H2
H3
H4
H5
H6
Br
Hr
Pre
BlockQuote
Address
Details
Summary
Dialog
Ul
Ol
Li
Dl
Dt
Dd
Menu
MenuItem
Dir
Table
Caption
THead
TBody
TFoot
Tr
Th
Td
ColGroup
Col
Form
FieldSet
Legend
Label
Input
Button
Select
OptGroup
SelectOption
TextArea
Output
Progress
Meter
DataList
Span
A
Em
Strong
B
I
U
S
Mark
Del
Ins
Code
Samp
Kbd
Var
Cite
Dfn
Abbr
Acronym
Q
Time
Sub
Sup
Small
Big
Bdo
Bdi
Wbr
Ruby
Rt
Rtc
Rp
Data
Canvas
Object
Param
Embed
Audio
Video
Source
Track
Map
Area
Svg
SvgG
SvgDefs
SvgSymbol
SvgUse
SvgSwitch
SvgPath
SvgCircle
SvgRect
SvgEllipse
SvgLine
SvgPolygon
SvgPolyline
SvgText(String)
SvgTspan
SvgTextPath
SvgLinearGradient
SvgRadialGradient
SvgStop
SvgPattern
SvgClipPathElement
SvgMask
SvgFilter
SvgFeBlend
SvgFeColorMatrix
SvgFeComponentTransfer
SvgFeComposite
SvgFeConvolveMatrix
SvgFeDiffuseLighting
SvgFeDisplacementMap
SvgFeDistantLight
SvgFeDropShadow
SvgFeFlood
SvgFeFuncR
SvgFeFuncG
SvgFeFuncB
SvgFeFuncA
SvgFeGaussianBlur
SvgFeImage
SvgFeMerge
SvgFeMergeNode
SvgFeMorphology
SvgFeOffset
SvgFePointLight
SvgFeSpecularLighting
SvgFeSpotLight
SvgFeTile
SvgFeTurbulence
SvgMarker
SvgImage(ImageRef)
SvgForeignObject
SvgTitle
SvgDesc
SvgMetadata
SvgA
SvgView
SvgStyle
SvgScript
SvgAnimate
SvgAnimateMotion
SvgAnimateTransform
SvgSet
SvgMpath
Title
Meta
Link
Script
Style
Base
Before
After
Marker
Placeholder
Text(BoxOrStaticString)
Image(BoxOrStaticImageRef)
VirtualView
Icon(BoxOrStaticString)
GeolocationProbe(GeolocationProbeConfig)
Holds information about a UI element for accessibility purposes (e.g., screen readers). This is a wrapper for platform-specific accessibility APIs like MSAA.
struct AccessibilityInfo has destructor
accessibility_name: OptionString
accessibility_value: OptionString
description: OptionString
accelerator: OptionVirtualKeyCodeCombo
default_action: OptionString
states: AccessibilityStateVec
supported_actions: AccessibilityActionVec
labelled_by: OptionDomNodeId
described_by: OptionDomNodeId
role: AccessibilityRole
is_live_region: bool
Defines the element's purpose for accessibility APIs, informing assistive technologies like screen readers about the function of a UI element. Each variant corresponds to a standard control type or UI structure. For more details, see the [MSDN Role Constants page](https://docs.microsoft.com/en-us/windows/winauto/object-roles).
enum AccessibilityRole
Represents the title or caption bar of a window. - Purpose: To identify the title bar containing the window title and system commands. - When to use: This role is typically inserted by the operating system for standard windows. - Example: The bar at the top of an application window displaying its name and the minimize, maximize, and close buttons.
TitleBar
Represents a menu bar at the top of a window. - Purpose: To contain a set of top-level menus for an application. - When to use: For the main menu bar of an application, such as one containing "File," "Edit," and "View." - Example: The "File", "Edit", "View" menu bar at the top of a text editor.
MenuBar
Represents a vertical or horizontal scroll bar. - Purpose: To enable scrolling through content that is larger than the visible area. - When to use: For any scrollable region of content. - Example: The bar on the side of a web page that allows the user to scroll up and down.
ScrollBar
Represents a handle or grip used for moving or resizing. - Purpose: To provide a user interface element for manipulating another element's size or position. - When to use: For handles that allow resizing of windows, panes, or other objects. - Example: The small textured area in the bottom-right corner of a window that can be dragged to resize it.
Grip
Represents a system sound indicating an event. - Purpose: To associate a sound with a UI event, providing an auditory cue. - When to use: When a sound is the primary representation of an event. - Example: A system notification sound that plays when a new message arrives.
Sound
Represents the system's mouse pointer or other pointing device. - Purpose: To indicate the screen position of the user's pointing device. - When to use: This role is managed by the operating system. - Example: The arrow that moves on the screen as you move the mouse.
Cursor
Represents the text insertion point indicator. - Purpose: To show the current text entry or editing position. - When to use: This role is typically managed by the operating system for text input fields. - Example: The blinking vertical line in a text box that shows where the next character will be typed.
Caret
Represents an alert or notification. - Purpose: To convey an important, non-modal message to the user. - When to use: For non-intrusive notifications that do not require immediate user interaction. - Example: A small, temporary "toast" notification that appears to confirm an action, like "Email sent."
Alert
Represents a window frame. - Purpose: To serve as the container for other objects like a title bar and client area. - When to use: This is a fundamental role, typically managed by the windowing system. - Example: The main window of any application, which contains all other UI elements.
Window
Represents a window's client area, where the main content is displayed. - Purpose: To define the primary content area of a window. - When to use: For the main content region of a window. It's often the default role for a custom control container. - Example: The area of a web browser where the web page content is rendered.
Client
Represents a pop-up menu. - Purpose: To display a list of
MenuItemobjects that appears when a user performs an action. - When to use: For context menus (right-click menus) or drop-down menus. - Example: The menu that appears when you right-click on a file in a file explorer.MenuPopup
Represents an individual item within a menu. - Purpose: To represent a single command, option, or separator within a menu. - When to use: For individual options inside a
MenuBarorMenuPopup. - Example: The "Save" option within the "File" menu.MenuItem
Represents a small pop-up window that provides information. - Purpose: To offer brief, contextual help or information about a UI element. - When to use: For informational pop-ups that appear on mouse hover. - Example: The small box of text that appears when you hover over a button in a toolbar.
Tooltip
Represents the main window of an application. - Purpose: To identify the top-level window of an application. - When to use: For the primary window that represents the application itself. - Example: The main window of a calculator or notepad application.
Application
Represents a document window within an application. - Purpose: To represent a contained document, typically in a Multiple Document Interface (MDI) application. - When to use: For individual document windows inside a larger application shell. - Example: In a photo editor that allows multiple images to be open in separate windows, each image window would be a
Document.Document
Represents a pane or a distinct section of a window. - Purpose: To divide a window into visually and functionally distinct areas. - When to use: For sub-regions of a window, like a navigation pane, preview pane, or sidebar. - Example: The preview pane in an email client that shows the content of the selected email.
Pane
Represents a graphical chart or graph. - Purpose: To display data visually in a chart format. - When to use: For any type of chart, such as a bar chart, line chart, or pie chart. - Example: A bar chart displaying monthly sales figures.
Chart
Represents a dialog box or message box. - Purpose: To create a secondary window that requires user interaction before returning to the main application. - When to use: For modal or non-modal windows that prompt the user for information or a response. - Example: The "Open File" or "Print" dialog in most applications.
Dialog
Represents a window's border. - Purpose: To identify the border of a window, which is often used for resizing. - When to use: This role is typically managed by the windowing system. - Example: The decorative and functional frame around a window.
Border
Represents a group of related controls. - Purpose: To logically group other objects that share a common purpose. - When to use: For grouping controls like a set of radio buttons or a fieldset with a legend. - Example: A "Settings" group box in a dialog that contains several related checkboxes.
Grouping
Represents a visual separator. - Purpose: To visually divide a space or a group of controls. - When to use: For visual separators in menus, toolbars, or between panes. - Example: The horizontal line in a menu that separates groups of related menu items.
Separator
Represents a toolbar containing a group of controls. - Purpose: To group controls, typically buttons, for quick access to frequently used functions. - When to use: For a bar of buttons or other controls, usually at the top of a window or pane. - Example: The toolbar at the top of a word processor with buttons for "Bold," "Italic," and "Underline."
Toolbar
Represents a status bar for displaying information. - Purpose: To display status information about the current state of the application. - When to use: For a bar, typically at the bottom of a window, that displays messages. - Example: The bar at the bottom of a web browser that shows the loading status of a page.
StatusBar
Represents a data table. - Purpose: To present data in a two-dimensional grid of rows and columns. - When to use: For grid-like data presentation. - Example: A spreadsheet or a table of data in a database application.
Table
Represents a column header in a table. - Purpose: To provide a label for a column of data. - When to use: For the headers of columns in a
Table. - Example: The header row in a spreadsheet with labels like "Name," "Date," and "Amount."ColumnHeader
Represents a row header in a table. - Purpose: To provide a label for a row of data. - When to use: For the headers of rows in a
Table. - Example: The numbered rows on the left side of a spreadsheet.RowHeader
Represents a full column of cells in a table. - Purpose: To represent an entire column as a single accessible object. - When to use: When it is useful to interact with a column as a whole. - Example: The "Amount" column in a financial data table.
Column
Represents a full row of cells in a table. - Purpose: To represent an entire row as a single accessible object. - When to use: When it is useful to interact with a row as a whole. - Example: A row representing a single customer's information in a customer list.
Row
Represents a single cell within a table. - Purpose: To represent a single data point or control within a
Table. - When to use: For individual cells in a grid or table. - Example: A single cell in a spreadsheet containing a specific value.Cell
Represents a hyperlink to a resource. - Purpose: To provide a navigational link to another document or location. - When to use: For text or images that, when clicked, navigate to another resource. - Example: A clickable link on a web page.
Link
Represents a help balloon or pop-up. - Purpose: To provide more detailed help information than a standard tooltip. - When to use: For a pop-up that offers extended help text, often initiated by a help button. - Example: A pop-up balloon with a paragraph of help text that appears when a user clicks a help icon.
HelpBalloon
Represents an animated, character-like graphic object. - Purpose: To provide an animated agent for user assistance or entertainment. - When to use: For animated characters or avatars that provide help or guidance. - Example: An animated paperclip that offers tips in a word processor (e.g., Microsoft's Clippy).
Character
Represents a list of items. - Purpose: To contain a set of
ListItemobjects. - When to use: For list boxes or similar controls that present a list of selectable items. - Example: The list of files in a file selection dialog.List
Represents an individual item within a list. - Purpose: To represent a single, selectable item within a
List. - When to use: For each individual item in a list box or combo box. - Example: A single file name in a list of files.ListItem
Represents an outline or tree structure. - Purpose: To display a hierarchical view of data. - When to use: For tree-view controls that show nested items. - Example: A file explorer's folder tree view.
Outline
Represents an individual item within an outline or tree. - Purpose: To represent a single node (which can be a leaf or a branch) in an
Outline. - When to use: For each node in a tree view. - Example: A single folder in a file explorer's tree view.OutlineItem
Represents a single tab in a tabbed interface. - Purpose: To provide a control for switching between different
PropertyPageviews. - When to use: For the individual tabs that the user can click to switch pages. - Example: The "General" and "Security" tabs in a file properties dialog.PageTab
Represents the content of a page in a property sheet. - Purpose: To serve as a container for the controls displayed when a
PageTabis selected. - When to use: For the content area associated with a specific tab. - Example: The set of options displayed when the "Security" tab is active.PropertyPage
Represents a visual indicator, like a slider thumb. - Purpose: To visually indicate the current value or position of another control. - When to use: For a sub-element that indicates status, like the thumb of a scrollbar. - Example: The draggable thumb of a scrollbar that indicates the current scroll position.
Indicator
Represents a picture or graphical image. - Purpose: To display a non-interactive image. - When to use: For images and icons that are purely decorative or informational. - Example: A company logo displayed in an application's "About" dialog.
Graphic
Represents read-only text. - Purpose: To provide a non-editable text label for another control or for displaying information. - When to use: For text that the user cannot edit. - Example: The label "Username:" next to a text input field.
StaticText
Represents editable text or a text area. - Purpose: To allow for user text input or selection. - When to use: For text input fields where the user can type. - Example: A text box for entering a username or password.
Text
Represents a standard push button. - Purpose: To initiate an immediate action. - When to use: For standard buttons that perform an action when clicked. - Example: An "OK" or "Cancel" button in a dialog.
PushButton
Represents a check box control. - Purpose: To allow the user to make a binary choice (checked or unchecked). - When to use: For options that can be toggled on or off independently. - Example: A "Remember me" checkbox on a login form.
CheckButton
Represents a radio button. - Purpose: To allow the user to select one option from a mutually exclusive group. - When to use: For a choice where only one option from a
Groupingcan be selected. - Example: "Male" and "Female" radio buttons for selecting gender.RadioButton
Represents a combination of a text field and a drop-down list. - Purpose: To allow the user to either type a value or select one from a list. - When to use: For controls that offer a list of suggestions but also allow custom input. - Example: A font selector that allows you to type a font name or choose one from a list.
ComboBox
Represents a drop-down list box. - Purpose: To allow the user to select an item from a non-editable list that drops down. - When to use: For selecting a single item from a predefined list of options. - Example: A country selection drop-down menu.
DropList
Represents a progress bar. - Purpose: To indicate the progress of a lengthy operation. - When to use: To provide feedback for tasks like file downloads or installations. - Example: The bar that fills up to show the progress of a file copy operation.
ProgressBar
Represents a dial or knob. - Purpose: To allow selecting a value from a continuous or discrete range, often circularly. - When to use: For controls that resemble real-world dials, like a volume knob. - Example: A volume control knob in a media player application.
Dial
Represents a control for entering a keyboard shortcut. - Purpose: To capture a key combination from the user. - When to use: In settings where users can define their own keyboard shortcuts. - Example: A text field in a settings dialog where a user can press a key combination to assign it to a command.
HotkeyField
Represents a slider for selecting a value within a range. - Purpose: To allow the user to adjust a setting along a continuous or discrete range. - When to use: For adjusting values like volume, brightness, or zoom level. - Example: A slider to control the volume of a video.
Slider
Represents a spin button (up/down arrows) for incrementing or decrementing a value. - Purpose: To provide fine-tuned adjustment of a value, typically numeric. - When to use: For controls that allow stepping through a range of values. - Example: The up and down arrows next to a number input for setting the font size.
SpinButton
Represents a diagram or flowchart. - Purpose: To represent data or relationships in a schematic form. - When to use: For visual representations of structures that are not charts, like a database schema diagram. - Example: A flowchart illustrating a business process.
Diagram
Represents an animation control. - Purpose: To display a sequence of images or indicate an ongoing process. - When to use: For animations that show that an operation is in progress. - Example: The animation that plays while files are being copied.
Animation
Represents a mathematical equation. - Purpose: To display a mathematical formula in the correct format. - When to use: For displaying mathematical equations. - Example: A rendered mathematical equation in a scientific document editor.
Equation
Represents a button that drops down a list of items. - Purpose: To combine a default action button with a list of alternative actions. - When to use: For buttons that have a primary action and a secondary list of options. - Example: A "Send" button with a dropdown arrow that reveals "Send and Archive."
ButtonDropdown
Represents a button that drops down a full menu. - Purpose: To provide a button that opens a menu of choices rather than performing a single action. - When to use: When a button's primary purpose is to reveal a menu. - Example: A "Tools" button that opens a menu with various tool options.
ButtonMenu
Represents a button that drops down a grid for selection. - Purpose: To allow selection from a two-dimensional grid of options. - When to use: For buttons that open a grid-based selection UI. - Example: A color picker button that opens a grid of color swatches.
ButtonDropdownGrid
Represents blank space between other objects. - Purpose: To represent significant empty areas in a UI that are part of the layout. - When to use: Sparingly, to signify that a large area is intentionally blank. - Example: A large empty panel in a complex layout might use this role.
Whitespace
Represents the container for a set of tabs. - Purpose: To group a set of
PageTabelements. - When to use: To act as the parent container for a row or column of tabs. - Example: The entire row of tabs at the top of a properties dialog.PageTabList
Represents a clock control. - Purpose: To display the current time. - When to use: For any UI element that displays time. - Example: The clock in the system tray of the operating system.
Clock
Represents a button with two parts: a default action and a dropdown. - Purpose: To combine a frequently used action with a set of related, less-used actions. - When to use: When a button has a default action and other related actions available in a dropdown. - Example: A "Save" split button where the primary part saves, and the dropdown offers "Save As."
SplitButton
Represents a control for entering an IP address. - Purpose: To provide a specialized input field for IP addresses, often with formatting and validation. - When to use: For dedicated IP address input fields. - Example: A network configuration dialog with a field for entering a static IP address.
IpAddress
Represents an element with no specific role. - Purpose: To indicate an element that has no semantic meaning for accessibility. - When to use: Should be used sparingly for purely decorative elements that should be ignored by assistive technologies. - Example: A decorative graphical flourish that has no function or information to convey.
Nothing
Unknown or unspecified role. - Purpose: Default fallback when no specific role is assigned. - When to use: As a default value or when role information is unavailable.
Unknown
Defines the current state of an element for accessibility APIs (e.g., focused, checked). These states provide dynamic information to assistive technologies about the element's condition. See the [MSDN State Constants page](https://docs.microsoft.com/en-us/windows/win32/winauto/object-state-constants) for more details.
enum AccessibilityState
Unavailable
Selected
Focused
CheckedTrue
CheckedFalse
Readonly
Default
Expanded
Collapsed
Busy
Offscreen
Focusable
Selectable
Linked
Traversed
Multiselectable
Protected
Determines the behavior of an element in sequential focus navigation
union enum TabIndex
Automatic tab index, similar to simply setting
focusable = "true"ortabindex = 0(both have the effect of making the element focusable). Sidenote: See https://www.w3.org/TR/html5/editing.html#sequential-focus-navigation-and-the-tabindex-attribute for interesting notes on tabindex and accessibilityAuto
Set the tab index in relation to its parent element. I.e. if you have a list of elements, the focusing order is restricted to the current parent. Ex. a div might have: no_run,ignore div (Auto) |- element1 (OverrideInParent 0) <- current focus |- element2 (OverrideInParent 5) |- element3 (OverrideInParent 2) |- element4 (Global 5) ignore When pressing tab repeatedly, the focusing order will be "element3, element2, element4, div", since OverrideInParent elements take precedence among global order.
OverrideInParent(u32)
Elements can be focused in callbacks, but are not accessible via keyboard / tab navigation (-1).
NoKeyboardFocus
Packed representation of tab index + contenteditable flag as a u32.
struct NodeFlags
inner: u32
A unique, runtime-generated identifier for a single
Dominstance.struct DomId
inner: usize
A UUID for a DOM node within a
LayoutWindow.struct DomNodeId
The ID of the
Domthis node belongs to.dom: DomId
The hierarchical ID of the node within its
Dom.node: NodeHierarchyItemId
union enum AccessibilityAction has destructor
Default
Focus
Blur
Collapse
Expand
ScrollIntoView
Increment
Decrement
ShowContextMenu
HideTooltip
ShowTooltip
ScrollUp
ScrollDown
ScrollLeft
ScrollRight
ReplaceSelectedText(String)
ScrollToPoint(LogicalPosition)
SetScrollOffset(LogicalPosition)
SetTextSelection(TextSelectionStartEnd)
SetSequentialFocusNavigationStartingPoint
SetValue(String)
SetNumericValue(FloatValue)
CustomAction(i32)
struct ListViewOnColumnClickCallback
cb: ListViewOnColumnClickCallbackType
callable: OptionRefAny
struct TagIdToNodeIdMapping
tag_id: TagId
node_id: NodeHierarchyItemId
tab_index: OptionTabIndex
struct CoreCallback
cb: CoreCallbackType
ctx: OptionRefAny
struct NodeHierarchyItemId
inner: usize
constructor from_raw:
arg value: usize
Creates an
NodeHierarchyItemIdfrom a raw 1-based encoded value.
# Warning
The value must use 1-based encoding (0 = None, n = NodeId(n-1)). Prefer using [NodeHierarchyItemId::from_crate_internal] instead.fn into_raw:
&self
-> usize
Returns the raw 1-based encoded value.
# Warning
The returned value uses 1-based encoding. Do NOT use as an array index!struct CoreCallbackData
event: EventFilter
callback: CoreCallback
refany: RefAny
struct ListViewOnRowClickCallback
cb: ListViewOnRowClickCallbackType
callable: OptionRefAny
struct CoreMenuCallback
refany: RefAny
callback: CoreCallback
struct AttributeNameValue has destructor
attr_name: String
value: String
Tag of an XML node, such as the "button" in
<button>Hello</button>.struct XmlTagName has destructor
inner: String
struct CheckBoxOnToggleCallback
cb: CheckBoxOnToggleCallbackType
callable: OptionRefAny
struct DropDownOnChoiceChangeCallback
cb: DropDownOnChoiceChangeCallbackType
callable: OptionRefAny
struct TabOnClickCallback
callable: OptionRefAny
struct ParentWithNodeDepth
depth: usize
node_id: NodeHierarchyItemId
struct ListViewOnLazyLoadScrollCallback
cb: ListViewOnLazyLoadScrollCallbackType
callable: OptionRefAny
union enum AttributeType has destructor
Id(String)
Class(String)
AriaLabel(String)
AriaLabelledBy(String)
AriaDescribedBy(String)
AriaRole(String)
AriaState(AttributeNameValue)
AriaProperty(AttributeNameValue)
Href(String)
Rel(String)
Target(String)
Src(String)
Alt(String)
Title(String)
Name(String)
Value(String)
InputType(String)
Placeholder(String)
Required
Disabled
Readonly
CheckedTrue
CheckedFalse
Selected
Max(String)
Min(String)
Step(String)
Pattern(String)
MinLength(i32)
MaxLength(i32)
Autocomplete(String)
Scope(String)
ColSpan(i32)
RowSpan(i32)
TabIndex(i32)
Focusable
Lang(String)
Dir(String)
ContentEditable(bool)
Draggable(bool)
Hidden
Data(AttributeNameValue)
Custom(AttributeNameValue)
union enum XmlNodeChild has destructor
Text(String)
Element(XmlNode)
struct NodeHierarchyItem
parent: usize
previous_sibling: usize
next_sibling: usize
last_child: usize
struct ButtonOnClickCallback
callable: OptionRefAny
struct XmlNode has destructor
node_type: XmlTagName
attributes: XmlAttributeMap
children: XmlNodeChildVec
struct TagId
inner: u64
Attributes of an XML node, such as
["color" => "blue"]in<button color="blue" />.struct XmlAttributeMap has destructor
inner: StringPairVec
enum NodeTypeTag
Html
Head
Body
Div
P
Article
Section
Nav
Aside
Header
Footer
Main
Figure
FigCaption
H1
H2
H3
H4
H5
H6
Br
Hr
Pre
BlockQuote
Address
Details
Summary
Dialog
Ul
Ol
Li
Dl
Dt
Dd
Menu
MenuItem
Dir
Table
Caption
THead
TBody
TFoot
Tr
Th
Td
ColGroup
Col
Form
FieldSet
Legend
Label
Input
Button
Select
OptGroup
SelectOption
TextArea
Output
Progress
Meter
DataList
Span
A
Em
Strong
B
I
U
S
Mark
Del
Ins
Code
Samp
Kbd
Var
Cite
Dfn
Abbr
Acronym
Q
Time
Sub
Sup
Small
Big
Bdo
Bdi
Wbr
Ruby
Rt
Rtc
Rp
Data
Canvas
Object
Param
Embed
Audio
Video
Source
Track
Map
Area
Svg
SvgPath
SvgCircle
SvgRect
SvgEllipse
SvgLine
SvgPolygon
SvgPolyline
SvgG
SvgDefs
SvgSymbol
SvgUse
SvgSwitch
SvgText
SvgTspan
SvgTextPath
SvgLinearGradient
SvgRadialGradient
SvgStop
SvgPattern
SvgClipPathElement
SvgMask
SvgFilter
SvgFeBlend
SvgFeColorMatrix
SvgFeComponentTransfer
SvgFeComposite
SvgFeConvolveMatrix
SvgFeDiffuseLighting
SvgFeDisplacementMap
SvgFeDistantLight
SvgFeDropShadow
SvgFeFlood
SvgFeFuncR
SvgFeFuncG
SvgFeFuncB
SvgFeFuncA
SvgFeGaussianBlur
SvgFeImage
SvgFeMerge
SvgFeMergeNode
SvgFeMorphology
SvgFeOffset
SvgFePointLight
SvgFeSpecularLighting
SvgFeSpotLight
SvgFeTile
SvgFeTurbulence
SvgMarker
SvgImage
SvgForeignObject
SvgTitle
SvgDesc
SvgMetadata
SvgA
SvgView
SvgStyle
SvgScript
SvgAnimate
SvgAnimateMotion
SvgAnimateTransform
SvgSet
SvgMpath
Title
Meta
Link
Script
Style
Base
Text
Img
VirtualView
Icon
GeolocationProbe
Before
After
Marker
Placeholder
enum VertexAttributeType
Float
Double
UnsignedByte
UnsignedShort
UnsignedInt
struct VertexAttribute has destructor
va_name: String
layout_location: OptionUsize
attribute_type: VertexAttributeType
item_count: usize
struct InstantPtrCloneCallback
struct InstantPtrDestructorCallback
struct Callback
cb: CallbackType
ctx: OptionRefAny
constructor create:
arg cb: CallbackType
-> Callback
Create a new callback with just a function pointer (for native Rust code)
fn to_core:
self
-> CoreCallback
Converts this Callback to a CoreCallback for use with Dom::set_callback
struct DebugState
profiler_dbg: bool
render_target_dbg: bool
texture_cache_dbg: bool
gpu_time_queries: bool
gpu_sample_queries: bool
disable_batching: bool
epochs: bool
echo_driver_messages: bool
show_overdraw: bool
gpu_cache_dbg: bool
texture_cache_dbg_clear_evicted: bool
picture_caching_dbg: bool
primitive_dbg: bool
zoom_dbg: bool
small_screen: bool
disable_opaque_pass: bool
disable_alpha_pass: bool
disable_clip_masks: bool
disable_text_prims: bool
disable_gradient_prims: bool
obscure_images: bool
glyph_flashing: bool
smart_profiler: bool
invalidation_dbg: bool
tile_cache_logging_dbg: bool
profiler_capture: bool
force_picture_invalidation: bool
struct KeyboardState has destructor
current_virtual_keycode: OptionVirtualKeyCode
pressed_virtual_keycodes: VirtualKeyCodeVec
pressed_scancodes: ScanCodeVec
struct TouchState
num_touches: usize
touch_points: TouchPointVec
struct GeolocationProbeConfig
high_accuracy: bool
background: bool
max_accuracy_m: f32
min_interval_ms: u32
struct LocationFix
latitude_deg: f64
longitude_deg: f64
accuracy_m: f32
altitude_m: f32
altitude_accuracy_m: f32
heading_deg: f32
speed_mps: f32
timestamp_ms: u64
struct MouseState
mouse_cursor_type: OptionMouseCursorType
cursor_position: CursorPosition
is_cursor_locked: bool
left_down: bool
right_down: bool
middle_down: bool
struct NodeId
inner: usize
constructor create:
arg value: usize
-> NodeId
Creates a new
NodeIdfrom a zero-based index.
# Panics
In debug mode, panics if the index would overflow when incremented. In release mode, saturates to the maximum value.
# Examplesfn index:
&self
-> usize
struct CoreRenderImageCallback
cb: CoreRenderImageCallbackType
ctx: OptionRefAny
struct CoreImageCallback
refany: RefAny
callback: CoreRenderImageCallback
struct ClipboardContent has destructor
plain_text: String
styled_runs: StyledTextRunVec
union enum Selection
Cursor(TextCursor)
Range(SelectionRange)
union enum TextInputSelection
All
FromTo(TextInputSelectionRange)
struct SelectionId
inner: u64
struct SelectionRange
start: TextCursor
end: TextCursor
struct TextInputSelectionRange
dir_from: usize
dir_to: usize
struct TextSelectionStartEnd
selection_start: usize
selection_end: usize
struct VirtualKeyCodeCombo has destructor
keys: VirtualKeyCodeVec
struct SelectionColor
inner: ColorU
struct SelectionRadius
inner: PixelValue
struct TextInputOnVirtualKeyDown
data: RefAny
callback: TextInputOnVirtualKeyDownCallback
struct TextInputOnVirtualKeyDownCallback
cb: TextInputOnVirtualKeyDownCallbackType
callable: OptionRefAny
struct SelectionState
selections: SelectionVec
node_id: DomNodeId
enum VirtualKeyCode
Key1
Key2
Key3
Key4
Key5
Key6
Key7
Key8
Key9
Key0
A
B
C
D
E
F
G
H
I
J
K
L
M
N
O
P
Q
R
S
T
U
V
W
X
Y
Z
Escape
F1
F2
F3
F4
F5
F6
F7
F8
F9
F10
F11
F12
F13
F14
F15
F16
F17
F18
F19
F20
F21
F22
F23
F24
Snapshot
Scroll
Pause
Insert
Home
Delete
End
PageDown
PageUp
Left
Up
Right
Down
Back
Return
Space
Compose
Caret
Numlock
Numpad0
Numpad1
Numpad2
Numpad3
Numpad4
Numpad5
Numpad6
Numpad7
Numpad8
Numpad9
NumpadAdd
NumpadDivide
NumpadDecimal
NumpadComma
NumpadEnter
NumpadEquals
NumpadMultiply
NumpadSubtract
AbntC1
AbntC2
Apostrophe
Apps
Asterisk
At
Ax
Backslash
Calculator
Capital
Colon
Comma
Convert
Equals
Grave
Kana
Kanji
LAlt
LBracket
LControl
LShift
LWin
Mail
MediaSelect
MediaStop
Minus
Mute
MyComputer
NavigateForward
NavigateBackward
NextTrack
NoConvert
OEM102
Period
PlayPause
Plus
Power
PrevTrack
RAlt
RBracket
RControl
RShift
RWin
Semicolon
Slash
Sleep
Stop
Sysrq
Tab
Underline
Unlabeled
VolumeDown
VolumeUp
Wake
WebBack
WebFavorites
WebForward
WebHome
WebRefresh
WebSearch
WebStop
Yen
Copy
Paste
Cut
struct TextOpExtendSelection
old_range: SelectionRange
new_range: SelectionRange
direction: SelectionDirection
Callback for rendering dynamic images
struct RenderImageCallback
ctx: OptionRefAny
constructor create:
arg cb: RenderImageCallbackType
Creates a new RenderImageCallback from a function pointer
fn to_core:
self
Converts this RenderImageCallback to a CoreRenderImageCallback for use with ImageRef::callback
enum SelectionDirection
Forward
Backward
struct DragState has destructor
drag_type: DragType
source_node: OptionDomNodeId
current_drop_target: OptionDomNodeId
file_path: OptionString
struct TextOpSetSelection
old_range: OptionSelectionRange
new_range: SelectionRange
struct TextOpClearSelection
old_range: SelectionRange
struct NodeStateSnapshot has destructor
node_id: NodeId
text_content: String
cursor_position: OptionTextCursor
selection_range: OptionSelectionRange
timestamp: Instant
enum DragType
Node
File
struct SmallAriaInfo has destructor
label: OptionString
role: OptionAccessibilityRole
description: OptionString
fn with_role:
self
arg role: AccessibilityRole
fn with_description:
self
arg desc: String
Returns a copy with the given accessibility role.
Returns a copy with the given accessible description.
Accessibility information for a
<progress>indicator.struct ProgressAriaInfo has destructor
label: OptionString
current_value: OptionF32
max: OptionF32
indeterminate: bool
description: OptionString
self
arg value: f32
fn with_max:
self
arg max: f32
self
arg indeterminate: bool
fn with_description:
self
arg desc: String
Returns a copy with the given current value.
Returns a copy with the given maximum value.
Returns a copy with the indeterminate flag set.
Returns a copy with the given description.
Accessibility information for a
<meter>gauge.struct MeterAriaInfo has destructor
label: OptionString
current_value: f32
min: f32
max: f32
low: OptionF32
high: OptionF32
optimum: OptionF32
description: OptionString
constructor create:
arg label: String
arg current_value: f32
arg min: f32
arg max: f32
Creates a
MeterAriaInfowith the required label and value/range triple.fn with_low:
self
arg low: f32
fn with_high:
self
arg high: f32
fn with_optimum:
self
arg optimum: f32
fn with_description:
self
arg desc: String
Returns a copy with the given low threshold.
Returns a copy with the given high threshold.
Returns a copy with the given optimum value.
Returns a copy with the given description.
union enum IdOrClass has destructor
Id(String)
Class(String)
struct DatasetMergeCallback
callable: OptionRefAny
constructor from:
arg cb: DatasetMergeCallbackType
struct NodeDataVecSlice has destructor
Pointer to the slice data
ptr: NodeData
Number of elements in the slice
len: usize
struct VirtualKeyCodeVecSlice
Pointer to the slice data
ptr: VirtualKeyCode
Number of elements in the slice
len: usize
struct NodeHierarchyItemVecSlice
Pointer to the slice data
ptr: NodeHierarchyItem
Number of elements in the slice
len: usize
struct DomIdVecSlice
ptr: DomId
len: usize
struct TagIdToNodeIdMappingVecSlice
Pointer to the slice data
ptr: TagIdToNodeIdMapping
Number of elements in the slice
len: usize
struct VertexAttributeVecSlice has destructor
Pointer to the slice data
ptr: VertexAttribute
Number of elements in the slice
len: usize
struct AccessibilityStateVecSlice
Pointer to the slice data
ptr: AccessibilityState
Number of elements in the slice
len: usize
struct NodeHierarchyItemIdVecSlice
ptr: NodeHierarchyItemId
len: usize
struct IdOrClassVecSlice has destructor
Pointer to the slice data
ptr: IdOrClass
Number of elements in the slice
len: usize
struct SelectionRangeVecSlice
Pointer to the slice data
ptr: SelectionRange
Number of elements in the slice
len: usize
struct SelectionVecSlice
Pointer to the slice data
ptr: Selection
Number of elements in the slice
len: usize
struct DomVecSlice has destructor
Pointer to the slice data
ptr: Dom
Number of elements in the slice
len: usize
struct AttributeTypeVecSlice has destructor
Pointer to the slice data
ptr: AttributeType
Number of elements in the slice
len: usize
struct AccessibilityActionVecSlice has destructor
Pointer to the slice data
ptr: AccessibilityAction
Number of elements in the slice
len: usize
struct CoreCallbackDataVecSlice
Pointer to the slice data
ptr: CoreCallbackData
Number of elements in the slice
len: usize
struct ScanCodeVecSlice
Pointer to the slice data
ptr: ScanCode
Number of elements in the slice
len: usize
struct ParentWithNodeDepthVecSlice
Pointer to the slice data
ptr: ParentWithNodeDepth
Number of elements in the slice
len: usize
struct XmlNodeChildVecSlice has destructor
Pointer to the slice data
ptr: XmlNodeChild
Number of elements in the slice
len: usize
struct AccessibilitySettings
text_scale_factor: f32
prefers_bold_text: bool
prefers_larger_text: bool
prefers_high_contrast: bool
prefers_reduced_motion: bool
prefers_reduced_transparency: bool
screen_reader_active: bool
differentiate_without_color: bool
struct InputMetrics
double_click_time_ms: u32
double_click_distance_px: f32
drag_threshold_px: f32
caret_blink_rate_ms: u32
caret_width_px: f32
wheel_scroll_lines: u32
hover_time_ms: u32
struct FocusVisuals
focus_ring_color: OptionColorU
focus_border_width: OptionPixelValue
focus_border_height: OptionPixelValue
enum FocusBehavior
AlwaysVisible
KeyboardOnly
struct DragDelta
dx: f32
dy: f32
Drop effect - the outcome if the dragged data is dropped on the current target (HTML5
DataTransfer.dropEffect). Must be one ofNone,Copy,Link, orMove; defaults toNone.enum DropEffect
None
Copy
Link
Move
Set of drag operations the drag source permits (HTML5
DataTransfer.effectAllowed). Superset ofDropEffectadding combined values (CopyLink,CopyMove,LinkMove,All) andUninitialized(the default).enum DragEffect
Uninitialized
None
Copy
CopyLink
CopyMove
Link
LinkMove
Move
All
Drag data (HTML5
DataTransfer): the MIME-keyed payload and the set of operations the source allows.struct DragData has destructor
data: MimeTypeDataVec
effect_allowed: DragEffect
struct ParseIntErrorWithInput has destructor
error: String
input: String
struct ParseFloatErrorWithInput has destructor
error: ParseFloatError
input: String
union enum VirtualViewCallbackReason
InitialRender
DomRecreated
BoundsExpanded
EdgeScrolled(EdgeType)
ScrollBeyondContent
C-ABI wrapper over an
VirtualViewCallbackTypestruct VirtualViewCallback
ctx: OptionRefAny
enum ScrollIntoViewBehavior
Auto
Instant
Smooth
struct RibbonOnTabClickCallback
cb: RibbonOnTabClickCallbackType
callable: OptionRefAny
struct TreeViewOnNodeClickCallback
cb: TreeViewOnNodeClickCallbackType
callable: OptionRefAny
struct CssAttributeSelector has destructor
name: String
op: AttributeMatchOp
value: OptionString
enum AttributeMatchOp
Exists
Eq
Includes
DashMatch
Prefix
Suffix
Substring
struct OnVideoFrameCallback
callable: OptionRefAny
struct MapPinTapCallback
callable: OptionRefAny
struct OnAudioFrameCallback
callable: OptionRefAny
Cssparsing modulemod css:
One block of rules that applies a bunch of rules to a "path" in the style, i.e.
div#myid.myclass -> { ("justify-content", "center") }struct CssRuleBlock has destructor
The css path (full selector) of the style ruleset
path: CssPath
"justify-content: center"=>CssDeclaration::Static(CssProperty::JustifyContent(LayoutJustifyContent::Center))declarations: CssDeclarationVec
Conditions from enclosing @-rules (@media, @lang, etc.) that must ALL be satisfied for this rule block to apply. Empty = unconditional.
conditions: DynamicSelectorVec
Layer priority. 0 = UA / framework, 10 = system, 20 = author CSS (default), 30 = inline, 50 = runtime overrides. Combined with selector specificity in
Css::sort_by_specificityto put rules in cascade order.priority: u8
Represents one parsed CSS key-value pair, such as
"width: 20px"=>CssProperty::Width(LayoutWidth::px(20.0))union enum CssProperty
CaretColor(CaretColorValue)
CaretAnimationDuration(CaretAnimationDurationValue)
CaretWidth(CaretWidthValue)
SelectionBackgroundColor(SelectionBackgroundColorValue)
SelectionColor(SelectionColorValue)
SelectionRadius(SelectionRadiusValue)
TextColor(StyleTextColorValue)
FontSize(StyleFontSizeValue)
FontFamily(StyleFontFamilyVecValue)
FontWeight(StyleFontWeightValue)
FontStyle(StyleFontStyleValue)
TextAlign(StyleTextAlignValue)
TextJustify(LayoutTextJustifyValue)
VerticalAlign(StyleVerticalAlignValue)
LetterSpacing(StyleLetterSpacingValue)
TextIndent(StyleTextIndentValue)
InitialLetter(StyleInitialLetterValue)
LineClamp(StyleLineClampValue)
HangingPunctuation(StyleHangingPunctuationValue)
TextCombineUpright(StyleTextCombineUprightValue)
UnicodeBidi(StyleUnicodeBidiValue)
TextBoxTrim(StyleTextBoxTrimValue)
TextBoxEdge(StyleTextBoxEdgeValue)
DominantBaseline(StyleDominantBaselineValue)
AlignmentBaseline(StyleAlignmentBaselineValue)
InitialLetterAlign(StyleInitialLetterAlignValue)
InitialLetterWrap(StyleInitialLetterWrapValue)
ScrollbarGutter(StyleScrollbarGutterValue)
OverflowClipMargin(StyleOverflowClipMarginValue)
Clip(StyleClipRectValue)
ExclusionMargin(StyleExclusionMarginValue)
HyphenationLanguage(StyleHyphenationLanguageValue)
LineHeight(StyleLineHeightValue)
WordSpacing(StyleWordSpacingValue)
TabSize(StyleTabSizeValue)
WhiteSpace(StyleWhiteSpaceValue)
Hyphens(StyleHyphensValue)
WordBreak(StyleWordBreakValue)
OverflowWrap(StyleOverflowWrapValue)
LineBreak(StyleLineBreakValue)
ObjectFit(StyleObjectFitValue)
ObjectPosition(StyleObjectPositionValue)
AspectRatio(StyleAspectRatioValue)
TextOrientation(StyleTextOrientationValue)
TextAlignLast(StyleTextAlignLastValue)
Direction(StyleDirectionValue)
UserSelect(StyleUserSelectValue)
TextDecoration(StyleTextDecorationValue)
Cursor(StyleCursorValue)
Display(LayoutDisplayValue)
Float(LayoutFloatValue)
BoxSizing(LayoutBoxSizingValue)
Width(LayoutWidthValue)
Height(LayoutHeightValue)
MinWidth(LayoutMinWidthValue)
MinHeight(LayoutMinHeightValue)
MaxWidth(LayoutMaxWidthValue)
MaxHeight(LayoutMaxHeightValue)
Position(LayoutPositionValue)
Top(LayoutTopValue)
Right(LayoutRightValue)
Left(LayoutLeftValue)
Bottom(LayoutInsetBottomValue)
ZIndex(LayoutZIndexValue)
FlexWrap(LayoutFlexWrapValue)
FlexDirection(LayoutFlexDirectionValue)
FlexGrow(LayoutFlexGrowValue)
FlexShrink(LayoutFlexShrinkValue)
FlexBasis(LayoutFlexBasisValue)
JustifyContent(LayoutJustifyContentValue)
AlignItems(LayoutAlignItemsValue)
AlignContent(LayoutAlignContentValue)
ColumnGap(LayoutColumnGapValue)
RowGap(LayoutRowGapValue)
GridTemplateColumns(LayoutGridTemplateColumnsValue)
GridTemplateRows(LayoutGridTemplateRowsValue)
GridAutoColumns(LayoutGridAutoColumnsValue)
GridAutoRows(LayoutGridAutoRowsValue)
GridColumn(LayoutGridColumnValue)
GridRow(LayoutGridRowValue)
GridTemplateAreas(LayoutGridTemplateAreasValue)
WritingMode(LayoutWritingModeValue)
Clear(LayoutClearValue)
BackgroundContent(StyleBackgroundContentVecValue)
BackgroundPosition(StyleBackgroundPositionVecValue)
BackgroundSize(StyleBackgroundSizeVecValue)
BackgroundRepeat(StyleBackgroundRepeatVecValue)
OverflowX(LayoutOverflowValue)
OverflowY(LayoutOverflowValue)
OverflowBlock(LayoutOverflowValue)
OverflowInline(LayoutOverflowValue)
GridAutoFlow(LayoutGridAutoFlowValue)
JustifySelf(LayoutJustifySelfValue)
JustifyItems(LayoutJustifyItemsValue)
Gap(LayoutGapValue)
GridGap(LayoutGapValue)
AlignSelf(LayoutAlignSelfValue)
Font(StyleFontValue)
PaddingTop(LayoutPaddingTopValue)
PaddingLeft(LayoutPaddingLeftValue)
PaddingRight(LayoutPaddingRightValue)
PaddingBottom(LayoutPaddingBottomValue)
PaddingInlineStart(LayoutPaddingInlineStartValue)
PaddingInlineEnd(LayoutPaddingInlineEndValue)
MarginTop(LayoutMarginTopValue)
MarginLeft(LayoutMarginLeftValue)
MarginRight(LayoutMarginRightValue)
MarginBottom(LayoutMarginBottomValue)
BorderTopLeftRadius(StyleBorderTopLeftRadiusValue)
BorderTopRightRadius(StyleBorderTopRightRadiusValue)
BorderBottomLeftRadius(StyleBorderBottomLeftRadiusValue)
BorderBottomRightRadius(StyleBorderBottomRightRadiusValue)
BorderTopColor(StyleBorderTopColorValue)
BorderRightColor(StyleBorderRightColorValue)
BorderLeftColor(StyleBorderLeftColorValue)
BorderBottomColor(StyleBorderBottomColorValue)
BorderTopStyle(StyleBorderTopStyleValue)
BorderRightStyle(StyleBorderRightStyleValue)
BorderLeftStyle(StyleBorderLeftStyleValue)
BorderBottomStyle(StyleBorderBottomStyleValue)
BorderTopWidth(LayoutBorderTopWidthValue)
BorderRightWidth(LayoutBorderRightWidthValue)
BorderLeftWidth(LayoutBorderLeftWidthValue)
BorderBottomWidth(LayoutBorderBottomWidthValue)
BoxShadowLeft(StyleBoxShadowValue)
BoxShadowRight(StyleBoxShadowValue)
BoxShadowTop(StyleBoxShadowValue)
BoxShadowBottom(StyleBoxShadowValue)
ScrollbarTrack(StyleBackgroundContentValue)
ScrollbarThumb(StyleBackgroundContentValue)
ScrollbarButton(StyleBackgroundContentValue)
ScrollbarCorner(StyleBackgroundContentValue)
ScrollbarResizer(StyleBackgroundContentValue)
ScrollbarWidth(LayoutScrollbarWidthValue)
ScrollbarColor(StyleScrollbarColorValue)
ScrollbarVisibility(ScrollbarVisibilityModeValue)
ScrollbarFadeDelay(ScrollbarFadeDelayValue)
ScrollbarFadeDuration(ScrollbarFadeDurationValue)
Opacity(StyleOpacityValue)
Visibility(StyleVisibilityValue)
Transform(StyleTransformVecValue)
TransformOrigin(StyleTransformOriginValue)
PerspectiveOrigin(StylePerspectiveOriginValue)
BackfaceVisibility(StyleBackfaceVisibilityValue)
MixBlendMode(StyleMixBlendModeValue)
Filter(StyleFilterVecValue)
BackdropFilter(StyleFilterVecValue)
TextShadow(StyleBoxShadowValue)
BreakBefore(PageBreakValue)
BreakAfter(PageBreakValue)
BreakInside(BreakInsideValue)
Orphans(OrphansValue)
Widows(WidowsValue)
BoxDecorationBreak(BoxDecorationBreakValue)
ColumnCount(ColumnCountValue)
ColumnWidth(ColumnWidthValue)
ColumnSpan(ColumnSpanValue)
ColumnFill(ColumnFillValue)
ColumnRuleWidth(ColumnRuleWidthValue)
ColumnRuleStyle(ColumnRuleStyleValue)
ColumnRuleColor(ColumnRuleColorValue)
FlowInto(FlowIntoValue)
FlowFrom(FlowFromValue)
ShapeOutside(ShapeOutsideValue)
ShapeInside(ShapeInsideValue)
ClipPath(ClipPathValue)
ShapeMargin(ShapeMarginValue)
ShapeImageThreshold(ShapeImageThresholdValue)
TableLayout(LayoutTableLayoutValue)
BorderCollapse(StyleBorderCollapseValue)
BorderSpacing(LayoutBorderSpacingValue)
CaptionSide(StyleCaptionSideValue)
EmptyCells(StyleEmptyCellsValue)
Content(ContentValue)
CounterReset(CounterResetValue)
CounterIncrement(CounterIncrementValue)
ListStyleType(StyleListStyleTypeValue)
ListStylePosition(StyleListStylePositionValue)
StringSet(StringSetValue)
constructor none:
arg prop_type: CssPropertyType
-> CssProperty
constructor auto:
arg prop_type: CssPropertyType
-> CssProperty
constructor initial:
arg prop_type: CssPropertyType
-> CssProperty
constructor inherit:
arg prop_type: CssPropertyType
-> CssProperty
constructor text_color:
arg input: StyleTextColor
-> CssProperty
constructor font_size:
arg input: StyleFontSize
-> CssProperty
constructor font_family:
arg input: StyleFontFamilyVec
-> CssProperty
constructor font_weight:
arg input: StyleFontWeight
-> CssProperty
constructor font_style:
arg input: StyleFontStyle
-> CssProperty
constructor text_align:
arg input: StyleTextAlign
-> CssProperty
constructor text_justify:
arg input: LayoutTextJustify
-> CssProperty
constructor vertical_align:
arg input: StyleVerticalAlign
-> CssProperty
constructor letter_spacing:
arg input: StyleLetterSpacing
-> CssProperty
constructor text_indent:
arg input: StyleTextIndent
-> CssProperty
constructor line_height:
arg input: StyleLineHeight
-> CssProperty
constructor word_spacing:
arg input: StyleWordSpacing
-> CssProperty
constructor tab_size:
arg input: StyleTabSize
-> CssProperty
constructor cursor:
arg input: StyleCursor
-> CssProperty
constructor user_select:
arg input: StyleUserSelect
-> CssProperty
constructor text_decoration:
arg input: StyleTextDecoration
-> CssProperty
constructor display:
arg input: LayoutDisplay
-> CssProperty
constructor box_sizing:
arg input: LayoutBoxSizing
-> CssProperty
constructor width:
arg input: LayoutWidth
-> CssProperty
constructor height:
arg input: LayoutHeight
-> CssProperty
constructor min_width:
arg input: LayoutMinWidth
-> CssProperty
constructor caret_color:
arg input: CaretColor
-> CssProperty
constructor caret_animation_duration:
arg input: CaretAnimationDuration
-> CssProperty
constructor selection_background_color:
arg input: SelectionBackgroundColor
-> CssProperty
constructor selection_color:
arg input: SelectionColor
-> CssProperty
constructor min_height:
arg input: LayoutMinHeight
-> CssProperty
constructor max_width:
arg input: LayoutMaxWidth
-> CssProperty
constructor max_height:
arg input: LayoutMaxHeight
-> CssProperty
constructor position:
arg input: LayoutPosition
-> CssProperty
constructor top:
arg input: LayoutTop
-> CssProperty
constructor right:
arg input: LayoutRight
-> CssProperty
constructor left:
arg input: LayoutLeft
-> CssProperty
constructor bottom:
arg input: LayoutInsetBottom
-> CssProperty
constructor z_index:
arg input: LayoutZIndex
-> CssProperty
constructor flex_wrap:
arg input: LayoutFlexWrap
-> CssProperty
constructor flex_direction:
arg input: LayoutFlexDirection
-> CssProperty
constructor flex_grow:
arg input: LayoutFlexGrow
-> CssProperty
constructor flex_shrink:
arg input: LayoutFlexShrink
-> CssProperty
constructor justify_content:
arg input: LayoutJustifyContent
-> CssProperty
constructor grid_auto_flow:
arg input: LayoutGridAutoFlow
-> CssProperty
constructor justify_self:
arg input: LayoutJustifySelf
-> CssProperty
constructor justify_items:
arg input: LayoutJustifyItems
-> CssProperty
constructor gap:
arg input: LayoutGap
-> CssProperty
constructor grid_gap:
arg input: LayoutGap
-> CssProperty
constructor align_self:
arg input: LayoutAlignSelf
-> CssProperty
constructor font:
arg input: StyleFontFamilyVec
-> CssProperty
constructor align_items:
arg input: LayoutAlignItems
-> CssProperty
constructor align_content:
arg input: LayoutAlignContent
-> CssProperty
constructor background_content:
arg input: StyleBackgroundContentVec
-> CssProperty
constructor background_position:
arg input: StyleBackgroundPositionVec
-> CssProperty
constructor background_size:
arg input: StyleBackgroundSizeVec
-> CssProperty
constructor background_repeat:
arg input: StyleBackgroundRepeatVec
-> CssProperty
constructor overflow_x:
arg input: LayoutOverflow
-> CssProperty
constructor overflow_y:
arg input: LayoutOverflow
-> CssProperty
constructor padding_top:
arg input: LayoutPaddingTop
-> CssProperty
constructor padding_left:
arg input: LayoutPaddingLeft
-> CssProperty
constructor padding_right:
arg input: LayoutPaddingRight
-> CssProperty
constructor padding_bottom:
arg input: LayoutPaddingBottom
-> CssProperty
constructor margin_top:
arg input: LayoutMarginTop
-> CssProperty
constructor margin_left:
arg input: LayoutMarginLeft
-> CssProperty
constructor margin_right:
arg input: LayoutMarginRight
-> CssProperty
constructor margin_bottom:
arg input: LayoutMarginBottom
-> CssProperty
constructor border_top_left_radius:
arg input: StyleBorderTopLeftRadius
-> CssProperty
constructor border_top_right_radius:
arg input: StyleBorderTopRightRadius
-> CssProperty
constructor border_bottom_left_radius:
arg input: StyleBorderBottomLeftRadius
-> CssProperty
constructor border_bottom_right_radius:
arg input: StyleBorderBottomRightRadius
-> CssProperty
constructor border_top_color:
arg input: StyleBorderTopColor
-> CssProperty
constructor border_right_color:
arg input: StyleBorderRightColor
-> CssProperty
constructor border_left_color:
arg input: StyleBorderLeftColor
-> CssProperty
constructor border_bottom_color:
arg input: StyleBorderBottomColor
-> CssProperty
constructor border_top_style:
arg input: StyleBorderTopStyle
-> CssProperty
constructor border_right_style:
arg input: StyleBorderRightStyle
-> CssProperty
constructor border_left_style:
arg input: StyleBorderLeftStyle
-> CssProperty
constructor border_bottom_style:
arg input: StyleBorderBottomStyle
-> CssProperty
constructor border_top_width:
arg input: LayoutBorderTopWidth
-> CssProperty
constructor border_right_width:
arg input: LayoutBorderRightWidth
-> CssProperty
constructor border_left_width:
arg input: LayoutBorderLeftWidth
-> CssProperty
constructor border_bottom_width:
arg input: LayoutBorderBottomWidth
-> CssProperty
constructor box_shadow_left:
arg input: StyleBoxShadow
-> CssProperty
constructor box_shadow_right:
arg input: StyleBoxShadow
-> CssProperty
constructor box_shadow_top:
arg input: StyleBoxShadow
-> CssProperty
constructor box_shadow_bottom:
arg input: StyleBoxShadow
-> CssProperty
constructor opacity:
arg input: StyleOpacity
-> CssProperty
constructor visibility:
arg input: StyleVisibility
-> CssProperty
constructor transform:
arg input: StyleTransformVec
-> CssProperty
constructor transform_origin:
arg input: StyleTransformOrigin
-> CssProperty
constructor perspective_origin:
arg input: StylePerspectiveOrigin
-> CssProperty
constructor backface_visibility:
arg input: StyleBackfaceVisibility
-> CssProperty
constructor break_before:
arg input: PageBreak
-> CssProperty
constructor break_after:
arg input: PageBreak
-> CssProperty
constructor break_inside:
arg input: BreakInside
-> CssProperty
constructor orphans:
arg input: Orphans
-> CssProperty
constructor widows:
arg input: Widows
-> CssProperty
constructor box_decoration_break:
arg input: BoxDecorationBreak
-> CssProperty
constructor column_count:
arg input: ColumnCount
-> CssProperty
constructor column_width:
arg input: ColumnWidth
-> CssProperty
constructor column_span:
arg input: ColumnSpan
-> CssProperty
constructor column_fill:
arg input: ColumnFill
-> CssProperty
constructor column_rule_width:
arg input: ColumnRuleWidth
-> CssProperty
constructor column_rule_style:
arg input: ColumnRuleStyle
-> CssProperty
constructor column_rule_color:
arg input: ColumnRuleColor
-> CssProperty
constructor flow_into:
arg input: FlowInto
-> CssProperty
constructor flow_from:
arg input: FlowFrom
-> CssProperty
constructor shape_outside:
arg input: ShapeOutside
-> CssProperty
constructor shape_inside:
arg input: ShapeInside
-> CssProperty
constructor clip_path:
arg input: ClipPath
-> CssProperty
constructor shape_margin:
arg input: ShapeMargin
-> CssProperty
constructor shape_image_threshold:
arg input: ShapeImageThreshold
-> CssProperty
constructor content:
arg input: Content
-> CssProperty
constructor counter_reset:
arg input: CounterReset
-> CssProperty
constructor counter_increment:
arg input: CounterIncrement
-> CssProperty
constructor list_style_type:
arg input: StyleListStyleType
-> CssProperty
constructor list_style_position:
arg input: StyleListStylePosition
-> CssProperty
constructor string_set:
arg input: StringSet
-> CssProperty
constructor table_layout:
arg input: LayoutTableLayout
-> CssProperty
constructor border_collapse:
arg input: StyleBorderCollapse
-> CssProperty
constructor border_spacing:
arg input: LayoutBorderSpacing
-> CssProperty
constructor caption_side:
arg input: StyleCaptionSide
-> CssProperty
constructor empty_cells:
arg input: StyleEmptyCells
-> CssProperty
constructor const_none:
arg prop_type: CssPropertyType
-> CssProperty
constructor const_auto:
arg prop_type: CssPropertyType
-> CssProperty
constructor const_initial:
arg prop_type: CssPropertyType
-> CssProperty
constructor const_inherit:
arg prop_type: CssPropertyType
-> CssProperty
constructor const_text_color:
arg input: StyleTextColor
-> CssProperty
constructor const_font_size:
arg input: StyleFontSize
-> CssProperty
constructor const_font_family:
arg input: StyleFontFamilyVec
-> CssProperty
constructor const_text_align:
arg input: StyleTextAlign
-> CssProperty
constructor const_vertical_align:
arg input: StyleVerticalAlign
-> CssProperty
constructor const_letter_spacing:
arg input: StyleLetterSpacing
-> CssProperty
constructor const_text_indent:
arg input: StyleTextIndent
-> CssProperty
constructor const_line_height:
arg input: StyleLineHeight
-> CssProperty
constructor const_word_spacing:
arg input: StyleWordSpacing
-> CssProperty
constructor const_tab_size:
arg input: StyleTabSize
-> CssProperty
constructor const_cursor:
arg input: StyleCursor
-> CssProperty
constructor const_display:
arg input: LayoutDisplay
-> CssProperty
constructor const_float:
arg input: LayoutFloat
-> CssProperty
constructor const_box_sizing:
arg input: LayoutBoxSizing
-> CssProperty
constructor const_width:
arg input: LayoutWidth
-> CssProperty
constructor const_height:
arg input: LayoutHeight
-> CssProperty
constructor const_min_width:
arg input: LayoutMinWidth
-> CssProperty
constructor const_min_height:
arg input: LayoutMinHeight
-> CssProperty
constructor const_max_width:
arg input: LayoutMaxWidth
-> CssProperty
constructor const_max_height:
arg input: LayoutMaxHeight
-> CssProperty
constructor const_position:
arg input: LayoutPosition
-> CssProperty
constructor const_top:
arg input: LayoutTop
-> CssProperty
constructor const_right:
arg input: LayoutRight
-> CssProperty
constructor const_left:
arg input: LayoutLeft
-> CssProperty
constructor const_bottom:
arg input: LayoutInsetBottom
-> CssProperty
constructor const_flex_wrap:
arg input: LayoutFlexWrap
-> CssProperty
constructor const_flex_direction:
arg input: LayoutFlexDirection
-> CssProperty
constructor const_flex_grow:
arg input: LayoutFlexGrow
-> CssProperty
constructor const_flex_shrink:
arg input: LayoutFlexShrink
-> CssProperty
constructor const_justify_content:
arg input: LayoutJustifyContent
-> CssProperty
constructor const_align_items:
arg input: LayoutAlignItems
-> CssProperty
constructor const_align_content:
arg input: LayoutAlignContent
-> CssProperty
constructor const_background_content:
arg input: StyleBackgroundContentVec
-> CssProperty
constructor const_background_position:
arg input: StyleBackgroundPositionVec
-> CssProperty
constructor const_background_size:
arg input: StyleBackgroundSizeVec
-> CssProperty
constructor const_background_repeat:
arg input: StyleBackgroundRepeatVec
-> CssProperty
constructor const_overflow_x:
arg input: LayoutOverflow
-> CssProperty
constructor const_overflow_y:
arg input: LayoutOverflow
-> CssProperty
constructor const_padding_top:
arg input: LayoutPaddingTop
-> CssProperty
constructor const_padding_left:
arg input: LayoutPaddingLeft
-> CssProperty
constructor const_padding_right:
arg input: LayoutPaddingRight
-> CssProperty
constructor const_padding_bottom:
arg input: LayoutPaddingBottom
-> CssProperty
constructor const_margin_top:
arg input: LayoutMarginTop
-> CssProperty
constructor const_margin_left:
arg input: LayoutMarginLeft
-> CssProperty
constructor const_margin_right:
arg input: LayoutMarginRight
-> CssProperty
constructor const_margin_bottom:
arg input: LayoutMarginBottom
-> CssProperty
constructor const_border_top_left_radius:
arg input: StyleBorderTopLeftRadius
-> CssProperty
constructor const_border_top_right_radius:
arg input: StyleBorderTopRightRadius
-> CssProperty
constructor const_border_bottom_left_radius:
arg input: StyleBorderBottomLeftRadius
-> CssProperty
constructor const_border_bottom_right_radius:
arg input: StyleBorderBottomRightRadius
-> CssProperty
constructor const_border_top_color:
arg input: StyleBorderTopColor
-> CssProperty
constructor const_border_right_color:
arg input: StyleBorderRightColor
-> CssProperty
constructor const_border_left_color:
arg input: StyleBorderLeftColor
-> CssProperty
constructor const_border_bottom_color:
arg input: StyleBorderBottomColor
-> CssProperty
constructor const_border_top_style:
arg input: StyleBorderTopStyle
-> CssProperty
constructor const_border_right_style:
arg input: StyleBorderRightStyle
-> CssProperty
constructor const_border_left_style:
arg input: StyleBorderLeftStyle
-> CssProperty
constructor const_border_bottom_style:
arg input: StyleBorderBottomStyle
-> CssProperty
constructor const_border_top_width:
arg input: LayoutBorderTopWidth
-> CssProperty
constructor const_border_right_width:
arg input: LayoutBorderRightWidth
-> CssProperty
constructor const_border_left_width:
arg input: LayoutBorderLeftWidth
-> CssProperty
constructor const_border_bottom_width:
arg input: LayoutBorderBottomWidth
-> CssProperty
constructor const_box_shadow_left:
arg input: StyleBoxShadow
-> CssProperty
constructor const_box_shadow_right:
arg input: StyleBoxShadow
-> CssProperty
constructor const_box_shadow_top:
arg input: StyleBoxShadow
-> CssProperty
constructor const_box_shadow_bottom:
arg input: StyleBoxShadow
-> CssProperty
constructor const_opacity:
arg input: StyleOpacity
-> CssProperty
constructor const_transform:
arg input: StyleTransformVec
-> CssProperty
constructor const_transform_origin:
arg input: StyleTransformOrigin
-> CssProperty
constructor const_perspective_origin:
arg input: StylePerspectiveOrigin
-> CssProperty
constructor const_backface_visibility:
arg input: StyleBackfaceVisibility
-> CssProperty
constructor const_break_before:
arg input: PageBreak
-> CssProperty
constructor const_break_after:
arg input: PageBreak
-> CssProperty
constructor const_break_inside:
arg input: BreakInside
-> CssProperty
constructor const_orphans:
arg input: Orphans
-> CssProperty
constructor const_widows:
arg input: Widows
-> CssProperty
constructor const_box_decoration_break:
arg input: BoxDecorationBreak
-> CssProperty
constructor const_column_count:
arg input: ColumnCount
-> CssProperty
constructor const_column_width:
arg input: ColumnWidth
-> CssProperty
constructor const_column_span:
arg input: ColumnSpan
-> CssProperty
constructor const_column_fill:
arg input: ColumnFill
-> CssProperty
constructor const_column_rule_width:
arg input: ColumnRuleWidth
-> CssProperty
constructor const_column_rule_style:
arg input: ColumnRuleStyle
-> CssProperty
constructor const_column_rule_color:
arg input: ColumnRuleColor
-> CssProperty
constructor const_flow_into:
arg input: FlowInto
-> CssProperty
constructor const_flow_from:
arg input: FlowFrom
-> CssProperty
constructor const_shape_outside:
arg input: ShapeOutside
-> CssProperty
constructor const_shape_inside:
arg input: ShapeInside
-> CssProperty
constructor const_clip_path:
arg input: ClipPath
-> CssProperty
constructor const_shape_margin:
arg input: ShapeMargin
-> CssProperty
constructor const_shape_image_threshold:
arg input: ShapeImageThreshold
-> CssProperty
constructor const_content:
arg input: Content
-> CssProperty
constructor const_counter_reset:
arg input: CounterReset
-> CssProperty
constructor const_counter_increment:
arg input: CounterIncrement
-> CssProperty
constructor const_list_style_type:
arg input: StyleListStyleType
-> CssProperty
constructor const_list_style_position:
arg input: StyleListStylePosition
-> CssProperty
constructor const_string_set:
arg input: StringSet
-> CssProperty
constructor const_table_layout:
arg input: LayoutTableLayout
-> CssProperty
constructor const_border_collapse:
arg input: StyleBorderCollapse
-> CssProperty
constructor const_border_spacing:
arg input: LayoutBorderSpacing
-> CssProperty
constructor const_caption_side:
arg input: StyleCaptionSide
-> CssProperty
constructor const_empty_cells:
arg input: StyleEmptyCells
-> CssProperty
fn value:
&self
-> String
fn format_css:
&self
-> String
fn is_initial:
&self
-> bool
union enum CssNthChildSelector
Number(u32)
Even
Odd
Pattern(CssNthChildPattern)
struct CssNthChildPattern
pattern_repeat: u32
offset: u32
Css stylesheet - contains a parsed CSS stylesheet as a flat list of
CssRuleBlocks. Layer separation (UA / system / author / inline / runtime) is encoded per-rule viaCssRuleBlock::priority.struct Css has destructor
All rule blocks, in source order. Sort by
(priority, specificity)viasort_by_specificityto put them in cascade order.rules: CssRuleBlockVec
constructor empty:
-> Css
constructor from_string:
Creates a new, empty CSS with no rules
fn is_empty:
&self
-> bool
&mut self
Contains one parsed
key: valuepair, static or dynamicunion enum CssDeclaration has destructor
Static key-value pair, such as
width: 500pxStatic(CssProperty)
Dynamic key-value pair with default value, such as
width: [[ my_id | 500px ]]Dynamic(DynamicCssProperty)
A
DynamicCssPropertyis a type of css property that can be changed on possibly every frame by the Rust code - for example to implement anOn::Hoverbehaviour. The syntax for such a property looks like this: no_run,ignore #my_div { padding: var(--my_dynamic_property_id, 400px); } Azul will register a dynamic property with the key "my_dynamic_property_id" and the default value of 400px. If the property gets overridden during one frame, the overridden property takes precedence. At runtime the style is immutable (which is a performance optimization - if we can assume that the property never changes at runtime), we can do some optimizations on it. Dynamic style properties can also be used for animations and conditional styles (i.e.hover,focus, etc.), thereby leading to cleaner code, since all of these special cases now use one single API.struct DynamicCssProperty has destructor
The stringified ID of this property, i.e. the
"my_id"inwidth: var(--my_id, 500px).dynamic_id: String
Default values for this properties - one single value can control multiple properties!
default_value: CssProperty
u8-based color, range 0 to 255 (similar to webrenders ColorU)
struct ColorU
r: u8
g: u8
b: u8
a: u8
constructor from_str:
constructor transparent:
-> ColorU
constructor white:
-> ColorU
constructor black:
-> ColorU
constructor create:
arg r: u8
arg g: u8
arg b: u8
arg a: u8
-> ColorU
constructor rgb:
arg r: u8
arg g: u8
arg b: u8
-> ColorU
constructor red:
-> ColorU
constructor green:
-> ColorU
constructor blue:
-> ColorU
constructor yellow:
-> ColorU
constructor cyan:
-> ColorU
constructor magenta:
-> ColorU
constructor orange:
-> ColorU
constructor pink:
-> ColorU
constructor purple:
-> ColorU
constructor brown:
-> ColorU
constructor gray:
-> ColorU
constructor light_gray:
-> ColorU
constructor dark_gray:
-> ColorU
constructor teal:
-> ColorU
constructor olive:
-> ColorU
constructor maroon:
-> ColorU
constructor lime:
-> ColorU
constructor aqua:
-> ColorU
constructor silver:
-> ColorU
constructor fuchsia:
-> ColorU
constructor indigo:
-> ColorU
constructor gold:
-> ColorU
constructor coral:
-> ColorU
constructor salmon:
-> ColorU
constructor turquoise:
-> ColorU
constructor violet:
-> ColorU
constructor crimson:
-> ColorU
constructor chocolate:
-> ColorU
constructor sky_blue:
-> ColorU
constructor forest_green:
-> ColorU
constructor sea_green:
-> ColorU
constructor slate_gray:
-> ColorU
constructor midnight_blue:
-> ColorU
constructor dark_red:
-> ColorU
constructor dark_green:
-> ColorU
constructor dark_blue:
-> ColorU
constructor light_blue:
-> ColorU
constructor light_green:
-> ColorU
constructor light_yellow:
-> ColorU
constructor light_pink:
-> ColorU
constructor rgba:
arg r: u8
arg g: u8
arg b: u8
arg a: u8
-> ColorU
constructor new:
arg r: u8
arg g: u8
arg b: u8
arg a: u8
-> ColorU
constructor new_rgb:
arg r: u8
arg g: u8
arg b: u8
-> ColorU
constructor strawberry:
arg shade: usize
-> ColorU
constructor palette_orange:
arg shade: usize
-> ColorU
constructor banana:
arg shade: usize
-> ColorU
constructor palette_lime:
arg shade: usize
-> ColorU
constructor mint:
arg shade: usize
-> ColorU
constructor blueberry:
arg shade: usize
-> ColorU
constructor grape:
arg shade: usize
-> ColorU
constructor bubblegum:
arg shade: usize
-> ColorU
constructor cocoa:
arg shade: usize
-> ColorU
constructor palette_silver:
arg shade: usize
-> ColorU
constructor slate:
arg shade: usize
-> ColorU
constructor dark:
arg shade: usize
-> ColorU
constructor apple_red:
-> ColorU
constructor apple_red_dark:
-> ColorU
constructor apple_orange:
-> ColorU
constructor apple_orange_dark:
-> ColorU
constructor apple_yellow:
-> ColorU
constructor apple_yellow_dark:
-> ColorU
constructor apple_green:
-> ColorU
constructor apple_green_dark:
-> ColorU
constructor apple_mint:
-> ColorU
constructor apple_mint_dark:
-> ColorU
constructor apple_teal:
-> ColorU
constructor apple_teal_dark:
-> ColorU
constructor apple_cyan:
-> ColorU
constructor apple_cyan_dark:
-> ColorU
constructor apple_blue:
-> ColorU
constructor apple_blue_dark:
-> ColorU
constructor apple_indigo:
-> ColorU
constructor apple_indigo_dark:
-> ColorU
constructor apple_purple:
-> ColorU
constructor apple_purple_dark:
-> ColorU
constructor apple_pink:
-> ColorU
constructor apple_pink_dark:
-> ColorU
constructor apple_brown:
-> ColorU
constructor apple_brown_dark:
-> ColorU
constructor apple_gray:
-> ColorU
constructor apple_gray_dark:
-> ColorU
constructor bootstrap_primary:
-> ColorU
constructor bootstrap_primary_hover:
-> ColorU
constructor bootstrap_primary_active:
-> ColorU
constructor bootstrap_secondary:
-> ColorU
constructor bootstrap_secondary_hover:
-> ColorU
constructor bootstrap_secondary_active:
-> ColorU
constructor bootstrap_success:
-> ColorU
constructor bootstrap_success_hover:
-> ColorU
constructor bootstrap_success_active:
-> ColorU
constructor bootstrap_danger:
-> ColorU
constructor bootstrap_danger_hover:
-> ColorU
constructor bootstrap_danger_active:
-> ColorU
constructor bootstrap_warning:
-> ColorU
constructor bootstrap_warning_hover:
-> ColorU
constructor bootstrap_warning_active:
-> ColorU
constructor bootstrap_info:
-> ColorU
constructor bootstrap_info_hover:
-> ColorU
constructor bootstrap_info_active:
-> ColorU
constructor bootstrap_light:
-> ColorU
constructor bootstrap_light_hover:
-> ColorU
constructor bootstrap_light_active:
-> ColorU
constructor bootstrap_dark:
-> ColorU
constructor bootstrap_dark_hover:
-> ColorU
constructor bootstrap_dark_active:
-> ColorU
constructor bootstrap_link:
-> ColorU
constructor bootstrap_link_hover:
-> ColorU
Creates a new color with RGB values (alpha = 255).
Creates a new color with RGBA values.
Alias for
rgba- kept for internal compatibility, not exposed in FFI.Alias for
rgb- kept for internal compatibility, not exposed in FFI.Strawberry color palette (shade: 100, 300, 500, 700, 900)
Orange color palette (shade: 100, 300, 500, 700, 900)
Banana color palette (shade: 100, 300, 500, 700, 900)
Lime color palette (shade: 100, 300, 500, 700, 900)
Mint color palette (shade: 100, 300, 500, 700, 900)
Blueberry color palette (shade: 100, 300, 500, 700, 900)
Grape color palette (shade: 100, 300, 500, 700, 900)
Bubblegum color palette (shade: 100, 300, 500, 700, 900)
Cocoa color palette (shade: 100, 300, 500, 700, 900)
Silver color palette (shade: 100, 300, 500, 700, 900)
Slate color palette (shade: 100, 300, 500, 700, 900)
Dark color palette (shade: 100, 300, 500, 700, 900)
Apple Red (light mode)
Apple Red (dark mode)
Apple Orange (light mode)
Apple Orange (dark mode)
Apple Yellow (light mode)
Apple Yellow (dark mode)
Apple Green (light mode)
Apple Green (dark mode)
Apple Mint (light mode)
Apple Mint (dark mode)
Apple Teal (light mode)
Apple Teal (dark mode)
Apple Cyan (light mode)
Apple Cyan (dark mode)
Apple Blue (light mode)
Apple Blue (dark mode)
Apple Indigo (light mode)
Apple Indigo (dark mode)
Apple Purple (light mode)
Apple Purple (dark mode)
Apple Pink (light mode)
Apple Pink (dark mode)
Apple Brown (light mode)
Apple Brown (dark mode)
Apple Gray (light mode)
Apple Gray (dark mode)
Primary button color (blue) - used for main actions
Primary button hover color
Primary button active/pressed color
Secondary button color (gray)
Success button color (green) - used for confirmations
Danger button color (red) - used for destructive actions
Warning button color (yellow) - uses BLACK text
Info button color (teal/cyan)
Light button color
Dark button color
Link button text color
fn to_hash:
&self
-> String
fn has_alpha:
&self
-> bool
fn interpolate:
fn lighten:
&self
arg amount: f32
-> ColorU
fn darken:
&self
arg amount: f32
-> ColorU
fn mix:
fn hover_variant:
&self
-> ColorU
fn active_variant:
&self
-> ColorU
fn luminance:
&self
-> f32
&self
-> f32
fn contrast_text:
&self
-> ColorU
&self
-> ColorU
fn contrast_ratio:
&self
arg other: ColorU
-> f32
fn meets_wcag_aa:
&self
arg other: ColorU
-> bool
&self
arg other: ColorU
-> bool
fn meets_wcag_aaa:
&self
arg other: ColorU
-> bool
&self
arg other: ColorU
-> bool
fn apca_contrast:
&self
arg background: ColorU
-> f32
fn meets_apca_body:
&self
arg background: ColorU
-> bool
fn meets_apca_large:
&self
arg background: ColorU
-> bool
fn is_light:
&self
-> bool
fn is_dark:
&self
-> bool
fn ensure_contrast:
fn with_alpha:
&self
arg a: u8
-> ColorU
fn with_alpha_f32:
&self
arg a: f32
-> ColorU
fn invert:
&self
-> ColorU
fn to_grayscale:
&self
-> ColorU
Interpolate between two colors. t=0.0 returns self, t=1.0 returns other.
Lighten a color by a percentage (0.0 to 1.0). Returns a new color blended towards white.
Darken a color by a percentage (0.0 to 1.0). Returns a new color blended towards black.
Mix two colors together with a given ratio (0.0 = self, 1.0 = other).
Create a hover variant (slightly lighter for dark colors, darker for light colors). Useful for button hover states.
Create an active/pressed variant (darker than hover). Useful for button active states.
Calculate relative luminance (0.0 = black, 1.0 = white). Uses the sRGB luminance formula.
Calculate relative luminance per WCAG 2.1 specification. Uses sRGB to linear conversion for accurate results.
Returns white or black text color for best contrast on this background.
Suggest the best text color (black or white) for this background, ensuring WCAG AA compliance for normal text.
Calculate the contrast ratio between this color and another. Returns a value between 1.0 (no contrast) and 21.0 (max contrast).
WCAG 2.1 requirements: - AA normal text: >= 4.5:1 - AA large text: >= 3.0:1 - AAA normal text: >= 7.0:1 - AAA large text: >= 4.5:1Check if the contrast ratio meets WCAG AA requirements for normal text (>= 4.5:1).
Check if the contrast ratio meets WCAG AA requirements for large text (>= 3.0:1). Large text is defined as 18pt+ or 14pt+ bold.
Check if the contrast ratio meets WCAG AAA requirements for normal text (>= 7.0:1).
Check if the contrast ratio meets WCAG AAA requirements for large text (>= 4.5:1).
Calculate the APCA (Accessible Perceptual Contrast Algorithm) contrast. This is a newer algorithm that may replace WCAG contrast in future standards. Returns a value between -108 (white on black) and 106 (black on white). For most purposes, use the absolute value.
Check if the APCA contrast meets the recommended minimum for body text (|Lc| >= 60).
Check if the APCA contrast meets the minimum for large text (|Lc| >= 45).
Returns true if this color is considered 'light' (luminance > 0.5).
Returns true if this color is considered 'dark' (luminance <= 0.5).
Adjust the color to ensure it meets the minimum contrast ratio against a background. Returns the original color if it already meets the requirement.
Set the alpha channel while keeping RGB values.
Set the alpha as a float (0.0 to 1.0).
Invert the color (keeping alpha).
Convert to grayscale using luminance weights.
Enum representing the metric associated with a number (px, pt, em, etc.)
enum SizeMetric
Px
Pt
Em
Rem
In
Cm
Mm
Percent
Viewport width: 1vw = 1% of viewport width
Vw
Viewport height: 1vh = 1% of viewport height
Vh
Viewport minimum: 1vmin = 1% of smaller viewport dimension
Vmin
Viewport maximum: 1vmax = 1% of larger viewport dimension
Vmax
struct PixelValue
metric: SizeMetric
number: FloatValue
constructor zero:
-> PixelValue
constructor px:
arg value: f32
-> PixelValue
constructor em:
arg value: f32
-> PixelValue
constructor rem:
arg value: f32
-> PixelValue
constructor pt:
arg value: f32
-> PixelValue
constructor percent:
arg value: f32
-> PixelValue
constructor from_metric:
arg metric: SizeMetric
arg value: f32
-> PixelValue
Creates a zero pixel value.
Creates a pixel value in px units.
Creates a pixel value in em units.
Creates a pixel value in rem units.
Creates a pixel value in pt units.
Creates a pixel value in percent.
Creates a pixel value from a metric and value.
Two-dimensional size in PixelValue units (width, height) Used for background-size and similar properties
struct PixelValueSize
width: PixelValue
height: PixelValue
Same as PixelValue, but doesn't allow a "%" sign
struct PixelValueNoPercent
inner: PixelValue
A pixel value that can be either concrete or a system metric reference. System metrics are resolved at runtime based on user's system theme. CSS syntax: 10px, 1.5em, system:button-padding, etc.
union enum PixelValueOrSystem
Value(PixelValue)
System(SystemMetricRef)
constructor value:
arg v: PixelValue
constructor system:
arg s: SystemMetricRef
Creates a PixelValueOrSystem from a concrete value.
Creates a PixelValueOrSystem from a system metric reference.
What direction should a
box-shadowbe clipped in (inset or outset).enum BoxShadowClipMode
Outset
Inset
Represents a
box-shadowortext-shadowproperty.struct StyleBoxShadow
offset_x: PixelValueNoPercent
offset_y: PixelValueNoPercent
blur_radius: PixelValueNoPercent
spread_radius: PixelValueNoPercent
clip_mode: BoxShadowClipMode
color: ColorU
Represents a
mix-blend-modeattribute, which determines how an element's content should blend with the content of the element's parent.enum StyleMixBlendMode
Normal
Multiply
Screen
Overlay
Darken
Lighten
ColorDodge
ColorBurn
HardLight
SoftLight
Difference
Exclusion
Hue
Saturation
Color
Luminosity
union enum StyleFilter
Blend(StyleMixBlendMode)
Flood(ColorU)
Blur(StyleBlur)
Opacity(PercentageValue)
ColorMatrix(StyleColorMatrix)
DropShadow(StyleBoxShadow)
ComponentTransfer
Offset(StyleFilterOffset)
Composite(StyleCompositeFilter)
Brightness(PercentageValue)
Contrast(PercentageValue)
Grayscale(PercentageValue)
HueRotate(AngleValue)
Invert(PercentageValue)
Saturate(PercentageValue)
Sepia(PercentageValue)
struct StyleBlur
width: PixelValue
height: PixelValue
struct StyleColorMatrix
m0: FloatValue
m1: FloatValue
m2: FloatValue
m3: FloatValue
m4: FloatValue
m5: FloatValue
m6: FloatValue
m7: FloatValue
m8: FloatValue
m9: FloatValue
m10: FloatValue
m11: FloatValue
m12: FloatValue
m13: FloatValue
m14: FloatValue
m15: FloatValue
m16: FloatValue
m17: FloatValue
m18: FloatValue
m19: FloatValue
struct StyleFilterOffset
x: PixelValue
y: PixelValue
union enum StyleCompositeFilter
Over
In
Atop
Out
Xor
Lighter
Arithmetic(ArithmeticCoefficients)
Represents an
align-contentattribute, which aligns a flex container's lines within it when there is extra space in the cross-axis. Default:Stretchenum LayoutAlignContent
Stretch
Center
Start
End
SpaceBetween
SpaceAround
Represents an
align-itemsattribute, which defines the default behavior for how flex items are laid out along the cross axis on the current line. Default:Stretchenum LayoutAlignItems
Stretch
Center
Start
End
Baseline
Represents a
box-sizingattributeenum LayoutBoxSizing
ContentBox
BorderBox
Represents a
flex-directionattribute, which establishes the main-axis, thus defining the direction flex items are placed in the flex container. Default:Rowenum LayoutFlexDirection
Row
RowReverse
Column
ColumnReverse
fn get_axis:
&self
-> LayoutAxis
fn is_reverse:
&self
-> bool
Returns the
LayoutAxis(Horizontal or Vertical) that this flex-direction lays items along.Returns
trueif this flex-direction is a reversed variant (RowReverseorColumnReverse).Represents the main or cross axis of a flex container.
enum LayoutAxis
Horizontal
Vertical
Represents a
displayCSS property valueenum LayoutDisplay
None
Block
Inline
InlineBlock
Flex
InlineFlex
Table
InlineTable
TableRowGroup
TableHeaderGroup
TableFooterGroup
TableRow
TableColumnGroup
TableColumn
TableCell
TableCaption
FlowRoot
ListItem
RunIn
Marker
Grid
InlineGrid
Contents
Represents a
flex-growattribute, which dictates what proportion of the remaining space in the flex container should be assigned to the item. Default: 0struct LayoutFlexGrow
inner: FloatValue
constructor create:
arg value: f32
Creates a flex-grow value
Represents a
flex-shrinkattribute, which dictates what proportion of the negative space in the flex container should be removed from the item. Default: 1struct LayoutFlexShrink
inner: FloatValue
Represents a
floatattributeenum LayoutFloat
Left
Right
None
union enum LayoutHeight
Auto
Px(PixelValue)
MinContent
MaxContent
FitContent(PixelValue)
Calc(CalcAstItemVec)
Represents a
justify-contentattribute, which defines the alignment along the main axis. Default:Start(flex-start)enum LayoutJustifyContent
FlexStart
FlexEnd
Start
End
Center
SpaceBetween
SpaceAround
SpaceEvenly
struct LayoutLeft
inner: PixelValue
Layout margin bottom value
struct LayoutMarginBottom
inner: PixelValue
Layout margin left value
struct LayoutMarginLeft
inner: PixelValue
Layout margin right value
struct LayoutMarginRight
inner: PixelValue
Layout margin top value
struct LayoutMarginTop
inner: PixelValue
struct LayoutMaxHeight
inner: PixelValue
struct LayoutMaxWidth
inner: PixelValue
struct LayoutMinHeight
inner: PixelValue
struct LayoutMinWidth
inner: PixelValue
Layout padding bottom value
struct LayoutPaddingBottom
inner: PixelValue
struct LayoutPaddingLeft
inner: PixelValue
Layout padding right value
struct LayoutPaddingRight
inner: PixelValue
Layout padding top value
struct LayoutPaddingTop
inner: PixelValue
Represents a
positionattribute - default:Staticenum LayoutPosition
Static
Relative
Absolute
Fixed
Sticky
struct LayoutRight
inner: PixelValue
struct LayoutTop
inner: PixelValue
union enum LayoutWidth
Auto
Px(PixelValue)
MinContent
MaxContent
FitContent(PixelValue)
Calc(CalcAstItemVec)
Represents a
flex-wrapattribute, which determines whether flex items are forced onto one line or can wrap onto multiple lines. Default:NoWrapenum LayoutFlexWrap
Wrap
NoWrap
WrapReverse
Represents an
overflow-xoroverflow-yproperty. Determines what to do when content overflows an element's box.enum LayoutOverflow
Always shows a scroll bar, overflows on scroll.
Scroll
Shows a scroll bar only when content overflows. This is the default.
Auto
Clips overflowing content. The rest of the content will be invisible.
Hidden
Content is not clipped and renders outside the element's box.
Visible
Similar to
hidden, clips the content at the box's edge.Clip
Wrapper around an f32 value that is internally casted to an isize, in order to provide hash-ability (to avoid numerical instability).
struct FloatValue
number: isize
constructor create:
arg value: f32
-> FloatValue
Creates a new FloatValue from an f32.
fn get:
&self
-> f32
Gets the internal f32 value.
Wrapper around FloatValue, represents a percentage instead of just being a regular floating-point value, i.e
5=5%struct PercentageValue
number: FloatValue
Enum representing the metric associated with an angle (deg, rad, etc.)
enum AngleMetric
Degree
Radians
Grad
Turn
Percent
FloatValue, but associated with a certain metric (i.e. deg, rad, etc.)
struct AngleValue
metric: AngleMetric
number: FloatValue
fn zero:
-> AngleValue
fn deg:
arg value: f32
-> AngleValue
fn rad:
arg value: f32
-> AngleValue
fn grad:
arg value: f32
-> AngleValue
fn turn:
arg value: f32
-> AngleValue
fn get_degrees:
&self
-> f32
Creates an AngleValue of zero degrees.
Creates an AngleValue from degrees
Creates an AngleValue from radians
Creates an AngleValue from gradians
Creates an AngleValue from turns (1 turn = 360 degrees)
struct NormalizedLinearColorStop
offset: PercentageValue
color: ColorOrSystem
struct NormalizedRadialColorStop
angle: AngleValue
color: ColorOrSystem
enum DirectionCorner
Right
Left
Top
Bottom
TopRight
TopLeft
BottomRight
BottomLeft
fn opposite:
&self
Returns the corner opposite to this one (e.g.
TopLeft->BottomRight).struct DirectionCorners
dir_from: DirectionCorner
dir_to: DirectionCorner
CSS direction (necessary for gradients). Can either be a fixed angle or a direction ("to right" / "to left", etc.).
union enum Direction
Angle(AngleValue)
FromTo(DirectionCorners)
struct LinearGradient has destructor
direction: Direction
extend_mode: ExtendMode
stops: NormalizedLinearColorStopVec
enum Shape
Ellipse
Circle
enum RadialGradientSize
ClosestSide
ClosestCorner
FarthestSide
FarthestCorner
struct RadialGradient has destructor
shape: Shape
size: RadialGradientSize
position: StyleBackgroundPosition
extend_mode: ExtendMode
stops: NormalizedLinearColorStopVec
struct ConicGradient has destructor
extend_mode: ExtendMode
center: StyleBackgroundPosition
angle: AngleValue
stops: NormalizedRadialColorStopVec
union enum StyleBackgroundContent has destructor
LinearGradient(LinearGradient)
RadialGradient(RadialGradient)
ConicGradient(ConicGradient)
Image(String)
Color(ColorU)
union enum BackgroundPositionHorizontal
Left
Center
Right
Exact(PixelValue)
union enum BackgroundPositionVertical
Top
Center
Bottom
Exact(PixelValue)
struct StyleBackgroundPosition
horizontal: BackgroundPositionHorizontal
vertical: BackgroundPositionVertical
enum StyleBackgroundRepeat
NoRepeat
PatternRepeat
RepeatX
RepeatY
union enum StyleBackgroundSize
ExactSize(PixelValueSize)
Contain
Cover
struct StyleBorderBottomColor
inner: ColorU
struct StyleBorderBottomLeftRadius
inner: PixelValue
struct StyleBorderBottomRightRadius
inner: PixelValue
Style of a
border: solid, double, dash, ridge, etc.enum BorderStyle
None
Solid
Double
Dotted
Dashed
Hidden
Groove
Ridge
Inset
Outset
struct StyleBorderBottomStyle
inner: BorderStyle
struct LayoutBorderBottomWidth
inner: PixelValue
struct StyleBorderLeftColor
inner: ColorU
struct StyleBorderLeftStyle
inner: BorderStyle
struct LayoutBorderLeftWidth
inner: PixelValue
struct StyleBorderRightColor
inner: ColorU
struct StyleBorderRightStyle
inner: BorderStyle
struct LayoutBorderRightWidth
inner: PixelValue
struct StyleBorderTopColor
inner: ColorU
struct StyleBorderTopLeftRadius
inner: PixelValue
struct StyleBorderTopRightRadius
inner: PixelValue
struct StyleBorderTopStyle
inner: BorderStyle
struct LayoutBorderTopWidth
inner: PixelValue
Represents a
font-familyattributeunion enum StyleFontFamily has destructor
System(String)
SystemType(SystemFontType)
File(String)
Ref(FontRef)
Represents a
font-sizeattributestruct StyleFontSize
inner: PixelValue
constructor px:
arg value: f32
Creates a font size from a pixel value
Represents a
letter-spacingattributestruct StyleLetterSpacing
inner: PixelValue
Represents a
line-heightattributestruct StyleLineHeight
inner: PercentageValue
Represents an
opacityattribute, a value from 0.0 to 1.0.struct StyleOpacity
inner: PercentageValue
Represents a
transform-originattributestruct StyleTransformOrigin
x: PixelValue
y: PixelValue
Represents a
backface-visibilityattributeenum StyleBackfaceVisibility
Visible
Hidden
Represents one component of a
transformattributeunion enum StyleTransform
Matrix(StyleTransformMatrix2D)
Matrix3D(StyleTransformMatrix3D)
Translate(StyleTransformTranslate2D)
Translate3D(StyleTransformTranslate3D)
TranslateX(PixelValue)
TranslateY(PixelValue)
TranslateZ(PixelValue)
Rotate(AngleValue)
Rotate3D(StyleTransformRotate3D)
RotateX(AngleValue)
RotateY(AngleValue)
RotateZ(AngleValue)
Scale(StyleTransformScale2D)
Scale3D(StyleTransformScale3D)
ScaleX(PercentageValue)
ScaleY(PercentageValue)
ScaleZ(PercentageValue)
Skew(StyleTransformSkew2D)
SkewX(AngleValue)
SkewY(AngleValue)
Perspective(PixelValue)
struct StyleTransformMatrix2D
a: FloatValue
b: FloatValue
c: FloatValue
d: FloatValue
tx: FloatValue
ty: FloatValue
struct StyleTransformMatrix3D
m11: FloatValue
m12: FloatValue
m13: FloatValue
m14: FloatValue
m21: FloatValue
m22: FloatValue
m23: FloatValue
m24: FloatValue
m31: FloatValue
m32: FloatValue
m33: FloatValue
m34: FloatValue
m41: FloatValue
m42: FloatValue
m43: FloatValue
m44: FloatValue
struct StyleTransformTranslate2D
x: PixelValue
y: PixelValue
struct StyleTransformTranslate3D
x: PixelValue
y: PixelValue
z: PixelValue
struct StyleTransformRotate3D
x: FloatValue
y: FloatValue
z: FloatValue
angle: AngleValue
struct StyleTransformScale2D
x: FloatValue
y: FloatValue
struct StyleTransformScale3D
x: FloatValue
y: FloatValue
z: FloatValue
struct StyleTransformSkew2D
x: AngleValue
y: AngleValue
Horizontal text alignment enum (left, center, right) - default:
Leftenum StyleTextAlign
Left
Center
Right
Justify
Start
End
Represents a
colorattribute.struct StyleTextColor
inner: ColorU
Represents a
word-spacingattributestruct StyleWordSpacing
inner: PixelValue
Generic CSS property value that can be Auto, None, Initial, Inherit, or an exact value
union enum CssPropertyValue
Auto
None
Initial
Inherit
Revert
Unset
Exact(T)
struct CounterReset has destructor
counter_name: String
value: i32
Represents a grid line position (start or end)
union enum GridLine has destructor
Auto
Line(i32)
Named(NamedGridLine)
Span(i32)
Represents a
perspective-originattributestruct StylePerspectiveOrigin
x: PixelValue
y: PixelValue
Represents a
z-indexattribute - controls stacking order of positioned elementsunion enum LayoutZIndex
Auto
Integer(i32)
Represents
justify-itemsfor grid containersenum LayoutJustifyItems
Start
End
Center
Stretch
struct SelectionBackgroundColor
inner: ColorU
struct ColumnRuleColor
inner: ColorU
enum ColumnSpan
None
All
Represents a
clearattributeenum LayoutClear
None
Left
Right
Both
How to handle white space inside an element.
enum StyleWhiteSpace
Normal
Pre
Nowrap
PreWrap
PreLine
BreakSpaces
Represents a
break-insideCSS property value.enum BreakInside
Auto
Avoid
AvoidPage
AvoidColumn
Represents an
align-selfattribute, which allows the default alignment (or the one specified by align-items) to be overridden for individual flex items. Default:Autoenum LayoutAlignSelf
Auto
Stretch
Center
Start
End
Baseline
struct CaretAnimationDuration
inner: CssDuration
struct ColumnRuleStyle
inner: BorderStyle
Represents
grid-roworgrid-column(start / end)struct GridPlacement has destructor
grid_start: GridLine
grid_end: GridLine
CSS shape-outside property for wrapping text around shapes
union enum ShapeOutside has destructor
None
Shape(CssShape)
union enum ColumnCount
Auto
Integer(u32)
Represents a
writing-modeattributeenum LayoutWritingMode
HorizontalTb
VerticalRl
VerticalLr
Controls whether the user can select text. Used to prevent accidental text selection on UI controls like buttons.
enum StyleUserSelect
Browser determines selectability (default)
Auto
Text is selectable
Text
Text is not selectable
None
User can select all text with a single action
All
Represents
grid-template-columnsorgrid-template-rowsstruct GridTemplate has destructor
tracks: GridTrackSizingVec
Represents
justify-selffor grid itemsenum LayoutJustifySelf
Auto
Start
End
Center
Stretch
struct Content has destructor
inner: String
Hyphenation rules.
enum StyleHyphens
None
Manual
Auto
struct LayoutGap
inner: PixelValue
Text direction.
enum StyleDirection
Ltr
Rtl
Represents a
flex-basisattributeunion enum LayoutFlexBasis
Auto
Exact(PixelValue)
struct ShapeMargin
inner: PixelValue
enum LayoutTextJustify
Auto
None
InterWord
InterCharacter
Distribute
union enum ColumnWidth
Auto
Length(PixelValue)
struct CounterIncrement has destructor
counter_name: String
value: i32
Represents a
box-decoration-breakCSS property value.enum BoxDecorationBreak
Slice
Clone
Represents a
visibilityattribute, controlling element visibility.enum StyleVisibility
Visible
Hidden
Collapse
struct ShapeImageThreshold
inner: FloatValue
Represents the
grid-auto-flowpropertyenum LayoutGridAutoFlow
Row
Column
RowDense
ColumnDense
struct ColumnRuleWidth
inner: PixelValue
Text decoration (underline, overline, line-through).
enum StyleTextDecoration
No decoration
None
Underline
Underline
Line above text
Overline
Strike-through line
LineThrough
struct CaretColor
inner: ColorU
Only used for calculations: Size (width, height) in layout space.
struct LayoutSize
width: isize
height: isize
constructor create:
arg width: isize
arg height: isize
-> LayoutSize
constructor zero:
-> LayoutSize
Creates a new LayoutSize with the given width and height.
Creates a LayoutSize with zero dimensions.
enum ColumnFill
Auto
Balance
Represents grid-auto-columns or grid-auto-rows Structurally identical to GridTemplate but semantically different
struct GridAutoTracks has destructor
tracks: GridTrackSizingVec
Represents a
break-beforeorbreak-afterCSS property value.enum PageBreak
Auto
Avoid
Always
All
Page
AvoidPage
Left
Right
Recto
Verso
Column
AvoidColumn
Represents the standard
scrollbar-widthproperty.enum LayoutScrollbarWidth
Auto
Thin
None
Represents the standard
scrollbar-colorproperty.union enum StyleScrollbarColor
Auto
Custom(ScrollbarColorCustom)
Vertical text alignment enum (baseline, top, middle, bottom, sub, super, text-top, text-bottom) - default:
Baselineunion enum StyleVerticalAlign
Baseline
Top
Middle
Bottom
Sub
Superscript
TextTop
TextBottom
Percentage(PercentageValue)
Length(PixelValue)
line-clamp property for limiting visible lines
struct StyleLineClamp
max_lines: usize
CSS shape-inside property for flowing text within shapes
union enum ShapeInside has destructor
None
Shape(CssShape)
struct Orphans
inner: u32
Represents a
text-indentattribute (indentation of first line in a block).struct StyleTextIndent
inner: PixelValue
each-line keyword: indent first line of each block container AND each line after a forced line break (but not after soft wrap).
each_line: bool
hanging keyword: inverts which lines are affected by the indent.
hanging: bool
Sets the distance between the borders of adjacent cells. The
border-spacingproperty is only applicable whenborder-collapseis set toseparate. It can have one or two values: - One value: Sets both horizontal and vertical spacing - Two values: First is horizontal, second is vertical This struct represents a single spacing value (either horizontal or vertical).struct LayoutBorderSpacing
Horizontal spacing between cell borders
horizontal: PixelValue
Vertical spacing between cell borders
vertical: PixelValue
struct LayoutPaddingInlineStart
inner: PixelValue
Represents the
font-weightproperty.enum StyleFontWeight
Lighter
W100
W200
W300
Normal
W500
W600
Bold
W800
W900
Bolder
-azul-exclusion-marginproperty: defines margin around shape exclusions This property controls the spacing between text and shapes that text flows around. It's similar toshape-marginbut specifically for exclusions (text wrapping). # Example ss .element { -azul-exclusion-margin: 10.5; }struct StyleExclusionMargin
inner: FloatValue
struct Widows
inner: u32
struct LayoutColumnGap
inner: PixelValue
struct LayoutPaddingInlineEnd
inner: PixelValue
enum StyleListStyleType
None
Disc
Circle
Square
Decimal
DecimalLeadingZero
LowerRoman
UpperRoman
LowerGreek
UpperGreek
LowerAlpha
UpperAlpha
CSS clip-path property for clipping element rendering
union enum ClipPath has destructor
None
Shape(CssShape)
-azul-hyphenation-languageproperty: specifies language for hyphenation This property defines the language code (BCP 47 format) used for automatic hyphenation. Examples: "en-US", "de-DE", "fr-FR" # Example ss .element { -azul-hyphenation-language: "en-US"; }struct StyleHyphenationLanguage has destructor
inner: String
enum StyleListStylePosition
Inside
Outside
Specifies whether cell borders are collapsed into a single border or separated. The
border-collapseproperty determines the border rendering model: - separate: Each cell has its own border (default, uses border-spacing) - collapse: Adjacent cells share borders (ignores border-spacing)enum StyleBorderCollapse
Borders are separated (default). Each cell has its own border. The
border-spacingproperty defines the distance between borders.Separate
Borders are collapsed. Adjacent cells share a single border. Border conflict resolution rules apply when borders differ.
Collapse
Specifies the placement of a table caption. The
caption-sideproperty positions the caption either above or below the table.enum StyleCaptionSide
Caption is placed above the table (default)
Top
Caption is placed below the table
Bottom
struct LayoutRowGap
inner: PixelValue
hanging-punctuation property for hanging punctuation marks
struct StyleHangingPunctuation
first: bool
force_end: bool
allow_end: bool
last: bool
Controls the algorithm used to lay out table cells, rows, and columns. The
table-layoutproperty determines whether the browser should use: - auto: Column widths are determined by the content (slower but flexible) - fixed: Column widths are determined by the first row (faster and predictable)enum LayoutTableLayout
Use automatic table layout algorithm (content-based, default). Column width is set by the widest unbreakable content in the cells.
Auto
Use fixed table layout algorithm (first-row-based). Column width is set by the width property of the column or first-row cell. Renders faster than auto.
Fixed
initial-letter property for drop caps
struct StyleInitialLetter
size: u32
sink: OptionU32
Specifies whether or not to display borders and background on empty cells. The
empty-cellsproperty only applies whenborder-collapseis set toseparate. A cell is considered empty if it contains no visible content.enum StyleEmptyCells
Show borders and background on empty cells (default)
Show
Hide borders and background on empty cells
Hide
Represents the
font-styleproperty.enum StyleFontStyle
Normal
Italic
Oblique
text-combine-upright property for combining horizontal text in vertical layout
union enum StyleTextCombineUpright
None
All
Digits(u8)
union enum GridTrackSizing
Fixed(PixelValue)
Fr(i32)
MinContent
MaxContent
Auto
MinMax(GridMinMax)
FitContent(PixelValue)
Physical size with u32 dimensions
struct PhysicalSizeU32
width: u32
height: u32
enum HoverEventFilter
MouseOver
MouseDown
LeftMouseDown
RightMouseDown
MiddleMouseDown
MouseUp
LeftMouseUp
RightMouseUp
MiddleMouseUp
MouseEnter
MouseLeave
Scroll
ScrollStart
ScrollEnd
TextInput
VirtualKeyDown
VirtualKeyUp
HoveredFile
DroppedFile
HoveredFileCancelled
TouchStart
TouchMove
TouchEnd
TouchCancel
PenDown
PenMove
PenUp
PenEnter
PenLeave
PenSqueeze
PenDoubleTap
PenHover
GeolocationFix
GeolocationError
SensorChanged
GamepadInput
DragStart
Drag
DragEnd
DragEnter
DragOver
DragLeave
Drop
DoubleClick
LongPress
SwipeLeft
SwipeRight
SwipeUp
SwipeDown
PinchIn
PinchOut
RotateClockwise
RotateCounterClockwise
MouseOut
FocusIn
FocusOut
CompositionStart
CompositionUpdate
CompositionEnd
SystemTextSingleClick
SystemTextDoubleClick
SystemTextTripleClick
enum ShapeRendering
OptimizeSpeed
CrispEdges
GeometricPrecision
enum ApplicationEventFilter
DeviceConnected
DeviceDisconnected
MonitorConnected
MonitorDisconnected
struct XmlTextPos
row: u32
col: u32
struct LogicalSize
width: f32
height: f32
constructor create:
arg width: f32
arg height: f32
-> LogicalSize
constructor zero:
-> LogicalSize
struct StyledNodeState
hover: bool
active: bool
focused: bool
disabled: bool
checked: bool
focus_within: bool
visited: bool
backdrop: bool
dragging: bool
drag_over: bool
struct CssPropertyCachePtr
ptr: c_void
run_destructor: bool
struct SvgRenderTransform
sx: f32
kx: f32
ky: f32
sy: f32
tx: f32
ty: f32
enum TextRendering
OptimizeSpeed
OptimizeLegibility
GeometricPrecision
enum FocusEventFilter
MouseOver
MouseDown
LeftMouseDown
RightMouseDown
MiddleMouseDown
MouseUp
LeftMouseUp
RightMouseUp
MiddleMouseUp
MouseEnter
MouseLeave
Scroll
ScrollStart
ScrollEnd
TextInput
VirtualKeyDown
VirtualKeyUp
FocusReceived
FocusLost
PenDown
PenMove
PenUp
DragStart
Drag
DragEnd
DragEnter
DragOver
DragLeave
Drop
DoubleClick
LongPress
SwipeLeft
SwipeRight
SwipeUp
SwipeDown
PinchIn
PinchOut
RotateClockwise
RotateCounterClockwise
FocusIn
FocusOut
CompositionStart
CompositionUpdate
CompositionEnd
struct LogicalPosition
x: f32
y: f32
struct ScreenPosition
x: f32
y: f32
struct CursorNodePosition
x: f32
y: f32
union enum EventFilter
Hover(HoverEventFilter)
Focus(FocusEventFilter)
Window(WindowEventFilter)
Component(ComponentEventFilter)
Application(ApplicationEventFilter)
struct PhysicalSize
width: T
height: T
enum FontDatabase
Empty
System
struct StyledDom has destructor
root: NodeHierarchyItemId
node_hierarchy: NodeHierarchyItemVec
node_data: NodeDataVec
styled_nodes: StyledNodeVec
cascade_info: CascadeInfoVec
nodes_with_window_callbacks: NodeHierarchyItemIdVec
nodes_with_datasets: NodeHierarchyItemIdVec
tag_ids_to_node_ids: TagIdToNodeIdMappingVec
non_leaf_nodes: ParentWithNodeDepthVec
css_property_cache: CssPropertyCachePtr
dom_id: DomId
fn append_child:
&mut self
arg other: StyledDom
fn with_child:
fn node_count:
&self
-> usize
fn get_rects_in_rendering_order:
&self
-> ContentGroup
&mut self
-> StyledDom
Appends another
StyledDomas a child to theself.rootwithout re-styling the DOM itselfSame as
append_child(), but as a builder methodReturns the total number of nodes in this StyledDom.
Sets the menu bar for the root node
Builder method for setting the menu bar
Sets the context menu for the root node
Builder method for setting the context menu
Returns nodes grouped by their rendering order (respects z-index and position).
Replaces this StyledDom with default and returns the old value.
struct VertexLayout has destructor
fields: VertexAttributeVec
struct GridMinMax
min: c_void
max: c_void
struct NamedGridLine has destructor
grid_line_name: String
span_count: i32
struct ScrollbarColorCustom
thumb: ColorU
track: ColorU
struct ShapeInset
inset_top: f32
inset_right: f32
inset_bottom: f32
inset_left: f32
border_radius: OptionF32
union enum CssShape has destructor
Circle(ShapeCircle)
Ellipse(ShapeEllipse)
Polygon(ShapePolygon)
Inset(ShapeInset)
Path(ShapePath)
struct ShapePath has destructor
data: String
struct ShapeEllipse
center: ShapePoint
radius_x: f32
radius_y: f32
struct ShapePoint
x: f32
y: f32
enum WindowBackgroundMaterial
Opaque
Transparent
Sidebar
Menu
HUD
Titlebar
MicaAlt
struct LayoutRect
origin: LayoutPoint
size: LayoutSize
constructor create:
arg origin: LayoutPoint
arg size: LayoutSize
-> LayoutRect
constructor zero:
-> LayoutRect
Creates a new LayoutRect with the given origin and size.
Creates a LayoutRect at the origin with zero size.
fn contains_f32:
&self
arg x: f32
arg y: f32
-> bool
fn contains_rect:
&self
arg other: LayoutRect
-> bool
fn union:
arg rects: LayoutRectVecSlice
Returns whether this rectangle contains the given (x, y) point in f32 coordinates.
Returns whether
otheris fully contained inside this rectangle.Returns the bounding rectangle that covers every rectangle in the slice, or
OptionLayoutRect::Noneif the slice is empty.struct LayoutRectVecSlice
Pointer to the slice data
ptr: LayoutRect
Number of elements in the slice
len: usize
union enum WindowPosition
Uninitialized
Initialized(PhysicalPositionI32)
struct LayoutPoint
x: isize
y: isize
constructor create:
arg x: isize
arg y: isize
-> LayoutPoint
constructor zero:
-> LayoutPoint
Creates a new LayoutPoint with the given x and y coordinates.
Creates a LayoutPoint at the origin (0, 0).
union enum CursorPosition
OutOfWindow(LogicalPosition)
Uninitialized
InWindow(LogicalPosition)
union enum ImePosition
Uninitialized
Initialized(LogicalRect)
enum WindowDecorations
Normal
NoTitle
NoTitleAutoInject
NoControls
None
struct PhysicalPosition
x: T
y: T
struct LinuxDecorationsState
is_dragging_titlebar: bool
close_button_hover: bool
maximize_button_hover: bool
minimize_button_hover: bool
enum Srgb
Enabled
Disabled
DontCare
struct LayoutInsetBottom
inner: PixelValue
struct ContentGroup
root: NodeHierarchyItemId
children: ContentGroupVec
enum CssPropertyType
CaretColor
CaretAnimationDuration
CaretWidth
SelectionBackgroundColor
SelectionColor
SelectionRadius
TextColor
FontSize
FontFamily
FontWeight
FontStyle
TextAlign
TextJustify
VerticalAlign
LetterSpacing
TextIndent
InitialLetter
LineClamp
HangingPunctuation
TextCombineUpright
UnicodeBidi
TextBoxTrim
TextBoxEdge
DominantBaseline
AlignmentBaseline
InitialLetterAlign
InitialLetterWrap
ScrollbarGutter
OverflowClipMargin
Clip
ExclusionMargin
HyphenationLanguage
LineHeight
WordSpacing
TabSize
WhiteSpace
Hyphens
WordBreak
OverflowWrap
LineBreak
ObjectFit
ObjectPosition
AspectRatio
TextOrientation
TextAlignLast
Direction
UserSelect
TextDecoration
Cursor
Display
Float
BoxSizing
Width
Height
MinWidth
MinHeight
MaxWidth
MaxHeight
Position
Top
Right
Left
Bottom
ZIndex
FlexWrap
FlexDirection
FlexGrow
FlexShrink
FlexBasis
JustifyContent
AlignItems
AlignContent
ColumnGap
RowGap
GridTemplateColumns
GridTemplateRows
GridAutoColumns
GridAutoRows
GridColumn
GridRow
GridTemplateAreas
GridAutoFlow
JustifySelf
JustifyItems
Gap
GridGap
AlignSelf
Font
WritingMode
Clear
BackgroundContent
BackgroundPosition
BackgroundSize
BackgroundRepeat
OverflowX
OverflowY
OverflowBlock
OverflowInline
PaddingTop
PaddingLeft
PaddingRight
PaddingBottom
PaddingInlineStart
PaddingInlineEnd
MarginTop
MarginLeft
MarginRight
MarginBottom
BorderTopLeftRadius
BorderTopRightRadius
BorderBottomLeftRadius
BorderBottomRightRadius
BorderTopColor
BorderRightColor
BorderLeftColor
BorderBottomColor
BorderTopStyle
BorderRightStyle
BorderLeftStyle
BorderBottomStyle
BorderTopWidth
BorderRightWidth
BorderLeftWidth
BorderBottomWidth
BoxShadowLeft
BoxShadowRight
BoxShadowTop
BoxShadowBottom
ScrollbarTrack
ScrollbarThumb
ScrollbarButton
ScrollbarCorner
ScrollbarResizer
ScrollbarWidth
ScrollbarColor
ScrollbarVisibility
ScrollbarFadeDelay
ScrollbarFadeDuration
Opacity
Visibility
Transform
TransformOrigin
PerspectiveOrigin
BackfaceVisibility
MixBlendMode
Filter
BackdropFilter
TextShadow
BreakBefore
BreakAfter
BreakInside
Orphans
Widows
BoxDecorationBreak
ColumnCount
ColumnWidth
ColumnSpan
ColumnFill
ColumnRuleWidth
ColumnRuleStyle
ColumnRuleColor
FlowInto
FlowFrom
ShapeOutside
ShapeInside
ClipPath
ShapeMargin
ShapeImageThreshold
TableLayout
BorderCollapse
BorderSpacing
CaptionSide
EmptyCells
Content
CounterReset
CounterIncrement
ListStyleType
ListStylePosition
StringSet
struct StyledNode
styled_node_state: StyledNodeState
struct StyledTextRun has destructor
text: String
font_family: OptionString
font_size_px: f32
color: ColorU
is_bold: bool
is_italic: bool
struct TextOpReplaceText has destructor
range: SelectionRange
old_text: String
new_text: String
new_cursor: CursorPosition
union enum TextOperation has destructor
InsertText(TextOpInsertText)
DeleteText(TextOpDeleteText)
ReplaceText(TextOpReplaceText)
SetSelection(TextOpSetSelection)
ExtendSelection(TextOpExtendSelection)
ClearSelection(TextOpClearSelection)
MoveCursor(TextOpMoveCursor)
Copy(TextOpCopy)
Cut(TextOpCut)
Paste(TextOpPaste)
SelectAll(TextOpSelectAll)
struct TextOpCopy has destructor
range: SelectionRange
content: ClipboardContent
struct TextOpDeleteText has destructor
range: SelectionRange
deleted_text: String
new_cursor: CursorPosition
struct TextOpSelectAll
old_range: OptionSelectionRange
new_range: SelectionRange
struct TextOpInsertText has destructor
text: String
position: CursorPosition
new_cursor: CursorPosition
struct TextOpPaste has destructor
content: ClipboardContent
position: CursorPosition
new_cursor: CursorPosition
struct TextOpCut has destructor
range: SelectionRange
content: ClipboardContent
new_cursor: CursorPosition
enum ExtendMode
Clamp
Repeat
union enum FlowFrom has destructor
None
Named(String)
union enum FlowInto has destructor
None
Named(String)
struct ArithmeticCoefficients
k1: FloatValue
k2: FloatValue
k3: FloatValue
k4: FloatValue
Has all the necessary information about the style CSS path
struct CascadeInfo
index_in_parent: u32
is_last_child: bool
A CSS property with optional conditions for when it should be applied. Supports OS-specific, media query, container query, theme, and pseudo-state conditions.
struct CssPropertyWithConditions has destructor
property: CssProperty
apply_if: DynamicSelectorVec
constructor simple:
arg property: CssProperty
constructor with_condition:
arg property: CssProperty
arg condition: DynamicSelector
constructor with_conditions:
arg property: CssProperty
arg conditions: DynamicSelectorVec
constructor on_hover:
arg property: CssProperty
constructor on_active:
arg property: CssProperty
constructor on_focus:
arg property: CssProperty
constructor when_disabled:
arg property: CssProperty
constructor on_os:
arg property: CssProperty
arg os: OsCondition
constructor dark_theme:
arg property: CssProperty
constructor light_theme:
arg property: CssProperty
constructor on_windows:
arg property: CssProperty
constructor on_macos:
arg property: CssProperty
constructor on_linux:
arg property: CssProperty
Create an unconditional property (always applies) - const version
Create a property with a single condition (non-const, allocates)
Create a property with multiple conditions (all must match)
Create a property that applies only on hover (const version)
Create a property that applies only when active (const version)
Create a property that applies only when focused (const version)
Create a property that applies only when disabled (const version)
Create a property that applies only on a specific OS (non-const, needs runtime value)
Create a property that applies only in dark theme (const version)
Create a property that applies only in light theme (const version)
Create a property for Windows only (const version)
Create a property for macOS only (const version)
Create a property for Linux only (const version)
fn is_conditional:
&self
-> bool
&self
-> bool
&self
-> bool
Check if this property has any conditions
Check if this property is a pseudo-state conditional only (hover, active, focus, etc.)
Check if this property affects layout (width, height, margin, etc.) TODO: Implement when CssProperty has this method
Linux desktop environment for DE-specific styling
enum LinuxDesktopEnv
Gnome
KDE
XFCE
Unity
Cinnamon
MATE
Other
struct SystemFonts has destructor
ui_font: OptionString
ui_font_size: OptionF32
monospace_font: OptionString
monospace_font_size: OptionF32
ui_font_bold: OptionString
title_font: OptionString
title_font_size: OptionF32
menu_font: OptionString
menu_font_size: OptionF32
small_font: OptionString
small_font_size: OptionF32
struct SystemStyle has destructor
fonts: SystemFonts
metrics: SystemMetrics
linux: LinuxCustomization
platform: Platform
focus_visuals: FocusVisuals
language: String
app_specific_stylesheet: c_void
scrollbar: c_void
scroll_physics: ScrollPhysics
theme: Theme
os_version: OsVersion
prefers_reduced_motion: BoolCondition
prefers_high_contrast: BoolCondition
accessibility: AccessibilitySettings
input: InputMetrics
text_rendering: TextRenderingHints
scrollbar_preferences: ScrollbarPreferences
visual_hints: VisualHints
animation: AnimationMetrics
colors: SystemColors
icon_style: IconStyleOptions
audio: AudioMetrics
constructor detect:
-> SystemStyle
Discovers the system's UI style, and loads an optional app-specific stylesheet.
If the "io" feature is enabled, this function may be slow as it can involve running external commands and reading files.
If the "io" feature is disabled, this returns a hard-coded, deterministic style based on the target operating system.&self
-> Css
Create a CSS stylesheet for CSD (Client-Side Decorations) titlebar
This generates CSS rules for the CSD titlebar using system colors, fonts, and metrics to match the native platform look.struct SystemColors
text: OptionColorU
secondary_text: OptionColorU
tertiary_text: OptionColorU
background: OptionColorU
accent: OptionColorU
accent_text: OptionColorU
button_face: OptionColorU
button_text: OptionColorU
disabled_text: OptionColorU
window_background: OptionColorU
under_page_background: OptionColorU
selection_background: OptionColorU
selection_text: OptionColorU
selection_background_inactive: OptionColorU
selection_text_inactive: OptionColorU
link: OptionColorU
separator: OptionColorU
grid: OptionColorU
find_highlight: OptionColorU
sidebar_background: OptionColorU
sidebar_selection: OptionColorU
union enum DesktopEnvironment has destructor
Gnome
Kde
Other(String)
enum ScrollLogicalPosition
Start
Center
End
Nearest
struct CaretWidth
inner: PixelValue
struct PendingTextEdit has destructor
node: DomNodeId
inserted_text: String
old_text: String
struct StyleTabSize
inner: PixelValue
Configuration for how fonts should be loaded at app startup.
union enum FontLoadingConfig has destructor
LoadAllSystemFonts
LoadOnlyFamilies(StringVec)
BundledFontsOnly
A named font bundled with the application (name + raw bytes). The name is used to reference the font in CSS (e.g. font-family: "MyFont").
struct NamedFont has destructor
The font family name to use in CSS (e.g. "Roboto", "MyCustomFont")
name: String
Raw font file bytes (TTF, OTF, etc.)
bytes: U8Vec
struct GridTrackSizingVecSlice
Pointer to the slice data
ptr: GridTrackSizing
Number of elements in the slice
len: usize
struct ContentGroupVecSlice
Pointer to the slice data
ptr: ContentGroup
Number of elements in the slice
len: usize
struct StyledTextRunVecSlice has destructor
Pointer to the slice data
ptr: StyledTextRun
Number of elements in the slice
len: usize
struct CssRuleBlockVecSlice has destructor
Pointer to the slice data
ptr: CssRuleBlock
Number of elements in the slice
len: usize
struct CascadeInfoVecSlice
ptr: CascadeInfo
len: usize
struct NormalizedRadialColorStopVecSlice
Pointer to the slice data
ptr: NormalizedRadialColorStop
Number of elements in the slice
len: usize
struct StyleFontFamilyVecSlice has destructor
Pointer to the slice data
ptr: StyleFontFamily
Number of elements in the slice
len: usize
struct StyleFilterVecSlice
Pointer to the slice data
ptr: StyleFilter
Number of elements in the slice
len: usize
struct StyleBackgroundSizeVecSlice
Pointer to the slice data
ptr: StyleBackgroundSize
Number of elements in the slice
len: usize
struct StyleBackgroundContentVecSlice has destructor
len: usize
struct CssDeclarationVecSlice has destructor
ptr: CssDeclaration
len: usize
struct StyleBackgroundPositionVecSlice
Pointer to the slice data
Number of elements in the slice
len: usize
struct NormalizedLinearColorStopVecSlice
ptr: NormalizedLinearColorStop
len: usize
struct CssPropertyWithConditionsVecSlice has destructor
Pointer to the slice data
ptr: CssPropertyWithConditions
Number of elements in the slice
len: usize
struct CssVecSlice has destructor
Pointer to the slice data
ptr: Css
Number of elements in the slice
len: usize
struct StyleTransformVecSlice
ptr: StyleTransform
len: usize
struct StyledNodeVecSlice
Pointer to the slice data
ptr: StyledNode
Number of elements in the slice
len: usize
struct ShapePointVecSlice
Pointer to the slice data
ptr: ShapePoint
Number of elements in the slice
len: usize
struct StyleBackgroundRepeatVecSlice
Pointer to the slice data
Number of elements in the slice
len: usize
struct NamedFontVecSlice has destructor
Pointer to the slice data
ptr: NamedFont
Number of elements in the slice
len: usize
struct CssMockEnvironment has destructor
theme: OptionThemeCondition
language: OptionString
os_version: OptionOsVersion
desktop_env: OptionLinuxDesktopEnv
viewport_width: OptionF32
viewport_height: OptionF32
prefers_reduced_motion: OptionBool
prefers_high_contrast: OptionBool
union enum ColorOrSystem
Color(ColorU)
System(SystemColorRef)
enum SystemColorRef
Text
Background
Accent
AccentText
ButtonFace
ButtonText
WindowBackground
SelectionBackground
SelectionText
Safe area insets for devices with notches, rounded corners, or sensor housings.
struct SafeAreaInsets
Inset from the top edge (notch, camera housing, etc.)
top: OptionPixelValue
Inset from the bottom edge (home indicator on iPhone)
bottom: OptionPixelValue
Inset from the left edge (rounded corners)
left: OptionPixelValue
Inset from the right edge (rounded corners)
right: OptionPixelValue
enum SystemFontType
Ui
UiBold
Monospace
MonospaceBold
MonospaceItalic
Title
TitleBold
Menu
Small
Serif
SerifBold
enum ScrollbarTrackClick
JumpToPosition
PageUpDown
enum SubpixelType
None
Rgb
Bgr
VRgb
VBgr
struct ScrollbarPreferences
visibility: ScrollbarVisibility
track_click: ScrollbarTrackClick
enum ScrollbarVisibility
Always
WhenScrolling
Automatic
struct TextRenderingHints
subpixel_type: SubpixelType
font_smoothing_gamma: u32
font_smoothing_enabled: bool
increased_contrast: bool
enum ToolbarStyle
IconsOnly
TextOnly
TextBesideIcon
TextBelowIcon
struct AnimationMetrics
animations_enabled: bool
animation_duration_factor: f32
focus_indicator_behavior: FocusBehavior
struct GridAreaDefinition has destructor
name: String
row_start: u16
row_end: u16
column_start: u16
column_end: u16
struct GridTemplateAreas has destructor
areas: GridAreaDefinitionVec
struct GridAreaDefinitionVecSlice has destructor
Pointer to the slice data
ptr: GridAreaDefinition
Number of elements in the slice
len: usize
union enum CssColorParseErrorOwned has destructor
InvalidColor(String)
InvalidFunctionName(String)
InvalidColorComponent(u8)
IntValueParseErr(ParseIntError)
FloatValueParseErr(ParseFloatError)
FloatValueOutOfRange(f32)
MissingColorComponent(CssColorComponent)
ExtraArguments(String)
UnclosedColor(String)
EmptyInput
DirectionParseError(CssDirectionParseErrorOwned)
UnsupportedDirection(String)
InvalidPercentage(PercentageParseError)
union enum CssPixelValueParseErrorOwned has destructor
EmptyString
NoValueGiven(PixelNoValueGivenError)
ValueParseErr(ParseFloatErrorWithInput)
InvalidPixelValue(String)
union enum CssBorderStyleParseErrorOwned has destructor
InvalidStyle(String)
union enum StyleExclusionMarginParseErrorOwned has destructor
FloatValue(String)
union enum StyleInitialLetterParseErrorOwned has destructor
InvalidFormat(String)
InvalidSize(String)
InvalidSink(String)
union enum JustifyContentParseErrorOwned has destructor
InvalidValue(String)
union enum LayoutMarginParseErrorOwned has destructor
PixelValueParseError(CssPixelValueParseErrorOwned)
TooManyValues
TooFewValues
union enum StyleTextColorParseErrorOwned has destructor
ColorParseError(CssColorParseErrorOwned)
union enum AlignItemsParseErrorOwned has destructor
InvalidValue(String)
union enum AlignContentParseErrorOwned has destructor
InvalidValue(String)
union enum StyleTabSizeParseErrorOwned has destructor
PixelValue(CssPixelValueParseErrorOwned)
union enum LayoutDisplayParseErrorOwned has destructor
InvalidValue(String)
union enum AlignSelfParseErrorOwned has destructor
InvalidValue(String)
struct PercentageParseErrorWithInput has destructor
error: PercentageParseError
input: String
union enum CssStylePerspectiveOriginParseErrorOwned has destructor
WrongNumberOfComponents(WrongComponentCountError)
PixelValueParseError(CssPixelValueParseErrorOwned)
union enum TextJustifyParseErrorOwned has destructor
InvalidValue(String)
union enum CssBackgroundParseErrorOwned has destructor
Error(String)
InvalidBackground(ParenthesisParseErrorOwned)
UnclosedGradient(String)
NoDirection(String)
TooFewGradientStops(String)
DirectionParseError(CssDirectionParseErrorOwned)
GradientParseError(CssGradientStopParseErrorOwned)
ConicGradient(CssConicGradientParseErrorOwned)
ShapeParseError(CssShapeParseErrorOwned)
ImageParseError(CssImageParseErrorOwned)
ColorParseError(CssColorParseErrorOwned)
union enum JustifySelfParseErrorOwned has destructor
InvalidValue(String)
union enum StyleVisibilityParseErrorOwned has destructor
InvalidValue(InvalidValueErrOwned)
union enum LayoutBoxSizingParseErrorOwned has destructor
InvalidValue(String)
union enum StyleTextIndentParseErrorOwned has destructor
PixelValue(CssPixelValueParseErrorOwned)
union enum LayoutClearParseErrorOwned has destructor
InvalidValue(String)
union enum StyleLetterSpacingParseErrorOwned has destructor
PixelValue(CssPixelValueParseErrorOwned)
union enum ColumnCountParseErrorOwned has destructor
InvalidValue(String)
ParseInt(String)
union enum CssStyleFilterParseErrorOwned has destructor
InvalidFilter(String)
InvalidParenthesis(ParenthesisParseErrorOwned)
Shadow(CssShadowParseErrorOwned)
BlendMode(InvalidValueErrOwned)
Color(CssColorParseErrorOwned)
Opacity(PercentageParseError)
Brightness(PercentageParseError)
Contrast(PercentageParseError)
Saturate(PercentageParseError)
Blur(CssStyleBlurParseErrorOwned)
ColorMatrix(CssStyleColorMatrixParseErrorOwned)
Offset(CssStyleFilterOffsetParseErrorOwned)
Composite(CssStyleCompositeFilterParseErrorOwned)
Angle(CssAngleValueParseErrorOwned)
union enum OpacityParseErrorOwned has destructor
ParsePercentage(PercentageParseErrorWithInput)
OutOfRange(String)
union enum CssStyleTransformParseErrorOwned has destructor
InvalidTransform(String)
InvalidParenthesis(ParenthesisParseErrorOwned)
WrongNumberOfComponents(WrongComponentCountError)
NumberParseError(ParseFloatError)
PixelValueParseError(CssPixelValueParseErrorOwned)
AngleValueParseError(CssAngleValueParseErrorOwned)
PercentageValueParseError(PercentageParseError)
union enum CssConicGradientParseErrorOwned has destructor
Position(CssBackgroundPositionParseErrorOwned)
Angle(CssAngleValueParseErrorOwned)
NoAngle(String)
union enum StyleTextDecorationParseErrorOwned has destructor
InvalidValue(InvalidValueErrOwned)
union enum LayoutZIndexParseErrorOwned has destructor
InvalidValue(String)
ParseInt(ParseIntErrorWithInput)
union enum StyleWhiteSpaceParseErrorOwned has destructor
InvalidValue(InvalidValueErrOwned)
union enum StyleTextCombineUprightParseErrorOwned has destructor
InvalidValue(String)
InvalidDigits(String)
union enum StyleDirectionParseErrorOwned has destructor
InvalidValue(InvalidValueErrOwned)
union enum StyleVerticalAlignParseErrorOwned has destructor
InvalidValue(InvalidValueErrOwned)
union enum CssStyleCompositeFilterParseErrorOwned has destructor
Invalid(InvalidValueErrOwned)
Float(ParseFloatError)
WrongNumberOfComponents(WrongComponentCountError)
union enum CssShapeParseErrorOwned has destructor
ShapeErr(InvalidValueErrOwned)
union enum PercentageParseErrorOwned has destructor
ValueParseErr(ParseFloatError)
NoPercentSign
InvalidUnit(String)
union enum LayoutPositionParseErrorOwned has destructor
InvalidValue(String)
union enum StyleHyphensParseErrorOwned has destructor
InvalidValue(InvalidValueErrOwned)
union enum CssAngleValueParseErrorOwned has destructor
EmptyString
NoValueGiven(AngleNoValueGivenError)
ValueParseErr(ParseFloatErrorWithInput)
InvalidAngle(String)
union enum LayoutFloatParseErrorOwned has destructor
InvalidValue(String)
union enum ColumnRuleColorParseErrorOwned has destructor
Color(CssColorParseErrorOwned)
union enum CssBorderSideParseErrorOwned has destructor
InvalidDeclaration(String)
Width(CssPixelValueParseErrorOwned)
Style(CssBorderStyleParseErrorOwned)
Color(CssColorParseErrorOwned)
union enum FlexDirectionParseErrorOwned has destructor
InvalidValue(String)
union enum CssStyleFontSizeParseErrorOwned has destructor
PixelValue(CssPixelValueParseErrorOwned)
union enum MixBlendModeParseErrorOwned has destructor
InvalidValue(InvalidValueErrOwned)
union enum CssStyleFilterOffsetParseErrorOwned has destructor
Pixel(CssPixelValueParseErrorOwned)
WrongNumberOfComponents(WrongComponentCountError)
union enum CssBackfaceVisibilityParseErrorOwned has destructor
InvalidValue(String)
union enum StyleHyphenationLanguageParseErrorOwned has destructor
InvalidString(String)
union enum ColumnWidthParseErrorOwned has destructor
InvalidValue(String)
PixelValue(CssPixelValueParseErrorOwned)
enum CombinedCssPropertyType
BorderRadius
Overflow
Margin
Border
BorderLeft
BorderRight
BorderTop
BorderBottom
BorderColor
BorderStyle
BorderWidth
Padding
BoxShadow
BackgroundColor
BackgroundImage
Background
Flex
Grid
Gap
GridGap
Font
Columns
ColumnRule
GridArea
TextBox
InsetBlock
InsetInline
union enum StyleListStyleTypeParseErrorOwned has destructor
InvalidValue(String)
union enum ColumnRuleWidthParseErrorOwned has destructor
Pixel(CssPixelValueParseErrorOwned)
union enum CssGradientStopParseErrorOwned has destructor
Error(String)
Percentage(PercentageParseErrorOwned)
Angle(CssAngleValueParseErrorOwned)
ColorParseError(CssColorParseErrorOwned)
union enum ColumnRuleStyleParseErrorOwned has destructor
union enum CssFontStyleParseErrorOwned has destructor
InvalidValue(InvalidValueErrOwned)
union enum LayoutWritingModeParseErrorOwned has destructor
InvalidValue(String)
union enum StyleWordSpacingParseErrorOwned has destructor
PixelValue(CssPixelValueParseErrorOwned)
union enum StyleUserSelectParseErrorOwned has destructor
InvalidValue(InvalidValueErrOwned)
union enum CssShadowParseErrorOwned has destructor
TooManyOrTooFewComponents(String)
ValueParseErr(CssPixelValueParseErrorOwned)
ColorParseError(CssColorParseErrorOwned)
union enum LayoutHeightParseErrorOwned has destructor
PixelValue(CssPixelValueParseErrorOwned)
InvalidKeyword(String)
union enum JustifyItemsParseErrorOwned has destructor
InvalidValue(String)
union enum BoxDecorationBreakParseErrorOwned has destructor
InvalidValue(String)
union enum PageBreakParseErrorOwned has destructor
InvalidValue(String)
union enum StyleScrollbarColorParseErrorOwned has destructor
InvalidValue(String)
Color(CssColorParseErrorOwned)
union enum StyleLineClampParseErrorOwned has destructor
InvalidValue(String)
ZeroValue
union enum CssDirectionParseErrorOwned has destructor
Error(String)
InvalidArguments(String)
ParseFloat(ParseFloatError)
CornerError(CssDirectionCornerParseErrorOwned)
AngleError(CssAngleValueParseErrorOwned)
union enum LayoutPaddingParseErrorOwned has destructor
PixelValueParseError(CssPixelValueParseErrorOwned)
TooManyValues
TooFewValues
union enum BreakInsideParseErrorOwned has destructor
InvalidValue(String)
union enum StyleTextAlignParseErrorOwned has destructor
InvalidValue(InvalidValueErrOwned)
union enum LayoutScrollbarWidthParseErrorOwned has destructor
InvalidValue(String)
union enum CssStyleBlurParseErrorOwned has destructor
Pixel(CssPixelValueParseErrorOwned)
TooManyComponents(String)
union enum LayoutOverflowParseErrorOwned has destructor
InvalidValue(String)
union enum CssDirectionCornerParseErrorOwned has destructor
InvalidDirection(String)
union enum CssStyleFontFamilyParseErrorOwned has destructor
InvalidStyleFontFamily(String)
UnclosedQuotes(String)
union enum LayoutWidthParseErrorOwned has destructor
PixelValue(CssPixelValueParseErrorOwned)
InvalidKeyword(String)
union enum CssStyleColorMatrixParseErrorOwned has destructor
Float(ParseFloatError)
WrongNumberOfComponents(WrongComponentCountError)
union enum CssBorderRadiusParseErrorOwned has destructor
TooManyValues(String)
PixelValue(CssPixelValueParseErrorOwned)
union enum StyleHangingPunctuationParseErrorOwned has destructor
InvalidValue(String)
union enum CssStyleTransformOriginParseErrorOwned has destructor
WrongNumberOfComponents(WrongComponentCountError)
PixelValueParseError(CssPixelValueParseErrorOwned)
union enum CssBackgroundPositionParseErrorOwned has destructor
NoPosition(String)
TooManyComponents(String)
FirstComponentWrong(CssPixelValueParseErrorOwned)
SecondComponentWrong(CssPixelValueParseErrorOwned)
union enum StyleListStylePositionParseErrorOwned has destructor
InvalidValue(String)
struct CssSyntaxInvalidAdvance
expected: isize
total: usize
pos: CssSyntaxErrorPos
struct CssStyleBorderRadiusParseErrorOwned has destructor
struct CssBorderParseErrorOwned has destructor
inner: CssBorderSideParseErrorOwned
union enum StyleBorderBottomRightRadiusParseErrorOwned has destructor
PixelValue(CssPixelValueParseErrorOwned)
union enum ColumnFillParseErrorOwned has destructor
InvalidValue(String)
union enum StyleBorderBottomLeftRadiusParseErrorOwned has destructor
PixelValue(CssPixelValueParseErrorOwned)
union enum ColumnSpanParseErrorOwned has destructor
InvalidValue(String)
union enum LayoutMaxWidthParseErrorOwned has destructor
PixelValue(CssPixelValueParseErrorOwned)
union enum StyleBorderTopLeftRadiusParseErrorOwned has destructor
PixelValue(CssPixelValueParseErrorOwned)
union enum LayoutMinHeightParseErrorOwned has destructor
PixelValue(CssPixelValueParseErrorOwned)
union enum LayoutMinWidthParseErrorOwned has destructor
PixelValue(CssPixelValueParseErrorOwned)
union enum OrphansParseErrorOwned has destructor
ParseInt(ParseIntErrorWithInput)
NegativeValue(String)
union enum LayoutMaxHeightParseErrorOwned has destructor
PixelValue(CssPixelValueParseErrorOwned)
union enum WidowsParseErrorOwned has destructor
ParseInt(ParseIntErrorWithInput)
NegativeValue(String)
union enum StyleBorderTopRightRadiusParseErrorOwned has destructor
PixelValue(CssPixelValueParseErrorOwned)
struct SvgTransform
sx: f32
kx: f32
ky: f32
sy: f32
tx: f32
ty: f32
struct SvgFillStyle
line_join: SvgLineJoin
miter_limit: f32
tolerance: f32
fill_rule: SvgFillRule
transform: SvgTransform
anti_alias: bool
high_quality_aa: bool
union enum ScrollbarVisibilityModeParseErrorOwned has destructor
InvalidValue(String)
union enum ScrollbarFadeDurationParseErrorOwned has destructor
InvalidValue(String)
union enum ScrollbarFadeDelayParseErrorOwned has destructor
InvalidValue(String)
enum ScrollbarVisibilityMode
Always
WhenScrolling
Auto
struct ScrollbarFadeDuration
ms: u32
struct ScrollbarFadeDelay
ms: u32
union enum StyleTextAlignLastParseErrorOwned has destructor
InvalidValue(InvalidValueErrOwned)
union enum StyleWordBreakParseErrorOwned has destructor
InvalidValue(InvalidValueErrOwned)
union enum StyleOverflowWrapParseErrorOwned has destructor
InvalidValue(InvalidValueErrOwned)
union enum StyleLineBreakParseErrorOwned has destructor
InvalidValue(InvalidValueErrOwned)
enum StyleLineBreak
Auto
Loose
Normal
Strict
Anywhere
enum StyleTextAlignLast
Auto
Start
End
Left
Right
Center
Justify
enum StyleOverflowWrap
Normal
Anywhere
BreakWord
enum StyleWordBreak
Normal
BreakAll
KeepAll
BreakWord
union enum StyleTextOrientationParseErrorOwned has destructor
InvalidValue(String)
union enum StyleObjectFitParseErrorOwned has destructor
InvalidValue(String)
enum StyleTextOrientation
Mixed
Upright
Sideways
enum StyleObjectFit
Fill
Contain
Cover
None
ScaleDown
union enum StyleAspectRatioParseErrorOwned has destructor
InvalidValue(String)
union enum StyleObjectPositionParseErrorOwned has destructor
InvalidValue(String)
struct StyleObjectPosition
horizontal: BackgroundPositionHorizontal
vertical: BackgroundPositionVertical
union enum StyleAspectRatio
Auto
Ratio(AspectRatioValue)
union enum StyleAlignmentBaselineParseErrorOwned has destructor
InvalidValue(InvalidValueErrOwned)
union enum StyleUnicodeBidiParseErrorOwned has destructor
InvalidValue(InvalidValueErrOwned)
union enum StyleTextBoxEdgeParseErrorOwned has destructor
InvalidValue(InvalidValueErrOwned)
union enum StyleScrollbarGutterParseErrorOwned has destructor
InvalidValue(String)
union enum StyleTextBoxTrimParseErrorOwned has destructor
InvalidValue(InvalidValueErrOwned)
union enum StyleOverflowClipMarginParseErrorOwned has destructor
InvalidValue(String)
union enum StyleDominantBaselineParseErrorOwned has destructor
InvalidValue(InvalidValueErrOwned)
union enum StyleInitialLetterWrapParseErrorOwned has destructor
InvalidValue(InvalidValueErrOwned)
union enum StyleInitialLetterAlignParseErrorOwned has destructor
InvalidValue(InvalidValueErrOwned)
enum StyleInitialLetterWrap
None
First
All
Grid
struct StyleOverflowClipMargin
clip_edge: VisualBox
inner: PixelValue
enum VisualBox
ContentBox
PaddingBox
BorderBox
enum StyleInitialLetterAlign
Auto
Alphabetic
Hanging
Ideographic
enum StyleTextBoxEdge
Auto
TextEdge
CapHeight
ExHeight
enum StyleAlignmentBaseline
Baseline
TextBottom
Alphabetic
Ideographic
Middle
Central
Mathematical
TextTop
enum StyleDominantBaseline
Auto
TextBottom
Alphabetic
Ideographic
Middle
Central
Mathematical
Hanging
TextTop
enum StyleTextBoxTrim
None
TrimStart
TrimEnd
TrimBoth
enum StyleScrollbarGutter
Auto
Stable
StableBothEdges
enum StyleUnicodeBidi
Normal
Embed
Isolate
BidiOverride
IsolateOverride
Plaintext
Media type for @media queries
enum MediaType
Screen
Print
All
Orientation type for responsive styling
enum OrientationType
Portrait
Landscape
union enum CalcAstItem
Value(PixelValue)
Add
Sub
Mul
Div
BraceOpen
BraceClose
OS version condition for version-specific styling
union enum OsVersionCondition
Min(OsVersion)
Max(OsVersion)
Exact(OsVersion)
DesktopEnvironment(LinuxDesktopEnv)
DesktopEnvMin(DesktopEnvVersion)
DesktopEnvMax(DesktopEnvVersion)
DesktopEnvExact(DesktopEnvVersion)
struct U16VecSlice
Pointer to the slice data
ptr: u16
Number of elements in the slice
len: usize
struct AudioMetrics
event_sounds_enabled: bool
input_feedback_sounds_enabled: bool
Scroll physics configuration for momentum scrolling. Controls how scrolling feels - the 'weight' and 'friction' of the scroll.
struct ScrollPhysics
smooth_scroll_duration_ms: u32
deceleration_rate: f32
min_velocity_threshold: f32
max_velocity: f32
wheel_multiplier: f32
invert_direction: bool
overscroll_elasticity: f32
max_overscroll_distance: f32
bounce_back_duration_ms: u32
timer_interval_ms: u32
Metrics for titlebar layout and window chrome. Provides information needed to correctly position custom titlebar content when using WindowDecorations::NoTitle (expanded title mode).
struct TitlebarMetrics has destructor
Which side the window control buttons are on
button_side: TitlebarButtonSide
Which buttons are available
buttons: TitlebarButtons
Height of the titlebar in pixels
height: OptionPixelValue
Width reserved for window control buttons (close/min/max)
button_area_width: OptionPixelValue
Horizontal padding inside the titlebar
padding_horizontal: OptionPixelValue
Safe area insets for notched/rounded displays
safe_area: SafeAreaInsets
Title text font
title_font: OptionString
Title text font size
title_font_size: OptionF32
Title text font weight (400 = normal, 600 = semibold, 700 = bold)
title_font_weight: OptionU16
constructor windows:
constructor macos:
constructor linux_gnome:
constructor ios:
constructor android:
Windows-style titlebar (buttons on right)
macOS-style titlebar (buttons on left, traffic lights)
Linux GNOME-style titlebar
iOS-style safe area (for notched devices)
Android-style titlebar (action bar)
struct OsVersion
os: OsFamily
version_id: u32
Dynamic selector for runtime CSS evaluation based on OS, media, container, theme, and pseudo-state
union enum DynamicSelector has destructor
Os(OsCondition)
OsVersion(OsVersionCondition)
Media(MediaType)
ViewportWidth(MinMaxRange)
ViewportHeight(MinMaxRange)
ContainerWidth(MinMaxRange)
ContainerHeight(MinMaxRange)
ContainerName(String)
Theme(ThemeCondition)
AspectRatio(MinMaxRange)
Orientation(OrientationType)
PrefersReducedMotion(BoolCondition)
PrefersHighContrast(BoolCondition)
PseudoState(PseudoStateType)
Language(LanguageCondition)
Reference to a specific system metric value. These are resolved at runtime based on the user's system preferences. CSS syntax: system:button-padding, system:button-radius, etc.
enum SystemMetricRef
Button corner radius (system:button-radius)
ButtonRadius
Button horizontal padding (system:button-padding-horizontal)
ButtonPaddingHorizontal
Button vertical padding (system:button-padding-vertical)
ButtonPaddingVertical
Button border width (system:button-border-width)
ButtonBorderWidth
Titlebar height (system:titlebar-height)
TitlebarHeight
Titlebar button area width (system:titlebar-button-width)
TitlebarButtonWidth
Titlebar horizontal padding (system:titlebar-padding)
TitlebarPadding
Safe area top inset for notched devices (system:safe-area-top)
SafeAreaTop
Safe area bottom inset (system:safe-area-bottom)
SafeAreaBottom
Safe area left inset (system:safe-area-left)
SafeAreaLeft
Safe area right inset (system:safe-area-right)
SafeAreaRight
struct InvalidValueErrOwned has destructor
value: String
Pseudo-state type for element state conditions
enum PseudoStateType
Normal
Hover
Active
Focus
Disabled
CheckedTrue
CheckedFalse
FocusWithin
Visited
Backdrop
Dragging
DragOver
Operating system condition for OS-specific styling
enum OsCondition
Any
Apple
MacOS
IOS
Linux
Windows
Android
Web
struct CalcAstItemVecSlice
Pointer to the slice data
ptr: CalcAstItem
Number of elements in the slice
len: usize
Min/Max range for numeric conditions (NaN = no limit)
struct MinMaxRange
min: f32
max: f32
struct AspectRatioValue
width: u32
height: u32
struct SystemMetrics has destructor
corner_radius: OptionPixelValue
border_width: OptionPixelValue
The horizontal (left/right) padding for buttons and similar controls.
button_padding_horizontal: OptionPixelValue
The vertical (top/bottom) padding for buttons and similar controls.
button_padding_vertical: OptionPixelValue
Titlebar layout information (button positions, safe areas, etc.)
titlebar: TitlebarMetrics
struct F32VecSlice
Pointer to the slice data
ptr: f32
Number of elements in the slice
len: usize
struct EmptyStruct
_reserved: u8
constructor create:
-> EmptyStruct
Create a new EmptyStruct value (FFI-safe replacement for
())struct U32VecSlice
Pointer to the slice data
ptr: u32
Number of elements in the slice
len: usize
Enum that stores either a heap-allocated Box<T> or a *const T pointer to static data. Used to optimize CSS property values by storing compile-time constants as static pointers instead of heap allocations. Size: 16 bytes on 64-bit (1 tag + 7 padding + 8 pointer).
union enum BoxOrStatic
Boxed(T)
Static(T)
struct VisualHints
toolbar_style: ToolbarStyle
show_button_images: bool
show_menu_images: bool
show_tooltips: bool
flash_on_alert: bool
enum OsFamily
Windows
MacOS
IOS
Linux
Android
union enum LanguageCondition has destructor
Exact(String)
Prefix(String)
Boolean condition for accessibility preferences
enum BoolCondition
False
True
struct DynamicSelectorVecSlice has destructor
Pointer to the slice data
ptr: DynamicSelector
Number of elements in the slice
len: usize
struct U8VecSlice
Pointer to the slice data
ptr: u8
Number of elements in the slice
len: usize
struct LinuxCustomization has destructor
gtk_theme: OptionString
icon_theme: OptionString
cursor_theme: OptionString
cursor_size: u32
titlebar_button_layout: OptionString
union enum StyleClipRectParseErrorOwned has destructor
InvalidValue(String)
struct StyleClipRect
top: OptionF32
right: OptionF32
bottom: OptionF32
left: OptionF32
union enum LayoutLeftParseErrorOwned has destructor
PixelValue(CssPixelValueParseErrorOwned)
union enum LayoutTopParseErrorOwned has destructor
PixelValue(CssPixelValueParseErrorOwned)
union enum LayoutInsetBottomParseErrorOwned has destructor
PixelValue(CssPixelValueParseErrorOwned)
union enum LayoutRightParseErrorOwned has destructor
PixelValue(CssPixelValueParseErrorOwned)
List of file extension patterns and a human-readable descriptor used to filter a file dialog.
struct FileTypeList has destructor
document_types: StringVec
document_descriptor: String
What triggered the current
layout()invocation.
The framework re-invokes the layout callback for any change that may produce a structurally different DOM (resize across a CSS breakpoint, theme toggle, route switch, callback returning Update::RefreshDom). Read viaLayoutCallbackInfo.relayout_reason()so the callback can branch - for example, skip expensive analytics onResizecalls.enum RelayoutReason
Initial
RefreshDom
Resize
ThemeChange
RouteChange
Other
struct DesktopEnvVersion
env: LinuxDesktopEnv
version_id: u32
Dominant direction of a swipe gesture, used by
CallbackInfo::get_swipe_direction().enum GestureDirection
Up
Down
Left
Right
Default, built-in widgets (button, label, textinput, etc.)
mod widgets:
The semantic type/role of a button. Each type has distinct styling to indicate its purpose to the user.
enum ButtonType
Default
Primary
Secondary
Success
Danger
Warning
Info
Link
struct Button has destructor
label: String
image: OptionImageRef
button_type: ButtonType
container_style: CssPropertyWithConditionsVec
label_style: CssPropertyWithConditionsVec
image_style: CssPropertyWithConditionsVec
on_click: OptionButtonOnClick
constructor create:
constructor with_type:
arg label: String
arg button_type: ButtonType
-> Button
Creates a new labeled button
Creates a new button with a specific type (Primary, Secondary, Success, Danger, Warning, Info, Link)
fn set_on_click:
fn with_on_click:
fn set_button_type:
&mut self
arg button_type: ButtonType
fn with_button_type:
self
arg button_type: ButtonType
-> Button
fn dom:
self
-> Dom
Register a click handler on the button.
Takes aCallback(the wrapper struct) so managed-FFI callers can preserve the host-handle ctx attached viaCallback::create_from_host_handle. Native Rust / C callers can still pass a bare function pointer thanks toCallback'sFrom<CallbackType>impl (ctx: None).Set the button type and update styling accordingly
Builder method to set the button type
struct MapTileId
z: u8
x: u32
y: u32
struct MapTileLayer has destructor
url_template: String
min_zoom: u8
max_zoom: u8
attribution: String
style_css: String
struct MapViewport
centre_lat_deg: f64
centre_lon_deg: f64
zoom: f32
bearing_deg: f32
pitch_deg: f32
Map widget - MVT tile + MapCSS -> SVG -> DOM (AzulMaps goal app, SUPER_PLAN_2 P3). Tile cache lives in a
RefAnydataset owned by aDatasetMergeCallbackso in-flight fetches and decoded SVG bytes survive relayout. Visible-tile grid is computed by an innerVirtualViewcallback running Web Mercator math.struct MapWidget has destructor
layer: MapTileLayer
viewport: MapViewport
container_style: CssPropertyWithConditionsVec
on_viewport_changed: OptionMapViewportChanged
on_pin_tap: OptionMapPinTap
constructor create:
arg layer: MapTileLayer
-> MapWidget
Build a fresh
MapWidgetfrom aMapTileLayer. The viewport defaults toMapViewport::default()(lat 0, lon 0, zoom 2). Chainwith_viewport(...)to relocate.fn with_viewport:
self
arg viewport: MapViewport
-> MapWidget
fn set_viewport:
&mut self
arg viewport: MapViewport
self
arg css: CssPropertyWithConditionsVec
-> MapWidget
fn dom:
self
-> Dom
fn dom_with_fetch:
self
arg cb: ThreadCallback
-> Dom
self
arg data: RefAny
arg callback: MapViewportChangedCallback
-> MapWidget
&mut self
arg data: RefAny
arg callback: MapViewportChangedCallback
fn latlon_at_px:
arg viewport: MapViewport
arg px: LogicalPosition
arg container: LogicalSize
-> MapLatLon
fn px_at_latlon:
arg viewport: MapViewport
arg coord: MapLatLon
arg container: LogicalSize
fn set_on_pin_tap:
&mut self
arg data: RefAny
arg callback: MapPinTapCallback
fn with_on_pin_tap:
self
arg data: RefAny
arg callback: MapPinTapCallback
-> MapWidget
Builder: set the centre + zoom + bearing + pitch.
Mutator: replace the viewport in place.
Builder: replace the container CSS.
Consume the widget and produce its rendered
Dom.Like [
dom](Self::dom), but wires a tile-fetch worker thread.cbruns on a frameworkThreadper visible tile: it reads theTileFetchInit, fetches + decodes, thensender.send(ThreadReceiveMsg::WriteBack(...))aTileReadyMsgtargetingmap_tile_writeback. The standard worker isazul_dll::desktop::extra::map::tile_fetch_worker; wrap it in aThreadCallbackto pass it here. See the recipe inMOBILE_SESSION_LOG.md.Builder form of [
set_on_viewport_changed](Self::set_on_viewport_changed).Set a hook fired when the user pans / zooms the map. The map owns its own pan/pinch state; this lets your app observe or persist the resulting
MapViewport. The backreference DI pattern (architecture.md).Project a screen pixel
px(relative to the map node's top-left, in a node of sizecontainer) to a lat/lon on the map atviewport. Small- angle Mercator (accurate at city zooms). Inverse of [px_at_latlon](Self::px_at_latlon). Exposed so apps don't reimplement the projection (e.g. to drop a pin where the user tapped).Inverse of [
latlon_at_px](Self::latlon_at_px): wherecoordlands in container pixels atviewport.Set a hook fired when the user taps the map (a press + release at ~the same point, no drag), with the tapped lat/lon. The backreference DI pattern (architecture.md).
Builder form of [
set_on_pin_tap](Self::set_on_pin_tap).struct ButtonOnClick
data: RefAny
callback: ButtonOnClickCallback
struct FileInput has destructor
file_input_state: FileInputStateWrapper
default_text: String
image: OptionImageRef
container_style: CssPropertyWithConditionsVec
label_style: CssPropertyWithConditionsVec
image_style: CssPropertyWithConditionsVec
constructor create:
arg path: OptionString
-> FileInput
Creates a new file input button
fn set_default_text:
&mut self
arg default_text: String
&mut self
arg data: RefAny
arg callback: FileInputOnPathChangeCallbackType
self
arg data: RefAny
arg callback: FileInputOnPathChangeCallbackType
-> FileInput
fn dom:
self
-> Dom
struct FileInputStateWrapper has destructor
inner: FileInputState
on_path_change: OptionFileInputOnPathChange
file_dialog_title: String
default_dir: OptionString
struct FileInputState has destructor
path: OptionString
struct FileInputOnPathChange
data: RefAny
callback: FileInputOnPathChangeCallback
struct FileInputOnPathChangeCallback
cb: FileInputOnPathChangeCallbackType
callable: OptionRefAny
struct CheckBox has destructor
check_box_state: CheckBoxStateWrapper
container_style: CssPropertyWithConditionsVec
content_style: CssPropertyWithConditionsVec
fn set_on_toggle:
&mut self
arg data: RefAny
arg callback: CheckBoxOnToggleCallbackType
fn with_on_toggle:
self
arg data: RefAny
arg callback: CheckBoxOnToggleCallbackType
-> CheckBox
fn dom:
self
-> Dom
struct CheckBoxStateWrapper
Content (image or text) of this CheckBox, centered by default
inner: CheckBoxState
Optional: Function to call when the CheckBox is toggled
on_toggle: OptionCheckBoxOnToggle
struct CheckBoxOnToggle
data: RefAny
callback: CheckBoxOnToggleCallback
struct CheckBoxState
checked: bool
struct DropDown has destructor
choices: StringVec
selected: usize
on_choice_change: OptionDropDownOnChoiceChange
constructor create:
Creates a new dropdown with the given choices. Opens a native popup menu on click.
&mut self
arg data: RefAny
arg callback: DropDownOnChoiceChangeCallbackType
self
arg data: RefAny
arg callback: DropDownOnChoiceChangeCallbackType
-> DropDown
fn dom:
self
-> Dom
struct DropDownOnChoiceChange
data: RefAny
callback: DropDownOnChoiceChangeCallback
struct ColorInput has destructor
color_input_state: ColorInputStateWrapper
style: CssPropertyWithConditionsVec
constructor create:
arg color: ColorU
-> ColorInput
&mut self
arg data: RefAny
arg callback: ColorInputOnValueChangeCallbackType
self
arg data: RefAny
arg callback: ColorInputOnValueChangeCallbackType
-> ColorInput
fn dom:
self
-> Dom
struct ColorInputStateWrapper has destructor
inner: ColorInputState
title: String
on_value_change: OptionColorInputOnValueChange
struct ColorInputState
color: ColorU
struct ColorInputOnValueChange
data: RefAny
callback: ColorInputOnValueChangeCallback
struct ColorInputOnValueChangeCallback
cb: ColorInputOnValueChangeCallbackType
callable: OptionRefAny
struct TextInput has destructor
text_input_state: TextInputStateWrapper
placeholder_style: CssPropertyWithConditionsVec
container_style: CssPropertyWithConditionsVec
label_style: CssPropertyWithConditionsVec
fn set_text:
&mut self
arg text: String
fn with_text:
fn set_placeholder:
&mut self
arg text: String
fn with_placeholder:
&mut self
arg data: RefAny
arg callback: TextInputOnTextInputCallbackType
self
arg data: RefAny
arg callback: TextInputOnTextInputCallbackType
-> TextInput
&mut self
arg data: RefAny
arg callback: TextInputOnVirtualKeyDownCallbackType
self
arg data: RefAny
arg callback: TextInputOnVirtualKeyDownCallbackType
-> TextInput
&mut self
arg data: RefAny
arg callback: TextInputOnFocusLostCallbackType
self
arg data: RefAny
arg callback: TextInputOnFocusLostCallbackType
-> TextInput
fn dom:
self
-> Dom
struct TextInputStateWrapper has destructor
inner: TextInputState
on_text_input: OptionTextInputOnTextInput
on_virtual_key_down: OptionTextInputOnVirtualKeyDown
on_focus_lost: OptionTextInputOnFocusLost
update_text_input_before_calling_focus_lost_fn: bool
update_text_input_before_calling_vk_down_fn: bool
cursor_animation: OptionTimerId
struct TextInputState has destructor
text: U32Vec
placeholder: OptionString
max_len: usize
selection: OptionTextInputSelection
cursor_pos: usize
struct TextInputOnTextInput
data: RefAny
callback: TextInputOnTextInputCallback
struct TextInputOnTextInputCallback
cb: TextInputOnTextInputCallbackType
callable: OptionRefAny
struct TextInputOnFocusLost
data: RefAny
callback: TextInputOnFocusLostCallback
struct TextInputOnFocusLostCallback
cb: TextInputOnFocusLostCallbackType
callable: OptionRefAny
struct OnTextInputReturn
update: Update
valid: TextInputValid
enum TextInputValid
Yes
No
struct NumberInput has destructor
number_input_state: NumberInputStateWrapper
text_input: TextInput
style: CssPropertyWithConditionsVec
constructor create:
arg number: f32
-> NumberInput
&mut self
arg data: RefAny
arg callback: TextInputOnTextInputCallbackType
self
arg data: RefAny
arg callback: TextInputOnTextInputCallbackType
-> NumberInput
&mut self
arg data: RefAny
arg callback: TextInputOnVirtualKeyDownCallbackType
self
arg data: RefAny
arg callback: TextInputOnVirtualKeyDownCallbackType
-> NumberInput
&mut self
arg data: RefAny
arg callback: NumberInputOnFocusLostCallbackType
self
arg data: RefAny
arg callback: NumberInputOnFocusLostCallbackType
-> NumberInput
&mut self
arg data: RefAny
arg callback: NumberInputOnValueChangeCallbackType
self
arg data: RefAny
arg callback: NumberInputOnValueChangeCallbackType
-> NumberInput
fn dom:
self
-> Dom
struct NumberInputStateWrapper
inner: NumberInputState
on_value_change: OptionNumberInputOnValueChange
on_focus_lost: OptionNumberInputOnFocusLost
struct NumberInputState
previous: f32
number: f32
min: f32
max: f32
struct NumberInputOnValueChange
data: RefAny
callback: NumberInputOnValueChangeCallback
struct NumberInputOnValueChangeCallback
cb: NumberInputOnValueChangeCallbackType
callable: OptionRefAny
struct NumberInputOnFocusLost
data: RefAny
callback: NumberInputOnFocusLostCallback
struct NumberInputOnFocusLostCallback
cb: NumberInputOnFocusLostCallbackType
callable: OptionRefAny
struct ProgressBar has destructor
progressbar_state: ProgressBarState
height: PixelValue
bar_background: StyleBackgroundContentVec
container_background: StyleBackgroundContentVec
constructor create:
arg percent_done: f32
-> ProgressBar
fn set_height:
&mut self
arg height: PixelValue
fn with_height:
self
arg height: PixelValue
-> ProgressBar
&mut self
arg background: StyleBackgroundContentVec
self
arg background: StyleBackgroundContentVec
-> ProgressBar
&mut self
arg background: StyleBackgroundContentVec
self
arg background: StyleBackgroundContentVec
-> ProgressBar
fn dom:
self
-> Dom
struct ProgressBarState
percent_done: f32
display_percentage: bool
struct TabHeader has destructor
tabs: StringVec
active_tab: usize
on_click: OptionTabOnClick
fn set_active_tab:
&mut self
arg active_tab: usize
fn with_active_tab:
self
arg active_tab: usize
-> TabHeader
fn set_on_click:
&mut self
arg data: RefAny
arg callback: TabOnClickCallbackType
fn with_on_click:
self
arg data: RefAny
arg callback: TabOnClickCallbackType
-> TabHeader
fn dom:
self
-> Dom
struct TabOnClick
data: RefAny
callback: TabOnClickCallback
struct Frame has destructor
title: String
flex_grow: f32
content: Dom
fn set_flex_grow:
&mut self
arg flex_grow: f32
fn with_flex_grow:
self
arg flex_grow: f32
-> Frame
fn dom:
self
-> Dom
List view, optionally able to lazy-load data
struct ListView has destructor
Column names
columns: StringVec
Currently rendered rows. Note that the ListView does not have to render all rows at once, usually you'd only render the top 100 rows
rows: ListViewRowVec
Which column is the list view sorted by (default = None)?
sorted_by: OptionUsize
Offset to add to the rows used when layouting row positions during lazy-loaded scrolling. Also affects the scroll position
scroll_offset: PixelValueNoPercent
Height of the content, if not all rows are loaded
content_height: OptionPixelValueNoPercent
Context menu for the columns (usually opens a context menu to select which columns to show)
column_context_menu: OptionMenu
Indicates that this ListView is being lazily loaded, allows control over what happens when the user scrolls the ListView.
on_lazy_load_scroll: OptionListViewOnLazyLoadScroll
What to do when the user left-clicks the column (usually used for storing which column to sort by)
on_column_click: OptionListViewOnColumnClick
What to do when the user left-clicks a row (usually used for selecting the row depending on the state)
on_row_click: OptionListViewOnRowClick
fn with_rows:
self
arg rows: ListViewRowVec
-> ListView
fn dom:
self
-> Dom
Row of the ListView
struct ListViewRow has destructor
Each cell is an opaque Dom object
cells: DomVec
Height of the row, if known beforehand
height: OptionPixelValueNoPercent
struct ListViewOnLazyLoadScroll
data: RefAny
callback: ListViewOnLazyLoadScrollCallback
struct ListViewOnColumnClick
data: RefAny
callback: ListViewOnColumnClickCallback
struct ListViewOnRowClick
data: RefAny
callback: ListViewOnRowClickCallback
struct ListViewState has destructor
columns: StringVec
sorted_by: OptionUsize
current_row_count: usize
scroll_offset: PixelValueNoPercent
current_scroll_position: LogicalPosition
current_content_height: LogicalSize
struct TabHeaderState
active_tab: usize
struct ListViewRowVecSlice has destructor
Pointer to the slice data
ptr: ListViewRow
Number of elements in the slice
len: usize
Which window control buttons are available in the titlebar.
struct TitlebarButtons
Close button is available
has_close: bool
Minimize button is available
has_minimize: bool
Maximize/zoom button is available
has_maximize: bool
Fullscreen button is available (macOS green button behavior)
has_fullscreen: bool
Which side of the titlebar the window control buttons are on.
enum TitlebarButtonSide
Buttons are on the left (macOS default)
Left
Buttons are on the right (Windows, most Linux DEs)
Right
struct RibbonSection has destructor
title: String
content: Dom
struct RibbonTab has destructor
label: String
sections: RibbonSectionVec
fn add_section:
&mut self
arg section: RibbonSection
fn with_section:
self
arg section: RibbonSection
-> RibbonTab
struct Ribbon has destructor
tabs: RibbonTabVec
active_tab: usize
on_tab_click: OptionRibbonOnTabClick
constructor new:
arg tabs: RibbonTabVec
-> Ribbon
fn set_active_tab:
&mut self
arg index: usize
fn set_on_tab_click:
&mut self
arg data: RefAny
arg cb: RibbonOnTabClickCallback
self
arg data: RefAny
arg cb: RibbonOnTabClickCallback
-> Ribbon
fn dom:
self
-> Dom
struct RibbonOnTabClick
data: RefAny
callback: RibbonOnTabClickCallback
struct TreeView has destructor
root: TreeViewNode
on_node_click: OptionTreeViewOnNodeClick
constructor new:
arg root: TreeViewNode
-> TreeView
&mut self
arg data: RefAny
arg callback: TreeViewOnNodeClickCallback
self
arg data: RefAny
arg callback: TreeViewOnNodeClickCallback
-> TreeView
fn dom:
self
-> Dom
struct TreeViewNode has destructor
label: String
children: TreeViewNodeVec
is_expanded: bool
is_selected: bool
constructor new:
arg label: String
-> TreeViewNode
fn add_child:
&mut self
arg child: TreeViewNode
fn with_child:
self
arg child: TreeViewNode
-> TreeViewNode
fn with_expanded:
self
arg expanded: bool
-> TreeViewNode
fn with_selected:
self
arg selected: bool
-> TreeViewNode
struct TreeViewOnNodeClick
data: RefAny
callback: TreeViewOnNodeClickCallback
struct RibbonSectionVecSlice has destructor
Pointer to the slice data
ptr: RibbonSection
Number of elements in the slice
len: usize
struct RibbonTabVecSlice has destructor
Pointer to the slice data
ptr: RibbonTab
Number of elements in the slice
len: usize
struct TreeViewNodeVecSlice has destructor
Pointer to the slice data
ptr: TreeViewNode
Number of elements in the slice
len: usize
struct Titlebar has destructor
title: String
height: f32
font_size: f32
padding_left: f32
padding_right: f32
title_color: ColorU
fn dom:
self
-> Dom
fn domWithButtons:
self
arg buttons: TitlebarButtons
arg button_side: TitlebarButtonSide
-> Dom
Convert this titlebar into a title-only DOM tree (no window control buttons)
Convert this titlebar into a full CSD DOM tree with close/minimize/maximize buttons
enum GamepadButton
South
East
North
West
LeftBumper
RightBumper
LeftTrigger
RightTrigger
Select
Start
Mode
LeftThumb
RightThumb
DPadUp
DPadDown
DPadLeft
DPadRight
struct CameraWidget
config: CameraConfig
on_frame: OptionOnVideoFrame
constructor create:
arg config: CameraConfig
-> CameraWidget
Create a camera widget for the given capture config.
fn dom:
self
-> Dom
fn with_on_frame:
self
arg data: RefAny
arg on_frame: OnVideoFrameCallback
-> CameraWidget
fn set_on_frame:
&mut self
arg data: RefAny
arg on_frame: OnVideoFrameCallback
Build the widget's DOM: a single
<img>node, fed by a background capture thread started on mount.Builder form of [
set_on_frame](Self::set_on_frame).Set a hook invoked with every captured frame - for live effects, saving frames into your data model, or sending them over the network (azul-meet). The backreference DI pattern (see
architecture.md).struct ScreenCaptureWidget
config: ScreenCaptureConfig
on_frame: OptionOnVideoFrame
constructor create:
arg config: ScreenCaptureConfig
Create a screencap widget for the given config.
fn dom:
self
-> Dom
fn with_on_frame:
self
arg data: RefAny
arg on_frame: OnVideoFrameCallback
fn set_on_frame:
&mut self
arg data: RefAny
arg on_frame: OnVideoFrameCallback
Build the widget's DOM: a single
<img>node, fed by a background capture thread started on mount.Builder form of [
set_on_frame](Self::set_on_frame).Set a hook invoked with every captured frame - for live effects, saving frames into your data model, or sending them over the network (azul-meet). The backreference DI pattern (see
architecture.md).struct VideoWidget has destructor
config: VideoConfig
on_frame: OptionOnVideoFrame
constructor create:
arg config: VideoConfig
-> VideoWidget
Create a video widget for the given config.
fn dom:
self
-> Dom
fn with_on_frame:
self
arg data: RefAny
arg on_frame: OnVideoFrameCallback
-> VideoWidget
fn set_on_frame:
&mut self
arg data: RefAny
arg on_frame: OnVideoFrameCallback
Build the widget's DOM: a single
<img>node, fed by a background decode thread started on mount.Builder form of [
set_on_frame](Self::set_on_frame).Set a hook invoked with every decoded frame - for live effects, saving frames into your data model, or sending them over the network (azul-meet). The backreference DI pattern (see
architecture.md).struct VideoFrame has destructor
width: u32
height: u32
bytes: U8Vec
struct OnVideoFrame
data: RefAny
callback: OnVideoFrameCallback
struct MapViewportChangedCallback
cb: MapViewportChangedCallbackType
callable: OptionRefAny
struct MapViewportChanged
data: RefAny
callback: MapViewportChangedCallback
struct MapLatLon
lat_deg: f64
lon_deg: f64
struct OnAudioFrame
data: RefAny
callback: OnAudioFrameCallback
struct MicrophoneWidget
config: AudioConfig
on_frame: OptionOnAudioFrame
constructor create:
arg config: AudioConfig
Create a microphone widget for the given capture config.
fn with_on_frame:
self
arg data: RefAny
arg on_frame: OnAudioFrameCallback
fn set_on_frame:
&mut self
arg data: RefAny
arg on_frame: OnAudioFrameCallback
fn dom:
self
-> Dom
Builder form of [
set_on_frame](Self::set_on_frame).Set a hook invoked with every captured audio chunk - for saving, effects, or sending over the network (azul-meet). The backreference DI pattern (see
architecture.md).Build the widget's DOM: a single invisible node, fed by a background capture thread started on mount. Place it anywhere in your tree - the capture lives as long as the node is mounted (unmount stops it).
struct AudioFrame has destructor
sample_rate: u32
channels: u16
samples: F32Vec
fn frame_count:
&self
-> usize
Number of sample *frames* (samples per channel) in this chunk.
OpenGl helper types (
Texture,Gl, etc.)mod gl:
OpenGL texture, use
ReadOnlyWindow::create_textureto create a texturestruct Texture has destructor
gl_context: GlContextPtr
texture_id: GLuint
refcount: c_void
size: PhysicalSizeU32
format: RawImageFormat
background_color: ColorU
flags: TextureFlags
run_destructor: bool
constructor create:
arg texture_id: GLuint
arg flags: TextureFlags
arg size: PhysicalSizeU32
arg background_color: ColorU
arg gl_context: GlContextPtr
arg format: RawImageFormat
-> Texture
constructor allocate_rgba8:
arg gl_context: GlContextPtr
arg size: PhysicalSizeU32
arg background: ColorU
-> Texture
constructor allocate_clip_mask:
arg gl: GlContextPtr
arg size: PhysicalSizeU32
arg background: ColorU
-> Texture
Allocates an OpenGL texture of a given size with a single red channel (used for image masks)
fn clear:
&mut self
fn apply_fxaa:
&mut self
-> bool
fn draw_tesselated_svg_gpu_node:
&mut self
arg node: TessellatedGPUSvgNode
arg size: PhysicalSizeU32
arg color: ColorU
arg transforms: StyleTransformVec
-> bool
fn get_descriptor:
&self
fn draw_tesselated_colored_svg_gpu_node:
&mut self
arg node: TessellatedColoredGPUSvgNode
arg size: PhysicalSizeU32
arg transforms: StyleTransformVec
-> bool
Applies an FXAA filter to the texture
Draws a
TessellatedGPUSvgNodewith the given color to the textureDraws a
TessellatedColoredGPUSvgNodeto the texturePassing *const c_void is not easily possible when generating APIs, so this wrapper struct is for easier API generation
struct GlVoidPtrConst has destructor
ptr: c_void
run_destructor: bool
struct GlVoidPtrMut
ptr: c_void
struct TextureFlags
Whether this texture contains an alpha component
is_opaque: bool
Optimization: use the compositor instead of OpenGL for energy optimization
is_video_texture: bool
For .get_gl_precision_format(), but ABI-safe - returning an array or a tuple is not ABI-safe
struct GlShaderPrecisionFormatReturn
_0: GLint
_1: GLint
_2: GLint
struct GlContextPtr has destructor
ptr: c_void
renderer_type: RendererType
run_destructor: bool
fn get_type:
&self
-> GlType
&self
arg target: GLenum
arg size: GLsizeiptr
arg data: GlVoidPtrConst
arg usage: GLenum
&self
arg target: GLenum
arg offset: isize
arg size: GLsizeiptr
arg data: GlVoidPtrConst
fn map_buffer:
&self
arg target: GLenum
arg access: GLbitfield
-> GlVoidPtrMut
fn map_buffer_range:
&self
arg target: GLenum
arg offset: GLintptr
arg length: GLsizeiptr
arg access: GLbitfield
-> GlVoidPtrMut
fn unmap_buffer:
fn tex_buffer:
fn read_buffer:
&self
arg mode: GLenum
fn read_pixels:
fn sample_coverage:
&self
arg value: GLclampf
arg invert: bool
fn polygon_offset:
fn pixel_store_i:
fn gen_buffers:
fn gen_framebuffers:
fn gen_textures:
fn gen_queries:
fn begin_query:
fn end_query:
&self
arg target: GLenum
fn query_counter:
fn delete_queries:
&self
arg queries: GLuintVecRef
&self
arg vertex_arrays: GLuintVecRef
fn delete_buffers:
&self
arg buffers: GLuintVecRef
&self
arg renderbuffers: GLuintVecRef
&self
arg framebuffers: GLuintVecRef
fn delete_textures:
&self
arg textures: GLuintVecRef
fn depth_func:
&self
arg func: GLenum
fn active_texture:
&self
arg texture: GLenum
fn attach_shader:
fn get_uniform_iv:
&self
arg program: GLuint
arg location: GLint
arg result: GLintVecRefMut
fn get_uniform_fv:
&self
arg program: GLuint
arg location: GLint
arg result: GLfloatVecRefMut
fn bind_buffer_base:
&self
arg target: GLenum
arg index: GLuint
arg buffer: GLuint
arg offset: GLintptr
arg size: GLsizeiptr
fn bind_buffer:
&self
arg vao: GLuint
fn bind_framebuffer:
fn bind_texture:
fn draw_buffers:
&self
arg bufs: GLenumVecRef
fn tex_image_2d:
fn tex_image_3d:
fn tex_sub_image_2d:
fn tex_sub_image_3d:
fn tex_storage_2d:
fn tex_storage_3d:
&self
arg target: GLenum
arg level: GLint
arg format: GLenum
arg ty: GLenum
arg output: U8VecRefMut
&self
arg target: GLenum
arg attachments: GLenumVecRef
fn get_integer_v:
&self
arg name: GLenum
arg result: GLintVecRefMut
fn get_integer_64v:
&self
arg name: GLenum
arg result: GLint64VecRefMut
fn get_integer_iv:
&self
arg name: GLenum
arg index: GLuint
arg result: GLintVecRefMut
fn get_integer_64iv:
&self
arg name: GLenum
arg index: GLuint
arg result: GLint64VecRefMut
fn get_boolean_v:
&self
arg name: GLenum
arg result: GLbooleanVecRefMut
fn get_float_v:
&self
arg name: GLenum
arg result: GLfloatVecRefMut
fn tex_parameter_i:
fn tex_parameter_f:
fn blit_framebuffer:
fn vertex_attrib_4f:
fn viewport:
fn scissor:
fn line_width:
&self
arg width: GLfloat
fn use_program:
&self
arg program: GLuint
fn validate_program:
&self
arg program: GLuint
fn draw_arrays:
fn draw_elements:
fn blend_color:
&self
arg r: f32
arg g: f32
arg b: f32
arg a: f32
fn blend_func:
fn blend_equation:
&self
arg mode: GLenum
fn color_mask:
&self
arg r: bool
arg g: bool
arg b: bool
arg a: bool
fn cull_face:
&self
arg mode: GLenum
fn front_face:
&self
arg mode: GLenum
fn enable:
&self
arg cap: GLenum
fn disable:
&self
arg cap: GLenum
fn hint:
fn is_enabled:
fn is_shader:
fn is_texture:
fn is_framebuffer:
fn is_renderbuffer:
fn enable_vertex_attrib_array:
&self
arg index: GLuint
fn disable_vertex_attrib_array:
&self
arg index: GLuint
fn uniform_1f:
fn uniform_1fv:
fn uniform_1i:
fn uniform_1iv:
fn uniform_1ui:
fn uniform_2f:
fn uniform_2fv:
fn uniform_2i:
fn uniform_2iv:
fn uniform_2ui:
fn uniform_3f:
fn uniform_3fv:
fn uniform_3i:
fn uniform_3iv:
fn uniform_3ui:
fn uniform_4f:
fn uniform_4i:
fn uniform_4iv:
fn uniform_4ui:
fn uniform_4fv:
fn depth_mask:
&self
arg flag: bool
fn depth_range:
&self
arg near: f64
arg far: f64
fn get_program_iv:
&self
arg program: GLuint
arg pname: GLenum
arg result: GLintVecRefMut
&self
arg program: GLuint
fn program_binary:
&self
arg index: GLuint
arg pname: GLenum
arg result: GLintVecRefMut
&self
arg index: GLuint
arg pname: GLenum
arg result: GLfloatVecRefMut
fn get_vertex_attrib_pointer_v:
&self
arg index: GLuint
arg pname: GLenum
-> GLsizeiptr
fn get_shader_iv:
&self
arg shader: GLuint
arg pname: GLenum
arg result: GLintVecRefMut
fn compile_shader:
&self
arg shader: GLuint
fn create_program:
&self
-> GLuint
fn delete_program:
&self
arg program: GLuint
fn create_shader:
fn delete_shader:
&self
arg shader: GLuint
fn detach_shader:
fn link_program:
&self
arg program: GLuint
fn clear_color:
&self
arg r: f32
arg g: f32
arg b: f32
arg a: f32
fn clear:
&self
arg buffer_mask: GLbitfield
fn clear_depth:
&self
arg depth: f64
fn clear_stencil:
&self
arg s: GLint
fn flush:
&self
fn finish:
&self
fn get_error:
&self
-> GLenum
fn stencil_mask:
&self
arg mask: GLuint
fn stencil_func:
fn stencil_op:
fn egl_image_target_texture2d_oes:
&self
arg target: GLenum
arg image: GlVoidPtrConst
fn generate_mipmap:
&self
arg target: GLenum
&self
&self
fn fence_sync:
&self
arg condition: GLenum
arg flags: GLbitfield
-> GLsyncPtr
fn client_wait_sync:
&self
arg sync: GLsyncPtr
arg flags: GLbitfield
arg timeout: GLuint64
-> u32
fn wait_sync:
&self
arg sync: GLsyncPtr
arg flags: GLbitfield
arg timeout: GLuint64
fn delete_sync:
&self
arg sync: GLsyncPtr
fn gen_fences_apple:
&self
arg fences: GLuintVecRef
fn set_fence_apple:
&self
arg fence: GLuint
&self
arg fence: GLuint
fn test_fence_apple:
&self
arg fence: GLuint
&self
&self
&self
arg mode: GLenum
&self
arg vao: GLuint
fn delete_vertex_arrays_apple:
&self
arg vertex_arrays: GLuintVecRef
&self
arg source_id: GLuint
arg source_level: GLint
arg dest_target: GLenum
arg dest_id: GLuint
arg dest_level: GLint
arg x_offset: GLint
arg y_offset: GLint
arg x: GLint
arg y: GLint
arg width: GLsizei
arg height: GLsizei
arg unpack_flip_y: GLboolean
arg unpack_premultiply_alpha: GLboolean
arg unpack_unmultiply_alpha: GLboolean
fn egl_image_target_renderbuffer_storage_oes:
&self
arg target: u32
arg image: GlVoidPtrConst
&self
arg source_id: GLuint
arg source_level: GLint
arg dest_target: GLenum
arg dest_id: GLuint
arg dest_level: GLint
arg x_offset: GLint
arg y_offset: GLint
arg z_offset: GLint
arg x: GLint
arg y: GLint
arg z: GLint
arg width: GLsizei
arg height: GLsizei
arg depth: GLsizei
arg unpack_flip_y: GLboolean
arg unpack_premultiply_alpha: GLboolean
arg unpack_unmultiply_alpha: GLboolean
fn buffer_storage:
&self
arg target: GLenum
arg size: GLsizeiptr
arg data: GlVoidPtrConst
arg flags: GLbitfield
&self
arg target: GLenum
arg offset: GLintptr
arg length: GLsizeiptr
fn get_svg_shader:
&self
-> GLuint
fn get_fxaa_shader:
&self
-> GLuint
fn shader_source:
&self
arg program: GLuint
arg names: RefstrVecRef
-> GLuintVec
fn get_string:
fn get_string_i:
&self
arg message: String
&self
arg message: String
C-ABI stable reexport of
(U8Vec, u32)struct GetProgramBinaryReturn has destructor
_0: U8Vec
_1: u32
C-ABI stable reexport of
(i32, u32, AzString)struct GetActiveAttribReturn has destructor
_0: i32
_1: u32
_2: String
C-ABI stable reexport of
*const gleam::gl::GLsyncstruct GLsyncPtr has destructor
ptr: c_void
run_destructor: bool
C-ABI stable reexport of
(i32, u32, AzString)struct GetActiveUniformReturn has destructor
_0: i32
_1: u32
_2: String
struct SvgVertex
x: f32
y: f32
enum GlType
Gl
Gles
struct VertexArrayObject has destructor
vertex_layout: VertexLayout
vao_id: GLuint
gl_context: GlContextPtr
refcount: c_void
run_destructor: bool
struct VertexBuffer has destructor
vao: VertexArrayObject
vertex_buffer_id: GLuint
vertex_buffer_len: usize
index_buffer_id: GLuint
index_buffer_len: usize
refcount: c_void
index_buffer_format: IndexBufferFormat
run_destructor: bool
enum IndexBufferFormat
Points
Lines
LineStrip
Triangles
TriangleStrip
TriangleFan
struct DebugMessage has destructor
message: String
source: GLenum
ty: GLenum
id: GLenum
severity: GLenum
struct SvgVertexVecSlice
Pointer to the slice data
ptr: SvgVertex
Number of elements in the slice
len: usize
struct DebugMessageVecSlice has destructor
Pointer to the slice data
ptr: DebugMessage
Number of elements in the slice
len: usize
struct GLuintVecSlice
ptr: GLuint
len: usize
struct GLintVecSlice
Pointer to the slice data
ptr: GLint
Number of elements in the slice
len: usize
Struct definitions for image loading
mod image:
struct ImageRef has destructor
data: c_void
copies: c_void
run_destructor: bool
constructor raw_image:
arg data: RawImage
constructor gl_texture:
constructor callback:
arg callback: CoreRenderImageCallback
arg data: RefAny
-> ImageRef
constructor new_rawimage:
arg image_data: RawImage
constructor new_gltexture:
constructor null_image:
arg width: usize
arg height: usize
arg format: RawImageFormat
arg tag: U8VecRef
-> ImageRef
Creates an image reference from a CPU-backed buffer
Creates an image reference from an OpenGL texture
fn is_invalid:
&self
-> bool
fn is_gl_texture:
&self
-> bool
fn is_raw_image:
&self
-> bool
fn is_callback:
&self
-> bool
fn get_raw_image:
&self
fn is_null_image:
&self
-> bool
fn get_rawimage:
&self
fn get_bytes:
&self
fn get_size:
&self
-> LogicalSize
fn get_hash:
&self
-> ImageRefHash
&self
&mut self
fn deep_copy:
&self
-> ImageRef
fn get_bytes_ptr:
&self
-> u8
Returns whether the image is a null (invalid) image
If the image is a RawImage, returns a COPY of the internal image bytes (useful for encoding the RawImage / exporting the ImageRef to a file)
Get raw bytes from the image as a slice Returns None if this is not a Raw image or if it's an External image
NOTE: returns (0, 0) for a Callback
In difference to the default shallow copy, creates a new image ref
Get a pointer to the raw bytes for debugging/profiling purposes Returns a unique pointer for this ImageRef's data
struct RawImage has destructor
pixels: RawImageData
width: usize
height: usize
premultiplied_alpha: bool
data_format: RawImageFormat
tag: U8Vec
constructor empty:
-> RawImage
constructor allocate_clip_mask:
arg size: LayoutSize
-> RawImage
constructor decode_image_bytes_any:
arg bytes: U8VecRef
Returns a zero-sized image
Allocates a width * height, single-channel image with zeroed bytes
Decodes a RawImage from any supported image format - automatically guesses the format based on magic header
fn encode_bmp:
&self
fn encode_png:
&self
fn encode_jpeg:
&self
arg quality: u8
fn encode_tga:
&self
fn encode_pnm:
&self
fn encode_gif:
&self
fn encode_tiff:
&self
Encodes the RawImage in the BMP image format
Encodes the RawImage in the PNG image format
Encodes the RawImage in the JPG image format. Quality is a value from 0 to 100.
Encodes the RawImage in the TGA image format
Encodes the RawImage in the PNM image format
Encodes the RawImage in the GIF image format
Encodes the RawImage in the TIFF image format
struct ImageMask has destructor
image: ImageRef
rect: LogicalRect
repeat: bool
enum RawImageFormat
R8
RG8
RGB8
RGBA8
R16
RG16
RGB16
RGBA16
BGR8
BGRA8
RGBF32
RGBAF32
union enum RawImageData has destructor
U8(U8Vec)
U16(U16Vec)
F32(F32Vec)
enum ImageRendering
OptimizeQuality
OptimizeSpeed
struct ImageDescriptor
format: RawImageFormat
width: usize
height: usize
stride: OptionI32
offset: i32
flags: ImageDescriptorFlags
struct ImageDescriptorFlags
is_opaque: bool
allow_mipmaps: bool
struct ImageRefHash
inner: usize
union enum CssImageParseErrorOwned has destructor
UnclosedQuotes(String)
struct Route has destructor
pattern: String
layout_callback: LayoutCallback
struct RouteMatch has destructor
pattern: String
params: StringPairVec
struct RouteVecSlice has destructor
Pointer to the slice data
ptr: Route
Number of elements in the slice
len: usize
struct VideoEncoder
ptr: c_void
run_destructor: bool
constructor open:
arg width: u32
arg height: u32
arg h265: bool
arg bitrate_kbps: u32
-> VideoEncoder
Open an encoder for
widthxheight, H.265 ifh265else H.264, atbitrate_kbps. Uses the platform-native backend ([backend_name]). Returns an invalid handle (is_open()false) where no backend exists.fn backend_name:
-> String
fn is_open:
&self
-> bool
fn encode:
&self
arg frame: VideoFrame
arg force_keyframe: bool
-> U8Vec
fn frames_encoded:
&self
-> u64
fn close:
&mut self
The native codec backend selected for this platform ("VideoToolbox", "MediaCodec", "gpu-video", or "none").
Whether the encoder opened (a backend exists for this platform).
Encode one
VideoFrame(RGBA), returning the encoded chunk (Annex-B for H.264/H.265), or empty if buffered / not open.force_keyframerequests an IDR. (Stub: counts frames + returns empty; the on-device backend produces the bitstream.)Frames submitted to [
encode](Self::encode) so far (stub progress).Release the encoder. (Drop does this too.)
struct VideoDecoder
ptr: c_void
run_destructor: bool
constructor open:
arg h265: bool
-> VideoDecoder
Open a decoder (H.265 if
h265else H.264) using the platform-native backend. Invalid handle where no backend exists.fn is_open:
&self
-> bool
fn decode:
&self
arg data: U8Vec
fn close:
&mut self
Whether the decoder opened.
Decode one encoded chunk, returning the next decoded
VideoFrameif one is ready (Nonewhile buffering / not open). (Stub: counts + returns None; the on-device backend produces frames.)Release the decoder. (Drop does this too.)
Font decoding / parsing module
mod font:
Font metrics structure containing all font-related measurements from the font file tables (head, hhea, and os/2 tables).
struct FontMetrics
ul_code_page_range1: OptionU32
ul_code_page_range2: OptionU32
ul_unicode_range1: u32
ul_unicode_range2: u32
ul_unicode_range3: u32
ul_unicode_range4: u32
ach_vend_id: u32
s_typo_ascender: OptionI16
s_typo_descender: OptionI16
s_typo_line_gap: OptionI16
us_win_ascent: OptionU16
us_win_descent: OptionU16
sx_height: OptionI16
s_cap_height: OptionI16
us_default_char: OptionU16
us_break_char: OptionU16
us_max_context: OptionU16
us_lower_optical_point_size: OptionU16
us_upper_optical_point_size: OptionU16
units_per_em: u16
font_flags: u16
x_min: i16
y_min: i16
x_max: i16
y_max: i16
ascender: i16
descender: i16
line_gap: i16
advance_width_max: u16
min_left_side_bearing: i16
min_right_side_bearing: i16
x_max_extent: i16
caret_slope_rise: i16
caret_slope_run: i16
caret_offset: i16
num_h_metrics: u16
x_avg_char_width: i16
us_weight_class: u16
us_width_class: u16
fs_type: u16
y_subscript_x_size: i16
y_subscript_y_size: i16
y_subscript_x_offset: i16
y_subscript_y_offset: i16
y_superscript_x_size: i16
y_superscript_y_size: i16
y_superscript_x_offset: i16
y_superscript_y_offset: i16
y_strikeout_size: i16
y_strikeout_position: i16
s_family_class: i16
fs_selection: u16
us_first_char_index: u16
us_last_char_index: u16
panose: Panose
constructor zero:
-> FontMetrics
Returns a FontMetrics struct with all fields set to 0
fn use_typo_metrics:
&self
-> bool
fn get_ascender:
&self
-> i16
fn get_descender:
&self
-> i16
fn get_line_gap:
&self
-> i16
fn get_x_min:
&self
-> i16
fn get_y_min:
&self
-> i16
fn get_x_max:
&self
-> i16
fn get_y_max:
&self
-> i16
&self
-> u16
&self
-> i16
fn get_min_right_side_bearing:
&self
-> i16
fn get_x_max_extent:
&self
-> i16
&self
-> i16
&self
-> i16
&self
-> i16
&self
-> i16
&self
-> i16
&self
-> i16
&self
-> i16
fn get_y_superscript_x_offset:
&self
-> i16
fn get_y_superscript_y_offset:
&self
-> i16
Returns whether typographic metrics should be used (from fs_selection flag)
Returns the ascender value from the hhea table
Returns the descender value from the hhea table
Returns the line gap value from the hhea table
Returns the x_min value from the head table
Returns the y_min value from the head table
Returns the x_max value from the head table
Returns the y_max value from the head table
Returns the maximum advance width from the hhea table
Returns the minimum left side bearing from the hhea table
Returns the minimum right side bearing from the hhea table
Returns the maximum extent in the x direction from the hhea table
Returns the average character width from the os/2 table
Returns the subscript x size from the os/2 table
Returns the subscript y size from the os/2 table
Returns the subscript x offset from the os/2 table
Returns the subscript y offset from the os/2 table
Returns the superscript x size from the os/2 table
Returns the superscript y size from the os/2 table
Returns the superscript x offset from the os/2 table
Returns the superscript y offset from the os/2 table
FontRef is a reference-counted pointer to a parsed font. It holds a *const c_void that points to the actual parsed font data (typically a ParsedFont from the layout crate). The parsed data is managed via atomic reference counting, allowing safe sharing across threads without duplicating the font data.
struct FontRef has destructor
parsed: c_void
copies: c_void
run_destructor: bool
parsed_destructor: FontRefDestructorCallbackType
constructor parse:
arg source: LoadedFontSource
constructor create:
arg parsed: *const c_void
arg destructor: FontRefDestructorCallbackType
-> FontRef
Parses a new font from bytes. Returns
Noneif the font could not be parsed correctly.Create a new FontRef from parsed font data
# Arguments *parsed- Pointer to parsed font data (e.g., Arc::into_raw(Arc::new(ParsedFont))) *destructor- Function to clean up the parsed datafn get_bytes:
&self
-> U8Vec
fn get_font_metrics:
&self
-> FontMetrics
fn get_hash:
&self
-> u64
Returns the font bytes of the underlying font source
Returns the font metrics of the parsed font
Returns the hash of the FontRef (fast)
Source data of a font file (bytes)
struct LoadedFontSource has destructor
data: U8Vec
index: u32
load_outlines: bool
struct Panose
family_type: u8
serif_style: u8
weight: u8
proportion: u8
contrast: u8
stroke_variation: u8
arm_style: u8
letterform: u8
midline: u8
x_height: u8
struct LoadedFont has destructor
font_hash: u64
family_name: String
num_glyphs: u32
has_bytes: bool
constructor new:
arg font_hash: u64
arg family_name: String
arg num_glyphs: u32
arg has_bytes: bool
-> LoadedFont
struct LoadedFontVecSlice has destructor
Pointer to the slice data
ptr: LoadedFont
Number of elements in the slice
len: usize
SVG parsing and rendering functions
mod svg:
struct Svg has destructor
tree: c_void
run_destructor: bool
constructor from_string:
arg svg_string: String
arg parse_options: SvgParseOptions
constructor from_bytes:
arg svg_bytes: U8VecRef
arg parse_options: SvgParseOptions
struct TessellatedSvgNode has destructor
vertices: SvgVertexVec
indices: U32Vec
constructor empty:
constructor from_nodes:
arg nodes: TessellatedSvgNodeVecRef
Creates a new TessellatedSvgNode by joining all the given nodes together into one array and inserting a
GL_RESTART_INDEX(u32::MAX) into the indices (so that the resulting buffer can be drawn in one draw call).union enum SvgFitTo
Original
Width(u32)
Height(u32)
Zoom(f32)
union enum CssPathPseudoSelector has destructor
First
Last
NthChild(CssNthChildSelector)
Hover
Active
Focus
Lang(String)
Backdrop
Dragging
DragOver
struct LogicalRect
origin: LogicalPosition
size: LogicalSize
constructor create:
arg origin: LogicalPosition
arg size: LogicalSize
-> LogicalRect
constructor zero:
-> LogicalRect
fn max_x:
&self
-> f32
fn min_x:
&self
-> f32
fn max_y:
&self
-> f32
fn min_y:
&self
-> f32
fn contains:
&self
arg point: LogicalPosition
-> bool
fn intersects:
&self
arg other: LogicalRect
-> bool
Returns whether this rectangle contains the given point
Returns whether this rectangle intersects with another rectangle
union enum CssPathSelector has destructor
Global
Type(NodeTypeTag)
Class(String)
Id(String)
PseudoSelector(CssPathPseudoSelector)
Attribute(CssAttributeSelector)
DirectChildren
Children
AdjacentSibling
GeneralSibling
struct CssPath has destructor
selectors: CssPathSelectorVec
struct ShapeCircle
center: ShapePoint
radius: f32
struct ShapePolygon
points: ShapePointVec
struct TessellatedGPUSvgNode has destructor
vertex_index_buffer: VertexBuffer
constructor create:
arg node: TessellatedSvgNode
arg gl: GlContextPtr
Uploads the tesselated SVG node to GPU memory
fn draw:
&self
arg texture: *mut Texture
arg target_size: PhysicalSizeU32
arg color: ColorU
arg transforms: StyleTransformVec
-> bool
Draw the vertex buffer to the texture with the given color and transform
struct TessellatedColoredGPUSvgNode has destructor
vertex_index_buffer: VertexBuffer
struct FilePath has destructor
inner: String
constructor create:
constructor empty:
-> FilePath
constructor from_str:
constructor get_temp_dir:
-> FilePath
constructor get_current_dir:
constructor get_home_dir:
constructor get_cache_dir:
constructor get_config_dir:
constructor get_config_local_dir:
constructor get_data_dir:
constructor get_data_local_dir:
constructor get_desktop_dir:
constructor get_document_dir:
constructor get_download_dir:
constructor get_executable_dir:
constructor get_font_dir:
constructor get_picture_dir:
constructor get_preference_dir:
constructor get_public_dir:
constructor get_runtime_dir:
constructor get_state_dir:
constructor get_audio_dir:
constructor get_video_dir:
constructor get_template_dir:
constructor from:
Creates a new path from a string
Creates an empty path
Creates a path from a string slice
Returns the system temporary directory
Returns the current working directory
Returns the user's home directory (e.g., /home/username on Linux, C:\Users\username on Windows)
Returns the user's cache directory (e.g., ~/.cache on Linux, ~/Library/Caches on macOS)
Returns the user's config directory (e.g., ~/.config on Linux, ~/Library/Application Support on macOS)
Returns the user's local config directory
Returns the user's data directory (e.g., ~/.local/share on Linux, ~/Library/Application Support on macOS)
Returns the user's local data directory
Returns the user's desktop directory (e.g., ~/Desktop)
Returns the user's documents directory (e.g., ~/Documents)
Returns the user's downloads directory (e.g., ~/Downloads)
Returns the user's executable directory (e.g., ~/.local/bin on Linux)
Returns the user's font directory (e.g., ~/.local/share/fonts on Linux, ~/Library/Fonts on macOS)
Returns the user's pictures directory (e.g., ~/Pictures)
Returns the user's preference directory (e.g., ~/.config on Linux, ~/Library/Preferences on macOS)
Returns the user's public directory (e.g., ~/Public)
Returns the user's runtime directory (e.g., /run/user/1000 on Linux)
Returns the user's state directory (e.g., ~/.local/state on Linux)
Returns the user's audio directory (e.g., ~/Music)
Returns the user's video directory (e.g., ~/Videos)
Returns the user's templates directory
fn join:
fn join_str:
fn parent:
&self
fn file_name:
&self
-> OptionString
fn extension:
&self
-> OptionString
fn exists:
&self
-> bool
fn is_file:
&self
-> bool
fn is_dir:
&self
-> bool
fn is_absolute:
&self
-> bool
fn create_dir_all:
&self
fn create_dir:
&self
fn remove_file:
&self
fn remove_dir:
&self
fn remove_dir_all:
&self
fn read_bytes:
&self
fn read_string:
&self
fn write_bytes:
&self
arg data: U8Vec
fn write_string:
&self
arg data: String
fn copy_to:
&self
arg dest: FilePath
fn rename_to:
&self
arg dest: FilePath
fn as_string:
&self
-> String
fn read_dir:
&self
fn metadata:
&self
fn canonicalize:
&self
Joins this path with another path component
Joins this path with a string component
Returns the parent directory of this path
Returns the file name component of this path
Returns the file extension of this path
Checks if the path exists on the filesystem
Checks if the path is a file
Checks if the path is a directory
Checks if the path is absolute
Creates this directory and all parent directories
Creates this directory (parent must exist)
Removes this file
Removes this directory (must be empty)
Removes this directory and all contents
Reads the entire file at this path as bytes
Reads the entire file at this path as a string
Writes bytes to the file at this path
Writes a string to the file at this path
Copies a file from this path to another path
Renames/moves a file from this path to another path
Returns the path as an AzString
Lists directory contents
Returns metadata about the file/directory
Makes the path canonical (absolute, with no
.or..components)struct CssPathSelectorVecSlice has destructor
ptr: CssPathSelector
len: usize
enum SvgLineJoin
Miter
MiterClip
Round
Bevel
enum SvgFillRule
Winding
EvenOdd
struct SvgDashPattern
offset: f32
length_1: f32
gap_1: f32
length_2: f32
gap_2: f32
length_3: f32
gap_3: f32
struct SvgStrokeStyle
dash_pattern: OptionSvgDashPattern
transform: SvgTransform
start_cap: SvgLineCap
end_cap: SvgLineCap
line_join: SvgLineJoin
line_width: f32
miter_limit: f32
tolerance: f32
apply_line_width: bool
anti_alias: bool
high_quality_aa: bool
enum SvgLineCap
Butt
Square
Round
struct SvgLine
start: SvgPoint
end: SvgPoint
struct SvgCubicCurve
start: SvgPoint
ctrl_1: SvgPoint
ctrl_2: SvgPoint
end: SvgPoint
struct SvgVector
x: f64
y: f64
fn angle_degrees:
&self
-> f64
fn rotate_90deg_ccw:
&self
-> SvgVector
Returns the angle of the vector in degrees
Rotate the vector 90 degrees counter-clockwise
struct SvgQuadraticCurve
start: SvgPoint
ctrl: SvgPoint
end: SvgPoint
union enum SvgPathElement
Line(SvgLine)
QuadraticCurve(SvgQuadraticCurve)
CubicCurve(SvgCubicCurve)
constructor line:
arg l: SvgLine
constructor quadratic_curve:
arg qc: SvgQuadraticCurve
constructor cubic_curve:
arg cc: SvgCubicCurve
Creates a line path element from a SvgLine
Creates a quadratic curve path element from a SvgQuadraticCurve
Creates a cubic curve path element from a SvgCubicCurve
fn set_last:
&mut self
arg point: SvgPoint
fn set_first:
&mut self
arg point: SvgPoint
fn reverse:
&mut self
fn get_start:
&self
-> SvgPoint
fn get_end:
&self
-> SvgPoint
fn get_bounds:
&self
-> SvgRect
fn get_length:
&self
-> f64
fn get_t_at_offset:
&self
arg offset: f64
-> f64
&self
arg t: f64
-> SvgVector
fn get_x_at_t:
&self
arg t: f64
-> f64
fn get_y_at_t:
&self
arg t: f64
-> f64
struct SvgRect
width: f32
height: f32
x: f32
y: f32
radius_top_left: f32
radius_top_right: f32
radius_bottom_left: f32
radius_bottom_right: f32
fn expand:
&self
arg padding_top: f32
arg padding_bottom: f32
arg padding_left: f32
arg padding_right: f32
-> SvgRect
fn get_center:
&self
-> SvgPoint
Expands the rect with a certain amount of padding
Returns the center point of the rect
struct SvgPoint
x: f32
y: f32
struct SvgPath
items: SvgPathElementVec
constructor create:
arg items: SvgPathElementVec
-> SvgPath
Creates a new SvgPath from a vector of path elements
struct SvgMultiPolygon
rings: SvgPathVec
constructor create:
arg rings: SvgPathVec
Creates a new SvgMultiPolygon from a vector of paths (rings) NOTE: If a ring represents a hole, simply reverse the order of points
fn get_bounds:
&self
-> SvgRect
fn tessellate_fill:
&self
arg fill_style: SvgFillStyle
&self
arg stroke_style: SvgStrokeStyle
struct SvgPathVecSlice
ptr: SvgPath
len: usize
struct SvgPathElementVecSlice
ptr: SvgPathElement
len: usize
XML parsing / decoding module
mod xml:
struct Xml has destructor
root: XmlNodeChildVec
&self
Scan the XML/HTML document for external resource URLs.
This function traverses the entire document tree and extracts URLs from: -<img src="...">- Images -<link href="...">- Stylesheets, icons, fonts -<script src="...">- Scripts -<video src="...">,<source src="...">- Video -<audio src="...">- Audio -<a href="...">- Links (classified as Unknown) - CSSurl()in style attributes -<style>blocks with @import or url()struct ParsedSvg has destructor
svg_data: U8Vec
run_destructor: bool
constructor from_string:
arg svg_string: String
arg parse_options: SvgParseOptions
constructor from_bytes:
arg svg_bytes: U8VecRef
arg parse_options: SvgParseOptions
Parses an SVG from a string
Parses an SVG from bytes
fn render:
&self
arg options: SvgRenderOptions
Renders the SVG to a raw image
union enum CssFontWeightParseErrorOwned has destructor
InvalidValue(InvalidValueErrOwned)
InvalidNumber(ParseIntError)
union enum GridAutoFlowParseErrorOwned has destructor
InvalidValue(String)
struct CssParseErrorOwned has destructor
css_string: String
error: CssParseErrorInnerOwned
location: ErrorLocationRange
union enum FlexGrowParseErrorOwned has destructor
ParseFloat(ParseFloatErrorWithInput)
NegativeValue(String)
union enum CssParseErrorInnerOwned has destructor
ParseError(CssSyntaxError)
UnclosedBlock
MalformedCss
DynamicCssParseError(DynamicCssParseErrorOwned)
PseudoSelectorParseError(CssPseudoSelectorParseErrorOwned)
NodeTypeTag(NodeTypeTagParseErrorOwned)
UnknownPropertyKey(UnknownPropertyKeyError)
VarOnShorthandProperty(VarOnShorthandPropertyError)
union enum ParenthesisParseErrorOwned has destructor
UnclosedBraces
NoOpeningBraceFound
NoClosingBraceFound
StopWordNotFound(String)
EmptyInput
union enum NodeTypeTagParseErrorOwned has destructor
Invalid(String)
union enum CssPseudoSelectorParseErrorOwned has destructor
EmptyNthChild
UnknownSelector(UnknownSelectorError)
InvalidNthChildPattern(String)
InvalidNthChild(ParseIntError)
union enum FlexWrapParseErrorOwned has destructor
InvalidValue(String)
union enum GridParseErrorOwned has destructor
InvalidValue(String)
union enum FlexBasisParseErrorOwned has destructor
InvalidValue(String)
union enum FlexShrinkParseErrorOwned has destructor
ParseFloat(ParseFloatErrorWithInput)
NegativeValue(String)
union enum DynamicCssParseErrorOwned has destructor
InvalidBraceContents(String)
UnexpectedValue(CssParsingErrorOwned)
union enum FlowIntoParseErrorOwned has destructor
InvalidValue(String)
union enum FlowFromParseErrorOwned has destructor
InvalidValue(String)
Rust wrappers for
Instant/Durationclassesmod time:
union enum Instant
System(InstantPtr)
Tick(SystemTick)
constructor now:
-> Instant
Returns the current system time. On std platforms, uses std::time::Instant::now().
fn duration_since:
&self
arg earlier: Instant
fn add_duration:
Returns the duration since and earlier instant or None if the earlier instant is later than self
Adds a duration to the current time instant, returning the new
InstantLinearly interpolates between [start, end] if the
selfInstant lies between start and end. Returns values between 0.0 and 1.0struct SystemTickDiff
tick_diff: u64
fn div:
&self
arg other: SystemTickDiff
-> f64
Divides this tick-difference by another, returning the ratio as an f64. Returns Inf or NaN if other is zero.
struct SystemTick
tick_counter: u64
union enum Duration
System(SystemTimeDiff)
Tick(SystemTickDiff)
fn div:
&self
arg other: Duration
-> f32
fn min:
fn greater_than:
&self
arg other: Duration
-> bool
fn smaller_than:
&self
arg other: Duration
-> bool
Divides this duration by another, returning the ratio as an f32. Returns 0.0 if the variants differ (mixing System with Tick).
Returns the smaller of two durations.
Returns true if self > other. Panics if the variants differ (System vs. Tick).
Returns true if self < other. Panics if the variants differ (System vs. Tick).
struct SystemTimeDiff
secs: u64
nanos: u32
constructor from_secs:
arg secs: u64
constructor from_millis:
arg millis: u64
constructor from_nanos:
arg nanos: u64
Creates a duration from whole seconds.
Creates a duration from milliseconds.
Creates a duration from nanoseconds.
fn millis:
&self
-> u64
fn div:
&self
arg other: SystemTimeDiff
-> f64
Returns the total duration in milliseconds.
Divides this duration by another, returning the ratio as an f64. Returns Inf or NaN if other is zero.
struct InstantPtr
ptr: c_void
clone_fn: InstantPtrCloneCallback
destructor: InstantPtrDestructorCallback
run_destructor: bool
struct CssDuration
inner: u32
struct GetSystemTimeCallback
struct IcuTime
hour: u8
minute: u8
second: u8
union enum DurationParseErrorOwned has destructor
InvalidValue(String)
ParseFloat(String)
Definition of azuls internal
Stringwrappersmod str:
struct String has destructor
vec: U8Vec
constructor copy_from_bytes:
arg ptr: *const u8
arg start: usize
arg len: usize
-> String
constructor from_c_str:
arg ptr: *const i8
-> String
Creates a new String from a null-terminated C string (const char*). This copies the string data into a new allocation.
fn to_c_str:
&self
-> U8Vec
fn from_utf16_le:
arg ptr: *const u8
arg len: usize
-> String
fn from_utf16_be:
arg ptr: *const u8
arg len: usize
-> String
fn from_utf8_lossy:
arg ptr: *const u8
arg len: usize
-> String
fn from_utf8:
arg ptr: *const u8
arg len: usize
-> String
Creates a null-terminated copy of the string for C FFI usage. Returns a new U8Vec that contains the string data followed by a null byte. The caller is responsible for freeing this memory.
Creates a new String from UTF-16 encoded bytes (little-endian). Returns an empty string if the input is invalid UTF-16 or has odd length.
Creates a new String from UTF-16 encoded bytes (big-endian). Returns an empty string if the input is invalid UTF-16 or has odd length.
Creates a new String from UTF-8 bytes with lossy conversion. Invalid UTF-8 sequences are replaced with the Unicode replacement character (U+FFFD).
Creates a new String from UTF-8 bytes. Returns an empty string if the input is not valid UTF-8.
struct StringPair has destructor
key: String
value: String
struct StringSet has destructor
inner: String
struct StringPairVecSlice has destructor
Pointer to the slice data
ptr: StringPair
Number of elements in the slice
len: usize
struct StringVecSlice has destructor
Pointer to the slice data
ptr: String
Number of elements in the slice
len: usize
Definition of azuls internal
Vec<*>wrappersmod vec:
Wrapper over a Rust-allocated
Vec<ListViewRow>struct ListViewRowVec has destructor
ptr: ListViewRow
len: usize
cap: usize
destructor: ListViewRowVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: ListViewRow
fn copy_from_ptr:
arg ptr: *const ListViewRow
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
ListViewRowVecCreates a
ListViewRowVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
ListViewRowVeccontaining a single elementCopies elements from a C array into a
ListViewRowVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
ListViewRowVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
Wrapper over a Rust-allocated
Vec<StyleFilter>struct StyleFilterVec has destructor
ptr: StyleFilter
len: usize
cap: usize
destructor: StyleFilterVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: StyleFilter
fn copy_from_ptr:
arg ptr: *const StyleFilter
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
StyleFilterVecCreates a
StyleFilterVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
StyleFilterVeccontaining a single elementCopies elements from a C array into a
StyleFilterVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
StyleFilterVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
Wrapper over a Rust-allocated
Vec<AccessibilityState>struct AccessibilityStateVec has destructor
ptr: AccessibilityState
len: usize
cap: usize
destructor: AccessibilityStateVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: AccessibilityState
fn copy_from_ptr:
arg ptr: *const AccessibilityState
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
AccessibilityStateVecCreates a
AccessibilityStateVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
AccessibilityStateVeccontaining a single elementCopies elements from a C array into a
AccessibilityStateVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
AccessibilityStateVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
Wrapper over a Rust-allocated
Vec<MenuItem>struct MenuItemVec has destructor
ptr: MenuItem
len: usize
cap: usize
destructor: MenuItemVecDestructor
fn create:
-> MenuItemVec
fn with_capacity:
arg cap: usize
-> MenuItemVec
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: MenuItem
-> MenuItemVec
fn copy_from_ptr:
arg ptr: *const MenuItem
arg len: usize
-> MenuItemVec
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
MenuItemVecCreates a
MenuItemVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
MenuItemVeccontaining a single elementCopies elements from a C array into a
MenuItemVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
MenuItemVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
Wrapper over a Rust-allocated
Vec<StyleFontFamily>struct StyleFontFamilyVec has destructor
ptr: StyleFontFamily
len: usize
cap: usize
destructor: StyleFontFamilyVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: StyleFontFamily
fn copy_from_ptr:
arg ptr: *const StyleFontFamily
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
StyleFontFamilyVecCreates a
StyleFontFamilyVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
StyleFontFamilyVeccontaining a single elementCopies elements from a C array into a
StyleFontFamilyVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
StyleFontFamilyVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
Wrapper over a Rust-allocated
Vec<Dom>struct DomVec has destructor
ptr: Dom
len: usize
cap: usize
destructor: DomVecDestructor
fn create:
-> DomVec
fn with_capacity:
arg cap: usize
-> DomVec
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
-> OptionDom
fn from_item:
fn copy_from_ptr:
fn c_get:
&self
arg index: usize
-> OptionDom
fn as_c_slice:
&self
-> DomVecSlice
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
-> DomVecSlice
Creates an empty
DomVecCreates a
DomVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
DomVeccontaining a single elementCopies elements from a C array into a
DomVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
DomVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
Wrapper over a Rust-allocated
Vec<IdOrClass>struct IdOrClassVec has destructor
ptr: IdOrClass
len: usize
cap: usize
destructor: IdOrClassVecDestructor
fn create:
-> IdOrClassVec
fn with_capacity:
arg cap: usize
-> IdOrClassVec
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: IdOrClass
-> IdOrClassVec
fn copy_from_ptr:
arg ptr: *const IdOrClass
arg len: usize
-> IdOrClassVec
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
IdOrClassVecCreates a
IdOrClassVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
IdOrClassVeccontaining a single elementCopies elements from a C array into a
IdOrClassVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
IdOrClassVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
Wrapper over a Rust-allocated
Vec<DynamicSelector>struct DynamicSelectorVec has destructor
ptr: DynamicSelector
len: usize
cap: usize
destructor: DynamicSelectorVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: DynamicSelector
fn copy_from_ptr:
arg ptr: *const DynamicSelector
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
DynamicSelectorVecCreates a
DynamicSelectorVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
DynamicSelectorVeccontaining a single elementCopies elements from a C array into a
DynamicSelectorVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
DynamicSelectorVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
Wrapper over a Rust-allocated
Vec<CssPropertyWithConditions>struct CssPropertyWithConditionsVec has destructor
ptr: CssPropertyWithConditions
len: usize
cap: usize
destructor: CssPropertyWithConditionsVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
fn copy_from_ptr:
arg ptr: *const CssPropertyWithConditions
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
CssPropertyWithConditionsVecCreates a
CssPropertyWithConditionsVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
CssPropertyWithConditionsVeccontaining a single elementCopies elements from a C array into a
CssPropertyWithConditionsVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
CssPropertyWithConditionsVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
Wrapper over a Rust-allocated
Vec<StyleBackgroundContent>struct StyleBackgroundContentVec has destructor
len: usize
cap: usize
destructor: StyleBackgroundContentVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: StyleBackgroundContent
fn copy_from_ptr:
arg ptr: *const StyleBackgroundContent
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
StyleBackgroundContentVecCreates a
StyleBackgroundContentVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
StyleBackgroundContentVeccontaining a single elementCopies elements from a C array into a
StyleBackgroundContentVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
StyleBackgroundContentVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
Wrapper over a Rust-allocated
Vec<StyleBackgroundPosition>struct StyleBackgroundPositionVec has destructor
len: usize
cap: usize
destructor: StyleBackgroundPositionVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: StyleBackgroundPosition
fn copy_from_ptr:
arg ptr: *const StyleBackgroundPosition
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
StyleBackgroundPositionVecCreates a
StyleBackgroundPositionVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
StyleBackgroundPositionVeccontaining a single elementCopies elements from a C array into a
StyleBackgroundPositionVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
StyleBackgroundPositionVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
Wrapper over a Rust-allocated
Vec<StyleBackgroundRepeat>struct StyleBackgroundRepeatVec has destructor
len: usize
cap: usize
destructor: StyleBackgroundRepeatVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: StyleBackgroundRepeat
fn copy_from_ptr:
arg ptr: *const StyleBackgroundRepeat
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
StyleBackgroundRepeatVecCreates a
StyleBackgroundRepeatVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
StyleBackgroundRepeatVeccontaining a single elementCopies elements from a C array into a
StyleBackgroundRepeatVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
StyleBackgroundRepeatVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
Wrapper over a Rust-allocated
Vec<StyleBackgroundSize>struct StyleBackgroundSizeVec has destructor
ptr: StyleBackgroundSize
len: usize
cap: usize
destructor: StyleBackgroundSizeVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: StyleBackgroundSize
fn copy_from_ptr:
arg ptr: *const StyleBackgroundSize
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
StyleBackgroundSizeVecCreates a
StyleBackgroundSizeVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
StyleBackgroundSizeVeccontaining a single elementCopies elements from a C array into a
StyleBackgroundSizeVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
StyleBackgroundSizeVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
Wrapper over a Rust-allocated
Vec<StyleTransform>struct StyleTransformVec has destructor
ptr: StyleTransform
len: usize
cap: usize
destructor: StyleTransformVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: StyleTransform
fn copy_from_ptr:
arg ptr: *const StyleTransform
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
StyleTransformVecCreates a
StyleTransformVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
StyleTransformVeccontaining a single elementCopies elements from a C array into a
StyleTransformVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
StyleTransformVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
Wrapper over a Rust-allocated
Vec<SvgVertex>struct SvgVertexVec has destructor
ptr: SvgVertex
len: usize
cap: usize
destructor: SvgVertexVecDestructor
fn create:
-> SvgVertexVec
fn with_capacity:
arg cap: usize
-> SvgVertexVec
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: SvgVertex
-> SvgVertexVec
fn copy_from_ptr:
arg ptr: *const SvgVertex
arg len: usize
-> SvgVertexVec
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
SvgVertexVecCreates a
SvgVertexVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
SvgVertexVeccontaining a single elementCopies elements from a C array into a
SvgVertexVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
SvgVertexVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
Wrapper over a Rust-allocated
Vec<u32>struct U32Vec has destructor
ptr: u32
len: usize
cap: usize
destructor: U32VecDestructor
fn create:
-> U32Vec
fn with_capacity:
arg cap: usize
-> U32Vec
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
-> OptionU32
fn from_item:
arg item: u32
-> U32Vec
fn copy_from_ptr:
arg ptr: *const u32
arg len: usize
-> U32Vec
fn c_get:
&self
arg index: usize
-> OptionU32
fn as_c_slice:
&self
-> U32VecSlice
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
-> U32VecSlice
Creates an empty
U32VecCreates a
U32Vecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
U32Veccontaining a single elementCopies elements from a C array into a
U32Vec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
U32VecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
Wrapper over a Rust-allocated
Vec<VirtualKeyCode>struct VirtualKeyCodeVec has destructor
ptr: VirtualKeyCode
len: usize
cap: usize
destructor: VirtualKeyCodeVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: VirtualKeyCode
fn copy_from_ptr:
arg ptr: *const VirtualKeyCode
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
VirtualKeyCodeVecCreates a
VirtualKeyCodeVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
VirtualKeyCodeVeccontaining a single elementCopies elements from a C array into a
VirtualKeyCodeVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
VirtualKeyCodeVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
Wrapper over a Rust-allocated
Vec<CascadeInfo>struct CascadeInfoVec has destructor
ptr: CascadeInfo
len: usize
cap: usize
destructor: CascadeInfoVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: CascadeInfo
fn copy_from_ptr:
arg ptr: *const CascadeInfo
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
CascadeInfoVecCreates a
CascadeInfoVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
CascadeInfoVeccontaining a single elementCopies elements from a C array into a
CascadeInfoVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
CascadeInfoVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
Wrapper over a Rust-allocated
Vec<CssDeclaration>struct CssDeclarationVec has destructor
ptr: CssDeclaration
len: usize
cap: usize
destructor: CssDeclarationVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: CssDeclaration
fn copy_from_ptr:
arg ptr: *const CssDeclaration
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
CssDeclarationVecCreates a
CssDeclarationVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
CssDeclarationVeccontaining a single elementCopies elements from a C array into a
CssDeclarationVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
CssDeclarationVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
Wrapper over a Rust-allocated
Vec<CssPathSelector>struct CssPathSelectorVec has destructor
ptr: CssPathSelector
len: usize
cap: usize
destructor: CssPathSelectorVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: CssPathSelector
fn copy_from_ptr:
arg ptr: *const CssPathSelector
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
CssPathSelectorVecCreates a
CssPathSelectorVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
CssPathSelectorVeccontaining a single elementCopies elements from a C array into a
CssPathSelectorVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
CssPathSelectorVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
Wrapper over a Rust-allocated
Vec<Css>struct CssVec has destructor
ptr: Css
len: usize
cap: usize
destructor: CssVecDestructor
fn create:
-> CssVec
fn with_capacity:
arg cap: usize
-> CssVec
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
-> OptionCss
fn from_item:
fn copy_from_ptr:
fn c_get:
&self
arg index: usize
-> OptionCss
fn as_c_slice:
&self
-> CssVecSlice
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
-> CssVecSlice
Creates an empty
CssVecCreates a
CssVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
CssVeccontaining a single elementCopies elements from a C array into a
CssVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
CssVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
Wrapper over a Rust-allocated
Vec<CssRuleBlock>struct CssRuleBlockVec has destructor
ptr: CssRuleBlock
len: usize
cap: usize
destructor: CssRuleBlockVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: CssRuleBlock
fn copy_from_ptr:
arg ptr: *const CssRuleBlock
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
CssRuleBlockVecCreates a
CssRuleBlockVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
CssRuleBlockVeccontaining a single elementCopies elements from a C array into a
CssRuleBlockVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
CssRuleBlockVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
Wrapper over a Rust-allocated
Vec<u16>struct U16Vec has destructor
ptr: u16
len: usize
cap: usize
destructor: U16VecDestructor
fn create:
-> U16Vec
fn with_capacity:
arg cap: usize
-> U16Vec
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
-> OptionU16
fn from_item:
arg item: u16
-> U16Vec
fn copy_from_ptr:
arg ptr: *const u16
arg len: usize
-> U16Vec
fn c_get:
&self
arg index: usize
-> OptionU16
fn as_c_slice:
&self
-> U16VecSlice
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
-> U16VecSlice
Creates an empty
U16VecCreates a
U16Vecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
U16Veccontaining a single elementCopies elements from a C array into a
U16Vec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
U16VecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
Wrapper over a Rust-allocated
Vec<f32>struct F32Vec has destructor
ptr: f32
len: usize
cap: usize
destructor: F32VecDestructor
fn create:
-> F32Vec
fn with_capacity:
arg cap: usize
-> F32Vec
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
-> OptionF32
fn from_item:
arg item: f32
-> F32Vec
fn copy_from_ptr:
arg ptr: *const f32
arg len: usize
-> F32Vec
fn c_get:
&self
arg index: usize
-> OptionF32
fn as_c_slice:
&self
-> F32VecSlice
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
-> F32VecSlice
Creates an empty
F32VecCreates a
F32Vecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
F32Veccontaining a single elementCopies elements from a C array into a
F32Vec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
F32VecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
Wrapper over a Rust-allocated
Vec<u8>struct U8Vec has destructor
ptr: u8
len: usize
cap: usize
destructor: U8VecDestructor
constructor copy_from_bytes:
arg ptr: *const u8
arg start: usize
arg len: usize
-> U8Vec
Creates a new, heap-allocated U8Vec by copying the memory into Rust (heap allocation)
fn as_ref_vec:
&self
-> U8VecRef
fn create:
-> U8Vec
fn with_capacity:
arg cap: usize
-> U8Vec
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
-> OptionU8
fn from_item:
arg item: u8
-> U8Vec
fn copy_from_ptr:
arg ptr: *const u8
arg len: usize
-> U8Vec
fn c_get:
&self
arg index: usize
-> OptionU8
fn as_c_slice:
&self
-> U8VecSlice
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
-> U8VecSlice
Returns the
U8Vecas a non-owning slice, NOTE: TheU8Vecthat this slice was borrowed from MUST NOT be deleted before theU8VecRefCreates an empty
U8VecCreates a
U8Vecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
U8Veccontaining a single elementCopies elements from a C array into a
U8Vec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
U8VecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
Wrapper over a Rust-allocated
Vec<GLuint>struct GLuintVec has destructor
ptr: GLuint
len: usize
cap: usize
destructor: GLuintVecDestructor
fn create:
-> GLuintVec
fn with_capacity:
arg cap: usize
-> GLuintVec
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
-> OptionU32
fn from_item:
fn copy_from_ptr:
fn c_get:
&self
arg index: usize
-> OptionU32
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
GLuintVecCreates a
GLuintVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
GLuintVeccontaining a single elementCopies elements from a C array into a
GLuintVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
GLuintVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
Wrapper over a Rust-allocated
Vec<GLint>struct GLintVec has destructor
ptr: GLint
len: usize
cap: usize
destructor: GLintVecDestructor
fn create:
-> GLintVec
fn with_capacity:
arg cap: usize
-> GLintVec
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
-> OptionI32
fn from_item:
fn copy_from_ptr:
fn c_get:
&self
arg index: usize
-> OptionI32
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
GLintVecCreates a
GLintVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
GLintVeccontaining a single elementCopies elements from a C array into a
GLintVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
GLintVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
Wrapper over a Rust-allocated
Vec<String>struct StringVec has destructor
ptr: String
len: usize
cap: usize
destructor: StringVecDestructor
fn create:
-> StringVec
fn with_capacity:
arg cap: usize
-> StringVec
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
-> OptionString
fn from_item:
fn copy_from_ptr:
fn c_get:
&self
arg index: usize
-> OptionString
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
StringVecCreates a
StringVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
StringVeccontaining a single elementCopies elements from a C array into a
StringVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
StringVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
Wrapper over a Rust-allocated
Vec<MimeTypeData>struct MimeTypeDataVec has destructor
ptr: MimeTypeData
len: usize
cap: usize
destructor: MimeTypeDataVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: MimeTypeData
fn copy_from_ptr:
arg ptr: *const MimeTypeData
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
MimeTypeDataVecCreates a
MimeTypeDataVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
MimeTypeDataVeccontaining a single elementCopies elements from a C array into a
MimeTypeDataVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
MimeTypeDataVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
Wrapper over a Rust-allocated
Vec<StringPair>struct StringPairVec has destructor
ptr: StringPair
len: usize
cap: usize
destructor: StringPairVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: StringPair
fn copy_from_ptr:
arg ptr: *const StringPair
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
StringPairVecCreates a
StringPairVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
StringPairVeccontaining a single elementCopies elements from a C array into a
StringPairVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
StringPairVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
Wrapper over a Rust-allocated
Vec<NormalizedLinearColorStop>struct NormalizedLinearColorStopVec has destructor
ptr: NormalizedLinearColorStop
len: usize
cap: usize
destructor: NormalizedLinearColorStopVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
fn copy_from_ptr:
arg ptr: *const NormalizedLinearColorStop
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
NormalizedLinearColorStopVecCreates a
NormalizedLinearColorStopVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
NormalizedLinearColorStopVeccontaining a single elementCopies elements from a C array into a
NormalizedLinearColorStopVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
NormalizedLinearColorStopVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
Wrapper over a Rust-allocated
Vec<NormalizedRadialColorStop>struct NormalizedRadialColorStopVec has destructor
ptr: NormalizedRadialColorStop
len: usize
cap: usize
destructor: NormalizedRadialColorStopVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
fn copy_from_ptr:
arg ptr: *const NormalizedRadialColorStop
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
NormalizedRadialColorStopVecCreates a
NormalizedRadialColorStopVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
NormalizedRadialColorStopVeccontaining a single elementCopies elements from a C array into a
NormalizedRadialColorStopVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
NormalizedRadialColorStopVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
Wrapper over a Rust-allocated
Vec<NodeHierarchyItem>struct NodeHierarchyItemVec has destructor
ptr: NodeHierarchyItem
len: usize
cap: usize
destructor: NodeHierarchyItemVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: NodeHierarchyItem
fn copy_from_ptr:
arg ptr: *const NodeHierarchyItem
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
NodeHierarchyItemVecCreates a
NodeHierarchyItemVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
NodeHierarchyItemVeccontaining a single elementCopies elements from a C array into a
NodeHierarchyItemVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
NodeHierarchyItemVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
Wrapper over a Rust-allocated
Vec<TagIdToNodeIdMapping>struct TagIdToNodeIdMappingVec has destructor
ptr: TagIdToNodeIdMapping
len: usize
cap: usize
destructor: TagIdToNodeIdMappingVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: TagIdToNodeIdMapping
fn copy_from_ptr:
arg ptr: *const TagIdToNodeIdMapping
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
TagIdToNodeIdMappingVecCreates a
TagIdToNodeIdMappingVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
TagIdToNodeIdMappingVeccontaining a single elementCopies elements from a C array into a
TagIdToNodeIdMappingVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
TagIdToNodeIdMappingVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
Wrapper over a Rust-allocated
Vec<ParentWithNodeDepth>struct ParentWithNodeDepthVec has destructor
ptr: ParentWithNodeDepth
len: usize
cap: usize
destructor: ParentWithNodeDepthVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: ParentWithNodeDepth
fn copy_from_ptr:
arg ptr: *const ParentWithNodeDepth
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
ParentWithNodeDepthVecCreates a
ParentWithNodeDepthVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
ParentWithNodeDepthVeccontaining a single elementCopies elements from a C array into a
ParentWithNodeDepthVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
ParentWithNodeDepthVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
Wrapper over a Rust-allocated
Vec<NodeData>struct NodeDataVec has destructor
ptr: NodeData
len: usize
cap: usize
destructor: NodeDataVecDestructor
fn create:
-> NodeDataVec
fn with_capacity:
arg cap: usize
-> NodeDataVec
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: NodeData
-> NodeDataVec
fn copy_from_ptr:
arg ptr: *const NodeData
arg len: usize
-> NodeDataVec
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
NodeDataVecCreates a
NodeDataVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
NodeDataVeccontaining a single elementCopies elements from a C array into a
NodeDataVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
NodeDataVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
Wrapper over a Rust-allocated
Vec<AttributeType>struct AttributeTypeVec has destructor
ptr: AttributeType
len: usize
cap: usize
destructor: AttributeTypeVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: AttributeType
fn copy_from_ptr:
arg ptr: *const AttributeType
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
AttributeTypeVecCreates a
AttributeTypeVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
AttributeTypeVeccontaining a single elementCopies elements from a C array into a
AttributeTypeVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
AttributeTypeVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
Wrapper over a Rust-allocated
Vec<CoreCallbackData>struct CoreCallbackDataVec has destructor
ptr: CoreCallbackData
len: usize
cap: usize
destructor: CoreCallbackDataVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: CoreCallbackData
fn copy_from_ptr:
arg ptr: *const CoreCallbackData
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
CoreCallbackDataVecCreates a
CoreCallbackDataVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
CoreCallbackDataVeccontaining a single elementCopies elements from a C array into a
CoreCallbackDataVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
CoreCallbackDataVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
Wrapper over a Rust-allocated
Vec<AccessibilityAction>struct AccessibilityActionVec has destructor
ptr: AccessibilityAction
len: usize
cap: usize
destructor: AccessibilityActionVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: AccessibilityAction
fn copy_from_ptr:
arg ptr: *const AccessibilityAction
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
AccessibilityActionVecCreates a
AccessibilityActionVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
AccessibilityActionVeccontaining a single elementCopies elements from a C array into a
AccessibilityActionVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
AccessibilityActionVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
Wrapper over a Rust-allocated
Vec<XmlNodeChild>struct XmlNodeChildVec has destructor
ptr: XmlNodeChild
len: usize
cap: usize
destructor: XmlNodeChildVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: XmlNodeChild
fn copy_from_ptr:
arg ptr: *const XmlNodeChild
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
XmlNodeChildVecCreates a
XmlNodeChildVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
XmlNodeChildVeccontaining a single elementCopies elements from a C array into a
XmlNodeChildVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
XmlNodeChildVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
Wrapper over a Rust-allocated
Vec<GridTrackSizing>struct GridTrackSizingVec has destructor
ptr: GridTrackSizing
len: usize
cap: usize
destructor: GridTrackSizingVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: GridTrackSizing
fn copy_from_ptr:
arg ptr: *const GridTrackSizing
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
GridTrackSizingVecCreates a
GridTrackSizingVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
GridTrackSizingVeccontaining a single elementCopies elements from a C array into a
GridTrackSizingVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
GridTrackSizingVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
struct GLbooleanVecRefMut
ptr: c_void
len: usize
struct GLfloatVecRefMut
ptr: c_void
len: usize
struct U8VecRefMut
ptr: c_void
len: usize
struct TessellatedSvgNodeVecRef
ptr: c_void
len: usize
struct F32VecRef
ptr: c_void
len: usize
struct GLuintVecRef
ptr: c_void
len: usize
struct I32VecRef
ptr: c_void
len: usize
struct U8VecRef
ptr: c_void
len: usize
struct GLintVecRefMut
ptr: c_void
len: usize
struct GLenumVecRef
ptr: c_void
len: usize
struct GLint64VecRefMut
ptr: c_void
len: usize
fnptr StyleBackgroundContentVecDestructorType
arg *mut StyleBackgroundContentVec
fnptr StyleBackgroundRepeatVecDestructorType
arg *mut StyleBackgroundRepeatVec
union enum StyleFilterVecDestructor
DefaultRust
NoDestructor
External(StyleFilterVecDestructorType)
AlreadyDestroyed
union enum StyleTransformVecDestructor
DefaultRust
NoDestructor
External(StyleTransformVecDestructorType)
AlreadyDestroyed
fnptr MenuItemVecDestructorType
arg *mut MenuItemVec
fnptr AccessibilityStateVecDestructorType
arg *mut AccessibilityStateVec
fnptr CssPropertyWithConditionsVecDestructorType
arg *mut CssPropertyWithConditionsVec
fnptr NormalizedLinearColorStopVecDestructorType
arg *mut NormalizedLinearColorStopVec
fnptr F32VecDestructorType
arg *mut F32Vec
union enum GLuintVecDestructor
DefaultRust
NoDestructor
External(GLuintVecDestructorType)
AlreadyDestroyed
union enum XmlNodeChildVecDestructor
DefaultRust
NoDestructor
External(XmlNodeChildVecDestructorType)
AlreadyDestroyed
fnptr StyleBackgroundSizeVecDestructorType
arg *mut StyleBackgroundSizeVec
union enum StyleBackgroundContentVecDestructor
DefaultRust
NoDestructor
External(StyleBackgroundContentVecDestructorType)
AlreadyDestroyed
fnptr StringVecDestructorType
arg *mut StringVec
union enum CascadeInfoVecDestructor
DefaultRust
NoDestructor
External(CascadeInfoVecDestructorType)
AlreadyDestroyed
fnptr DomVecDestructorType
arg *mut DomVec
union enum AccessibilityStateVecDestructor
DefaultRust
NoDestructor
External(AccessibilityStateVecDestructorType)
AlreadyDestroyed
fnptr StringPairVecDestructorType
arg *mut StringPairVec
fnptr MimeTypeDataVecDestructorType
arg *mut MimeTypeDataVec
union enum DomVecDestructor
DefaultRust
NoDestructor
External(DomVecDestructorType)
AlreadyDestroyed
union enum StringVecDestructor
DefaultRust
NoDestructor
External(StringVecDestructorType)
AlreadyDestroyed
fnptr CssRuleBlockVecDestructorType
arg *mut CssRuleBlockVec
union enum NodeDataVecDestructor
DefaultRust
NoDestructor
External(NodeDataVecDestructorType)
AlreadyDestroyed
union enum MenuItemVecDestructor
DefaultRust
NoDestructor
External(MenuItemVecDestructorType)
AlreadyDestroyed
fnptr AttributeTypeVecDestructorType
arg *mut AttributeTypeVec
union enum ListViewRowVecDestructor
DefaultRust
NoDestructor
External(ListViewRowVecDestructorType)
AlreadyDestroyed
fnptr StyleFilterVecDestructorType
arg *mut StyleFilterVec
fnptr U32VecDestructorType
arg *mut U32Vec
union enum SvgVertexVecDestructor
DefaultRust
NoDestructor
External(SvgVertexVecDestructorType)
AlreadyDestroyed
union enum CssVecDestructor
DefaultRust
NoDestructor
External(CssVecDestructorType)
AlreadyDestroyed
union enum U32VecDestructor
DefaultRust
NoDestructor
External(U32VecDestructorType)
AlreadyDestroyed
union enum CssRuleBlockVecDestructor
DefaultRust
NoDestructor
External(CssRuleBlockVecDestructorType)
AlreadyDestroyed
fnptr ParentWithNodeDepthVecDestructorType
arg *mut ParentWithNodeDepthVec
union enum NormalizedLinearColorStopVecDestructor
DefaultRust
NoDestructor
External(NormalizedLinearColorStopVecDestructorType)
AlreadyDestroyed
fnptr CoreCallbackDataVecDestructorType
arg *mut CoreCallbackDataVec
union enum StyleFontFamilyVecDestructor
DefaultRust
NoDestructor
External(StyleFontFamilyVecDestructorType)
AlreadyDestroyed
fnptr CascadeInfoVecDestructorType
arg *mut CascadeInfoVec
fnptr U8VecDestructorType
arg *mut U8Vec
fnptr NodeHierarchyItemVecDestructorType
arg *mut NodeHierarchyItemVec
union enum CssPathSelectorVecDestructor
DefaultRust
NoDestructor
External(CssPathSelectorVecDestructorType)
AlreadyDestroyed
fnptr StyleBackgroundPositionVecDestructorType
arg *mut StyleBackgroundPositionVec
fnptr VirtualKeyCodeVecDestructorType
arg *mut VirtualKeyCodeVec
union enum NodeHierarchyItemVecDestructor
DefaultRust
NoDestructor
External(NodeHierarchyItemVecDestructorType)
AlreadyDestroyed
union enum VirtualKeyCodeVecDestructor
DefaultRust
NoDestructor
External(VirtualKeyCodeVecDestructorType)
AlreadyDestroyed
fnptr SvgVertexVecDestructorType
arg *mut SvgVertexVec
union enum F32VecDestructor
DefaultRust
NoDestructor
External(F32VecDestructorType)
AlreadyDestroyed
union enum StyleBackgroundRepeatVecDestructor
DefaultRust
NoDestructor
External(StyleBackgroundRepeatVecDestructorType)
AlreadyDestroyed
union enum AccessibilityActionVecDestructor
DefaultRust
NoDestructor
External(AccessibilityActionVecDestructorType)
AlreadyDestroyed
fnptr ListViewRowVecDestructorType
arg *mut ListViewRowVec
fnptr GLuintVecDestructorType
arg *mut GLuintVec
fnptr StyleTransformVecDestructorType
arg *mut StyleTransformVec
fnptr TagIdToNodeIdMappingVecDestructorType
arg *mut TagIdToNodeIdMappingVec
union enum U16VecDestructor
DefaultRust
NoDestructor
External(U16VecDestructorType)
AlreadyDestroyed
union enum TagIdToNodeIdMappingVecDestructor
DefaultRust
NoDestructor
External(TagIdToNodeIdMappingVecDestructorType)
AlreadyDestroyed
fnptr U16VecDestructorType
arg *mut U16Vec
fnptr GridTrackSizingVecDestructorType
arg *mut GridTrackSizingVec
fnptr CssDeclarationVecDestructorType
arg *mut CssDeclarationVec
union enum ParentWithNodeDepthVecDestructor
DefaultRust
NoDestructor
External(ParentWithNodeDepthVecDestructorType)
AlreadyDestroyed
union enum GLintVecDestructor
DefaultRust
NoDestructor
External(GLintVecDestructorType)
AlreadyDestroyed
union enum CssPropertyWithConditionsVecDestructor
DefaultRust
NoDestructor
External(CssPropertyWithConditionsVecDestructorType)
AlreadyDestroyed
fnptr DynamicSelectorVecDestructorType
arg *mut DynamicSelectorVec
union enum DynamicSelectorVecDestructor
DefaultRust
NoDestructor
External(DynamicSelectorVecDestructorType)
AlreadyDestroyed
fnptr NormalizedRadialColorStopVecDestructorType
arg *mut NormalizedRadialColorStopVec
union enum NormalizedRadialColorStopVecDestructor
DefaultRust
NoDestructor
External(NormalizedRadialColorStopVecDestructorType)
AlreadyDestroyed
union enum StyleBackgroundPositionVecDestructor
DefaultRust
NoDestructor
External(StyleBackgroundPositionVecDestructorType)
AlreadyDestroyed
fnptr AccessibilityActionVecDestructorType
arg *mut AccessibilityActionVec
fnptr GLintVecDestructorType
arg *mut GLintVec
union enum AttributeTypeVecDestructor
DefaultRust
NoDestructor
External(AttributeTypeVecDestructorType)
AlreadyDestroyed
fnptr NodeDataVecDestructorType
arg *mut NodeDataVec
union enum CssDeclarationVecDestructor
DefaultRust
NoDestructor
External(CssDeclarationVecDestructorType)
AlreadyDestroyed
union enum IdOrClassVecDestructor
DefaultRust
NoDestructor
External(IdOrClassVecDestructorType)
AlreadyDestroyed
union enum StyleBackgroundSizeVecDestructor
DefaultRust
NoDestructor
External(StyleBackgroundSizeVecDestructorType)
AlreadyDestroyed
fnptr StyleFontFamilyVecDestructorType
arg *mut StyleFontFamilyVec
union enum StringPairVecDestructor
DefaultRust
NoDestructor
External(StringPairVecDestructorType)
AlreadyDestroyed
union enum MimeTypeDataVecDestructor
DefaultRust
NoDestructor
External(MimeTypeDataVecDestructorType)
AlreadyDestroyed
union enum CoreCallbackDataVecDestructor
DefaultRust
NoDestructor
External(CoreCallbackDataVecDestructorType)
AlreadyDestroyed
union enum U8VecDestructor
DefaultRust
NoDestructor
External(U8VecDestructorType)
AlreadyDestroyed
union enum GridTrackSizingVecDestructor
DefaultRust
NoDestructor
External(GridTrackSizingVecDestructorType)
AlreadyDestroyed
fnptr IdOrClassVecDestructorType
arg *mut IdOrClassVec
fnptr XmlNodeChildVecDestructorType
arg *mut XmlNodeChildVec
fnptr CssVecDestructorType
arg *mut CssVec
fnptr CssPathSelectorVecDestructorType
arg *mut CssPathSelectorVec
fnptr VertexAttributeVecDestructorType
arg *mut VertexAttributeVec
union enum VertexAttributeVecDestructor
DefaultRust
NoDestructor
External(VertexAttributeVecDestructorType)
AlreadyDestroyed
struct VertexAttributeVec has destructor
ptr: VertexAttribute
len: usize
cap: usize
destructor: VertexAttributeVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: VertexAttribute
fn copy_from_ptr:
arg ptr: *const VertexAttribute
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
VertexAttributeVecCreates a
VertexAttributeVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
VertexAttributeVeccontaining a single elementCopies elements from a C array into a
VertexAttributeVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
VertexAttributeVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
union enum DebugMessageVecDestructor
DefaultRust
NoDestructor
External(DebugMessageVecDestructorType)
AlreadyDestroyed
fnptr DebugMessageVecDestructorType
arg *mut DebugMessageVec
struct DebugMessageVec has destructor
ptr: DebugMessage
len: usize
cap: usize
destructor: DebugMessageVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: DebugMessage
fn copy_from_ptr:
arg ptr: *const DebugMessage
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
DebugMessageVecCreates a
DebugMessageVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
DebugMessageVeccontaining a single elementCopies elements from a C array into a
DebugMessageVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
DebugMessageVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
union enum ShapePointVecDestructor
DefaultRust
NoDestructor
External(ShapePointVecDestructorType)
AlreadyDestroyed
fnptr ShapePointVecDestructorType
arg *mut ShapePointVec
struct ShapePointVec
ptr: ShapePoint
len: usize
cap: usize
destructor: ShapePointVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: ShapePoint
fn copy_from_ptr:
arg ptr: *const ShapePoint
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
ShapePointVecCreates a
ShapePointVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
ShapePointVeccontaining a single elementCopies elements from a C array into a
ShapePointVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
ShapePointVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
struct MonitorVec has destructor
ptr: Monitor
len: usize
cap: usize
destructor: MonitorVecDestructor
fn create:
-> MonitorVec
fn with_capacity:
arg cap: usize
-> MonitorVec
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: Monitor
-> MonitorVec
fn copy_from_ptr:
arg ptr: *const Monitor
arg len: usize
-> MonitorVec
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
MonitorVecCreates a
MonitorVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
MonitorVeccontaining a single elementCopies elements from a C array into a
MonitorVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
MonitorVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
fnptr VideoModeVecDestructorType
arg *mut VideoModeVec
fnptr ScanCodeVecDestructorType
arg *mut ScanCodeVec
struct VideoModeVec
ptr: VideoMode
len: usize
cap: usize
destructor: VideoModeVecDestructor
fn create:
-> VideoModeVec
fn with_capacity:
arg cap: usize
-> VideoModeVec
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: VideoMode
-> VideoModeVec
fn copy_from_ptr:
arg ptr: *const VideoMode
arg len: usize
-> VideoModeVec
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
VideoModeVecCreates a
VideoModeVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
VideoModeVeccontaining a single elementCopies elements from a C array into a
VideoModeVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
VideoModeVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
struct XWindowTypeVec
ptr: XWindowType
len: usize
cap: usize
destructor: XWindowTypeVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: XWindowType
fn copy_from_ptr:
arg ptr: *const XWindowType
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
XWindowTypeVecCreates a
XWindowTypeVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
XWindowTypeVeccontaining a single elementCopies elements from a C array into a
XWindowTypeVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
XWindowTypeVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
union enum XWindowTypeVecDestructor
DefaultRust
NoDestructor
External(XWindowTypeVecDestructorType)
AlreadyDestroyed
fnptr MonitorVecDestructorType
arg *mut MonitorVec
union enum MonitorVecDestructor
DefaultRust
NoDestructor
External(MonitorVecDestructorType)
AlreadyDestroyed
union enum VideoModeVecDestructor
DefaultRust
NoDestructor
External(VideoModeVecDestructorType)
AlreadyDestroyed
fnptr XWindowTypeVecDestructorType
arg *mut XWindowTypeVec
union enum ScanCodeVecDestructor
DefaultRust
NoDestructor
External(ScanCodeVecDestructorType)
AlreadyDestroyed
struct ScanCodeVec
ptr: ScanCode
len: usize
cap: usize
destructor: ScanCodeVecDestructor
fn create:
-> ScanCodeVec
fn with_capacity:
arg cap: usize
-> ScanCodeVec
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
-> OptionU32
fn from_item:
arg item: ScanCode
-> ScanCodeVec
fn copy_from_ptr:
arg ptr: *const ScanCode
arg len: usize
-> ScanCodeVec
fn c_get:
&self
arg index: usize
-> OptionU32
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
ScanCodeVecCreates a
ScanCodeVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
ScanCodeVeccontaining a single elementCopies elements from a C array into a
ScanCodeVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
ScanCodeVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
union enum StyledNodeVecDestructor
DefaultRust
NoDestructor
External(StyledNodeVecDestructorType)
AlreadyDestroyed
struct ContentGroupVec
ptr: ContentGroup
len: usize
cap: usize
destructor: ContentGroupVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: ContentGroup
fn copy_from_ptr:
arg ptr: *const ContentGroup
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
ContentGroupVecCreates a
ContentGroupVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
ContentGroupVeccontaining a single elementCopies elements from a C array into a
ContentGroupVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
ContentGroupVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
struct StyledNodeVec
ptr: StyledNode
len: usize
cap: usize
destructor: StyledNodeVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: StyledNode
fn copy_from_ptr:
arg ptr: *const StyledNode
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
StyledNodeVecCreates a
StyledNodeVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
StyledNodeVeccontaining a single elementCopies elements from a C array into a
StyledNodeVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
StyledNodeVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
fnptr ContentGroupVecDestructorType
arg *mut ContentGroupVec
union enum ContentGroupVecDestructor
DefaultRust
NoDestructor
External(ContentGroupVecDestructorType)
AlreadyDestroyed
fnptr StyledNodeVecDestructorType
arg *mut StyledNodeVec
fnptr SelectionRangeVecDestructorType
arg *mut SelectionRangeVec
fnptr DomIdVecDestructorType
arg *mut DomIdVec
Wrapper over a Rust-allocated
Vec<DomId>struct DomIdVec has destructor
ptr: DomId
len: usize
cap: usize
destructor: DomIdVecDestructor
fn create:
-> DomIdVec
fn with_capacity:
arg cap: usize
-> DomIdVec
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
-> OptionDomId
fn from_item:
fn copy_from_ptr:
fn c_get:
&self
arg index: usize
-> OptionDomId
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
DomIdVecCreates a
DomIdVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
DomIdVeccontaining a single elementCopies elements from a C array into a
DomIdVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
DomIdVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
union enum DomIdVecDestructor
DefaultRust
NoDestructor
External(DomIdVecDestructorType)
AlreadyDestroyed
struct RefstrVecRef
ptr: c_void
len: usize
union enum TimerIdVecDestructor
DefaultRust
NoDestructor
External(TimerIdVecDestructorType)
AlreadyDestroyed
Wrapper over a Rust-allocated
Vec<TimerId>struct TimerIdVec has destructor
ptr: TimerId
len: usize
cap: usize
destructor: TimerIdVecDestructor
fn create:
-> TimerIdVec
fn with_capacity:
arg cap: usize
-> TimerIdVec
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: TimerId
-> TimerIdVec
fn copy_from_ptr:
arg ptr: *const TimerId
arg len: usize
-> TimerIdVec
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
TimerIdVecCreates a
TimerIdVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
TimerIdVeccontaining a single elementCopies elements from a C array into a
TimerIdVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
TimerIdVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
struct SelectionRangeVec
ptr: SelectionRange
len: usize
cap: usize
destructor: SelectionRangeVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: SelectionRange
fn copy_from_ptr:
arg ptr: *const SelectionRange
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
SelectionRangeVecCreates a
SelectionRangeVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
SelectionRangeVeccontaining a single elementCopies elements from a C array into a
SelectionRangeVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
SelectionRangeVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
fnptr TimerIdVecDestructorType
arg *mut TimerIdVec
union enum ThreadIdVecDestructor
DefaultRust
NoDestructor
External(ThreadIdVecDestructorType)
AlreadyDestroyed
Wrapper over a Rust-allocated
Vec<ThreadId>struct ThreadIdVec has destructor
ptr: ThreadId
len: usize
cap: usize
destructor: ThreadIdVecDestructor
fn create:
-> ThreadIdVec
fn with_capacity:
arg cap: usize
-> ThreadIdVec
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: ThreadId
-> ThreadIdVec
fn copy_from_ptr:
arg ptr: *const ThreadId
arg len: usize
-> ThreadIdVec
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
ThreadIdVecCreates a
ThreadIdVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
ThreadIdVeccontaining a single elementCopies elements from a C array into a
ThreadIdVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
ThreadIdVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
union enum SelectionRangeVecDestructor
DefaultRust
NoDestructor
External(SelectionRangeVecDestructorType)
AlreadyDestroyed
fnptr ThreadIdVecDestructorType
arg *mut ThreadIdVec
union enum StyledTextRunVecDestructor
DefaultRust
NoDestructor
External(StyledTextRunVecDestructorType)
AlreadyDestroyed
fnptr StyledTextRunVecDestructorType
arg *mut StyledTextRunVec
struct StyledTextRunVec has destructor
ptr: StyledTextRun
len: usize
cap: usize
destructor: StyledTextRunVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: StyledTextRun
fn copy_from_ptr:
arg ptr: *const StyledTextRun
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
StyledTextRunVecCreates a
StyledTextRunVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
StyledTextRunVeccontaining a single elementCopies elements from a C array into a
StyledTextRunVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
StyledTextRunVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
fnptr SelectionVecDestructorType
arg *mut SelectionVec
struct SelectionVec
ptr: Selection
len: usize
cap: usize
destructor: SelectionVecDestructor
fn create:
-> SelectionVec
fn with_capacity:
arg cap: usize
-> SelectionVec
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: Selection
-> SelectionVec
fn copy_from_ptr:
arg ptr: *const Selection
arg len: usize
-> SelectionVec
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
SelectionVecCreates a
SelectionVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
SelectionVeccontaining a single elementCopies elements from a C array into a
SelectionVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
SelectionVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
union enum SelectionVecDestructor
DefaultRust
NoDestructor
External(SelectionVecDestructorType)
AlreadyDestroyed
struct HttpHeaderVec has destructor
ptr: HttpHeader
len: usize
cap: usize
destructor: HttpHeaderVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: HttpHeader
fn copy_from_ptr:
arg ptr: *const HttpHeader
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
HttpHeaderVecCreates a
HttpHeaderVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
HttpHeaderVeccontaining a single elementCopies elements from a C array into a
HttpHeaderVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
HttpHeaderVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
fnptr HttpHeaderVecDestructorType
arg *mut HttpHeaderVec
fnptr FmtArgVecDestructorType
arg *mut FmtArgVec
struct FmtArgVec has destructor
ptr: FmtArg
len: usize
cap: usize
destructor: FmtArgVecDestructor
fn create:
-> FmtArgVec
fn with_capacity:
arg cap: usize
-> FmtArgVec
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
-> OptionFmtArg
fn from_item:
fn copy_from_ptr:
fn c_get:
&self
arg index: usize
-> OptionFmtArg
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
FmtArgVecCreates a
FmtArgVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
FmtArgVeccontaining a single elementCopies elements from a C array into a
FmtArgVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
FmtArgVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
union enum FmtArgVecDestructor
DefaultRust
NoDestructor
External(FmtArgVecDestructorType)
AlreadyDestroyed
union enum HttpHeaderVecDestructor
DefaultRust
NoDestructor
External(HttpHeaderVecDestructorType)
AlreadyDestroyed
struct JsonVec has destructor
ptr: Json
len: usize
cap: usize
destructor: JsonVecDestructor
constructor copy_from_array:
Creates a new, heap-allocated JsonVec by copying elements from a C array
fn create:
-> JsonVec
fn with_capacity:
arg cap: usize
-> JsonVec
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
-> OptionJson
fn from_item:
fn copy_from_ptr:
fn c_get:
&self
arg index: usize
-> OptionJson
fn as_c_slice:
&self
-> JsonVecSlice
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
-> JsonVecSlice
Creates an empty
JsonVecCreates a
JsonVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
JsonVeccontaining a single elementCopies elements from a C array into a
JsonVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
JsonVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
union enum JsonVecDestructor
DefaultRust
NoDestructor
External(JsonVecDestructorType)
AlreadyDestroyed
fnptr JsonVecDestructorType
arg *mut JsonVec
struct DirEntryVec has destructor
ptr: DirEntry
len: usize
cap: usize
destructor: DirEntryVecDestructor
fn create:
-> DirEntryVec
fn with_capacity:
arg cap: usize
-> DirEntryVec
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: DirEntry
-> DirEntryVec
fn copy_from_ptr:
arg ptr: *const DirEntry
arg len: usize
-> DirEntryVec
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
DirEntryVecCreates a
DirEntryVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
DirEntryVeccontaining a single elementCopies elements from a C array into a
DirEntryVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
DirEntryVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
fnptr DirEntryVecDestructorType
arg *mut DirEntryVec
union enum DirEntryVecDestructor
DefaultRust
NoDestructor
External(DirEntryVecDestructorType)
AlreadyDestroyed
struct JsonKeyValueVec has destructor
ptr: JsonKeyValue
len: usize
cap: usize
destructor: JsonKeyValueVecDestructor
constructor copy_from_array:
arg ptr: *const JsonKeyValue
arg len: usize
Creates a new, heap-allocated JsonKeyValueVec by copying elements from a C array
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: JsonKeyValue
fn copy_from_ptr:
arg ptr: *const JsonKeyValue
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
JsonKeyValueVecCreates a
JsonKeyValueVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
JsonKeyValueVeccontaining a single elementCopies elements from a C array into a
JsonKeyValueVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
JsonKeyValueVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
fnptr JsonKeyValueVecDestructorType
arg *mut JsonKeyValueVec
union enum JsonKeyValueVecDestructor
DefaultRust
NoDestructor
External(JsonKeyValueVecDestructorType)
AlreadyDestroyed
fnptr NamedFontVecDestructorType
arg *mut NamedFontVec
union enum NamedFontVecDestructor
DefaultRust
NoDestructor
External(NamedFontVecDestructorType)
AlreadyDestroyed
struct NamedFontVec has destructor
ptr: NamedFont
len: usize
cap: usize
destructor: NamedFontVecDestructor
fn create:
-> NamedFontVec
fn with_capacity:
arg cap: usize
-> NamedFontVec
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: NamedFont
-> NamedFontVec
fn copy_from_ptr:
arg ptr: *const NamedFont
arg len: usize
-> NamedFontVec
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
NamedFontVecCreates a
NamedFontVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
NamedFontVeccontaining a single elementCopies elements from a C array into a
NamedFontVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
NamedFontVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
struct ExternalResourceVec has destructor
ptr: ExternalResource
len: usize
cap: usize
destructor: ExternalResourceVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn from_item:
arg item: ExternalResource
fn copy_from_ptr:
arg ptr: *const ExternalResource
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
ExternalResourceVecCreates a
ExternalResourceVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Creates a
ExternalResourceVeccontaining a single elementCopies elements from a C array into a
ExternalResourceVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
ExternalResourceVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
union enum ExternalResourceVecDestructor
DefaultRust
NoDestructor
External(ExternalResourceVecDestructorType)
AlreadyDestroyed
fnptr ExternalResourceVecDestructorType
arg *mut ExternalResourceVec
union enum NodeHierarchyItemIdVecDestructor
DefaultRust
NoDestructor
External(NodeHierarchyItemIdVecDestructorType)
AlreadyDestroyed
fnptr NodeHierarchyItemIdVecDestructorType
arg *mut NodeHierarchyItemIdVec
struct NodeHierarchyItemIdVec
ptr: NodeHierarchyItemId
len: usize
cap: usize
destructor: NodeHierarchyItemIdVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn from_item:
arg item: NodeHierarchyItemId
fn copy_from_ptr:
arg ptr: *const NodeHierarchyItemId
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
NodeHierarchyItemIdVecCreates a
NodeHierarchyItemIdVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Creates a
NodeHierarchyItemIdVeccontaining a single elementCopies elements from a C array into a
NodeHierarchyItemIdVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
NodeHierarchyItemIdVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
struct CalcAstItemVec
ptr: CalcAstItem
len: usize
cap: usize
destructor: CalcAstItemVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn from_item:
arg item: CalcAstItem
fn copy_from_ptr:
arg ptr: *const CalcAstItem
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
CalcAstItemVecCreates a
CalcAstItemVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Creates a
CalcAstItemVeccontaining a single elementCopies elements from a C array into a
CalcAstItemVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
CalcAstItemVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
fnptr CalcAstItemVecDestructorType
arg *mut CalcAstItemVec
union enum CalcAstItemVecDestructor
DefaultRust
NoDestructor
External(CalcAstItemVecDestructorType)
AlreadyDestroyed
struct GridAreaDefinitionVec has destructor
ptr: GridAreaDefinition
len: usize
cap: usize
destructor: GridAreaDefinitionVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn from_item:
arg item: GridAreaDefinition
fn copy_from_ptr:
arg ptr: *const GridAreaDefinition
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
GridAreaDefinitionVecCreates a
GridAreaDefinitionVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Creates a
GridAreaDefinitionVeccontaining a single elementCopies elements from a C array into a
GridAreaDefinitionVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
GridAreaDefinitionVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
union enum GridAreaDefinitionVecDestructor
DefaultRust
NoDestructor
External(GridAreaDefinitionVecDestructorType)
AlreadyDestroyed
fnptr GridAreaDefinitionVecDestructorType
arg *mut GridAreaDefinitionVec
struct ComponentDataFieldVec has destructor
ptr: ComponentDataField
len: usize
cap: usize
destructor: ComponentDataFieldVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn from_item:
arg item: ComponentDataField
fn copy_from_ptr:
arg ptr: *const ComponentDataField
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
ComponentDataFieldVecCreates a
ComponentDataFieldVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Creates a
ComponentDataFieldVeccontaining a single elementCopies elements from a C array into a
ComponentDataFieldVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
ComponentDataFieldVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
fnptr ComponentDataFieldVecDestructorType
arg *mut ComponentDataFieldVec
union enum ComponentDataFieldVecDestructor
DefaultRust
NoDestructor
External(ComponentDataFieldVecDestructorType)
AlreadyDestroyed
union enum ComponentDefVecDestructor
DefaultRust
NoDestructor
External(ComponentDefVecDestructorType)
AlreadyDestroyed
fnptr ComponentDefVecDestructorType
arg *mut ComponentDefVec
struct ComponentDefVec has destructor
ptr: ComponentDef
len: usize
cap: usize
destructor: ComponentDefVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn from_item:
arg item: ComponentDef
fn copy_from_ptr:
arg ptr: *const ComponentDef
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
ComponentDefVecCreates a
ComponentDefVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Creates a
ComponentDefVeccontaining a single elementCopies elements from a C array into a
ComponentDefVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
ComponentDefVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
struct ComponentLibraryVec has destructor
ptr: ComponentLibrary
len: usize
cap: usize
destructor: ComponentLibraryVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn from_item:
arg item: ComponentLibrary
fn copy_from_ptr:
arg ptr: *const ComponentLibrary
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
ComponentLibraryVecCreates a
ComponentLibraryVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Creates a
ComponentLibraryVeccontaining a single elementCopies elements from a C array into a
ComponentLibraryVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
ComponentLibraryVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
fnptr ComponentLibraryVecDestructorType
arg *mut ComponentLibraryVec
union enum ComponentLibraryVecDestructor
DefaultRust
NoDestructor
External(ComponentLibraryVecDestructorType)
AlreadyDestroyed
fnptr ComponentDataModelVecDestructorType
arg *mut ComponentDataModelVec
union enum ComponentDataModelVecDestructor
DefaultRust
NoDestructor
External(ComponentDataModelVecDestructorType)
AlreadyDestroyed
struct ComponentDataModelVec has destructor
ptr: ComponentDataModel
len: usize
cap: usize
destructor: ComponentDataModelVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn from_item:
arg item: ComponentDataModel
fn copy_from_ptr:
arg ptr: *const ComponentDataModel
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
ComponentDataModelVecCreates a
ComponentDataModelVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Creates a
ComponentDataModelVeccontaining a single elementCopies elements from a C array into a
ComponentDataModelVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
ComponentDataModelVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
fnptr ComponentEnumModelVecDestructorType
arg *mut ComponentEnumModelVec
union enum ComponentEnumVariantVecDestructor
DefaultRust
NoDestructor
External(ComponentEnumVariantVecDestructorType)
AlreadyDestroyed
struct ComponentEnumModelVec has destructor
ptr: ComponentEnumModel
len: usize
cap: usize
destructor: ComponentEnumModelVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn from_item:
arg item: ComponentEnumModel
fn copy_from_ptr:
arg ptr: *const ComponentEnumModel
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
ComponentEnumModelVecCreates a
ComponentEnumModelVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Creates a
ComponentEnumModelVeccontaining a single elementCopies elements from a C array into a
ComponentEnumModelVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
ComponentEnumModelVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
union enum ComponentEnumModelVecDestructor
DefaultRust
NoDestructor
External(ComponentEnumModelVecDestructorType)
AlreadyDestroyed
fnptr ComponentEnumVariantVecDestructorType
arg *mut ComponentEnumVariantVec
struct ComponentEnumVariantVec has destructor
ptr: ComponentEnumVariant
len: usize
cap: usize
destructor: ComponentEnumVariantVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn from_item:
arg item: ComponentEnumVariant
fn copy_from_ptr:
arg ptr: *const ComponentEnumVariant
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
ComponentEnumVariantVecCreates a
ComponentEnumVariantVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Creates a
ComponentEnumVariantVeccontaining a single elementCopies elements from a C array into a
ComponentEnumVariantVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
ComponentEnumVariantVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
fnptr ComponentCallbackArgVecDestructorType
arg *mut ComponentCallbackArgVec
fnptr ComponentFieldOverrideVecDestructorType
arg *mut ComponentFieldOverrideVec
struct ComponentCallbackArgVec has destructor
ptr: ComponentCallbackArg
len: usize
cap: usize
destructor: ComponentCallbackArgVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn from_item:
arg item: ComponentCallbackArg
fn copy_from_ptr:
arg ptr: *const ComponentCallbackArg
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
ComponentCallbackArgVecCreates a
ComponentCallbackArgVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Creates a
ComponentCallbackArgVeccontaining a single elementCopies elements from a C array into a
ComponentCallbackArgVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
ComponentCallbackArgVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
union enum ComponentFieldOverrideVecDestructor
DefaultRust
NoDestructor
External(ComponentFieldOverrideVecDestructorType)
AlreadyDestroyed
struct ComponentFieldOverrideVec has destructor
len: usize
cap: usize
destructor: ComponentFieldOverrideVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn from_item:
arg item: ComponentFieldOverride
fn copy_from_ptr:
arg ptr: *const ComponentFieldOverride
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
ComponentFieldOverrideVecCreates a
ComponentFieldOverrideVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Creates a
ComponentFieldOverrideVeccontaining a single elementCopies elements from a C array into a
ComponentFieldOverrideVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
ComponentFieldOverrideVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
union enum ComponentCallbackArgVecDestructor
DefaultRust
NoDestructor
External(ComponentCallbackArgVecDestructorType)
AlreadyDestroyed
union enum SvgPathElementVecDestructor
DefaultRust
NoDestructor
External(SvgPathElementVecDestructorType)
AlreadyDestroyed
fnptr SvgPathElementVecDestructorType
arg *mut SvgPathElementVec
struct SvgPathElementVec
ptr: SvgPathElement
len: usize
cap: usize
destructor: SvgPathElementVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn from_item:
arg item: SvgPathElement
fn copy_from_ptr:
arg ptr: *const SvgPathElement
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
SvgPathElementVecCreates a
SvgPathElementVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Creates a
SvgPathElementVeccontaining a single elementCopies elements from a C array into a
SvgPathElementVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
SvgPathElementVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
union enum SvgPathVecDestructor
DefaultRust
NoDestructor
External(SvgPathVecDestructorType)
AlreadyDestroyed
fnptr SvgPathVecDestructorType
arg *mut SvgPathVec
struct SvgPathVec
ptr: SvgPath
len: usize
cap: usize
destructor: SvgPathVecDestructor
fn create:
-> SvgPathVec
fn with_capacity:
arg cap: usize
-> SvgPathVec
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn from_item:
arg item: SvgPath
-> SvgPathVec
fn copy_from_ptr:
arg ptr: *const SvgPath
arg len: usize
-> SvgPathVec
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
SvgPathVecCreates a
SvgPathVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Creates a
SvgPathVeccontaining a single elementCopies elements from a C array into a
SvgPathVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
SvgPathVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
struct RibbonSectionVec has destructor
ptr: RibbonSection
len: usize
cap: usize
destructor: RibbonSectionVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn from_item:
arg item: RibbonSection
fn copy_from_ptr:
arg ptr: *const RibbonSection
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
RibbonSectionVecCreates a
RibbonSectionVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Creates a
RibbonSectionVeccontaining a single elementCopies elements from a C array into a
RibbonSectionVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
RibbonSectionVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
union enum RibbonTabVecDestructor
DefaultRust
NoDestructor
External(RibbonTabVecDestructorType)
AlreadyDestroyed
fnptr RibbonSectionVecDestructorType
arg *mut RibbonSectionVec
struct RibbonTabVec has destructor
ptr: RibbonTab
len: usize
cap: usize
destructor: RibbonTabVecDestructor
fn create:
-> RibbonTabVec
fn with_capacity:
arg cap: usize
-> RibbonTabVec
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn from_item:
arg item: RibbonTab
-> RibbonTabVec
fn copy_from_ptr:
arg ptr: *const RibbonTab
arg len: usize
-> RibbonTabVec
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
RibbonTabVecCreates a
RibbonTabVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Creates a
RibbonTabVeccontaining a single elementCopies elements from a C array into a
RibbonTabVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
RibbonTabVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
fnptr RibbonTabVecDestructorType
arg *mut RibbonTabVec
union enum RibbonSectionVecDestructor
DefaultRust
NoDestructor
External(RibbonSectionVecDestructorType)
AlreadyDestroyed
struct TreeViewNodeVec has destructor
ptr: TreeViewNode
len: usize
cap: usize
destructor: TreeViewNodeVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn from_item:
arg item: TreeViewNode
fn copy_from_ptr:
arg ptr: *const TreeViewNode
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
TreeViewNodeVecCreates a
TreeViewNodeVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Creates a
TreeViewNodeVeccontaining a single elementCopies elements from a C array into a
TreeViewNodeVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
TreeViewNodeVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
fnptr TreeViewNodeVecDestructorType
arg *mut TreeViewNodeVec
union enum TreeViewNodeVecDestructor
DefaultRust
NoDestructor
External(TreeViewNodeVecDestructorType)
AlreadyDestroyed
fnptr RouteVecDestructorType
arg *mut RouteVec
struct RouteVec has destructor
ptr: Route
len: usize
cap: usize
destructor: RouteVecDestructor
fn create:
-> RouteVec
fn with_capacity:
arg cap: usize
-> RouteVec
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn from_item:
fn copy_from_ptr:
fn c_get:
&self
arg index: usize
-> OptionRoute
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
RouteVecCreates a
RouteVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Creates a
RouteVeccontaining a single elementCopies elements from a C array into a
RouteVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
RouteVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
union enum RouteVecDestructor
DefaultRust
NoDestructor
External(RouteVecDestructorType)
AlreadyDestroyed
fnptr TouchPointVecDestructorType
arg *mut TouchPointVec
union enum TouchPointVecDestructor
DefaultRust
NoDestructor
External(TouchPointVecDestructorType)
AlreadyDestroyed
struct TouchPointVec
ptr: TouchPoint
len: usize
cap: usize
destructor: TouchPointVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn from_item:
arg item: TouchPoint
fn copy_from_ptr:
arg ptr: *const TouchPoint
arg len: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
TouchPointVecCreates a
TouchPointVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Creates a
TouchPointVeccontaining a single elementCopies elements from a C array into a
TouchPointVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
TouchPointVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
fnptr LayoutRectVecDestructorType
arg *mut LayoutRectVec
union enum LayoutRectVecDestructor
DefaultRust
NoDestructor
External(LayoutRectVecDestructorType)
AlreadyDestroyed
Wrapper over a Rust-allocated
Vec<LayoutRect>struct LayoutRectVec has destructor
ptr: LayoutRect
len: usize
cap: usize
destructor: LayoutRectVecDestructor
constructor create:
constructor with_capacity:
arg cap: usize
constructor from_item:
arg item: LayoutRect
constructor copy_from_ptr:
arg ptr: *const LayoutRect
arg len: usize
Creates an empty
LayoutRectVecCreates a
LayoutRectVecwith a given capacityCreates a
LayoutRectVeccontaining a single elementCopies elements from a C array into a
LayoutRectVec. The array must be valid forlenelements.fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn get:
&self
arg index: usize
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Returns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a reference to the element at the given index, or None if out of bounds
Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
LayoutRectVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
fnptr DbValueVecDestructorType
arg *mut DbValueVec
union enum DbValueVecDestructor
DefaultRust
NoDestructor
External(DbValueVecDestructorType)
AlreadyDestroyed
struct DbValueVec has destructor
ptr: DbValue
len: usize
cap: usize
destructor: DbValueVecDestructor
fn create:
-> DbValueVec
fn with_capacity:
arg cap: usize
-> DbValueVec
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn from_item:
arg item: DbValue
-> DbValueVec
fn copy_from_ptr:
arg ptr: *const DbValue
arg len: usize
-> DbValueVec
fn c_get:
&self
arg index: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
DbValueVecCreates a
DbValueVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Creates a
DbValueVeccontaining a single elementCopies elements from a C array into a
DbValueVec. The array must be valid forlenelements.Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Returns a C-compatible slice of the entire Vec as a
DbValueVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
struct LoadedFontVec has destructor
ptr: LoadedFont
len: usize
cap: usize
destructor: LoadedFontVecDestructor
fn create:
fn with_capacity:
arg cap: usize
fn len:
&self
-> usize
fn capacity:
&self
-> usize
fn is_empty:
&self
-> bool
fn c_get:
&self
arg index: usize
fn from_item:
arg item: LoadedFont
fn copy_from_ptr:
arg ptr: *const LoadedFont
arg len: usize
fn as_c_slice:
&self
fn as_c_slice_range:
&self
arg start: usize
arg end: usize
Creates an empty
LoadedFontVecCreates a
LoadedFontVecwith a given capacityReturns the number of elements in the Vec
Returns the capacity of the Vec
Returns whether the Vec is empty
Returns a copy of the element at the given index, or None if out of bounds. C-API compatible.
Creates a
LoadedFontVeccontaining a single elementCopies elements from a C array into a
LoadedFontVec. The array must be valid forlenelements.Returns a C-compatible slice of the entire Vec as a
LoadedFontVecSlice.Returns a C-compatible slice of a range within the Vec. Range is clamped to valid bounds.
fnptr LoadedFontVecDestructorType
arg *mut LoadedFontVec
union enum LoadedFontVecDestructor
DefaultRust
NoDestructor
External(LoadedFontVecDestructorType)
AlreadyDestroyed
Definition of azuls internal
Option<*>wrappersmod option:
union enum OptionScrollState
None
Some(ScrollState)
union enum OptionListViewOnRowClick
None
Some(ListViewOnRowClick)
union enum OptionListViewOnColumnClick
None
Some(ListViewOnColumnClick)
union enum OptionListViewOnLazyLoadScroll
None
Some(ListViewOnLazyLoadScroll)
union enum OptionMenu has destructor
None
Some(Menu)
union enum OptionPixelValueNoPercent
None
Some(PixelValueNoPercent)
union enum OptionPixelValue
None
Some(PixelValue)
union enum OptionColorInputOnValueChange
None
Some(ColorInputOnValueChange)
union enum OptionButtonOnClick
None
Some(ButtonOnClick)
union enum OptionTabOnClick
None
Some(TabOnClick)
union enum OptionFileInputOnPathChange
None
Some(FileInputOnPathChange)
union enum OptionCheckBoxOnToggle
None
Some(CheckBoxOnToggle)
union enum OptionDropDownOnChoiceChange
None
Some(DropDownOnChoiceChange)
union enum OptionTextInputOnTextInput
None
Some(TextInputOnTextInput)
union enum OptionTextInputOnVirtualKeyDown
None
union enum OptionTextInputOnFocusLost
None
Some(TextInputOnFocusLost)
union enum OptionTextInputSelection
None
Some(TextInputSelection)
union enum OptionNumberInputOnFocusLost
None
Some(NumberInputOnFocusLost)
union enum OptionNumberInputOnValueChange
None
Some(NumberInputOnValueChange)
union enum OptionMenuItemIcon has destructor
None
Some(MenuItemIcon)
union enum OptionVirtualKeyCodeCombo has destructor
None
Some(VirtualKeyCodeCombo)
union enum OptionTimerId
None
Some(TimerId)
union enum OptionTimer
None
Some(Timer)
union enum OptionThread
None
Some(Thread)
union enum OptionI16
None
Some(i16)
union enum OptionU16
None
Some(u16)
union enum OptionU32
None
Some(u32)
union enum OptionImageRef has destructor
None
Some(ImageRef)
union enum OptionFontRef has destructor
None
Some(FontRef)
union enum OptionRefAny
None
Some(RefAny)
union enum OptionLayoutSize
None
Some(LayoutSize)
union enum OptionLayoutRect
None
Some(LayoutRect)
union enum OptionDomNodeId
None
Some(DomNodeId)
union enum OptionColorU
None
Some(ColorU)
union enum OptionRawImage has destructor
None
Some(RawImage)
union enum OptionTabIndex
None
Some(TabIndex)
union enum OptionDuration
None
Some(Duration)
union enum OptionUsize
None
Some(usize)
union enum OptionCoreMenuCallback
None
Some(CoreMenuCallback)
struct SvgParseOptions has destructor
relative_image_path: OptionString
default_font_family: String
languages: StringVec
dpi: f32
font_size: f32
shape_rendering: ShapeRendering
text_rendering: TextRendering
image_rendering: ImageRendering
fontdb: FontDatabase
keep_named_groups: bool
struct SvgRenderOptions
target_size: OptionLayoutSize
background_color: OptionColorU
fit: SvgFitTo
transform: SvgRenderTransform
union enum OptionLogicalPosition
None
Some(LogicalPosition)
union enum OptionScreenPosition
None
Some(ScreenPosition)
union enum OptionCursorNodePosition
None
Some(CursorNodePosition)
union enum OptionDragDelta
None
Some(DragDelta)
union enum OptionString has destructor
None
Some(String)
union enum OptionF32
None
Some(f32)
union enum OptionF64
None
Some(f64)
union enum OptionBool
None
Some(bool)
union enum OptionI64
None
Some(i64)
union enum OptionWaylandTheme has destructor
None
Some(WaylandTheme)
union enum OptionMouseCursorType
None
Some(MouseCursorType)
union enum OptionWindowIcon has destructor
None
Some(WindowIcon)
union enum OptionCallback
None
Some(Callback)
union enum OptionTaskBarIcon has destructor
None
Some(TaskBarIcon)
union enum OptionHwndHandle
None
Some(HwndHandle)
union enum OptionLinuxDecorationsState
None
Some(LinuxDecorationsState)
union enum OptionI32
None
Some(i32)
union enum OptionLogicalSize
None
Some(LogicalSize)
union enum OptionLogicalRect
None
Some(LogicalRect)
union enum OptionVirtualKeyCode
None
Some(VirtualKeyCode)
union enum OptionX11Visual
None
Some(X11Visual)
union enum OptionRendererOptions
None
Some(RendererOptions)
union enum OptionWindowTheme
None
Some(WindowTheme)
union enum OptionInstant
None
Some(Instant)
union enum OptionAccessibilityRole
None
Some(AccessibilityRole)
union enum OptionGlContextPtr has destructor
None
Some(GlContextPtr)
union enum OptionSelectionRange
None
Some(SelectionRange)
union enum OptionKeyboardState has destructor
None
Some(KeyboardState)
union enum OptionMouseState
None
Some(MouseState)
union enum OptionSelectionState
None
Some(SelectionState)
union enum OptionThreadSendMsg
None
Some(ThreadSendMsg)
union enum OptionCssProperty
None
Some(CssProperty)
union enum OptionTextCursor
None
Some(TextCursor)
union enum OptionU64
None
Some(u64)
union enum OptionWindowFlags
None
Some(WindowFlags)
union enum OptionCoreImageCallback
None
Some(CoreImageCallback)
union enum OptionPenTilt
None
Some(PenTilt)
union enum OptionGestureDirection
None
Some(GestureDirection)
union enum OptionDetectedPinch
None
Some(DetectedPinch)
union enum OptionDetectedRotation
None
Some(DetectedRotation)
union enum OptionDetectedLongPress
None
Some(DetectedLongPress)
union enum OptionSelectAllResult has destructor
None
Some(SelectAllResult)
union enum OptionDeleteResult has destructor
None
Some(DeleteResult)
union enum OptionDragState has destructor
None
Some(DragState)
union enum OptionPenState
None
Some(PenState)
union enum OptionUndoableOperation has destructor
None
Some(UndoableOperation)
union enum OptionClipboardContent has destructor
None
Some(ClipboardContent)
union enum OptionFilePath has destructor
None
Some(FilePath)
union enum OptionJson has destructor
None
Some(Json)
struct IconStyleOptions
prefer_grayscale: bool
tint_color: OptionColorU
inherit_text_color: bool
union enum OptionDatasetMergeCallback
None
Some(DatasetMergeCallback)
struct ScrollIntoViewOptions
block: ScrollLogicalPosition
inline_axis: ScrollLogicalPosition
behavior: ScrollIntoViewBehavior
constructor nearest:
constructor center:
constructor start:
constructor end:
Create options with "nearest" alignment for both axes
Create options with "center" alignment for both axes
Create options with "start" alignment for both axes
Create options to align the end of the target with the end of the viewport
fn with_instant:
self
fn with_smooth:
self
Set instant scroll behavior
Set smooth scroll behavior
union enum OptionPendingTextEdit has destructor
None
Some(PendingTextEdit)
union enum OptionMimeTypeHint has destructor
None
Some(MimeTypeHint)
union enum OptionThreadId
None
Some(ThreadId)
union enum OptionDom has destructor
None
Some(Dom)
union enum OptionAccessibilityAction has destructor
None
Some(AccessibilityAction)
union enum OptionDomId
None
Some(DomId)
union enum OptionExternalResource has destructor
None
Some(ExternalResource)
union enum OptionAccessibilityState
None
Some(AccessibilityState)
union enum OptionTagIdToNodeIdMapping
None
Some(TagIdToNodeIdMapping)
union enum OptionDirEntry has destructor
None
Some(DirEntry)
union enum OptionNamedFont has destructor
None
Some(NamedFont)
union enum OptionStyleFilter
None
Some(StyleFilter)
union enum OptionSvgVertex
None
Some(SvgVertex)
union enum OptionCascadeInfo
None
Some(CascadeInfo)
union enum OptionStyledNode
None
Some(StyledNode)
union enum OptionStyleTransform
None
Some(StyleTransform)
union enum OptionStyleBackgroundPosition
None
Some(StyleBackgroundPosition)
union enum OptionFmtArg has destructor
None
Some(FmtArg)
union enum OptionCssDeclaration has destructor
None
Some(CssDeclaration)
union enum OptionMonitor has destructor
None
Some(Monitor)
union enum OptionJsonKeyValue has destructor
None
Some(JsonKeyValue)
union enum OptionNormalizedRadialColorStop
None
union enum OptionHttpHeader has destructor
None
Some(HttpHeader)
union enum OptionNodeHierarchyItem
None
Some(NodeHierarchyItem)
union enum OptionCssRuleBlock has destructor
None
Some(CssRuleBlock)
union enum OptionCss has destructor
None
Some(Css)
union enum OptionCoreCallbackData
None
Some(CoreCallbackData)
union enum OptionNormalizedLinearColorStop
None
union enum OptionXmlNodeChild has destructor
None
Some(XmlNodeChild)
union enum OptionStyleBackgroundContent has destructor
None
Some(StyleBackgroundContent)
union enum OptionVertexAttribute has destructor
None
Some(VertexAttribute)
union enum OptionMenuItem has destructor
None
Some(MenuItem)
union enum OptionDebugMessage has destructor
None
Some(DebugMessage)
union enum OptionListViewRow has destructor
None
Some(ListViewRow)
union enum OptionCssPathSelector has destructor
None
Some(CssPathSelector)
union enum OptionParentWithNodeDepth
None
Some(ParentWithNodeDepth)
union enum OptionNodeData has destructor
None
Some(NodeData)
union enum OptionStyleBackgroundSize
None
Some(StyleBackgroundSize)
union enum OptionStyledTextRun has destructor
None
Some(StyledTextRun)
union enum OptionSelection
None
Some(Selection)
union enum OptionCssPropertyWithConditions has destructor
None
union enum OptionContentGroup
None
Some(ContentGroup)
union enum OptionVideoMode
None
Some(VideoMode)
union enum OptionXWindowType
None
Some(XWindowType)
union enum OptionIdOrClass has destructor
None
Some(IdOrClass)
union enum OptionStyleBackgroundRepeat
None
Some(StyleBackgroundRepeat)
union enum OptionGridTrackSizing
None
Some(GridTrackSizing)
union enum OptionShapePoint
None
Some(ShapePoint)
union enum OptionStyleFontFamily has destructor
None
Some(StyleFontFamily)
union enum OptionDynamicSelector has destructor
None
Some(DynamicSelector)
union enum OptionStringVec has destructor
None
Some(StringVec)
union enum OptionU8VecRef
None
Some(U8VecRef)
union enum OptionJsonVec has destructor
None
Some(JsonVec)
union enum OptionJsonKeyValueVec has destructor
None
Some(JsonKeyValueVec)
union enum OptionAttributeType has destructor
None
Some(AttributeType)
union enum OptionNodeHierarchyItemId
No value
None
Some value of type NodeHierarchyItemId
Some(NodeHierarchyItemId)
union enum OptionStringPair has destructor
No value
None
Some value of type StringPair
Some(StringPair)
union enum OptionMimeTypeData has destructor
No value
None
Some value of type MimeTypeData
Some(MimeTypeData)
union enum OptionU8
No value
None
Some value of type u8
Some(u8)
union enum OptionLinuxDesktopEnv
None
Some(LinuxDesktopEnv)
union enum OptionCssMockEnvironment has destructor
None
Some(CssMockEnvironment)
union enum OptionOsVersion
None
Some(OsVersion)
union enum OptionOsCondition
None
Some(OsCondition)
union enum OptionThemeCondition has destructor
None
Some(ThemeCondition)
union enum OptionCalcAstItem
No value
None
Some value of type CalcAstItem
Some(CalcAstItem)
union enum OptionGridAreaDefinition has destructor
No value
None
Some value of type GridAreaDefinition
Some(GridAreaDefinition)
union enum OptionComponentDef has destructor
No value
None
Some value of type ComponentDef
Some(ComponentDef)
union enum OptionComponentLibrary has destructor
No value
None
Some value of type ComponentLibrary
Some(ComponentLibrary)
union enum OptionComponentDataField has destructor
No value
None
Some value of type ComponentDataField
Some(ComponentDataField)
union enum OptionComponentDataModel has destructor
No value
None
Some value of type ComponentDataModel
Some(ComponentDataModel)
union enum OptionComponentEnumModel has destructor
No value
None
Some value of type ComponentEnumModel
Some(ComponentEnumModel)
union enum OptionComponentEnumVariant has destructor
No value
None
Some value of type ComponentEnumVariant
Some(ComponentEnumVariant)
union enum OptionComponentDefaultValue has destructor
None
Some(ComponentDefaultValue)
union enum OptionComponentFieldOverride has destructor
No value
None
Some value of type ComponentFieldOverride
Some(ComponentFieldOverride)
union enum OptionComponentCallbackArg has destructor
No value
None
Some value of type ComponentCallbackArg
Some(ComponentCallbackArg)
union enum OptionSvgDashPattern
None
Some(SvgDashPattern)
union enum OptionSvgPoint
None
Some(SvgPoint)
union enum OptionSvgPath
None
Some(SvgPath)
union enum OptionSvgPathElement
No value
None
Some value of type SvgPathElement
Some(SvgPathElement)
union enum OptionRibbonOnTabClick
None
Some(RibbonOnTabClick)
union enum OptionTreeViewOnNodeClick
None
Some(TreeViewOnNodeClick)
union enum OptionRibbonTab has destructor
No value
None
Some value of type RibbonTab
Some(RibbonTab)
union enum OptionTreeViewNode has destructor
None
Some(TreeViewNode)
union enum OptionRibbonSection has destructor
No value
None
Some value of type RibbonSection
Some(RibbonSection)
union enum OptionRoute has destructor
None
Some(Route)
union enum OptionRouteMatch has destructor
None
Some(RouteMatch)
union enum OptionTouchPoint
No value
None
Some value of type TouchPoint
Some(TouchPoint)
union enum OptionFileTypeList has destructor
None
Some(FileTypeList)
union enum OptionLocationFix
None
Some(LocationFix)
union enum OptionBiometricResult
None
Some(BiometricResult)
union enum OptionKeyringResult has destructor
None
Some(KeyringResult)
union enum OptionDbValue has destructor
No value
None
Some value of type DbValue
Some(DbValue)
union enum OptionSensorReading
None
Some(SensorReading)
union enum OptionGamepadState
None
Some(GamepadState)
union enum OptionWacomPadState
None
Some(WacomPadState)
union enum OptionOnVideoFrame
None
Some(OnVideoFrame)
union enum OptionMapViewportChanged
None
Some(MapViewportChanged)
union enum OptionMapPinTap
None
Some(MapPinTap)
union enum OptionOnAudioFrame
None
Some(OnAudioFrame)
union enum OptionU8Vec has destructor
None
Some(U8Vec)
union enum OptionVideoFrame has destructor
None
Some(VideoFrame)
union enum OptionLoadedFont has destructor
None
Some(LoadedFont)
Definition of error and
Result<T, E>typesmod error:
union enum ResultXmlXmlError has destructor
Ok(Xml)
Err(XmlError)
union enum ResultSvgSvgParseError has destructor
Ok(Svg)
Err(SvgParseError)
union enum SvgParseError has destructor
NoParserAvailable
ElementsLimitReached
NotAnUtf8Str
MalformedGZip
InvalidSize
ParsingFailed(XmlError)
union enum XmlError has destructor
NoParserAvailable
InvalidXmlPrefixUri(XmlTextPos)
UnexpectedXmlUri(XmlTextPos)
UnexpectedXmlnsUri(XmlTextPos)
InvalidElementNamePrefix(XmlTextPos)
DuplicatedNamespace(DuplicatedNamespaceError)
UnknownNamespace(UnknownNamespaceError)
UnexpectedCloseTag(UnexpectedCloseTagError)
UnexpectedEntityCloseTag(XmlTextPos)
UnknownEntityReference(UnknownEntityReferenceError)
MalformedEntityReference(XmlTextPos)
EntityReferenceLoop(XmlTextPos)
InvalidAttributeValue(XmlTextPos)
DuplicatedAttribute(DuplicatedAttributeError)
NoRootNode
SizeLimit
DtdDetected
Invalid hierarchy close tags, i.e
<app></p></app>MalformedHierarchy(MalformedHierarchyError)
ParserError(XmlParseError)
UnclosedRootNode
UnexpectedDeclaration(XmlTextPos)
NodesLimitReached
AttributesLimitReached
NamespacesLimitReached
InvalidName(XmlTextPos)
NonXmlChar(XmlTextPos)
InvalidChar(XmlTextPos)
InvalidChar2(XmlTextPos)
InvalidString(XmlTextPos)
InvalidExternalID(XmlTextPos)
InvalidComment(XmlTextPos)
InvalidCharacterData(XmlTextPos)
UnknownToken(XmlTextPos)
UnexpectedEndOfStream
struct DuplicatedNamespaceError has destructor
ns: String
pos: XmlTextPos
struct UnknownNamespaceError has destructor
ns: String
pos: XmlTextPos
struct UnexpectedCloseTagError has destructor
expected: String
actual: String
pos: XmlTextPos
struct UnknownEntityReferenceError has destructor
entity: String
pos: XmlTextPos
struct DuplicatedAttributeError has destructor
attribute: String
pos: XmlTextPos
union enum XmlParseError has destructor
InvalidDeclaration(XmlTextError)
InvalidComment(XmlTextError)
InvalidPI(XmlTextError)
InvalidDoctype(XmlTextError)
InvalidEntity(XmlTextError)
InvalidElement(XmlTextError)
InvalidAttribute(XmlTextError)
InvalidCdata(XmlTextError)
InvalidCharData(XmlTextError)
UnknownToken(XmlTextPos)
struct XmlTextError has destructor
stream_error: XmlStreamError
pos: XmlTextPos
union enum XmlStreamError has destructor
UnexpectedEndOfStream
InvalidName
NonXmlChar(NonXmlCharError)
InvalidChar(InvalidCharError)
InvalidCharMultiple(InvalidCharMultipleError)
InvalidQuote(InvalidQuoteError)
InvalidSpace(InvalidSpaceError)
InvalidString(InvalidStringError)
InvalidReference
InvalidExternalID
InvalidCommentData
InvalidCommentEnd
InvalidCharacterData
struct NonXmlCharError
ch: u32
pos: XmlTextPos
struct InvalidCharError
expected: u8
got: u8
pos: XmlTextPos
struct InvalidCharMultipleError has destructor
expected: u8
got: U8Vec
pos: XmlTextPos
struct InvalidQuoteError
got: u8
pos: XmlTextPos
struct InvalidSpaceError
got: u8
pos: XmlTextPos
struct InvalidStringError has destructor
got: String
pos: XmlTextPos
struct MalformedHierarchyError has destructor
expected: String
got: String
enum EncodeImageError
EncoderNotAvailable
InsufficientMemory
DimensionError
InvalidData
Unknown
union enum ResultRawImageDecodeImageError has destructor
Ok(RawImage)
Err(DecodeImageError)
enum DecodeImageError
InsufficientMemory
DimensionError
UnsupportedImageFormat
Unknown
union enum ResultU8VecEncodeImageError has destructor
Ok(U8Vec)
Err(EncodeImageError)
union enum ResultRefAnyString has destructor
Ok(RefAny)
Err(String)
union enum ResultU8VecString has destructor
Ok(U8Vec)
Err(String)
union enum ResultVoidString has destructor
Ok
Err(String)
union enum ResultStringString has destructor
Ok(String)
Err(String)
union enum ResultParsedSvgSvgParseError has destructor
Ok(ParsedSvg)
Err(SvgParseError)
struct SelectAllResult has destructor
full_text: String
selection_range: SelectionRange
struct DeleteResult has destructor
range_to_delete: SelectionRange
deleted_text: String
union enum IcuResult has destructor
Ok(String)
Err(IcuError)
struct IcuError has destructor
message: String
struct FluentZipLoadResult has destructor
files_loaded: usize
files_failed: usize
errors: StringVec
union enum FluentSyntaxCheckResult has destructor
Ok
Errors(StringVec)
constructor checkSyntax:
arg source: String
constructor checkSyntaxBytes:
arg data: U8VecRef
Check the syntax of a Fluent (FTL) string.
Returns Ok if valid, or Errors with a list of error strings. Each error string has the format 'line:column: message'.Check the syntax of a Fluent (FTL) file from bytes.
Returns Ok if valid, or Errors with a list of error strings.fn getErrors:
&self
Get the error strings if this is an Errors result.
Returns None if this is Ok.struct HttpResponseTooLargeError
max_size: u64
actual_size: u64
union enum HttpError has destructor
InvalidUrl(String)
ConnectionFailed(String)
Timeout
TlsError(String)
HttpStatus(HttpStatusError)
IoError(String)
ResponseTooLarge(HttpResponseTooLargeError)
Other(String)
constructor invalid_url:
constructor connection_failed:
constructor tls_error:
constructor http_status:
constructor io_error:
constructor response_too_large:
arg max_size: u64
arg actual_size: u64
-> HttpError
constructor other:
struct HttpStatusError has destructor
status_code: u16
message: String
struct FileError has destructor
message: String
kind: FileErrorKind
enum FileErrorKind
NotFound
PermissionDenied
AlreadyExists
InvalidPath
IoError
DirectoryNotEmpty
IsDirectory
IsFile
Other
union enum ResultEmptyStructFileError has destructor
Ok(EmptyStruct)
Err(FileError)
union enum ResultHttpResponseHttpError has destructor
Ok(HttpResponse)
Err(HttpError)
union enum ResultU8VecHttpError has destructor
Ok(U8Vec)
Err(HttpError)
union enum Resultu64FileError has destructor
Ok(u64)
Err(FileError)
union enum ResultU8VecFileError has destructor
Ok(U8Vec)
Err(FileError)
union enum ResultFileMetadataFileError has destructor
Ok(FileMetadata)
Err(FileError)
union enum ResultStringFileError has destructor
Ok(String)
Err(FileError)
union enum ResultDirEntryVecFileError has destructor
Ok(DirEntryVec)
Err(FileError)
union enum ResultFilePathFileError has destructor
Ok(FilePath)
Err(FileError)
struct JsonParseError has destructor
message: String
line: u32
column: u32
union enum ResultJsonJsonParseError has destructor
Ok(Json)
Err(JsonParseError)
union enum ResultUrlUrlParseError has destructor
Ok(Url)
Err(UrlParseError)
struct UrlParseError has destructor
message: String
union enum RenderDomError has destructor
Component(ComponentError)
CssError(CssParseErrorOwned)
union enum DomXmlParseError has destructor
NoHtmlNode
MultipleHtmlRootNodes
NoBodyInHtml
MultipleBodyNodes
Xml(XmlError)
MalformedHierarchy(MalformedHierarchyError)
RenderDom(RenderDomError)
Component(ComponentParseError)
Css(CssParseErrorOwned)
struct ErrorLocation
original_pos: usize
struct PixelNoValueGivenError has destructor
value: String
metric: SizeMetric
struct VarOnShorthandPropertyError has destructor
value: String
union enum PercentageParseError has destructor
ValueParseErr(ParseFloatError)
NoPercentSign
InvalidUnit(String)
struct WrongComponentCountError has destructor
expected: usize
got: usize
input: String
struct AngleNoValueGivenError has destructor
value: String
metric: AngleMetric
struct WhiteSpaceInComponentNameError has destructor
arg_pos: usize
arg_name: String
union enum CompileError has destructor
Dom(RenderDomError)
Xml(DomXmlParseError)
Css(CssParseErrorOwned)
struct WhiteSpaceInComponentTypeError has destructor
arg_pos: usize
arg_name: String
arg_type: String
struct UnknownPropertyKeyError has destructor
key: String
value: String
struct UselessFunctionArgumentError has destructor
component_name: String
argument_name: String
valid_args: StringVec
union enum ComponentError has destructor
UselessFunctionArgument(UselessFunctionArgumentError)
UnknownComponent(String)
struct UnknownSelectorError has destructor
selector: String
suggestion: OptionString
union enum StyleLineHeightParseError has destructor
Percentage(PercentageParseError)
union enum ComponentParseError has destructor
NotAComponent
UnnamedComponent
MissingName(usize)
MissingType(MissingTypeError)
WhiteSpaceInComponentName(WhiteSpaceInComponentNameError)
WhiteSpaceInComponentType(WhiteSpaceInComponentTypeError)
CssError(CssParseErrorOwned)
struct MissingTypeError has destructor
arg_pos: usize
arg_name: String
union enum CssParsingErrorOwned has destructor
Border(CssBorderParseErrorOwned)
BorderRadius(CssStyleBorderRadiusParseErrorOwned)
Padding(LayoutPaddingParseErrorOwned)
Margin(LayoutMarginParseErrorOwned)
Overflow(InvalidValueErrOwned)
BoxShadow(CssShadowParseErrorOwned)
Color(CssColorParseErrorOwned)
PixelValue(CssPixelValueParseErrorOwned)
Percentage(PercentageParseError)
FontFamily(CssStyleFontFamilyParseErrorOwned)
InvalidValue(InvalidValueErrOwned)
FlexGrow(FlexGrowParseErrorOwned)
FlexShrink(FlexShrinkParseErrorOwned)
Background(CssBackgroundParseErrorOwned)
BackgroundPosition(CssBackgroundPositionParseErrorOwned)
Opacity(OpacityParseErrorOwned)
Visibility(StyleVisibilityParseErrorOwned)
LayoutScrollbarWidth(LayoutScrollbarWidthParseErrorOwned)
StyleScrollbarColor(StyleScrollbarColorParseErrorOwned)
ScrollbarVisibilityMode(ScrollbarVisibilityModeParseErrorOwned)
ScrollbarFadeDelay(ScrollbarFadeDelayParseErrorOwned)
ScrollbarFadeDuration(ScrollbarFadeDurationParseErrorOwned)
Transform(CssStyleTransformParseErrorOwned)
TransformOrigin(CssStyleTransformOriginParseErrorOwned)
PerspectiveOrigin(CssStylePerspectiveOriginParseErrorOwned)
Filter(CssStyleFilterParseErrorOwned)
TextColor(StyleTextColorParseErrorOwned)
FontSize(CssStyleFontSizeParseErrorOwned)
FontWeight(CssFontWeightParseErrorOwned)
FontStyle(CssFontStyleParseErrorOwned)
TextAlign(StyleTextAlignParseErrorOwned)
TextJustify(TextJustifyParseErrorOwned)
VerticalAlign(StyleVerticalAlignParseErrorOwned)
LetterSpacing(StyleLetterSpacingParseErrorOwned)
TextIndent(StyleTextIndentParseErrorOwned)
InitialLetter(StyleInitialLetterParseErrorOwned)
LineClamp(StyleLineClampParseErrorOwned)
HangingPunctuation(StyleHangingPunctuationParseErrorOwned)
TextCombineUpright(StyleTextCombineUprightParseErrorOwned)
UnicodeBidi(StyleUnicodeBidiParseErrorOwned)
TextBoxTrim(StyleTextBoxTrimParseErrorOwned)
TextBoxEdge(StyleTextBoxEdgeParseErrorOwned)
DominantBaseline(StyleDominantBaselineParseErrorOwned)
AlignmentBaseline(StyleAlignmentBaselineParseErrorOwned)
InitialLetterAlign(StyleInitialLetterAlignParseErrorOwned)
InitialLetterWrap(StyleInitialLetterWrapParseErrorOwned)
ScrollbarGutter(StyleScrollbarGutterParseErrorOwned)
OverflowClipMargin(StyleOverflowClipMarginParseErrorOwned)
Clip(StyleClipRectParseErrorOwned)
ExclusionMargin(StyleExclusionMarginParseErrorOwned)
HyphenationLanguage(StyleHyphenationLanguageParseErrorOwned)
LineHeight(StyleLineHeightParseError)
WordSpacing(StyleWordSpacingParseErrorOwned)
TabSize(StyleTabSizeParseErrorOwned)
WhiteSpace(StyleWhiteSpaceParseErrorOwned)
Hyphens(StyleHyphensParseErrorOwned)
WordBreak(StyleWordBreakParseErrorOwned)
OverflowWrap(StyleOverflowWrapParseErrorOwned)
LineBreak(StyleLineBreakParseErrorOwned)
ObjectFit(StyleObjectFitParseErrorOwned)
ObjectPosition(StyleObjectPositionParseErrorOwned)
AspectRatio(StyleAspectRatioParseErrorOwned)
TextOrientation(StyleTextOrientationParseErrorOwned)
TextAlignLast(StyleTextAlignLastParseErrorOwned)
Direction(StyleDirectionParseErrorOwned)
UserSelect(StyleUserSelectParseErrorOwned)
TextDecoration(StyleTextDecorationParseErrorOwned)
Cursor(CursorParseErrorOwned)
CaretColor(CssColorParseErrorOwned)
CaretAnimationDuration(DurationParseErrorOwned)
CaretWidth(CssPixelValueParseErrorOwned)
SelectionBackgroundColor(CssColorParseErrorOwned)
SelectionColor(CssColorParseErrorOwned)
SelectionRadius(CssPixelValueParseErrorOwned)
LayoutDisplay(LayoutDisplayParseErrorOwned)
LayoutFloat(LayoutFloatParseErrorOwned)
LayoutBoxSizing(LayoutBoxSizingParseErrorOwned)
LayoutWidth(LayoutWidthParseErrorOwned)
LayoutHeight(LayoutHeightParseErrorOwned)
LayoutMinWidth(LayoutMinWidthParseErrorOwned)
LayoutMinHeight(LayoutMinHeightParseErrorOwned)
LayoutMaxWidth(LayoutMaxWidthParseErrorOwned)
LayoutMaxHeight(LayoutMaxHeightParseErrorOwned)
LayoutPosition(LayoutPositionParseErrorOwned)
LayoutTop(LayoutTopParseErrorOwned)
LayoutRight(LayoutRightParseErrorOwned)
LayoutLeft(LayoutLeftParseErrorOwned)
LayoutInsetBottom(LayoutInsetBottomParseErrorOwned)
LayoutZIndex(LayoutZIndexParseErrorOwned)
FlexWrap(FlexWrapParseErrorOwned)
FlexDirection(FlexDirectionParseErrorOwned)
FlexBasis(FlexBasisParseErrorOwned)
JustifyContent(JustifyContentParseErrorOwned)
AlignItems(AlignItemsParseErrorOwned)
AlignContent(AlignContentParseErrorOwned)
Grid(GridParseErrorOwned)
GridAutoFlow(GridAutoFlowParseErrorOwned)
JustifySelf(JustifySelfParseErrorOwned)
JustifyItems(JustifyItemsParseErrorOwned)
AlignSelf(AlignSelfParseErrorOwned)
LayoutWritingMode(LayoutWritingModeParseErrorOwned)
LayoutClear(LayoutClearParseErrorOwned)
LayoutOverflow(LayoutOverflowParseErrorOwned)
BorderTopLeftRadius(StyleBorderTopLeftRadiusParseErrorOwned)
BorderTopRightRadius(StyleBorderTopRightRadiusParseErrorOwned)
BorderBottomLeftRadius(StyleBorderBottomLeftRadiusParseErrorOwned)
BorderBottomRightRadius(StyleBorderBottomRightRadiusParseErrorOwned)
BorderStyle(CssBorderStyleParseErrorOwned)
BackfaceVisibility(CssBackfaceVisibilityParseErrorOwned)
MixBlendMode(MixBlendModeParseErrorOwned)
PageBreak(PageBreakParseErrorOwned)
BreakInside(BreakInsideParseErrorOwned)
Widows(WidowsParseErrorOwned)
Orphans(OrphansParseErrorOwned)
BoxDecorationBreak(BoxDecorationBreakParseErrorOwned)
ColumnCount(ColumnCountParseErrorOwned)
ColumnWidth(ColumnWidthParseErrorOwned)
ColumnSpan(ColumnSpanParseErrorOwned)
ColumnFill(ColumnFillParseErrorOwned)
ColumnRuleWidth(ColumnRuleWidthParseErrorOwned)
ColumnRuleStyle(ColumnRuleStyleParseErrorOwned)
ColumnRuleColor(ColumnRuleColorParseErrorOwned)
FlowInto(FlowIntoParseErrorOwned)
FlowFrom(FlowFromParseErrorOwned)
GenericParseError
Content
Counter
ListStyleType(StyleListStyleTypeParseErrorOwned)
ListStylePosition(StyleListStylePositionParseErrorOwned)
StringSet
enum ParseFloatError
Empty
Invalid
enum ParseIntError
Empty
InvalidDigit
PosOverflow
NegOverflow
Zero
struct CssSyntaxErrorPos
row: usize
col: usize
union enum CssSyntaxError
UnexpectedEndOfStream(CssSyntaxErrorPos)
InvalidAdvance(CssSyntaxInvalidAdvance)
UnsupportedToken(CssSyntaxErrorPos)
UnknownToken(CssSyntaxErrorPos)
struct ErrorLocationRange
start: ErrorLocation
end: ErrorLocation
union enum ResultStyledDomRenderDomError has destructor
Ok(StyledDom)
Err(RenderDomError)
union enum ResultStringCompileError has destructor
Ok(String)
Err(CompileError)
enum BiometricResult
Authenticated
Failed
Cancelled
FellBackToPasscode
Unavailable
Error
union enum KeyringResult has destructor
Stored
Retrieved(String)
Deleted
NotFound
Denied
Unavailable
Error
Application entry point, configuration, and lifecycle management.
mod app:
struct AppConfig has destructor
log_level: AppLogLevel
enable_visual_panic_hook: bool
enable_logging_on_panic: bool
enable_tab_navigation: bool
termination_behavior: AppTerminationBehavior
icon_provider: IconProviderHandle
bundled_fonts: NamedFontVec
font_loading: FontLoadingConfig
mock_css_environment: OptionCssMockEnvironment
system_style: SystemStyle
component_libraries: ComponentLibraryVec
routes: RouteVec
struct App
ptr: c_void
run_destructor: bool
fn add_window:
&mut self
arg create_options: WindowCreateOptions
fn get_monitors:
&self
-> MonitorVec
fn run:
&self
arg root_window: WindowCreateOptions
enum AppTerminationBehavior
ReturnToMain
RunForever
EndProcess
enum AppLogLevel
Off
Error
Warn
Info
Debug
Trace
enum RendererType
Hardware
Software
struct RendererOptions
vsync: Vsync
srgb: Srgb
hw_accel: HwAcceleration
struct MapPinTap
data: RefAny
callback: MapPinTapCallback
Timer, thread, and async task management.
mod task:
union enum ThreadSendMsg
TerminateThread
Tick
Custom(RefAny)
struct ThreadSender
ptr: c_void
run_destructor: bool
ctx: OptionRefAny
fn send:
&mut self
arg msg: ThreadReceiveMsg
-> bool
Sends a message from the background thread to the main thread
struct ThreadReceiver
ptr: c_void
run_destructor: bool
ctx: OptionRefAny
fn recv:
&mut self
Receives a message from the main thread, if available
struct Timer
refany: RefAny
node_id: OptionDomNodeId
created: Instant
last_run: OptionInstant
run_count: usize
delay: OptionDuration
interval: OptionDuration
timeout: OptionDuration
callback: TimerCallback
constructor create:
arg refany: RefAny
arg callback: TimerCallback
arg get_system_time_fn: GetSystemTimeCallback
-> Timer
fn tick_millis:
&self
-> u64
&self
-> Instant
fn with_delay:
fn with_interval:
fn with_timeout:
&self
arg instant_now: Instant
-> bool
fn invoke:
&mut self
arg callback_info: CallbackInfo
arg get_system_time_fn: GetSystemTimeCallback
Invoke the timer callback and update internal state
enum TerminateTimer
Terminate
Continue
struct TimerId
id: usize
struct Thread
ptr: c_void
run_destructor: bool
constructor create:
arg thread_initialize_data: RefAny
arg writeback_data: RefAny
arg callback: ThreadCallback
-> Thread
constructor sleep_ms:
arg milliseconds: u64
-> EmptyStruct
constructor sleep_us:
arg microseconds: u64
-> EmptyStruct
constructor sleep_ns:
arg nanoseconds: u64
-> EmptyStruct
Creates a new thread that will execute the given callback function.
# Arguments *thread_initialize_data- Data passed to the callback when the thread starts *writeback_data- Data that will be passed back when writeback messages are received *callback- The function to execute in the background threadSleeps the current thread for the specified number of milliseconds. This is a cross-platform utility that can be called from C/C++/Python.
Sleeps the current thread for the specified number of microseconds.
Sleeps the current thread for the specified number of nanoseconds.
struct ThreadId
id: usize
struct ThreadWriteBackMsg
refany: RefAny
callback: WriteBackCallback
constructor create:
arg callback: WriteBackCallback
arg data: RefAny
Creates a new ThreadWriteBackMsg with the given callback and data
union enum ThreadReceiveMsg
WriteBack(ThreadWriteBackMsg)
Update(Update)
struct TimerIdVecSlice
ptr: TimerId
len: usize
struct ThreadIdVecSlice
Pointer to the slice data
ptr: ThreadId
Number of elements in the slice
len: usize
Miscellaneous utility types and helper functions.
mod misc:
union enum FmtValue has destructor
Bool(bool)
Uchar(u8)
Schar(i8)
Ushort(u16)
Sshort(i16)
Uint(u32)
Sint(i32)
Ulong(u64)
Slong(i64)
Isize(isize)
Usize(usize)
Float(f32)
Double(f64)
Str(String)
StrVec(StringVec)
struct FmtArg has destructor
key: String
value: FmtValue
struct Url has destructor
href: String
scheme: String
host: String
port: u16
path: String
query: String
fragment: String
constructor parse:
arg s: String
constructor from_parts:
Parse a URL from a string
# Arguments *s- The URL string to parse
# Returns *Result<Url, UrlParseError>- The parsed URL or an errorCreate a URL from components
fn to_string:
&self
-> String
fn is_https:
&self
-> bool
fn is_http:
&self
-> bool
fn effective_port:
&self
-> u16
fn join:
&self
arg path: String
Get the full URL as a string
Check if this is an HTTPS URL
Check if this is an HTTP URL
Get the effective port (using default ports for http/https)
Join a relative path to this URL
struct Json has destructor
value_type: JsonType
internal: JsonInternal
constructor parse:
arg s: String
constructor parse_bytes:
arg bytes: U8VecRef
constructor null:
-> Json
constructor bool:
arg value: bool
-> Json
constructor float:
arg value: f64
-> Json
constructor int:
arg value: i64
-> Json
constructor string:
constructor array:
constructor object:
arg entries: JsonKeyValueVec
-> Json
Parse JSON from a string
Parse JSON from bytes (UTF-8)
Create a null JSON value
Create a boolean JSON value
Create a floating-point JSON value
Create an integer JSON value
Create a string JSON value
Create a JSON array from a vector of JSON values
Create a JSON object from key-value pairs
fn is_null:
&self
-> bool
fn is_bool:
&self
-> bool
fn is_float:
&self
-> bool
fn is_string:
&self
-> bool
fn is_array:
&self
-> bool
fn is_object:
&self
-> bool
fn as_bool:
&self
-> OptionBool
fn as_float:
&self
-> OptionF64
fn as_int:
&self
-> OptionI64
fn as_string:
&self
-> OptionString
fn len:
&self
-> usize
fn is_empty:
&self
-> bool
fn get_index:
&self
arg index: usize
-> OptionJson
fn get_key:
&self
arg key: String
-> OptionJson
fn keys:
&self
-> StringVec
fn to_array:
&self
fn to_object:
&self
fn to_string:
&self
-> String
fn to_string_pretty:
&self
-> String
fn jq:
fn jq_all:
self
arg deserialize_fn: usize
Check if this is null
Check if this is a boolean
Check if this is a floating-point number
Check if this is a string
Check if this is an array
Check if this is an object
Get as boolean (returns None if not a bool)
Get as float (returns None if not a number)
Get as integer (returns None if not a number or not an integer)
Get as string (returns None if not a string)
Get the number of elements (for arrays) or keys (for objects)
Check if empty (for arrays/objects)
Get array element by index
Get object value by key
Get all keys of an object
Convert array to Vec<Json>
Convert object to Vec<JsonKeyValue>
Serialize to JSON string
Serialize to pretty-printed JSON string
Access a nested value using a JSON Pointer (RFC 6901).
The pointer syntax uses/to separate path components: -/fooaccesses key "foo" in an object -/0accesses index 0 in an array -/foo/bar/0accesses nested paths
Returns Json::null() if the path doesn't exist or points to an invalid location.
# ExampleAccess nested values using a JSON Pointer with wildcard support.
Similar tojq()but supports*wildcard to iterate over all elements in an array or all values in an object.
The wildcard*matches all keys/indices at that position and returns a Vec of all matched values.
# ExamplesDeserialize this JSON into a RefAny using the provided deserialize function pointer.
The deserialize_fn should be obtained from an existing RefAny of the target type via RefAny::get_deserialize_fn().
Returns Ok(RefAny) on success, or Err(String) with an error message on failure.enum JsonType
Null
Bool
Number
String
Array
Object
struct JsonInternal has destructor
string_value: String
number_value: f64
bool_value: bool
struct DirEntry has destructor
name: String
path: String
file_type: FileType
enum FileType
File
Directory
Symlink
Other
struct FileMetadata
size: u64
file_type: FileType
is_readonly: bool
modified_secs: u64
created_secs: u64
struct JsonKeyValue has destructor
key: String
value: Json
constructor create:
arg key: String
arg value: Json
-> JsonKeyValue
Create a new key-value pair
struct ExternalResource has destructor
url: String
kind: ExternalResourceKind
mime_type: OptionMimeTypeHint
source_element: String
source_attribute: String
enum ExternalResourceKind
Image
Font
Stylesheet
Script
Icon
Video
Audio
Unknown
struct ExternalResourceVecSlice has destructor
Pointer to the slice data
ptr: ExternalResource
Number of elements in the slice
len: usize
struct DirEntryVecSlice has destructor
Pointer to the slice data
ptr: DirEntry
Number of elements in the slice
len: usize
struct FmtArgVecSlice has destructor
Pointer to the slice data
ptr: FmtArg
Number of elements in the slice
len: usize
struct JsonKeyValueVecSlice has destructor
Pointer to the slice data
ptr: JsonKeyValue
Number of elements in the slice
len: usize
struct JsonVecSlice has destructor
Pointer to the slice data
ptr: Json
Number of elements in the slice
len: usize
Result of a Yes/No message box.
enum YesNo
Yes
No
Result of an Ok/Cancel message box.
enum OkCancel
Ok
Cancel
enum BiometricKind
NotAvailable
Fingerprint
Face
Iris
struct BiometricPrompt has destructor
reason: String
cancel_label: String
allow_device_credential: bool
struct Db
ptr: c_void
run_destructor: bool
constructor open:
Open (or create) a database at
path(":memory:"for in-memory). Returns an invalid handle (is_open()false) on failure or when thedb-sqlitefeature is disabled.fn is_open:
&self
-> bool
fn execute:
&self
arg sql: String
arg params: DbValueVec
-> usize
fn query:
&self
arg sql: String
arg params: DbValueVec
-> DbRows
trueif the database is open (thedb-sqliteengine is present andopensucceeded).Run a non-query statement (INSERT/UPDATE/DELETE/CREATE ...) with positional
params(?placeholders). Returns rows affected (0on error, a closed handle, or no engine).Run a query (SELECT) with positional
params. Returns an empty [DbRows] on error, a closed handle, or no engine.union enum DbValue has destructor
Null
Integer(i64)
Real(f64)
Text(String)
Blob(U8Vec)
struct DbRows has destructor
columns: StringVec
values: DbValueVec
struct Pdf
_reserved: u8
fn write_json:
fn read_json:
fn from_dom:
Write a PDF from a JSON document model -> PDF bytes. Empty on a malformed model or without the
pdffeature.Read a PDF (
bytes) into the JSON document model. JSONnullon a parse error or without thepdffeature.Render
domto PDF bytes at the given page size (logical px) - the "HTML/DOM -> PDF" path. Headless, multi-page, no file I/O; save the returned bytes yourself. Empty without thepdffeature or on failure.enum SensorKind
Accelerometer
Gyroscope
Magnetometer
struct SensorReading
kind: SensorKind
x: f32
y: f32
z: f32
timestamp_ms: u64
struct GamepadState
id: GamepadId
connected: bool
buttons: u32
left_stick_x: f32
left_stick_y: f32
right_stick_x: f32
right_stick_y: f32
left_z: f32
right_z: f32
fn is_pressed:
&self
arg button: GamepadButton
-> bool
fn axis:
&self
arg axis: GamepadAxis
-> f32
Whether
buttonis currently held.The current value of
axis(sticks[-1, 1], triggers[0, 1]).struct GamepadId
id: u32
enum GamepadAxis
LeftStickX
LeftStickY
RightStickX
RightStickY
LeftZ
RightZ
struct CameraConfig
facing: CameraFacing
width: u32
height: u32
fps: u32
output_format: RawImageFormat
enum CameraFacing
Front
Back
External
union enum ScreenCaptureSource
PrimaryDisplay
Display(u32)
Window(u64)
struct ScreenCaptureConfig
source: ScreenCaptureSource
fps: u32
output_format: RawImageFormat
struct VideoConfig has destructor
source: String
autoplay: bool
looping: bool
output_format: RawImageFormat
struct WacomPadState
express_keys: u32
touch_ring: f32
touch_ring_active: bool
device_id: u64
struct AudioConfig
sample_rate: u32
channels: u16
struct Udp
ptr: c_void
run_destructor: bool
constructor bind:
Bind a UDP socket to
local_addr(e.g. "0.0.0.0:0" for any interface + an OS-assigned port, or "0.0.0.0:9000" for a fixed port). The socket is set non-blocking so [recv](Self::recv) never stalls the UI thread. Returns an invalid handle (is_open()false) on failure.fn close:
&mut self
fn send_to:
fn recv:
&self
-> OptionU8Vec
fn is_open:
&self
-> bool
fn local_addr:
&self
-> String
fn send_chunked:
fn recv_chunked:
&self
-> OptionU8Vec
Close the socket + release it. (Dropping the handle does this too;
closeis for explicit / FFI control.)Send one datagram to
remote_addr(e.g. "192.168.1.5:9000"). Returns the number of bytes sent (0on failure / not open). The payload is the app's own framing.Receive one pending datagram (non-blocking). Returns
Some(bytes)if a datagram was waiting, orNoneif the queue is empty / the socket isn't open. Poll this from a timer or a background thread.Whether the socket bound successfully.
The local address the socket is bound to (e.g. to learn the OS-assigned port after binding to ":0", so a peer can be told where to send). Empty string if not open.
Send a (possibly large) message to
remote_addr, split into sequenced chunks. Use this for payloads bigger than a datagram (a video frame). Reassemble on the far side with [recv_chunked](Self::recv_chunked). Returns the number of chunks sent (0if not open). Lossy by nature: if a chunk is dropped in flight the message is discarded by the receiver rather than stalling.Drain pending datagrams and return the next fully-reassembled chunked message, or
Noneif none completed this poll. Out-of-order chunks are buffered; messages whose chunks never all arrive are eventually evicted (bounded memory). Pair with [send_chunked](Self::send_chunked).Result of rotation gesture detection (angle + center + duration).
struct DetectedRotation
Rotation angle in radians (positive = clockwise)
angle_radians: f32
Center point of rotation
center: LogicalPosition
Duration of rotation so far, in milliseconds
duration_ms: u64
Result of long-press detection (position + hold duration).
struct DetectedLongPress
Position where the long press is happening
position: LogicalPosition
How long the pointer has been held in place (milliseconds)
duration_ms: u64
Whether the callback has already been invoked for this long press
callback_invoked: bool
Session ID this long press belongs to
session_id: u64
struct DbValueVecSlice has destructor
Pointer to the slice data
ptr: DbValue
Number of elements in the slice
len: usize
ICU internationalization: date/time formatting, plurals, and list formatting.
mod icu:
struct IcuDateTime
date: IcuDate
time: IcuTime
enum PluralCategory
Zero
One
Two
Few
Many
Other
struct IcuDate
year: i32
month: u8
day: u8
enum FormatLength
Short
Medium
Long
Project Fluent localization: message bundles and argument formatting.
mod fluent:
struct IcuLocalizerHandle
ptr: c_void
copies: c_void
run_destructor: bool
constructor from_system_language:
arg language: String
constructor create:
arg default_locale: String
Create a cache initialized with the system language.
Create a new empty cache with a default locale.
&self
-> String
&mut self
arg locale: String
fn set_locale:
&mut self
arg locale: String
fn load_data_blob:
&self
arg data: U8VecRef
-> bool
fn get_language:
fn format_integer:
fn format_decimal:
&self
arg locale: String
arg value: i64
fn pluralize:
fn format_date:
&self
arg locale: String
arg date: IcuDate
arg length: FormatLength
-> IcuResult
fn format_time:
fn format_datetime:
&self
arg locale: String
arg datetime: IcuDateTime
arg length: FormatLength
-> IcuResult
fn compare_strings:
fn strings_equal:
fn format_plural:
fn clear_cache:
&self
&self
-> usize
Get the default locale string.
Set the default locale.
Alias for set_default_locale for compatibility.
Load additional locale data from a binary blob for all cached localizers.
The blob should be generated usingicu4x-datagenwith the--format blobflag. This allows supporting locales that aren't compiled into the binary.
Returnstrueif the data was successfully loaded.Get the language part of a locale (e.g., "en" from "en-US").
Format an integer with locale-appropriate grouping.
# ExampleFormat a decimal number.
# Arguments *locale- BCP 47 locale string (e.g., "en-US", "de-DE") *integer_part- The full integer value (e.g., 123456 for 1234.56) *decimal_places- Number of decimal places (e.g., 2 for 1234.56)Get the plural category for a number.
# ExampleSelect a string based on plural rules.
# Arguments *locale- BCP 47 locale string *value- The number to pluralize *zero,one,two,few,many,other- Strings for each categoryFormat a date according to the specified locale.
# ExampleFormat a time according to the specified locale.
# ExampleFormat a date and time according to the specified locale.
Compare two strings according to locale-specific collation rules.
Returns -1 if a < b, 0 if a == b, 1 if a > b.
# ExampleCheck if two strings are equal according to locale collation rules.
Convenience function to format a localized message with plural support.
This handles the common case of "{count} {item/items}" patterns. The{}placeholder in the template will be replaced with the formatted number.Clear the cache (useful for memory management or locale data reload).
Get the number of cached locales.
struct FluentLocalizerHandle
ptr: c_void
copies: c_void
run_destructor: bool
constructor create:
arg default_locale: String
Create a new Fluent localizer with the given default locale.
&self
-> String
&self
arg locale: String
fn add_resource:
fn load_from_zip:
&self
arg data: U8VecRef
fn translate:
fn has_message:
&self
-> StringVec
fn clear_locale:
&self
arg locale: String
fn clear_all:
&self
Get the default locale string.
Set the default locale.
Add a Fluent resource (FTL content) for a specific locale.
Returns true if the resource was successfully added.Add a Fluent resource from bytes (for loading from files).
Load translations from a ZIP archive containing .fluent files.
File naming convention:{locale}.fluentor{locale}/{filename}.fluentTranslate a message ID to the target locale.
Returns the translated string, or the message ID if not found.Check if a message ID exists in the given locale.
Get the list of all loaded locales.
Clear all loaded resources for a specific locale.
Clear all loaded resources.
Component system for reusable UI building blocks.
mod component:
struct ComponentId has destructor
collection: String
name: String
constructor builtin:
arg name: String
-> ComponentId
constructor new:
arg collection: String
arg name: String
-> ComponentId
fn qualified_name:
&self
-> String
Returns "collection:name" format string
struct ComponentDataField has destructor
name: String
field_type: ComponentFieldType
default_value: OptionComponentDefaultValue
required: bool
description: String
enum ComponentSource
Builtin
Compiled
UserDefined
constructor create:
enum CompileTarget
Rust
C
Cpp
Python
struct ComponentDef has destructor
id: ComponentId
display_name: String
description: String
css: String
source: ComponentSource
data_model: ComponentDataModel
render_fn: ComponentRenderFn
compile_fn: ComponentCompileFn
render_fn_source: OptionString
compile_fn_source: OptionString
Opaque compile function pointer for component code generation.
struct ComponentCompileFn
_internal: usize
Opaque render function pointer for component DOM rendering.
struct ComponentRenderFn
_internal: usize
struct ComponentLibrary has destructor
name: String
version: String
description: String
components: ComponentDefVec
exportable: bool
modifiable: bool
data_models: ComponentDataModelVec
enum_models: ComponentEnumModelVec
struct ComponentMap has destructor
libraries: ComponentLibraryVec
constructor create:
-> ComponentMap
struct ComponentDataModel has destructor
name: String
description: String
fields: ComponentDataFieldVec
enum ComponentEventFilter
AfterMount
BeforeUnmount
NodeResized
DefaultAction
Selected
Updated
enum CssColorComponent
Red
Green
Blue
Hue
Saturation
Lightness
Alpha
struct ComponentEnumVariant has destructor
name: String
description: String
fields: ComponentDataFieldVec
struct ComponentDataFieldVecSlice has destructor
Pointer to the slice data
ptr: ComponentDataField
Number of elements in the slice
len: usize
struct ComponentLibraryVecSlice has destructor
Pointer to the slice data
ptr: ComponentLibrary
Number of elements in the slice
len: usize
struct ComponentEnumModel has destructor
name: String
description: String
variants: ComponentEnumVariantVec
struct ComponentDefVecSlice has destructor
Pointer to the slice data
ptr: ComponentDef
Number of elements in the slice
len: usize
struct ComponentDataModelVecSlice has destructor
Pointer to the slice data
ptr: ComponentDataModel
Number of elements in the slice
len: usize
struct ComponentEnumVariantVecSlice has destructor
Pointer to the slice data
ptr: ComponentEnumVariant
Number of elements in the slice
len: usize
union enum ComponentFieldType has destructor
String
Bool
I32
I64
U32
U64
Usize
F32
F64
ColorU
CssProperty
ImageRef
FontRef
StyledDom
Callback(ComponentCallbackSignature)
RefAny(String)
OptionType(ComponentFieldTypeBox)
VecType(ComponentFieldTypeBox)
StructRef(String)
EnumRef(String)
struct ComponentFieldTypeBox
ptr: c_void
struct ComponentEnumModelVecSlice has destructor
Pointer to the slice data
ptr: ComponentEnumModel
Number of elements in the slice
len: usize
struct ComponentFieldOverride has destructor
field_name: String
source: ComponentFieldValueSource
struct ComponentInstanceDefault has destructor
library: String
component: String
field_overrides: ComponentFieldOverrideVec
struct ComponentCallbackSignature has destructor
return_type: String
args: ComponentCallbackArgVec
struct ComponentCallbackArg has destructor
name: String
arg_type: ComponentFieldType
union enum ComponentDefaultValue has destructor
None
String(String)
Bool(bool)
I32(i32)
I64(i64)
U32(u32)
U64(u64)
Usize(usize)
F32(f32)
F64(f64)
ColorU(ColorU)
ComponentInstance(ComponentInstanceDefault)
CallbackFnPointer(String)
Json(String)
union enum ComponentFieldValueSource has destructor
Default
Literal(String)
Binding(String)
struct ComponentFieldOverrideVecSlice has destructor
Pointer to the slice data
Number of elements in the slice
len: usize
struct ComponentCallbackArgVecSlice has destructor
Pointer to the slice data
ptr: ComponentCallbackArg
Number of elements in the slice
len: usize