API v1.0.0-alpha1

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

  DragStart

  Drag

  DragEnd

  DoubleClick

  LongPress

  SwipeLeft

  SwipeRight

  SwipeUp

  SwipeDown

  PinchIn

  PinchOut

  RotateClockwise

  RotateCounterClockwise

• struct HidpiAdjustedBounds

  logical_size: LogicalSize

  hidpi_factor: DpiScaleFactor

  • constructor from_bounds:

    • arg bounds: LayoutSize

    • arg hidpi_factor: DpiScaleFactor

    • -> HidpiAdjustedBounds

  • fn get_physical_size:

    • &self

    • -> PhysicalSizeU32

  • fn get_logical_size:

    • &self

    • -> LogicalSize

  • fn get_hidpi_factor:

    • &self

    • -> DpiScaleFactor

• 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

  x11_visual: OptionX11Visual

  x11_screen: OptionI32

  x11_wm_classes: StringPairVec

  x11_override_redirect: bool

  x11_window_types: XWindowTypeVec

  x11_gtk_theme_variant: OptionString

  x11_resize_increments: OptionLogicalSize

  x11_base_size: OptionLogicalSize

  wayland_app_id: OptionString

  wayland_theme: OptionWaylandTheme

  request_user_attention: UserAttentionType

  window_icon: OptionWindowIcon

  x11_decorations_state: OptionLinuxDecorationsState

• 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

  close_requested: bool

  decorations: WindowDecorations

  is_visible: bool

  is_always_on_top: bool

  is_resizable: bool

  has_focus: bool

  background_material: WindowBackgroundMaterial

  smooth_scroll_enabled: bool

  autotab_enabled: bool

  window_type: WindowType

  has_decorations: bool

  use_native_menus: bool

  use_native_context_menus: bool

  is_top_level: bool

  prevent_system_sleep: bool

• 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

  size_to_content: bool

  renderer: OptionRendererOptions

  theme: OptionWindowTheme

  create_callback: OptionCallback

  hot_reload: bool

  Create a new WindowCreateOptions with a layout callback

  • constructor create:

    • arg layout_callback: LayoutCallbackType

    • -> WindowCreateOptions

• struct FullWindowState has destructor

  Semantic window identifier for multi-window debugging. Can be set to identify specific windows (e.g., 'main', 'settings', 'popup-1')

  window_id: String

  theme: WindowTheme

  title: String

  size: WindowSize

  position: WindowPosition

  flags: WindowFlags

  debug_state: DebugState

  keyboard_state: KeyboardState

  mouse_state: MouseState

  touch_state: TouchState

  ime_position: ImePosition

  platform_specific_options: PlatformSpecificOptions

  renderer_options: RendererOptions

  background_color: ColorU

  layout_callback: LayoutCallback

  close_callback: OptionCallback

  monitor_id: OptionU32

  window_focused: bool

• 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

Callback type definitions + struct definitions of CallbackInfos

mod callbacks:

• Main callback type for UI event handling

  fnptr CallbackType

  • arg RefAny

  • arg CallbackInfo

  -> Update

• C-ABI wrapper over an IFrameCallbackType

  struct IFrameCallback

  cb: IFrameCallbackType

  ctx: OptionRefAny

• Type alias for extern "C" fn (&mut RefAny , &mut IFrameCallbackInfo) -> IFrameCallbackReturn

  fnptr IFrameCallbackType

  • arg RefAny

  • arg IFrameCallbackInfo

  -> IFrameCallbackReturn

• Return value for an IFrame rendering callback. # Dual Size Model IFrame 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 IFrame 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 IFrame callback will be re-invoked only when necessary to avoid performance overhead: 1. Initial render - First time the IFrame 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 IFrame bounds exceed scroll_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 existing scroll_size 4. 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 rendered scroll_size - Same constraints as rule #4 (threshold and once-per-edge) ## Window Resize Example text Frame 0: IFrame bounds = 800x600, scroll_size = 800x600 (perfectly covered) Frame 1: Window resizes to 1000x700 (larger) -> IFrame 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 return OptionStyledDom::None for the dom field. This signals the layout engine to keep using the current DOM and only update the scroll bounds. ,ignore fn my_iframe_callback(data: &mut MyData, info: &mut IFrameCallbackInfo) -> IFrameCallbackReturn { 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 IFrameCallbackReturn { dom: OptionStyledDom::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(...); IFrameCallbackReturn { dom: OptionStyledDom::Some(new_dom), ... } } # Example: Basic IFrame ,ignore fn my_iframe_callback(data: &mut MyData, info: &mut IFrameCallbackInfo) -> IFrameCallbackReturn { let dom = Dom::body() .with_child(Dom::text("Hello from IFrame!")); let styled_dom = dom.style(Css::empty()); IFrameCallbackReturn { // The rendered content dom: OptionStyledDom::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_iframe_callback(data: &mut TableData, info: &mut IFrameCallbackInfo) -> IFrameCallbackReturn { 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() ); IFrameCallbackReturn { dom: OptionStyledDom::Some(dom.style(Css::empty())), // 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, and scroll_size/scroll_offset are updated - User experiences seamless scrolling through the full dataset # How the Layout Engine Uses These Values ## For Rendering - Uses scroll_size to determine the actual size of the IFrame's content box - Uses scroll_offset to position the content within the virtual space - Clips rendering to the visible viewport ## For Scrollbars - Uses virtual_scroll_size to calculate scrollbar thumb size and track length - Uses virtual_scroll_offset as the base for scroll position calculations - User sees scrollbar representing full virtual size, not just rendered content ## For Re-invocation Checks - Compares viewport bounds against scroll_size to detect edge proximity - Compares current scroll position against scroll_offset + scroll_size bounds - Triggers callback when user scrolls beyond the rendered content threshold

  struct IFrameCallbackReturn has destructor

  The styled DOM with actual rendered content, or None to keep current DOM. - OptionStyledDom::Some(dom) - Replace current content with this new DOM - OptionStyledDom::None - Keep using the previous DOM, only update scroll bounds Returning None is an optimization when the callback determines that the current content is sufficient (e.g., already rendered ahead of scroll position).

  dom: OptionStyledDom

  Size of the actual rendered content rectangle. This is the size of the content in the dom field (if Some). It may be smaller than virtual_scroll_size if 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_size to 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

  Creates a new IFrameCallbackReturn with updated DOM content.
  Use this when the callback has rendered new content to display.
  # Arguments - dom - The new styled 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 - Usually LogicalPosition::zero()

  • constructor with_dom:

    • arg dom: StyledDom

    • arg scroll_size: LogicalSize

    • arg scroll_offset: LogicalPosition

    • arg virtual_scroll_size: LogicalSize

    • arg virtual_scroll_offset: LogicalPosition

    • -> IFrameCallbackReturn

  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 - Usually LogicalPosition::zero()

  • constructor keep_current:

    • arg scroll_size: LogicalSize

    • arg scroll_offset: LogicalPosition

    • arg virtual_scroll_size: LogicalSize

    • arg virtual_scroll_offset: LogicalPosition

    • -> IFrameCallbackReturn

• fnptr NumberInputOnFocusLostCallbackType

  • arg RefAny

  • arg CallbackInfo

  • arg NumberInputState

  -> Update

• fnptr TextInputOnVirtualKeyDownCallbackType

  • arg RefAny

  • arg CallbackInfo

  • arg TextInputState

  -> OnTextInputReturn

• fnptr ButtonOnClickCallbackType

  • arg RefAny

  • arg CallbackInfo

  -> Update

• fnptr CheckBoxOnToggleCallbackType

  • arg RefAny

  • arg CallbackInfo

  • arg CheckBoxState

  -> 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

  -> OnTextInputReturn

• 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 IFrameCallbackInfo

  reason: IFrameCallbackReason

  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

  Get the callable for FFI language bindings (Python, etc.)

  • fn get_ctx:

    • &self

    • -> OptionRefAny

  • fn get_bounds:

    • &self

    • -> HidpiAdjustedBounds

• struct CallbackInfo

  ref_data: c_void

  hit_dom_node: DomNodeId

  cursor_relative_to_item: OptionLogicalPosition

  cursor_in_viewport: OptionLogicalPosition

  changes: c_void

  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.

  • fn get_ctx:

    • &self

    • -> OptionRefAny

  Returns the OpenGL context if available

  • fn get_gl_context:

    • &self

    • -> OptionGlContextPtr

  Add a timer to this window (applied after callback returns)

  • fn add_timer:

    • &mut self

    • arg timer_id: TimerId

    • arg timer: Timer

  Remove a timer from this window (applied after callback returns)

  • fn remove_timer:

    • &mut self

    • arg timer_id: TimerId

  Add a thread to this window (applied after callback returns)

  • fn add_thread:

    • &mut self

    • arg thread_id: ThreadId

    • arg thread: Thread

  Remove a thread from this window (applied after callback returns)

  • fn remove_thread:

    • &mut self

    • arg thread_id: ThreadId

  Stop event propagation (applied after callback returns)

  • fn stop_propagation:

    • &mut self

  Create a new window (applied after callback returns)

  • fn create_window:

    • &mut self

    • arg options: WindowCreateOptions

  Close the current window (applied after callback returns)

  • fn close_window:

    • &mut self

  Modify the window state (applied after callback returns)

  • fn modify_window_state:

    • &mut self

    • arg state: FullWindowState

  Add an image to the image cache (applied after callback returns)

  • fn add_image_to_cache:

    • &mut self

    • arg id: String

    • arg image: ImageRef

  Remove an image from the image cache (applied after callback returns)

  • fn remove_image_from_cache:

    • &mut self

    • arg id: String

  Reload system fonts (applied after callback returns)
  Note: This is an expensive operation that rebuilds the entire font cache

  • fn reload_system_fonts:

    • &mut self

  Prevent 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.
  # Example

  • fn prevent_default:

    • &mut self

  Open 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's use_native_context_menus flag. Uses the position specified in the menu itself.
  # Arguments * menu - The menu to display

  • fn open_menu:

    • &mut self

    • arg menu: Menu

  Open a menu at a specific position
  # Arguments * menu - The menu to display * position - The position where the menu should appear (overrides menu's position)

  • fn open_menu_at:

    • &mut self

    • arg menu: Menu

    • arg position: LogicalPosition

  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: Uses TOOLTIPS_CLASS Win32 control - macOS: Uses NSPopover or custom NSWindow with tooltip styling - X11: Creates transient window with _NET_WM_WINDOW_TYPE_TOOLTIP - Wayland: Uses zwlr_layer_shell_v1 with overlay layer
  # Arguments * text - The tooltip text to display
  # Example

  • fn show_tooltip:

    • &mut self

    • arg text: String

  Show a tooltip at a specific position
  # Arguments * text - The tooltip text to display * position - The position where the tooltip should appear (in window coordinates)
  # Example

  • fn show_tooltip_at:

    • &mut self

    • arg text: String

    • arg position: LogicalPosition

  Hide the currently displayed tooltip
  # Example

  • fn hide_tooltip:

    • &mut self

  Open a menu positioned relative to the currently hit node
  Convenience method for opening a menu at the element that triggered the callback. Equivalent to open_menu_for_node(menu, info.get_hit_node()).
  # Arguments * menu - The menu to display
  # Returns * true if the menu was queued for opening * false if no node is currently hit or it has no layout information

  • fn open_menu_for_hit_node:

    • &mut self

    • arg menu: Menu

    • -> bool

  Get current window flags

  • fn get_current_window_flags:

    • &self

    • -> WindowFlags

  Get the current scroll offset for the hit node (if it's scrollable)
  Convenience method that uses the hit_dom_node from this callback. Use get_scroll_offset_for_node if you need to query a specific node.

  • fn get_scroll_offset:

    • &self

    • -> OptionLogicalPosition

  Get current keyboard state

  • fn get_current_keyboard_state:

    • &self

    • -> KeyboardState

  Get current mouse state

  • fn get_current_mouse_state:

    • &self

    • -> MouseState

  • fn get_cursor_relative_to_node:

    • &self

    • -> OptionLogicalPosition

  • fn get_cursor_relative_to_viewport:

    • &self

    • -> OptionLogicalPosition

  Get the current cursor position in logical coordinates relative to the window

  • fn get_cursor_position:

    • &self

    • -> OptionLogicalPosition

  • fn get_current_time:

    • &self

    • -> Instant

  Check if any node in a specific DOM is focused

  • fn is_dom_focused:

    • &self

    • arg dom_id: DomId

    • -> bool

  Check if pen is currently in contact with surface

  • fn is_pen_in_contact:

    • &self

    • -> bool

  Check if pen is in eraser mode

  • fn is_pen_eraser:

    • &self

    • -> bool

  Check if pen barrel button is pressed

  • fn is_pen_barrel_button_pressed:

    • &self

    • -> bool

  Set focus to a node matching a CSS path

  • fn set_focus_to_path:

    • &mut self

    • arg dom_id: DomId

    • arg css_path: CssPath

  Move focus to next focusable element in tab order

  • fn focus_next:

    • &mut self

  Move focus to previous focusable element in tab order

  • fn focus_previous:

    • &mut self

  Move focus to first focusable element

  • fn focus_first:

    • &mut self

  Move focus to last focusable element

  • fn focus_last:

    • &mut self

  Remove focus from all elements

  • fn clear_focus:

    • &mut self

  Check if a drag gesture is currently active
  Convenience method that queries the gesture manager.

  • fn is_dragging:

    • &self

    • -> bool

  Check if a node or file drag is currently active
  Returns true if either a node drag or file drag is in progress.

  • fn is_drag_active:

    • &self

    • -> bool

  Check if a node drag is specifically active

  • fn is_node_drag_active:

    • &self

    • -> bool

  Check if a file drag is specifically active

  • fn is_file_drag_active:

    • &self

    • -> bool

  Check if there's sufficient mouse history for gesture detection (at least 2 frames)

  • fn has_sufficient_history_for_gestures:

    • &self

    • -> bool

  Change the text content of a node (applied after callback returns)
  This method was previously called set_string_contents in older API versions.
  # Arguments * node_id - The text node to modify (DomNodeId containing both DOM and node IDs) * text - The new text content
  # Example

  • fn change_node_text:

    • &mut self

    • arg node_id: DomNodeId

    • arg text: String

  Re-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)
  # Example

  • fn update_image_callback:

    • &mut self

    • arg dom_id: DomId

    • arg node_id: NodeId

  Trigger re-rendering of an IFrame (applied after callback returns)
  This forces the IFrame to call its layout callback with reason DomRecreated and submit a new display list to WebRender. The IFrame'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)
  # Example

  • fn trigger_iframe_rerender:

    • &mut self

    • arg dom_id: DomId

    • arg node_id: NodeId

  Find 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.
  # Example

  • fn get_node_id_by_id_attribute:

    • &self

    • arg dom_id: DomId

    • arg id: String

    • -> NodeHierarchyItemId

  Get the parent node of the given node
  Returns None if the node has no parent (i.e., it's the root node)

  • fn get_parent_node:

    • &self

    • arg dom_id: DomId

    • arg node_id: NodeId

    • -> NodeHierarchyItemId

  Get the next sibling of the given node
  Returns None if the node has no next sibling

  • fn get_next_sibling_node:

    • &self

    • arg dom_id: DomId

    • arg node_id: NodeId

    • -> NodeHierarchyItemId

  Get the previous sibling of the given node
  Returns None if the node has no previous sibling

  • fn get_previous_sibling_node:

    • &self

    • arg dom_id: DomId

    • arg node_id: NodeId

    • -> NodeHierarchyItemId

  Get the first child of the given node
  Returns None if the node has no children

  • fn get_first_child_node:

    • &self

    • arg dom_id: DomId

    • arg node_id: NodeId

    • -> NodeHierarchyItemId

  Get the last child of the given node
  Returns None if the node has no children

  • fn get_last_child_node:

    • &self

    • arg dom_id: DomId

    • arg node_id: NodeId

    • -> NodeHierarchyItemId

  Change the image mask of a node (applied after callback returns)

  • fn change_node_image_mask:

    • &mut self

    • arg dom_id: DomId

    • arg node_id: NodeId

    • arg mask: ImageMask

  Set a single CSS property on a node (convenience method for widgets)
  This is a helper method that wraps change_node_css_properties for 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
  # Example

  • fn set_css_property:

    • &mut self

    • arg node_id: DomNodeId

    • arg property: CssProperty

  Scroll a node to a specific position (applied after callback returns)

  • fn scroll_to:

    • &mut self

    • arg dom_id: DomId

    • arg node_id: NodeHierarchyItemId

    • arg position: LogicalPosition

  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
  # Example

  • fn insert_text:

    • &mut self

    • arg dom_id: DomId

    • arg node_id: NodeId

    • arg text: String

  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 * true if the menu was queued for opening * false if the node doesn't exist or has no layout information

  • fn open_menu_for_node:

    • &mut self

    • arg menu: Menu

    • arg node_id: DomNodeId

    • -> bool

  • fn get_node_size:

    • &self

    • arg node_id: DomNodeId

    • -> OptionLogicalSize

  • fn get_node_position:

    • &self

    • arg node_id: DomNodeId

    • -> OptionLogicalPosition

  Get 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.

  • fn get_node_rect:

    • &self

    • arg node_id: DomNodeId

    • -> OptionLogicalRect

  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.

  • fn get_hit_node_rect:

    • &self

    • -> OptionLogicalRect

  Get a reference to a timer

  • fn get_timer:

    • &self

    • arg timer_id: TimerId

    • -> OptionTimer

  Get all timer IDs

  • fn get_timer_ids:

    • &self

    • -> TimerIdVec

  Get a reference to a thread

  • fn get_thread:

    • &self

    • arg thread_id: ThreadId

    • -> OptionThread

  Get all thread IDs

  • fn get_thread_ids:

    • &self

    • -> ThreadIdVec

  Get all DOM IDs that have layout results

  • fn get_dom_ids:

    • &self

    • -> DomIdVec

  • fn get_hit_node:

    • &self

    • -> DomNodeId

  • fn get_parent:

    • &self

    • arg node_id: DomNodeId

    • -> OptionDomNodeId

  • fn get_previous_sibling:

    • &self

    • arg node_id: DomNodeId

    • -> OptionDomNodeId

  • fn get_next_sibling:

    • &self

    • arg node_id: DomNodeId

    • -> OptionDomNodeId

  • fn get_first_child:

    • &self

    • arg node_id: DomNodeId

    • -> OptionDomNodeId

  • fn get_last_child:

    • &self

    • arg node_id: DomNodeId

    • -> OptionDomNodeId

  • fn get_dataset:

    • &mut self

    • arg node_id: DomNodeId

    • -> OptionRefAny

  • fn get_node_id_of_root_dataset:

    • &mut self

    • arg search_key: RefAny

    • -> OptionDomNodeId

  • fn get_string_contents:

    • &self

    • arg node_id: DomNodeId

    • -> OptionString

  Get the current selection state for a DOM

  • fn get_selection:

    • &self

    • arg dom_id: DomId

    • -> OptionSelectionState

  Check if a DOM has any selection

  • fn has_selection:

    • &self

    • arg dom_id: DomId

    • -> bool

  Get the primary cursor for a DOM (first in selection list)

  • fn get_primary_cursor:

    • &self

    • arg dom_id: DomId

    • -> OptionTextCursor

  Get all selection ranges (excludes plain cursors)

  • fn get_selection_ranges:

    • &self

    • arg dom_id: DomId

    • -> SelectionRangeVec

  Get full current window state (immutable reference)

  • fn get_current_window_state:

    • &self

    • -> FullWindowState

  Get previous window flags

  • fn get_previous_window_flags:

    • &self

    • -> OptionWindowFlags

  Get previous keyboard state

  • fn get_previous_keyboard_state:

    • &self

    • -> OptionKeyboardState

  Get previous mouse state

  • fn get_previous_mouse_state:

    • &self

    • -> OptionMouseState

  • fn get_current_window_handle:

    • &self

    • -> RawWindowHandle

  Get the layout rectangle of the currently hit node (in logical coordinates)

  • fn get_hit_node_layout_rect:

    • &self

    • -> OptionLogicalRect

  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 * None if the property is not set (will use default value)

  • fn get_computed_css_property:

    • &self

    • arg node_id: DomNodeId

    • arg property_type: CssPropertyType

    • -> OptionCssProperty

  Get the computed width of a node from CSS
  Convenience method for getting the CSS width property.

  • fn get_computed_width:

    • &self

    • arg node_id: DomNodeId

    • -> OptionCssProperty

  Get the computed height of a node from CSS
  Convenience method for getting the CSS height property.

  • fn get_computed_height:

    • &self

    • arg node_id: DomNodeId

    • -> OptionCssProperty

  • fn get_system_time_fn:

    • &self

    • -> GetSystemTimeCallback

  Check if a specific node is currently focused

  • fn is_node_focused:

    • &self

    • arg node_id: DomNodeId

    • -> bool

  Get current pen/stylus state if a pen is active

  • fn get_pen_state:

    • &self

    • -> OptionPenState

  Get current pen pressure (0.0 to 1.0) Returns None if no pen is active, Some(0.5) for mouse

  • fn get_pen_pressure:

    • &self

    • -> OptionF32

  Get current pen tilt angles (x_tilt, y_tilt) in degrees Returns None if no pen is active

  • fn get_pen_tilt:

    • &self

    • -> OptionPenTilt

  Get the event ID of the current event

  • fn get_current_event_id:

    • &self

    • -> OptionU64

  Set focus to a specific DOM node by ID

  • fn set_focus_to_node:

    • &mut self

    • arg dom_id: DomId

    • arg node_id: NodeId

  Get the currently focused node (if any)
  Returns None if no node has focus.

  • fn get_focused_node:

    • &self

    • -> OptionDomNodeId

  Check if a specific node has focus

  • fn has_focus:

    • &self

    • arg node_id: DomNodeId

    • -> bool

  Get the currently hovered file (if drag-drop is in progress)
  Returns None if no file is being hovered over the window.

  • fn get_hovered_file:

    • &self

    • -> OptionString

  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.

  • fn get_dropped_file:

    • &self

    • -> OptionString

  Get the node being dragged (if any)

  • fn get_dragged_node:

    • &self

    • -> OptionDomNodeId

  Get the file path being dragged (if any)

  • fn get_dragged_file:

    • &self

    • -> OptionString

  Get the current drag/drop state (if any)
  Returns None if no drag is active, or Some with drag details.

  • fn get_drag_state:

    • &self

    • -> OptionDragState

  Get the current scroll offset for a specific node (if it's scrollable)

  • fn get_scroll_offset_for_node:

    • &self

    • arg dom_id: DomId

    • arg node_id: NodeId

    • -> OptionLogicalPosition

  Get the scroll delta for a node in the current frame (for scroll event detection)

  • fn get_scroll_delta:

    • &self

    • arg dom_id: DomId

    • arg node_id: NodeId

    • -> OptionLogicalPosition

  Check if a node had scroll activity this frame

  • fn had_scroll_activity:

    • &self

    • arg dom_id: DomId

    • arg node_id: NodeId

    • -> bool

  Get the scroll state (container rect, content rect, current offset) for a node

  • fn get_scroll_state:

    • &self

    • arg dom_id: DomId

    • arg node_id: NodeId

    • -> OptionScrollState

  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).

  • fn inspect_paste_target_range:

    • &self

    • arg target: DomNodeId

    • -> OptionSelectionRange

  Inspect what text would be selected by Select All operation
  Returns the full text content and the range that would be selected.

  • fn inspect_select_all_changeset:

    • &self

    • arg target: DomNodeId

    • -> OptionSelectAllResult

  Inspect what would be deleted by a backspace/delete operation
  Uses the pure functions from text3::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)
  # Example

  • fn inspect_delete_changeset:

    • &self

    • arg target: DomNodeId

    • arg forward: bool

    • -> OptionDeleteResult

  Get 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.

  • fn get_clipboard_content:

    • &self

    • -> OptionClipboardContent

  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.

  • fn inspect_copy_changeset:

    • &self

    • arg target: DomNodeId

    • -> OptionClipboardContent

  Inspect a pending cut operation
  Returns the clipboard content that would be cut (copied + deleted). Use this to validate or transform content before cutting.

  • fn inspect_cut_changeset:

    • &self

    • arg target: DomNodeId

    • -> OptionClipboardContent

  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
  # Example

  • fn set_clipboard_content:

    • &mut self

    • arg content: ClipboardContent

  Set/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.
  # Example

  • fn set_copy_content:

    • &mut self

    • arg target: DomNodeId

    • arg content: ClipboardContent

  Set/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.

  • fn set_cut_content:

    • &mut self

    • arg target: DomNodeId

    • arg content: ClipboardContent

  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.

  • fn set_select_all_range:

    • &mut self

    • arg target: DomNodeId

    • arg range: SelectionRange

  Get the current text content of a node
  Helper for inspecting text before operations.

  • fn get_node_text_content:

    • &self

    • arg target: DomNodeId

    • -> OptionString

  Get the current cursor position in a node
  Returns the text cursor position if the node is focused.

  • fn get_node_cursor_position:

    • &self

    • arg target: DomNodeId

    • -> OptionTextCursor

  Get the current selection ranges in a node
  Returns all active selection ranges for the specified DOM.

  • fn get_node_selection_ranges:

    • &self

    • arg target: DomNodeId

    • -> SelectionRangeVec

  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.

  • fn node_has_selection:

    • &self

    • arg target: DomNodeId

    • -> bool

  Get the length of text in a node
  Useful for bounds checking in custom operations.

  • fn get_node_text_length:

    • &self

    • arg target: DomNodeId

    • -> OptionUsize

  Check if undo is available for a specific node
  Returns true if there is at least one undoable operation in the stack.

  • fn can_undo:

    • &self

    • arg node_id: NodeId

    • -> bool

  Check if redo is available for a specific node
  Returns true if there is at least one redoable operation in the stack.

  • fn can_redo:

    • &self

    • arg node_id: NodeId

    • -> bool

  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.

  • fn get_undo_text:

    • &self

    • arg node_id: NodeId

    • -> OptionString

  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.

  • fn get_redo_text:

    • &self

    • arg node_id: NodeId

    • -> OptionString

  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.

  • fn inspect_undo_operation:

    • &self

    • arg node_id: NodeId

    • -> OptionUndoableOperation

  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.

  • fn inspect_redo_operation:

    • &self

    • arg node_id: NodeId

    • -> OptionUndoableOperation

  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
  # Example
  

  • fn inspect_move_cursor_left:

    • &self

    • arg target: DomNodeId

    • -> OptionTextCursor

  Inspect 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.

  • fn inspect_move_cursor_right:

    • &self

    • arg target: DomNodeId

    • -> OptionTextCursor

  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.

  • fn inspect_move_cursor_up:

    • &self

    • arg target: DomNodeId

    • -> OptionTextCursor

  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.

  • fn inspect_move_cursor_down:

    • &self

    • arg target: DomNodeId

    • -> OptionTextCursor

  Inspect where the cursor would move when pressing Home key
  Returns the cursor position at the start of the current line.

  • fn inspect_move_cursor_to_line_start:

    • &self

    • arg target: DomNodeId

    • -> OptionTextCursor

  Inspect where the cursor would move when pressing End key
  Returns the cursor position at the end of the current line.

  • fn inspect_move_cursor_to_line_end:

    • &self

    • arg target: DomNodeId

    • -> OptionTextCursor

  Inspect where the cursor would move when pressing Ctrl+Home
  Returns the cursor position at the start of the document.

  • fn inspect_move_cursor_to_document_start:

    • &self

    • arg target: DomNodeId

    • -> OptionTextCursor

  Inspect where the cursor would move when pressing Ctrl+End
  Returns the cursor position at the end of the document.

  • fn inspect_move_cursor_to_document_end:

    • &self

    • arg target: DomNodeId

    • -> OptionTextCursor

  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).

  • fn inspect_backspace:

    • &self

    • arg target: DomNodeId

    • -> OptionDeleteResult

  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).

  • fn inspect_delete:

    • &self

    • arg target: DomNodeId

    • -> OptionDeleteResult

  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
  # Example

  • fn move_cursor_left:

    • &mut self

    • arg target: DomNodeId

    • arg extend_selection: bool

  Move cursor right (arrow right key)

  • fn move_cursor_right:

    • &mut self

    • arg target: DomNodeId

    • arg extend_selection: bool

  Move cursor up (arrow up key)

  • fn move_cursor_up:

    • &mut self

    • arg target: DomNodeId

    • arg extend_selection: bool

  Move cursor down (arrow down key)

  • fn move_cursor_down:

    • &mut self

    • arg target: DomNodeId

    • arg extend_selection: bool

  Move cursor to line start (Home key)

  • fn move_cursor_to_line_start:

    • &mut self

    • arg target: DomNodeId

    • arg extend_selection: bool

  Move cursor to line end (End key)

  • fn move_cursor_to_line_end:

    • &mut self

    • arg target: DomNodeId

    • arg extend_selection: bool

  Move cursor to document start (Ctrl+Home)

  • fn move_cursor_to_document_start:

    • &mut self

    • arg target: DomNodeId

    • arg extend_selection: bool

  Move cursor to document end (Ctrl+End)

  • fn move_cursor_to_document_end:

    • &mut self

    • arg target: DomNodeId

    • arg extend_selection: bool

  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.

  • fn delete_backward:

    • &mut self

    • arg target: DomNodeId

  Delete text forward (delete key)
  Queues a delete operation to be applied after the callback. Use inspect_delete() to see what would be deleted.

  • fn delete_forward:

    • &mut self

    • arg target: DomNodeId

  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).

  • fn get_all_children_nodes:

    • &self

    • arg dom_id: DomId

    • arg node_id: NodeId

    • -> NodeIdVec

  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.

  • fn get_children_count:

    • &self

    • arg dom_id: DomId

    • arg node_id: NodeId

    • -> usize

  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.

  • fn get_node_tag_name:

    • &self

    • arg node_id: DomNodeId

    • -> OptionString

  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 * None if the attribute doesn't exist or the node doesn't exist

  • fn get_node_attribute:

    • &self

    • arg node_id: DomNodeId

    • arg attr_name: String

    • -> OptionString

  Get all CSS classes of a node
  Returns a vector of all CSS class names applied to the node.

  • fn get_node_classes:

    • &self

    • arg node_id: DomNodeId

    • -> StringVec

  Get the ID attribute of a node
  Convenience method for getting the 'id' attribute. Equivalent to get_node_attribute(node_id, 'id').

  • fn get_node_id:

    • &self

    • arg node_id: DomNodeId

    • -> OptionString

  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 failed

  • fn take_screenshot:

    • &self

    • arg dom_id: DomId

    • -> ResultU8VecString

  Take 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 to

  • fn take_screenshot_to_file:

    • &self

    • arg dom_id: DomId

    • arg path: String

    • -> ResultVoidString

  Take 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 failed

  • fn take_native_screenshot:

    • &self

    • arg path: String

    • -> ResultVoidString

  Take 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 failed

  • fn take_native_screenshot_bytes:

    • &self

    • -> ResultU8VecString

  Take 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 failed

  • fn take_native_screenshot_base64:

    • &self

    • -> ResultStringString

  Take 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 failed

  • fn take_screenshot_base64:

    • &self

    • arg dom_id: DomId

    • -> ResultStringString

• union enum IFrameCallbackReason

  InitialRender

  DomRecreated

  BoundsExpanded

  EdgeScrolled(EdgeType)

  ScrollBeyondContent

• fnptr InstantPtrCloneCallbackType

  • arg InstantPtr

  -> InstantPtr

• fnptr InstantPtrDestructorCallbackType

  • arg InstantPtr

• fnptr LayoutCallbackType

  • arg RefAny

  • arg LayoutCallbackInfo

  -> StyledDom

• 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

  cb: LayoutCallbackType

  ctx: OptionRefAny

  • constructor create:

    • arg cb: LayoutCallbackType

    • -> LayoutCallback

• struct LayoutCallbackInfo

  ref_data: c_void

  window_size: WindowSize

  theme: WindowTheme

  callable_ptr: c_void

  _abi_mut: c_void

  Get the callable for FFI language bindings (Python, etc.)

  • fn get_ctx:

    • &self

    • -> OptionRefAny

  • fn get_gl_context:

    • &self

    • -> OptionGlContextPtr

  Returns true if the window width is less than the given pixel value
  # Example

  • fn window_width_less_than:

    • &self

    • arg px: f32

    • -> bool

  Returns true if the window width is greater than the given pixel value

  • fn window_width_greater_than:

    • &self

    • arg px: f32

    • -> bool

  Returns true if the window width is between min and max (inclusive)

  • fn window_width_between:

    • &self

    • arg min_px: f32

    • arg max_px: f32

    • -> bool

  Returns true if the window height is less than the given pixel value

  • fn window_height_less_than:

    • &self

    • arg px: f32

    • -> bool

  Returns true if the window height is greater than the given pixel value

  • fn window_height_greater_than:

    • &self

    • arg px: f32

    • -> bool

  Returns true if the window height is between min and max (inclusive)

  • fn window_height_between:

    • &self

    • arg min_px: f32

    • arg max_px: f32

    • -> bool

  Returns the current window width in pixels

  • fn get_window_width:

    • &self

    • -> f32

  Returns the current window height in pixels

  • fn get_window_height:

    • &self

    • -> f32

  Returns the current window DPI factor

  • fn get_dpi_factor:

    • &self

    • -> f32

• struct TimerCallback

  cb: TimerCallbackType

  ctx: OptionRefAny

• fnptr TimerCallbackType

  • arg RefAny

  • arg TimerCallbackInfo

  -> TimerCallbackReturn

• 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

    • -> TimerCallbackInfo

  • fn get_attached_node_size:

    • &self

    • -> OptionLogicalSize

  • fn get_attached_node_position:

    • &self

    • -> OptionLogicalPosition

• struct TimerCallbackReturn

  should_update: Update

  should_terminate: TerminateTimer

  Creates a new TimerCallbackReturn with the given update and terminate flags.

  • constructor create:

    • arg should_update: Update

    • arg should_terminate: TerminateTimer

    • -> TimerCallbackReturn

  Timer continues running, no DOM update needed.

  • constructor continue_unchanged:

    • -> TimerCallbackReturn

  Timer continues running and DOM should be refreshed.

  • constructor continue_and_update:

    • -> TimerCallbackReturn

  Timer should stop, no DOM update needed.

  • constructor terminate_unchanged:

    • -> TimerCallbackReturn

  Timer should stop and DOM should be refreshed.

  • constructor terminate_and_update:

    • -> TimerCallbackReturn

• fnptr ThreadDestructorCallbackType

  • arg ThreadInner

• fnptr WriteBackCallbackType

  • arg RefAny

  • arg RefAny

  • arg CallbackInfo

  -> Update

• fnptr GetSystemTimeCallbackType

  -> Instant

• fnptr LibrarySendThreadMsgCallbackType

  • arg c_void

  • arg ThreadSendMsg

  -> bool

• fnptr CheckThreadFinishedCallbackType

  • arg c_void

  -> bool

• struct WriteBackCallback

  cb: WriteBackCallbackType

  ctx: OptionRefAny

• fnptr LibraryReceiveThreadMsgCallbackType

  • arg c_void

  -> OptionThreadReceiveMsg

• fnptr ThreadCallbackType

  • arg RefAny

  • arg ThreadSender

  • arg ThreadReceiver

• struct ThreadCallback

  cb: ThreadCallbackType

  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

  _internal_ptr: c_void

  sharing_info: RefCount

  instance_id: u64

  run_destructor: bool

  Creates a new RefAny from a raw pointer wrapper, size, alignment, type_id, type_name and destructor

  • constructor new_c:

    • arg ptr: GlVoidPtrConst

    • arg len: usize

    • arg align: usize

    • arg type_id: u64

    • arg type_name: String

    • arg destructor: RefAnyDestructorType

    • -> RefAny

  Returns the type ID of this RefAny

  • fn get_type_id:

    • &self

    • -> u64

  Returns true if this RefAny is of the given type ID

  • fn is_type:

    • &self

    • arg type_id: u64

    • -> bool

• struct RefCount

  ptr: c_void

  run_destructor: bool

  Returns true if this RefCount can be shared (no mutable borrows active)

  • fn can_be_shared:

    • &self

    • -> bool

  Returns true if this RefCount can be mutably shared (no borrows active)

  • fn can_be_shared_mut:

    • &self

    • -> bool

  Increases the shared reference count

  • fn increase_ref:

    • &self

  Decreases the shared reference count

  • fn decrease_ref:

    • &self

  Increases the mutable reference count

  • fn increase_refmut:

    • &self

  Decreases the mutable reference count

  • fn decrease_refmut:

    • &self

• 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

  Returns the bounds of the laid-out node

  • fn get_bounds:

    • &self

    • -> HidpiAdjustedBounds

  Returns the DOM node ID that the callback is attached to

  • fn get_callback_node_id:

    • &self

    • -> DomNodeId

  Returns the OpenGL context if available

  • fn get_gl_context:

    • &self

    • -> OptionGlContextPtr

  Returns the context RefAny for FFI callbacks

  • fn get_ctx:

    • &self

    • -> OptionRefAny

• fnptr RenderImageCallbackType

  • arg RefAny

  • arg RenderImageCallbackInfo

  -> ImageRef

• struct PenState

  position: LogicalPosition

  pressure: f32

  tilt: PenTilt

  in_contact: bool

  is_eraser: bool

  barrel_button_pressed: bool

  device_id: u64

• 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

Dom construction and configuration

mod 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

  estimated_total_children: usize

  • constructor create:

    • arg node_type: NodeType

    • -> Dom

  • constructor create_body:

    • -> Dom

  Creates a generic block-level container.
  Accessibility: Prefer semantic elements like <article>, <section>, <nav> when applicable.

  • constructor create_div:

    • -> Dom

  • constructor create_br:

    • -> Dom

  • constructor create_text:

    • arg value: String

    • -> Dom

  • constructor create_image:

    • arg image: ImageRef

    • -> Dom

  Alias for create_body() - creates a body container.

  • constructor body:

    • -> Dom

  Alias for create_image() - creates an image node.

  • constructor image:

    • arg image: ImageRef

    • -> Dom

  • constructor create_iframe:

    • arg data: RefAny

    • arg callback: IFrameCallback

    • -> Dom

  Creates an empty DOM with a give NodeType. Note: This is a const fn and doesn't allocate, it only allocates once you add at least one child node.

  • constructor create_node:

    • arg node_type: NodeType

    • -> Dom

  • constructor from_data:

    • arg node_data: NodeData

    • -> Dom

  Creates the root HTML element.
  Accessibility: The <html> element is the root of an HTML document and should have a lang attribute.

  • constructor create_html:

    • -> Dom

  Creates the document head element.
  Accessibility: The <head> contains metadata. Use <title> for page titles.

  • constructor create_head:

    • -> Dom

  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.

  • constructor create_article:

    • -> Dom

  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.

  • constructor create_section:

    • -> Dom

  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").

  • constructor create_nav:

    • -> Dom

  Creates an aside element.
  Accessibility: Represents content tangentially related to main content (sidebars, callouts). Screen readers announce this as complementary content.

  • constructor create_aside:

    • -> Dom

  Creates a header element.
  Accessibility: Represents introductory content or navigational aids. Can be used for page headers or section headers.

  • constructor create_header:

    • -> Dom

  Creates a footer element.
  Accessibility: Represents footer for nearest section or page. Typically contains copyright, author info, or related links.

  • constructor create_footer:

    • -> Dom

  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.

  • constructor create_main:

    • -> Dom

  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.

  • constructor create_figure:

    • -> Dom

  Creates a figure caption element.
  Accessibility: Provides a caption for <figure>. Screen readers announce this as the figure description.

  • constructor create_figcaption:

    • -> Dom

  Creates a details disclosure element.
  Accessibility: Creates a disclosure widget. Screen readers announce expanded/collapsed state. Must contain a <summary> element. Keyboard accessible by default.

  • constructor create_details:

    • -> Dom

  Creates a summary element for details.
  Accessibility: The visible heading/label for <details>. Must be the first child of details. Keyboard accessible (Enter/Space to toggle).

  • constructor summary:

    • arg text: String

    • -> Dom

  Creates a dialog element.
  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.

  • constructor create_dialog:

    • -> Dom

  Creates a paragraph element.
  Accessibility: Paragraphs provide semantic structure for screen readers.

  • constructor create_p:

    • -> Dom

  Creates a heading level 1 element.
  Accessibility: Use h1 for the main page title. There should typically be only one h1 per page.
  Parameters: - text: Heading text

  • constructor h1:

    • arg text: String

    • -> Dom

  Creates a heading level 2 element.
  Accessibility: Use h2 for major section headings under h1.
  Parameters: - text: Heading text

  • constructor h2:

    • arg text: String

    • -> Dom

  Creates a heading level 3 element.
  Accessibility: Use h3 for subsections under h2.
  Parameters: - text: Heading text

  • constructor h3:

    • arg text: String

    • -> Dom

  Creates a heading level 4 element.
  Parameters: - text: Heading text

  • constructor h4:

    • arg text: String

    • -> Dom

  Creates a heading level 5 element.
  Parameters: - text: Heading text

  • constructor h5:

    • arg text: String

    • -> Dom

  Creates a heading level 6 element.
  Parameters: - text: Heading text

  • constructor h6:

    • arg text: String

    • -> Dom

  Creates a generic inline container (span).
  Accessibility: Prefer semantic elements like strong, em, code, etc. when applicable.
  Parameters: - text: Span content

  • constructor span:

    • arg text: String

    • -> Dom

  Creates a strongly emphasized text element (strong importance).
  Accessibility: Use strong instead of b for semantic meaning. Screen readers can convey the importance. Use for text that has strong importance, seriousness, or urgency.
  Parameters: - text: Text to emphasize

  • constructor strong:

    • arg text: String

    • -> Dom

  Creates an emphasized text element (stress emphasis).
  Accessibility: Use em instead of i for semantic meaning. Screen readers can convey the emphasis. Use for text that has stress emphasis.
  Parameters: - text: Text to emphasize

  • constructor em:

    • arg text: String

    • -> Dom

  Creates a code/computer code element.
  Accessibility: Represents a fragment of computer code. Screen readers can identify this as code content.
  Parameters: - code: Code content

  • constructor code:

    • arg code: String

    • -> Dom

  Creates a preformatted text element.
  Accessibility: Preserves whitespace and line breaks. Useful for code blocks or ASCII art. Screen readers will read the content as-is.
  Parameters: - text: Preformatted content

  • constructor pre:

    • arg text: String

    • -> Dom

  Creates a blockquote element.
  Accessibility: Represents a section quoted from another source. Screen readers can identify quoted content. Consider adding a cite attribute.
  Parameters: - text: Quote content

  • constructor blockquote:

    • arg text: String

    • -> Dom

  Creates a citation element.
  Accessibility: Represents a reference to a creative work. Screen readers can identify citations.
  Parameters: - text: Citation text

  • constructor cite:

    • arg text: String

    • -> Dom

  Creates an abbreviation element.
  Accessibility: Represents an abbreviation or acronym. Use with a title attribute to provide the full expansion for screen readers.
  Parameters: - abbr_text: Abbreviated text - title: Full expansion

  • constructor create_abbr:

    • arg abbr_text: String

    • arg title: String

    • -> Dom

  Creates a keyboard input element.
  Accessibility: Represents keyboard input or key combinations. Screen readers can identify keyboard instructions.
  Parameters: - text: Keyboard instruction

  • constructor kbd:

    • arg text: String

    • -> Dom

  Creates a sample output element.
  Accessibility: Represents sample output from a program or computing system.
  Parameters: - text: Sample text

  • constructor samp:

    • arg text: String

    • -> Dom

  Creates a variable element.
  Accessibility: Represents a variable in mathematical expressions or programming.
  Parameters: - text: Variable name

  • constructor var:

    • arg text: String

    • -> Dom

  Creates a subscript element.
  Accessibility: Screen readers may announce subscript formatting.
  Parameters: - text: Subscript content

  • constructor sub:

    • arg text: String

    • -> Dom

  Creates a superscript element.
  Accessibility: Screen readers may announce superscript formatting.
  Parameters: - text: Superscript content

  • constructor sup:

    • arg text: String

    • -> Dom

  Creates an underline text element.
  Accessibility: Screen readers typically don't announce underline formatting. Use semantic elements when possible (e.g., <em> for emphasis).

  • constructor u:

    • arg text: String

    • -> Dom

  Creates a strikethrough text element.
  Accessibility: Represents text that is no longer accurate or relevant. Consider using <del> for deleted content with datetime attribute.

  • constructor s:

    • arg text: String

    • -> Dom

  Creates a marked/highlighted text element.
  Accessibility: Represents text marked for reference or notation purposes. Screen readers may announce this as "highlighted".

  • constructor mark:

    • arg text: String

    • -> Dom

  Creates a deleted text element.
  Accessibility: Represents deleted content in document edits. Use with datetime and cite attributes for edit tracking.

  • constructor del:

    • arg text: String

    • -> Dom

  Creates an inserted text element.
  Accessibility: Represents inserted content in document edits. Use with datetime and cite attributes for edit tracking.

  • constructor ins:

    • arg text: String

    • -> Dom

  Creates a definition element.
  Accessibility: Represents the defining instance of a term. Often used within a definition list or with <abbr>.

  • constructor dfn:

    • arg text: String

    • -> Dom

  Creates a time element.
  Accessibility: Represents a specific time or date. Use datetime attribute for machine-readable format.
  Parameters: - text: Human-readable time/date - datetime: Optional machine-readable datetime

  • constructor create_time:

    • arg text: String

    • arg datetime: OptionString

    • -> Dom

  Creates a bi-directional override element.
  Accessibility: Overrides text direction. Use dir attribute (ltr/rtl).

  • constructor bdo:

    • arg text: String

    • -> Dom

  Creates an anchor/hyperlink element.
  Accessibility: Always provide meaningful link text. Avoid "click here" or "read more". Screen readers often navigate by links, so descriptive text is crucial.
  Parameters: - href: Link destination URL - label: Link text (pass None for image-only links with alt text)

  • constructor create_a:

    • arg href: String

    • arg label: OptionString

    • -> Dom

  Creates a button element.
  Accessibility: Buttons are keyboard accessible by default. Always provide clear button text or an aria-label for icon-only buttons.
  Parameters: - text: Button label text

  • constructor create_button:

    • arg text: String

    • -> Dom

  Creates a label element for form controls.
  Accessibility: Always associate labels with form controls using for attribute or by wrapping the control. This is critical for screen reader users.
  Parameters: - for_id: ID of the associated form control - text: Label text

  • constructor create_label:

    • arg for_id: String

    • arg text: String

    • -> Dom

  Creates an input element.
  Accessibility: Always provide a label or aria-label. Set appropriate type and aria- attributes for the input's purpose.
  Parameters: - input_type: Input type (text, password, email, etc.) - name: Form field name - label: Accessibility label (required)

  • constructor create_input:

    • arg input_type: String

    • arg name: String

    • arg label: String

    • -> Dom

  Creates a textarea element.
  Accessibility: Always provide a label or aria-label. Consider aria-describedby for additional instructions.
  Parameters: - name: Form field name - label: Accessibility label (required)

  • constructor create_textarea:

    • arg name: String

    • arg label: String

    • -> Dom

  Creates a select dropdown element.
  Accessibility: Always provide a label. Group related options with optgroup.
  Parameters: - name: Form field name - label: Accessibility label (required)

  • constructor create_select:

    • arg name: String

    • arg label: String

    • -> Dom

  Creates an option element for select dropdowns.
  Parameters: - value: Option value - text: Display text

  • constructor create_option:

    • arg value: String

    • arg text: String

    • -> Dom

  Creates an unordered list element.
  Accessibility: Screen readers announce lists and item counts, helping users understand content structure.

  • constructor create_ul:

    • -> Dom

  Creates an ordered list element.
  Accessibility: Screen readers announce lists and item counts, helping users understand content structure and numbering.

  • constructor create_ol:

    • -> Dom

  Creates a list item element.
  Accessibility: Must be a child of ul, ol, or menu. Screen readers announce list item position (e.g., "2 of 5").

  • constructor create_li:

    • -> Dom

  Creates a table element.
  Accessibility: Use proper table structure with thead, tbody, th, and td. Provide a caption for table purpose. Use scope attribute on header cells.

  • constructor create_table:

    • -> Dom

  Creates a table caption element.
  Accessibility: Describes the purpose of the table. Screen readers announce this first.

  • constructor create_caption:

    • -> Dom

  Creates a table header element.
  Accessibility: Groups header rows. Screen readers can navigate table structure.

  • constructor create_thead:

    • -> Dom

  Creates a table body element.
  Accessibility: Groups body rows. Screen readers can navigate table structure.

  • constructor create_tbody:

    • -> Dom

  Creates a table footer element.
  Accessibility: Groups footer rows. Screen readers can navigate table structure.

  • constructor create_tfoot:

    • -> Dom

  Creates a table row element.

  • constructor create_tr:

    • -> Dom

  Creates a table header cell element.
  Accessibility: Use scope attribute ("col" or "row") to associate headers with data cells. Screen readers use this to announce cell context.

  • constructor create_th:

    • -> Dom

  Creates a table data cell element.

  • constructor create_td:

    • -> Dom

  Creates a form element.
  Accessibility: Group related form controls with fieldset and legend. Provide clear labels for all inputs. Consider aria-describedby for instructions.

  • constructor create_form:

    • -> Dom

  Creates a fieldset element for grouping form controls.
  Accessibility: Groups related form controls. Always include a legend as the first child to describe the group. Screen readers announce the legend when entering the fieldset.

  • constructor create_fieldset:

    • -> Dom

  Creates a legend element for fieldsets.
  Accessibility: Describes the purpose of a fieldset. Must be the first child of a fieldset. Screen readers announce this when entering the fieldset.

  • constructor create_legend:

    • -> Dom

  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.

  • constructor create_hr:

    • -> Dom

  Creates an address element.
  Accessibility: Represents contact information. Screen readers identify this as address content.

  • constructor create_address:

    • -> Dom

  Creates a definition list element.
  Accessibility: Screen readers announce definition lists and their structure.

  • constructor create_dl:

    • -> Dom

  Creates a definition term element.
  Accessibility: Must be a child of dl. Represents the term being defined.

  • constructor create_dt:

    • -> Dom

  Creates a definition description element.
  Accessibility: Must be a child of dl. Provides the definition for the term.

  • constructor create_dd:

    • -> Dom

  Creates a table column group element.

  • constructor create_colgroup:

    • -> Dom

  Creates a table column element.

  • constructor create_col:

    • arg span: i32

    • -> Dom

  Creates an optgroup element for grouping select options.
  Parameters: - label: Label for the option group

  • constructor create_optgroup:

    • arg label: String

    • -> Dom

  Creates a quotation element.
  Accessibility: Represents an inline quotation.

  • constructor create_q:

    • -> Dom

  Creates an acronym element.
  Note: Deprecated in HTML5. Consider using abbr() instead.

  • constructor acronym:

    • -> Dom

  Creates a menu element.
  Accessibility: Represents a list of commands. Similar to <ul> but semantic for toolbars/menus.

  • constructor create_menu:

    • -> Dom

  Creates a menu item element.
  Accessibility: Represents a command in a menu. Use with appropriate role/aria attributes.

  • constructor menuitem:

    • -> Dom

  Creates an output element.
  Accessibility: Represents the result of a calculation or user action. Use for attribute to associate with input elements. Screen readers announce updates.

  • constructor create_output:

    • -> Dom

  Creates a progress indicator element.
  Accessibility: Represents task progress. Use value and max attributes. Screen readers announce progress percentage. Use aria-label to describe the task.

  • constructor create_progress:

    • arg value: f32

    • arg max: f32

    • -> Dom

  Creates a meter gauge element.
  Accessibility: Represents a scalar measurement within a known range. Use value, min, max, low, high, optimum attributes. Screen readers announce the measurement. Provide aria-label for context.

  • constructor create_meter:

    • arg value: f32

    • arg min: f32

    • arg max: f32

    • -> Dom

  Creates a datalist element for input suggestions.
  Accessibility: Provides autocomplete options for inputs. Associate with input using list attribute. Screen readers announce available options.

  • constructor create_datalist:

    • -> Dom

  Creates a canvas element for graphics.
  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.

  • constructor create_canvas:

    • -> Dom

  Creates an object element for embedded content.
  Accessibility: Provide fallback content as children. Use aria-label to describe content.

  • constructor create_object:

    • -> Dom

  Creates a param element for object parameters.
  Parameters: - name: Parameter name - value: Parameter value

  • constructor create_param:

    • arg name: String

    • arg value: String

    • -> Dom

  Creates an embed element.
  Accessibility: Provide alternative content or link. Use aria-label to describe embedded content.

  • constructor create_embed:

    • -> Dom

  Creates an audio element.
  Accessibility: Always provide controls. Use <track> for captions/subtitles. Provide fallback text for unsupported browsers.

  • constructor create_audio:

    • -> Dom

  Creates a video element.
  Accessibility: Always provide controls. Use <track> for captions/subtitles/descriptions. Provide fallback text. Consider providing transcript.

  • constructor create_video:

    • -> Dom

  Creates a source element for media.
  Parameters: - src: Media source URL - media_type: MIME type (e.g., "video/mp4", "audio/ogg")

  • constructor create_source:

    • arg src: String

    • arg media_type: String

    • -> Dom

  Creates a track element for media captions/subtitles.
  Accessibility: Essential for deaf/hard-of-hearing users and non-native speakers. Use kind (subtitles/captions/descriptions), srclang, and label attributes.
  Parameters: - src: Track file URL (WebVTT format) - kind: Track kind ("subtitles", "captions", "descriptions", "chapters", "metadata")

  • constructor create_track:

    • arg src: String

    • arg kind: String

    • -> Dom

  Creates a map element for image maps.
  Accessibility: Provide text alternatives. Ensure all areas have alt text.

  • constructor create_map:

    • -> Dom

  Creates an area element for image map regions.
  Accessibility: Always provide alt text describing the region/link purpose. Keyboard users should be able to navigate areas.

  • constructor create_area:

    • -> Dom

  Creates a title element for document title.
  Accessibility: Required for all pages. Screen readers announce this first. Should be unique and descriptive. Keep under 60 characters.

  • constructor title:

    • arg text: String

    • -> Dom

  Creates a meta element.
  Accessibility: Use for charset, viewport, description. Crucial for proper text display.

  • constructor meta:

    • -> Dom

  Creates a link element for external resources.
  Accessibility: Use for stylesheets, icons, alternate versions. Provide meaningful title attribute for alternate stylesheets.

  • constructor create_link:

    • -> Dom

  Creates a script element.
  Accessibility: Ensure scripted content is accessible. Provide noscript fallbacks for critical functionality.

  • constructor create_script:

    • -> Dom

  Creates a style element for embedded CSS.
  Note: In Azul, use the .style() method instead for styling. This creates a <style> HTML element for embedded stylesheets.

  • constructor style_element:

    • -> Dom

  Creates a base element for document base URL.
  Parameters: - href: Base URL for relative URLs in the document

  • constructor base:

    • arg href: String

    • -> Dom

  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.

  • constructor th_with_scope:

    • arg scope: String

    • arg text: String

    • -> Dom

  Creates a table data cell with text.
  Parameters: - text: Cell content

  • constructor td_with_text:

    • arg text: String

    • -> Dom

  Creates a table header cell with text.
  Parameters: - text: Header text

  • constructor th_with_text:

    • arg text: String

    • -> Dom

  Creates a list item with text.
  Parameters: - text: List item content

  • constructor li_with_text:

    • arg text: String

    • -> Dom

  Creates a paragraph with text.
  Parameters: - text: Paragraph content

  • constructor p_with_text:

    • arg text: String

    • -> Dom

  Creates a button with text content and accessibility information.
  Parameters: - text: The visible button text - aria: Accessibility information (role, description, etc.)
  Example:

  • constructor button_with_aria:

    • arg text: String

    • arg aria: SmallAriaInfo

    • -> Dom

  Creates a link (anchor) with href, text, and accessibility information.
  Parameters: - href: The link destination - text: The visible link text - aria: Accessibility information (expanded description, etc.)
  Example:

  • constructor link_with_aria:

    • arg href: String

    • arg text: String

    • arg aria: SmallAriaInfo

    • -> Dom

  Creates an input element with type, name, and accessibility information.
  Parameters: - input_type: The input type (text, password, email, etc.) - name: The form field name - label: Base accessibility label - aria: Additional accessibility information (description, etc.)
  Example:

  • constructor input_with_aria:

    • arg input_type: String

    • arg name: String

    • arg label: String

    • arg aria: SmallAriaInfo

    • -> Dom

  Creates a textarea with name and accessibility information.
  Parameters: - name: The form field name - label: Base accessibility label - aria: Additional accessibility information (description, etc.)
  Example:

  • constructor textarea_with_aria:

    • arg name: String

    • arg label: String

    • arg aria: SmallAriaInfo

    • -> Dom

  Creates a select dropdown with name and accessibility information.
  Parameters: - name: The form field name - label: Base accessibility label - aria: Additional accessibility information (description, etc.)
  Example:

  • constructor select_with_aria:

    • arg name: String

    • arg label: String

    • arg aria: SmallAriaInfo

    • -> Dom

  Creates a table with caption and accessibility information.
  Parameters: - caption: Table caption (visible title) - aria: Accessibility information describing table purpose
  Example:

  • constructor table_with_aria:

    • arg caption: String

    • arg aria: SmallAriaInfo

    • -> Dom

  Creates a label for a form control with additional accessibility information.
  Parameters: - for_id: The ID of the associated form control - text: The visible label text - aria: Additional accessibility information (description, etc.)
  Example:

  • constructor label_with_aria:

    • arg for_id: String

    • arg text: String

    • arg aria: SmallAriaInfo

    • -> Dom

  • fn set_dataset:

    • &mut self

    • arg dataset: RefAny

  • fn with_dataset:

    • self

    • arg data: OptionRefAny

    • -> Dom

  • fn set_ids_and_classes:

    • &mut self

    • arg ids_and_classes: IdOrClassVec

  • fn with_ids_and_classes:

    • self

    • arg ids_and_classes: IdOrClassVec

    • -> Dom

  • fn set_callbacks:

    • &mut self

    • arg callbacks: CoreCallbackDataVec

  • fn with_callbacks:

    • self

    • arg callbacks: CoreCallbackDataVec

    • -> Dom

  Adds a callback to this DOM node.

  • fn add_callback:

    • &mut self

    • arg event: EventFilter

    • arg data: RefAny

    • arg callback: CallbackType

  • 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:

    • self

    • arg child: Dom

    • -> Dom

  • fn set_children:

    • &mut self

    • arg children: DomVec

  • fn with_children:

    • self

    • arg children: DomVec

    • -> Dom

  Adds an CSS ID to the DOM root node.

  • fn add_id:

    • &mut self

    • arg id: String

  • fn with_id:

    • self

    • arg id: String

    • -> Dom

  Adds a CSS class to the DOM root node.

  • fn add_class:

    • &mut self

    • arg class: String

  • fn with_class:

    • self

    • arg class: String

    • -> Dom

  Adds an inline (normal) CSS property to the DOM root node.

  • fn add_css_property:

    • &mut self

    • arg prop: CssProperty

  • fn with_css_property:

    • self

    • arg prop: CssProperty

    • -> Dom

  Adds an inline (hover) CSS property to the DOM root node.

  • fn add_hover_css_property:

    • &mut self

    • arg prop: CssProperty

  • fn with_hover_css_property:

    • self

    • arg prop: CssProperty

    • -> Dom

  Adds an inline (hover) CSS property to the DOM root node.

  • fn add_active_css_property:

    • &mut self

    • arg prop: CssProperty

  • fn with_active_css_property:

    • self

    • arg prop: CssProperty

    • -> Dom

  Adds an inline (hover) CSS property to the DOM root node.

  • fn add_focus_css_property:

    • &mut self

    • arg prop: CssProperty

  • fn with_focus_css_property:

    • self

    • arg prop: CssProperty

    • -> Dom

  Sets inline CSS styles for the normal state, parsing from a CSS string. This allows setting multiple CSS properties at once using CSS syntax.

  • fn set_inline_style:

    • &mut self

    • arg style: String

  Builder method for setting inline CSS styles for the normal state. Parses CSS string and applies properties to the root node.

  • fn with_inline_style:

    • self

    • arg style: String

    • -> Dom

  Sets inline CSS styles for the hover state, parsing from a CSS string.

  • fn set_inline_hover_style:

    • &mut self

    • arg style: String

  Builder method for setting inline CSS styles for the hover state.

  • fn with_inline_hover_style:

    • self

    • arg style: String

    • -> Dom

  Sets inline CSS styles for the active state, parsing from a CSS string.

  • fn set_inline_active_style:

    • &mut self

    • arg style: String

  Builder method for setting inline CSS styles for the active state.

  • fn with_inline_active_style:

    • self

    • arg style: String

    • -> Dom

  Sets inline CSS styles for the focus state, parsing from a CSS string.

  • fn set_inline_focus_style:

    • &mut self

    • arg style: String

  Builder method for setting inline CSS styles for the focus state.

  • fn with_inline_focus_style:

    • self

    • arg style: String

    • -> Dom

  Sets the clip mask for the DOM root node.

  • fn set_clip_mask:

    • &mut self

    • arg clip_mask: ImageMask

  • fn with_clip_mask:

    • self

    • arg clip_mask: ImageMask

    • -> Dom

  Sets the tab index for the DOM root node.

  • fn set_tab_index:

    • &mut self

    • arg tab_index: TabIndex

  • fn with_tab_index:

    • self

    • arg tab_index: TabIndex

    • -> Dom

  Sets accessibility attributes for the DOM root node.

  • fn set_accessibility_info:

    • &mut self

    • arg accessibility_info: AccessibilityInfo

  • fn with_accessibility_info:

    • self

    • arg accessibility_info: AccessibilityInfo

    • -> Dom

  Sets the menu bar for the root node

  • fn set_menu_bar:

    • &mut self

    • arg menu_bar: Menu

  • fn with_menu_bar:

    • self

    • arg menu_bar: Menu

    • -> Dom

  Sets the context menu for the root node

  • fn set_context_menu:

    • &mut self

    • arg context_menu: Menu

  • fn with_context_menu:

    • self

    • arg context_menu: Menu

    • -> Dom

  • fn node_count:

    • &self

    • -> usize

  • fn style:

    • &mut self

    • arg css: Css

    • -> StyledDom

  • fn swap_with_default:

    • &mut self

    • -> Dom

  • fn copy_except_for_root:

    • &mut self

    • -> Dom

  Adds an attribute to this DOM element.
  Example:

  • fn with_attribute:

    • self

    • arg attr: AttributeType

    • -> Dom

  Adds multiple attributes to this DOM element.

  • fn with_attributes:

    • self

    • arg attributes: AttributeVec

    • -> Dom

  • fn fixup_children_estimated:

    • &mut self

    • -> usize

• Represents 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

  dataset: OptionRefAny

  ids_and_classes: IdOrClassVec

  attributes: AttributeVec

  callbacks: CoreCallbackDataVec

  inline_css_props: NodeDataInlineCssPropertyVec

  tab_index: OptionTabIndex

  extra: c_void

  Creates an new, empty NodeData struct

  • constructor create:

    • arg node_type: NodeType

    • -> NodeData

  Shorthand for NodeData::create_node(NodeType::Body).

  • constructor create_body:

    • -> NodeData

  Shorthand for NodeData::create_node(NodeType::Div).

  • constructor create_div:

    • -> NodeData

  Shorthand for NodeData::create_node(NodeType::Br).

  • constructor create_br:

    • -> NodeData

  Shorthand for NodeData::create_node(NodeType::Text(value.into())).

  • constructor create_text:

    • arg value: String

    • -> NodeData

  Shorthand for NodeData::create_node(NodeType::Image(image_id)).

  • constructor create_image:

    • arg image: ImageRef

    • -> NodeData

  • constructor create_iframe:

    • arg data: RefAny

    • arg callback: IFrameCallback

    • -> NodeData

  Creates a new NodeData instance from a given NodeType.

  • constructor create_node:

    • arg node_type: NodeType

    • -> NodeData

  • fn set_dataset:

    • &mut self

    • arg data: OptionRefAny

  • fn set_ids_and_classes:

    • &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

  • fn set_accessibility_info:

    • &mut self

    • arg accessibility_info: AccessibilityInfo

  • fn set_menu_bar:

    • &mut self

    • arg menu_bar: Menu

  • fn set_context_menu:

    • &mut self

    • arg context_menu: Menu

  • fn has_context_menu:

    • &self

    • -> bool

  • fn is_text_node:

    • &self

    • -> bool

  • fn is_iframe_node:

    • &self

    • -> bool

  Returns whether this node is an anonymous box generated for table layout.

  • fn is_anonymous:

    • &self

    • -> bool

  Marks this node as an anonymous box (generated for table layout).

  • 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_normal_css_property:

    • &mut self

    • arg p: CssProperty

  • fn add_hover_css_property:

    • &mut self

    • arg p: CssProperty

  • fn add_active_css_property:

    • &mut self

    • arg p: CssProperty

  • fn add_focus_css_property:

    • &mut self

    • arg p: CssProperty

  • fn is_focusable:

    • &self

    • -> bool

  • fn debug_print_end:

    • &self

    • -> String

• 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

  Root HTML element.

  Html

  Document head (metadata container).

  Head

  Root element of the document body.

  Body

  Generic block-level container.

  Div

  Paragraph.

  P

  Article content.

  Article

  Section of a document.

  Section

  Navigation links.

  Nav

  Sidebar/tangential content.

  Aside

  Header section.

  Header

  Footer section.

  Footer

  Main content.

  Main

  Figure with optional caption.

  Figure

  Caption for figure element.

  FigCaption

  Headings.

  H1

  H2

  H3

  H4

  H5

  H6

  Line break.

  Br

  Horizontal rule.

  Hr

  Preformatted text.

  Pre

  Block quote.

  BlockQuote

  Address.

  Address

  Details disclosure widget.

  Details

  Summary for details element.

  Summary

  Dialog box or window.

  Dialog

  Unordered list.

  Ul

  Ordered list.

  Ol

  List item.

  Li

  Definition list.

  Dl

  Definition term.

  Dt

  Definition description.

  Dd

  Menu list.

  Menu

  Menu item.

  MenuItem

  Directory list (deprecated).

  Dir

  Table container.

  Table

  Table caption.

  Caption

  Table header.

  THead

  Table body.

  TBody

  Table footer.

  TFoot

  Table row.

  Tr

  Table header cell.

  Th

  Table data cell.

  Td

  Table column group.

  ColGroup

  Table column.

  Col

  Form container.

  Form

  Form fieldset.

  FieldSet

  Fieldset legend.

  Legend

  Label for form controls.

  Label

  Input control.

  Input

  Button control.

  Button

  Select dropdown.

  Select

  Option group.

  OptGroup

  Select option.

  SelectOption

  Multiline text input.

  TextArea

  Form output element.

  Output

  Progress indicator.

  Progress

  Scalar measurement within a known range.

  Meter

  List of predefined options for input.

  DataList

  Generic inline container.

  Span

  Anchor/hyperlink.

  A

  Emphasized text.

  Em

  Strongly emphasized text.

  Strong

  Bold text (deprecated - use Dom::strong() for semantic importance).

  B

  Italic text (deprecated - use Dom::em() for emphasis or Dom::cite() for citations).

  I

  Underline text.

  U

  Strikethrough text.

  S

  Marked/highlighted text.

  Mark

  Deleted text.

  Del

  Inserted text.

  Ins

  Code.

  Code

  Sample output.

  Samp

  Keyboard input.

  Kbd

  Variable.

  Var

  Citation.

  Cite

  Defining instance of a term.

  Dfn

  Abbreviation.

  Abbr

  Acronym.

  Acronym

  Inline quotation.

  Q

  Date/time.

  Time

  Subscript.

  Sub

  Superscript.

  Sup

  Small text (deprecated - use CSS font-size instead).

  Small

  Big text (deprecated - use CSS font-size instead).

  Big

  Bi-directional override.

  Bdo

  Bi-directional isolate.

  Bdi

  Word break opportunity.

  Wbr

  Ruby annotation.

  Ruby

  Ruby text.

  Rt

  Ruby text container.

  Rtc

  Ruby parenthesis.

  Rp

  Machine-readable data.

  Data

  Canvas for graphics.

  Canvas

  Embedded object.

  Object

  Embedded object parameter.

  Param

  External resource embed.

  Embed

  Audio content.

  Audio

  Video content.

  Video

  Media source.

  Source

  Text track for media.

  Track

  Image map.

  Map

  Image map area.

  Area

  SVG graphics.

  Svg

  Document title.

  Title

  Metadata.

  Meta

  External resource link.

  Link

  Embedded or referenced script.

  Script

  Style information.

  Style

  Base URL for relative URLs.

  Base

  ::before pseudo-element.

  Before

  ::after pseudo-element.

  After

  ::marker pseudo-element.

  Marker

  ::placeholder pseudo-element.

  Placeholder

  Text content, ::text

  Text(String)

  Image element, ::image

  Image(ImageRef)

  IFrame (embedded content)

  IFrame(IFrameNode)

• 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

  role: AccessibilityRole

  states: AccessibilityStateVec

  accelerator: OptionVirtualKeyCodeCombo

  default_action: OptionString

  supported_actions: AccessibilityActionVec

  is_live_region: bool

  labelled_by: OptionDomNodeId

  described_by: OptionDomNodeId

• 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 MenuItem objects 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 MenuBar or MenuPopup. - 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 ListItem objects. - 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 PropertyPage views. - 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 PageTab is 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 Grouping can 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 PageTab elements. - 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

  The element is unavailable and cannot be interacted with. - Purpose: To indicate that a control is disabled or grayed out. - When to use: For disabled buttons, non-interactive menu items, or any control that is temporarily non-functional. - Example: A "Save" button that is disabled until the user makes changes to a document.

  Unavailable

  The element is selected. - Purpose: To indicate that an item is currently chosen or highlighted. This is distinct from having focus. - When to use: For selected items in a list, highlighted text, or the currently active tab in a tab list. - Example: A file highlighted in a file explorer, or multiple selected emails in an inbox.

  Selected

  The element has the keyboard focus. - Purpose: To identify the single element that will receive keyboard input. - When to use: For the control that is currently active and ready to be manipulated by the keyboard. - Example: A text box with a blinking cursor, or a button with a dotted outline around it.

  Focused

  The element is checked, toggled, or in a mixed state. - Purpose: To represent the state of controls like checkboxes, radio buttons, and toggle buttons. - When to use: For checkboxes that are ticked, selected radio buttons, or toggle buttons that are "on." - Example: A checked "I agree" checkbox, a selected "Yes" radio button, or an active "Bold" button in a toolbar.

  Checked

  The element's content cannot be edited by the user. - Purpose: To indicate that the element's value can be viewed and copied, but not modified. - When to use: For display-only text fields or documents. - Example: A text box displaying a license agreement that the user can scroll through but cannot edit.

  Readonly

  The element is the default action in a dialog or form. - Purpose: To identify the button that will be activated if the user presses the Enter key. - When to use: For the primary confirmation button in a dialog. - Example: The "OK" button in a dialog box, which often has a thicker or colored border.

  Default

  The element is expanded, showing its child items. - Purpose: To indicate that a collapsible element is currently open and its contents are visible. - When to use: For tree view nodes, combo boxes with their lists open, or expanded accordion panels. - Example: A folder in a file explorer's tree view that has been clicked to show its subfolders.

  Expanded

  The element is collapsed, hiding its child items. - Purpose: To indicate that a collapsible element is closed and its contents are hidden. - When to use: The counterpart to Expanded for any collapsible UI element. - Example: A closed folder in a file explorer's tree view, hiding its contents.

  Collapsed

  The element is busy and cannot respond to user interaction. - Purpose: To indicate that the element or application is performing an operation and is temporarily unresponsive. - When to use: When an application is loading, processing data, or otherwise occupied. - Example: A window that is grayed out and shows a spinning cursor while saving a large file.

  Busy

  The element is not currently visible on the screen. - Purpose: To indicate that an element exists but is currently scrolled out of the visible area. - When to use: For items in a long list or a large document that are not within the current viewport. - Example: A list item in a long dropdown that you would have to scroll down to see.

  Offscreen

  The element can accept keyboard focus. - Purpose: To indicate that the user can navigate to this element using the keyboard (e.g., with the Tab key). - When to use: On all interactive elements like buttons, links, and input fields, whether they currently have focus or not. - Example: A button that can receive focus, even if it is not the currently focused element.

  Focusable

  The element is a container whose children can be selected. - Purpose: To indicate that the element contains items that can be chosen. - When to use: On container controls like list boxes, tree views, or text spans where text can be highlighted. - Example: A list box control is Selectable, while its individual list items have the Selected state when chosen.

  Selectable

  The element is a hyperlink. - Purpose: To identify an object that navigates to another resource or location when activated. - When to use: On any object that functions as a hyperlink. - Example: Text or an image that, when clicked, opens a web page.

  Linked

  The element is a hyperlink that has been visited. - Purpose: To indicate that a hyperlink has already been followed by the user. - When to use: On a Linked object that the user has previously activated. - Example: A hyperlink on a web page that has changed color to show it has been visited.

  Traversed

  The element allows multiple of its children to be selected at once. - Purpose: To indicate that a container control supports multi-selection. - When to use: On container controls like list boxes or file explorers that support multiple selections (e.g., with Ctrl-click). - Example: A file list that allows the user to select several files at once for a copy operation.

  Multiselectable

  The element contains protected content that should not be read aloud. - Purpose: To prevent assistive technologies from speaking the content of a sensitive field. - When to use: Primarily for password input fields. - Example: A password text box where typed characters are masked with asterisks or dots.

  Protected

• Determines the behavior of an element in sequential focus navigation

  union enum TabIndex

  Automatic tab index, similar to simply setting focusable = "true" or tabindex = 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 accessibility

  Auto

  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

• Represents an inline CSS property attached to a node for a specific interaction state. This allows defining styles for :hover, :focus, etc., directly on a DOM node.

  union enum NodeDataInlineCssProperty

  A standard, non-interactive style property. - CSS Equivalent: (no pseudo-class)

  Normal(CssProperty)

  A style property that applies when the element is active (e.g., being clicked). - CSS Equivalent: :active

  Active(CssProperty)

  A style property that applies when the element has focus. - CSS Equivalent: :focus

  Focus(CssProperty)

  A style property that applies when the element is being hovered by the mouse. - CSS Equivalent: :hover

  Hover(CssProperty)

  A style property that applies when the element is disabled and cannot be interacted with. - CSS Equivalent: :disabled

  Disabled(CssProperty)

  A style property that applies when the element is checked (e.g., a checkbox or radio button). - CSS Equivalent: :checked

  Checked(CssProperty)

  A style property that applies when the element or one of its descendants has focus. - CSS Equivalent: :focus-within

  FocusWithin(CssProperty)

  A style property that applies to a link that has been visited. - CSS Equivalent: :visited

  Visited(CssProperty)

• A unique, runtime-generated identifier for a single Dom instance.

  struct DomId

  inner: usize

• A UUID for a DOM node within a LayoutWindow.

  struct DomNodeId

  The ID of the Dom this 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 has destructor

  tag_id: TagId

  Node ID of the node that has a tag

  node_id: NodeHierarchyItemId

  Whether this node has a tab-index field

  tab_index: OptionTabIndex

  Parents of this NodeID, sorted in depth order, necessary for efficient hit-testing

  parent_node_ids: NodeIdVec

• struct CoreCallback

  cb: CoreCallbackType

  ctx: OptionRefAny

• struct NodeHierarchyItemId

  inner: usize

  Creates an NodeHierarchyItemId from 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.

  • constructor from_raw:

    • arg value: usize

    • -> NodeHierarchyItemId

  Returns the raw 1-based encoded value.
  # Warning
  The returned value uses 1-based encoding. Do NOT use as an array index!

  • fn into_raw:

    • &self

    • -> usize

• struct CoreCallbackData

  event: EventFilter

  callback: CoreCallback

  refany: RefAny

• struct ListViewOnRowClickCallback

  cb: ListViewOnRowClickCallbackType

  callable: OptionRefAny

• union enum SvgSimpleNode has destructor

  Path(SvgPath)

  Circle(SvgCircle)

  Rect(SvgRect)

  CircleHole(SvgCircle)

  RectHole(SvgRect)

• 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 TabOnClickCallback

  cb: TabOnClickCallbackType

  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

  Checked

  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

  cb: ButtonOnClickCallbackType

  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

  Title

  Meta

  Link

  Script

  Style

  Base

  Text

  Img

  IFrame

  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

  cb: InstantPtrCloneCallbackType

• struct InstantPtrDestructorCallback

  cb: InstantPtrDestructorCallbackType

• struct Callback

  cb: CallbackType

  ctx: OptionRefAny

  Create a new callback with just a function pointer (for native Rust code)

  • constructor create:

    • arg cb: CallbackType

    • -> Callback

  Converts this Callback to a CoreCallback for use with Dom::set_callback

  • fn to_core:

    • self

    • -> CoreCallback

• 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

• 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

  Creates a new NodeId from a zero-based index.
  # Panics
  In debug mode, panics if the index would overflow when incremented. In release mode, saturates to the maximum value.
  # Examples
  

  • constructor new:

    • arg value: usize

    • -> NodeId

  • fn index:

    • &self

    • -> usize

• struct CoreRenderImageCallback

  cb: CoreRenderImageCallbackType

  ctx: OptionRefAny

• struct CoreImageCallback

  refany: RefAny

  callback: CoreRenderImageCallback

• struct LibraryReceiveThreadMsgCallback

  cb: LibraryReceiveThreadMsgCallbackType

• struct ClipboardContent has destructor

  plain_text: String

  styled_runs: StyledTextRunVec

• union enum Selection

  Cursor(TextCursor)

  Range(SelectionRange)

• struct CheckThreadFinishedCallback

  cb: CheckThreadFinishedCallbackType

• union enum TextInputSelection

  All

  FromTo(TextInputSelectionRange)

• struct SelectionRange

  start: TextCursor

  end: TextCursor

• struct TextInputSelectionRange

  dir_from: usize

  dir_to: usize

• struct TextSelectionStartEnd

  selection_start: usize

  selection_end: usize

• struct LibrarySendThreadMsgCallback

  cb: LibrarySendThreadMsgCallbackType

• struct VirtualKeyCodeCombo has destructor

  keys: VirtualKeyCodeVec

• struct SelectionColor

  inner: ColorU

• struct ThreadDestructorCallback

  cb: ThreadDestructorCallbackType

• 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

  cb: RenderImageCallbackType

  ctx: OptionRefAny

  Creates a new RenderImageCallback from a function pointer

  • constructor create:

    • arg cb: RenderImageCallbackType

    • -> RenderImageCallback

  Converts this RenderImageCallback to a CoreRenderImageCallback for use with ImageRef::callback

  • fn to_core:

    • self

    • -> CoreRenderImageCallback

• 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

• union enum IdOrClass has destructor

  Id(String)

  Class(String)

mod menu:

• Represents a menu (context menu, dropdown menu, or application menu). A menu consists of a list of items that can be displayed as a popup or attached to a window's menu bar. Modeled after the Windows API for cross-platform consistency. # Fields * items - The menu items to display * position - Where the menu should appear (for popups) * context_mouse_btn - Which mouse button triggers the context menu

  struct Menu has destructor

  items: MenuItemVec

  position: MenuPopupPosition

  context_mouse_btn: ContextMenuMouseButton

  Creates an new, empty Menu

  • constructor create:

    • arg items: MenuItemVec

    • -> Menu

  Sets the popup position of the menu, ignored on menu bars

  • fn set_popup_position:

    • &mut self

    • arg position: MenuPopupPosition

  Sets the popup position of the menu, ignored on menu bars (builder method)

  • fn with_popup_position:

    • self

    • arg position: MenuPopupPosition

    • -> Menu

• Determines whether this context menu should pop up on a left, right or middle click

  enum ContextMenuMouseButton

  Right

  Middle

  Left

• Specifies where a popup menu should appear relative to the cursor or clicked element. This positioning information is ignored for application-level menus (menu bars) and only applies to context menus and dropdowns.

  enum MenuPopupPosition

  Position menu below and to the left of the cursor

  BottomLeftOfCursor

  Position menu below and to the right of the cursor

  BottomRightOfCursor

  Position menu above and to the left of the cursor

  TopLeftOfCursor

  Position menu above and to the right of the cursor

  TopRightOfCursor

  Position menu below the rectangle that was clicked

  BottomOfHitRect

  Position menu to the left of the rectangle that was clicked

  LeftOfHitRect

  Position menu above the rectangle that was clicked

  TopOfHitRect

  Position menu to the right of the rectangle that was clicked

  RightOfHitRect

  Automatically calculate position based on available screen space near cursor

  AutoCursor

  Automatically calculate position based on available screen space near clicked rect

  AutoHitRect

• Represents a single item in a menu. Menu items can be regular text items with labels and callbacks, visual separators, or line breaks for horizontal menu layouts.

  union enum MenuItem has destructor

  A regular menu item with a label, optional icon, callback, and sub-items

  String(StringMenuItem)

  A visual separator line (only rendered in vertical layouts)

  Separator

  Forces a line break when the menu is laid out horizontally

  BreakLine

• A menu item with a text label and optional features. StringMenuItem represents a clickable menu entry that can have: - A text label - An optional keyboard accelerator (e.g., Ctrl+C) - An optional callback function - An optional icon (checkbox or image) - A state (normal, greyed, or disabled) - Child menu items (for sub-menus) # Examples ,no_run use azul_core::menu::StringMenuItem; use azul_css::AzString; let item = StringMenuItem::new(AzString::from_const_str("Copy"));

  struct StringMenuItem has destructor

  label: String

  accelerator: OptionVirtualKeyCodeCombo

  callback: OptionCoreMenuCallback

  menu_item_state: MenuItemState

  icon: OptionMenuItemIcon

  children: MenuItemVec

  Creates a new menu item

  • constructor create:

    • arg label: String

    • -> StringMenuItem

• Optional icon displayed next to a menu item. Icons can be either: - A checkbox (checked or unchecked) - A custom image (typically 16x16 pixels)

  union enum MenuItemIcon has destructor

  Displays a checkbox, with true = checked, false = unchecked

  Checkbox(bool)

  Displays a custom image (typically 16x16 format)

  Image(ImageRef)

• Describes the interactive state of a menu item. Menu items can be in different states that affect their appearance and behavior: - Normal items are clickable and render normally - Greyed items are visually disabled (greyed out) and non-clickable - Disabled items are non-clickable but retain normal appearance

  enum MenuItemState

  Normal menu item (default)

  Normal

  Menu item is greyed out and clicking it does nothing

  Greyed

  Menu item is disabled, but NOT greyed out

  Disabled