Azul API docs for version 1.0.0-alpha1

App construction and configuration

mod app:

• Version of the layout solver to use - future binary versions of azul may have more fields here, necessary so that old compiled applications don't break with newer releases of azul. Newer layout versions are opt-in only.

  enum LayoutSolverVersion

  Default, current layout solver version

  Default

• Configuration for optional features, such as whether to enable logging or panic hooks

  struct AppConfig

  If enabled, logs error and info messages. Default is LevelFilter::Error to log all errors by default

  log_level: AppLogLevel

  If the app crashes / panics, a window with a message box pops up. Setting this to false disables the popup box.

  enable_visual_panic_hook: bool

  If this is set to true (the default), a backtrace + error information gets logged to stdout and the logging file (only if logging is enabled).

  enable_logging_on_panic: bool

  (STUB) Whether keyboard navigation should be enabled (default: true). Currently not implemented.

  enable_tab_navigation: bool

  termination_behavior: AppTerminationBehavior

  Constructs a default AppConfig, uses the layout solver currently available

  • constructor new:

    • arg layout_solver: LayoutSolverVersion

    • -> AppConfig

• Configuration to set which messages should be logged.

  enum AppLogLevel

  Off

  Error

  Warn

  Info

  Debug

  Trace

• Main application class

  struct AzAppPtr has destructor

  ptr: *const c_void

  run_destructor: bool

  Creates a new App instance from the given AppConfig

  • constructor new:

    • arg data: RefAny

    • arg doc: The initialized data model of the application, will be passed to the `LayoutCallback` of the active windows

    • arg config: AppConfig

    • arg doc: Additional configuration on how the global application should behave

    • -> AzAppPtr

  Spawn a new window on the screen when the app is run.

  • fn add_window:

    • &mut self

    • arg window: WindowCreateOptions

    • arg doc: New window, note that this will **not** be spawned as the root window

  Adds a new image identified by an ID to the image cache

  • fn add_image:

    • &mut self

    • arg id: AzString

    • arg image: ImageRef

  Returns a list of monitors - useful for setting the monitor that a window should spawn on.

  • fn get_monitors:

    • &self

    • List of currently attached monitors, note that this Vec will be empty on wasm32

      -> MonitorVec

  Runs the application. Due to platform restrictions (specifically WinMain on Windows), this function never returns.

  • fn run:

    • &self

    • arg window: WindowCreateOptions

    • arg doc: Initial state of the root (main) window of the application

• External system callbacks to get the system time or create / manage threads

  struct ExternalSystemCallbacks

  create_thread_fn: CreateThreadCallback

  get_system_time_fn: GetSystemTimeCallback

  Use the default, library-internal callbacks instead of providing your own

  • constructor library_internal:

    • -> ExternalSystemCallbacks

Window creation / startup configuration

mod window:

• Options on how to initially create the window

  struct WindowCreateOptions has destructor

  state: WindowState

  size_to_content: bool

  renderer: OptionRendererOptions

  theme: OptionWindowTheme

  create_callback: OptionCallback

  hot_reload: bool

  Creates a new window configuration with a custom layout callback

  • constructor new:

    • arg layout_callback: LayoutCallbackType

    • arg doc: The callback to call when the UI of the window should be rendered

    • -> WindowCreateOptions

• Force a specific renderer: note that azul will crash on startup if the RendererOptions are not satisfied.

  struct RendererOptions

  vsync: Vsync

  srgb: Srgb

  hw_accel: HwAcceleration

• Whether the renderer has VSync enabled

  enum Vsync

  Enabled

  Disabled

  DontCare

• Does the renderer render in SRGB color space? By default, azul tries to set it to Enabled and falls back to Disabled if the OpenGL context can't be initialized properly

  enum Srgb

  Enabled

  Disabled

  DontCare

• Does the renderer render using hardware acceleration? By default, azul tries to set it to Enabled and falls back to Disabled if the OpenGL context can't be initialized properly

  enum HwAcceleration

  Enabled

  Disabled

  DontCare

• Offset in physical pixels (integer units)

  struct LayoutPoint

  x: isize

  y: isize

• Size in physical pixels (integer units)

  struct LayoutSize

  width: isize

  height: isize

• Represents a rectangle in physical pixels (integer units)

  struct LayoutRect

  origin: LayoutPoint

  size: LayoutSize

• Raw platform handle, for integration in / with other toolkits and custom non-azul window extensions

  union enum RawWindowHandle

  IOS(IOSHandle)

  MacOS(MacOSHandle)

  Xlib(XlibHandle)

  Xcb(XcbHandle)

  Wayland(WaylandHandle)

  Windows(WindowsHandle)

  Web(WebHandle)

  Android(AndroidHandle)

  Unsupported

• struct IOSHandle

  ui_window: *mut c_void

  ui_view: *mut c_void

  ui_view_controller: *mut c_void

• struct MacOSHandle

  ns_window: *mut c_void

  ns_view: *mut c_void

• struct XlibHandle

  An Xlib Window

  window: u64

  display: *mut c_void

• struct XcbHandle

  An X11 xcb_window_t.

  window: u32

  A pointer to an X server xcb_connection_t.

  connection: *mut c_void

• struct WaylandHandle

  A pointer to a wl_surface

  surface: *mut c_void

  A pointer to a wl_display.

  display: *mut c_void

• struct WindowsHandle

  A Win32 HWND handle.

  hwnd: *mut c_void

  The HINSTANCE associated with this type's HWND.

  hinstance: *mut c_void

• struct WebHandle

  An ID value inserted into the data attributes of the canvas element as 'raw-handle' When accessing from JS, the attribute will automatically be called rawHandle. Each canvas created by the windowing system should be assigned their own unique ID. 0 should be reserved for invalid / null IDs.

  id: u32

• struct AndroidHandle

  A pointer to an ANativeWindow.

  a_native_window: *mut c_void

• X window type. Maps directly to [_NET_WM_WINDOW_TYPE](https://specifications.freedesktop.org/wm-spec/wm-spec-1.5.html).

  enum XWindowType

  A desktop feature. This can include a single window containing desktop icons with the same dimensions as the screen, allowing the desktop environment to have full control of the desktop, without the need for proxying root window clicks.

  Desktop

  A dock or panel feature. Typically a Window Manager would keep such windows on top of all other windows.

  Dock

  Toolbar windows. "Torn off" from the main application.

  Toolbar

  Pinnable menu windows. "Torn off" from the main application.

  Menu

  A small persistent utility window, such as a palette or toolbox.

  Utility

  The window is a splash screen displayed as an application is starting up.

  Splash

  This is a dialog window.

  Dialog

  A dropdown menu that usually appears when the user clicks on an item in a menu bar. This property is typically used on override-redirect windows.

  DropdownMenu

  A popup menu that usually appears when the user right clicks on an object. This property is typically used on override-redirect windows.

  PopupMenu

  A tooltip window. Usually used to show additional information when hovering over an object with the cursor. This property is typically used on override-redirect windows.

  Tooltip

  The window is a notification. This property is typically used on override-redirect windows.

  Notification

  This should be used on the windows that are popped up by combo boxes. This property is typically used on override-redirect windows.

  Combo

  This indicates the the window is being dragged. This property is typically used on override-redirect windows.

  Dnd

  This is a normal, top-level window.

  Normal

• Same as LayoutPoint, but uses i32 instead of isize

  struct PhysicalPositionI32

  x: i32

  y: i32

• Same as LayoutPoint, but uses u32 instead of isize

  struct PhysicalSizeU32

  width: u32

  height: u32

• Logical rectangle area (can differ based on HiDPI settings). Usually this is what you'd want for hit-testing and positioning elements.

  struct LogicalRect

  origin: LogicalPosition

  size: LogicalSize

• Logical position (can differ based on HiDPI settings). Usually this is what you'd want for hit-testing and positioning elements.

  struct LogicalPosition

  x: f32

  y: f32

  • constructor new:

    • arg x: f32

    • arg y: f32

    • -> LogicalPosition

  • constructor zero:

    • -> LogicalPosition

• A size in "logical" (non-HiDPI-adjusted) pixels in floating-point units

  struct LogicalSize

  width: f32

  height: f32

  • fn to_physical:

    • &self

    • arg hidpi_factor: f32

    • -> PhysicalSizeU32

• Unique hash of a window icon, so that azul does not have to compare the actual bytes to see wether the window icon has changed.

  struct IconKey

  id: usize

• 16x16x4 bytes icon

  struct SmallWindowIconBytes

  key: IconKey

  rgba_bytes: U8Vec

• 16x16x4 bytes icon

  struct LargeWindowIconBytes

  key: IconKey

  rgba_bytes: U8Vec

• Window "favicon", usually shown in the top left of the window on Windows

  union enum WindowIcon

  Small(SmallWindowIconBytes)

  32x32x4 bytes icon

  Large(LargeWindowIconBytes)

• 256x256x4 bytes window icon

  struct TaskBarIcon

  key: IconKey

  rgba_bytes: U8Vec

• Symbolic name for a keyboard key, does NOT take the keyboard locale into account

  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

• Utility function for easier creation of a keymap - i.e. [vec![Ctrl, S], my_function]

  union enum AcceleratorKey

  Ctrl

  Alt

  Shift

  Key(VirtualKeyCode)

• Minimum / maximum / current size of the window in logical dimensions

  struct WindowSize

  Width and height of the window, in logical units (may not correspond to the physical on-screen size)

  dimensions: LogicalSize

  Actual DPI value (default: 96)

  dpi: u32

  Minimum dimensions of the window

  min_dimensions: OptionLogicalSize

  Maximum dimensions of the window

  max_dimensions: OptionLogicalSize

  Returns the hidpi factor of the bounds

  • fn get_hidpi_factor:

    • &self

    • -> f32

• Boolean flags relating to the current window state

  struct WindowFlags

  Is the window currently maximized, minimized or fullscreen

  frame: WindowFrame

  User clicked the close button (set by WindowDelegate, checked by event loop) The close_callback can set this to false to prevent closing

  close_requested: bool

  Window decoration style (title bar, native controls)

  decorations: WindowDecorations

  Is the window currently visible?

  is_visible: bool

  Is the window always on top?

  is_always_on_top: bool

  Whether the window is resizable

  is_resizable: bool

  Whether the window has focus or not (mutating this will request user attention)

  has_focus: bool

  Compositor blur/transparency effect material

  background_material: WindowBackgroundMaterial

  Is smooth scrolling enabled for this window?

  smooth_scroll_enabled: bool

  Is automatic TAB switching supported?

  autotab_enabled: bool

  Window type classification (Normal, Menu, Tooltip, Dialog)

  window_type: WindowType

  Enable client-side decorations (custom titlebar with CSD) Only effective when decorations == WindowDecorations::None

  has_decorations: bool

  Use native menus (Win32 HMENU, macOS NSMenu) instead of Azul window-based menus Default: true on Windows/macOS, false on Linux

  use_native_menus: bool

  Use native context menus instead of Azul window-based context menus Default: true on Windows/macOS, false on Linux

  use_native_context_menus: bool

  Keep window above all others (even from other applications) Platform-specific: Uses SetWindowPos(HWND_TOPMOST) on Windows, [NSWindow setLevel:] on macOS, _NET_WM_STATE_ABOVE on X11, zwlr_layer_shell on Wayland

  is_top_level: bool

  Prevent system from sleeping while window is open Platform-specific: Uses SetThreadExecutionState on Windows, IOPMAssertionCreateWithName on macOS, org.freedesktop.ScreenSaver.Inhibit on Linux

  prevent_system_sleep: bool

• State of the window frame (minimized, maximized, fullscreen or normal window)

  enum WindowFrame

  Normal

  Minimized

  Maximized

  Fullscreen

• Toggles webrender debug flags (will make stuff appear on the screen that you might not want to - used for debugging purposes)

  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

• Determines which keys are pressed currently (modifiers, etc.)

  struct KeyboardState has destructor

  Currently pressed virtual keycode - DO NOT USE THIS FOR TEXT INPUT. For text input, use the text_input parameter in callbacks. For example entering à will fire a VirtualKeyCode::Grave, then VirtualKeyCode::A, so to correctly combine characters, the framework handles text composition internally.

  current_virtual_keycode: OptionVirtualKeyCode

  Currently pressed virtual keycodes (READONLY) - it can happen that more than one key is pressed This is essentially an "extension" of current_scancodes - current_keys stores the characters, but what if the pressed key is not a character (such as ArrowRight or PgUp)? Note that this can have an overlap, so pressing "a" on the keyboard will insert both a VirtualKeyCode::A into current_virtual_keycodes and text input will be handled by the framework automatically for contenteditable nodes.

  pressed_virtual_keycodes: VirtualKeyCodeVec

  Same as current_virtual_keycodes, but the scancode identifies the physical key pressed, independent of the keyboard layout. The scancode does not change if the user adjusts the host's keyboard map. Use when the physical location of the key is more important than the key's host GUI semantics, such as for movement controls in a first-person game (German keyboard: Z key, UK keyboard: Y key, etc.)

  pressed_scancodes: ScanCodeVec

  Returns if the SHIFT key is held down (left OR right shift)

  • fn shift_down:

    • &self

    • -> bool

  Returns if the CTRL key is held down

  • fn ctrl_down:

    • &self

    • -> bool

  Returns if the ALT key is held down

  • fn alt_down:

    • &self

    • -> bool

  Returns if the SUPER ("Windows") key is held down

  • fn super_down:

    • &self

    • -> bool

  Returns if a key is held down

  • fn is_key_down:

    • &self

    • arg key: VirtualKeyCode

    • -> bool

• Current icon of the mouse cursor

  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

• Current position of the mouse cursor, relative to the window. Set to Uninitialized on startup (gets initialized on the first frame).

  union enum CursorPosition

  OutOfWindow(LogicalPosition)

  Uninitialized

  InWindow(LogicalPosition)

  • fn get_position:

    • &self

    • -> OptionLogicalPosition

• Mouse position, cursor type, user scroll input, etc.

  struct MouseState

  Current mouse cursor type, set to None if the cursor is hidden. (READWRITE)

  mouse_cursor_type: OptionMouseCursorType

  Where is the mouse cursor currently? Set to None if the window is not focused. (READWRITE)

  cursor_position: CursorPosition

  Is the mouse cursor locked to the current window (important for applications like games)? (READWRITE)

  is_cursor_locked: bool

  Is the left mouse button down? (READONLY)

  left_down: bool

  Is the right mouse button down? (READONLY)

  right_down: bool

  Is the middle mouse button down? (READONLY)

  middle_down: bool

• Platform-specific window configuration, i.e. WM options that are not cross-platform

  struct PlatformSpecificOptions has destructor

  windows_options: WindowsWindowOptions

  linux_options: LinuxWindowOptions

  mac_options: MacWindowOptions

  wasm_options: WasmWindowOptions

• Window configuration specific to Win32

  struct WindowsWindowOptions

  STARTUP ONLY: Whether the window should allow drag + drop operations (default: true)

  allow_drag_and_drop: bool

  STARTUP ONLY: Sets WS_EX_NOREDIRECTIONBITMAP

  no_redirection_bitmap: bool

  STARTUP ONLY: Window icon (decoded bytes), appears at the top right corner of the window

  window_icon: OptionWindowIcon

  READWRITE: Taskbar icon (decoded bytes), usually 256x256x4 bytes large (ICON_BIG). Can be changed in callbacks / at runtime.

  taskbar_icon: OptionTaskBarIcon

  STARTUP ONLY: Pointer (casted to void pointer) to a HWND handle

  parent_window: OptionHwndHandle

• CSD theme of the window title / button controls

  struct WaylandTheme

  title_bar_active_background_color: [u8;4]

  title_bar_active_separator_color: [u8;4]

  title_bar_active_text_color: [u8;4]

  title_bar_inactive_background_color: [u8;4]

  title_bar_inactive_separator_color: [u8;4]

  title_bar_inactive_text_color: [u8;4]

  maximize_idle_foreground_inactive_color: [u8;4]

  minimize_idle_foreground_inactive_color: [u8;4]

  close_idle_foreground_inactive_color: [u8;4]

  maximize_hovered_foreground_inactive_color: [u8;4]

  minimize_hovered_foreground_inactive_color: [u8;4]

  close_hovered_foreground_inactive_color: [u8;4]

  maximize_disabled_foreground_inactive_color: [u8;4]

  minimize_disabled_foreground_inactive_color: [u8;4]

  close_disabled_foreground_inactive_color: [u8;4]

  maximize_idle_background_inactive_color: [u8;4]

  minimize_idle_background_inactive_color: [u8;4]

  close_idle_background_inactive_color: [u8;4]

  maximize_hovered_background_inactive_color: [u8;4]

  minimize_hovered_background_inactive_color: [u8;4]

  close_hovered_background_inactive_color: [u8;4]

  maximize_disabled_background_inactive_color: [u8;4]

  minimize_disabled_background_inactive_color: [u8;4]

  close_disabled_background_inactive_color: [u8;4]

  maximize_idle_foreground_active_color: [u8;4]

  minimize_idle_foreground_active_color: [u8;4]

  close_idle_foreground_active_color: [u8;4]

  maximize_hovered_foreground_active_color: [u8;4]

  minimize_hovered_foreground_active_color: [u8;4]

  close_hovered_foreground_active_color: [u8;4]

  maximize_disabled_foreground_active_color: [u8;4]

  minimize_disabled_foreground_active_color: [u8;4]

  close_disabled_foreground_active_color: [u8;4]

  maximize_idle_background_active_color: [u8;4]

  minimize_idle_background_active_color: [u8;4]

  close_idle_background_active_color: [u8;4]

  maximize_hovered_background_active_color: [u8;4]

  minimize_hovered_background_active_color: [u8;4]

  close_hovered_background_active_color: [u8;4]

  maximize_disabled_background_active_color: [u8;4]

  minimize_disabled_background_active_color: [u8;4]

  close_disabled_background_active_color: [u8;4]

  title_bar_font: AzString

  title_bar_font_size: f32

• Renderer type of the current windows OpenGL context

  enum RendererType

  Force hardware rendering

  Hardware

  Force software rendering

  Software

• struct WindowState has destructor

  title: AzString

  theme: WindowTheme

  size: WindowSize

  position: WindowPosition

  flags: WindowFlags

  debug_state: DebugState

  keyboard_state: KeyboardState

  mouse_state: MouseState

  touch_state: TouchState

  ime_position: ImePosition

  monitor: Monitor

  platform_specific_options: PlatformSpecificOptions

  renderer_options: RendererOptions

  background_color: ColorU

  layout_callback: LayoutCallback

  close_callback: OptionCallback

  Creates a new WindowState with default settings and a custom layout callback

  • constructor new:

    • arg layout_callback: LayoutCallbackType

    • -> WindowState

  Creates a default WindowState with an empty layout callback - useful only if you use the Rust WindowState { .. WindowState::default() } intialization syntax.

  • constructor default:

    • -> WindowState

• struct LinuxWindowOptions has destructor

  (Unimplemented) - Can only be set at window creation, can't be changed in callbacks.

  x11_visual: OptionX11Visual

  (Unimplemented) - Can only be set at window creation, can't be changed in callbacks.

  x11_screen: OptionI32

  Build window with WM_CLASS hint; defaults to the name of the binary. Only relevant on X11. Can only be set at window creation, can't be changed in callbacks.

  x11_wm_classes: StringPairVec

  Build window with override-redirect flag; defaults to false. Only relevant on X11. Can only be set at window creation, can't be changed in callbacks.

  x11_override_redirect: bool

  Build window with _NET_WM_WINDOW_TYPE hint; defaults to Normal. Only relevant on X11. Can only be set at window creation, can't be changed in callbacks.

  x11_window_types: XWindowTypeVec

  Build window with _GTK_THEME_VARIANT hint set to the specified value. Currently only relevant on X11. Can only be set at window creation, can't be changed in callbacks.

  x11_gtk_theme_variant: OptionAzString

  Build window with resize increment hint. Only implemented on X11. Can only be set at window creation, can't be changed in callbacks.

  x11_resize_increments: OptionLogicalSize

  Build window with base size hint. Only implemented on X11. Can only be set at window creation, can't be changed in callbacks.

  x11_base_size: OptionLogicalSize

  Build window with a given application ID. It should match the .desktop file distributed with your program. Only relevant on Wayland. Can only be set at window creation, can't be changed in callbacks. For details about application ID conventions, see the [Desktop Entry Spec](https://specifications.freedesktop.org/desktop-entry-spec/desktop-entry-spec-latest.html#desktop-file-id)

  wayland_app_id: OptionAzString

  wayland_theme: OptionWaylandTheme

  request_user_attention: UserAttentionType

  window_icon: OptionWindowIcon

  X11-specific: Client-side decoration state (drag position, button hover, etc.)

  x11_decorations_state: OptionLinuxDecorationsState

• struct MacWindowOptions

  _reserved: u8

• struct WasmWindowOptions

  _reserved: u8

• enum FullScreenMode

  - macOS: If the window is in windowed mode, transitions it slowly to fullscreen mode - other: Does the same as FastFullScreen.

  SlowFullScreen

  Window should immediately go into fullscreen mode (on macOS this is not the default behaviour).

  FastFullScreen

  - macOS: If the window is in fullscreen mode, transitions slowly back to windowed state. - other: Does the same as FastWindowed.

  SlowWindowed

  If the window is in fullscreen mode, will immediately go back to windowed mode (on macOS this is not the default behaviour).

  FastWindowed

• State, size, etc of the window, for comparing to the last frame

  enum WindowTheme

  DarkMode

  LightMode

• Position of the top left corner of the window relative to the top left of the monitor

  union enum WindowPosition

  Uninitialized

  Initialized(PhysicalPositionI32)

• IME composition window rectangle (cursor position + height)

  union enum ImePosition

  Uninitialized

  Initialized(LogicalRect)

• Current state of touch devices / touch inputs

  struct TouchState

  Number of active touch points

  num_touches: usize

• Complete information about a monitor/display

  struct Monitor has destructor

  Unique identifier for this monitor (stable across frames)

  id: MonitorId

  Human-readable name (e.g., "\\.\DISPLAY1", "HDMI-1", "Built-in Retina Display")

  name: OptionAzString

  Physical size of the monitor in logical pixels

  size: LayoutSize

  Position of the monitor in the virtual screen coordinate system

  position: LayoutPoint

  DPI scale factor (1.0 = 96 DPI, 2.0 = 192 DPI for Retina)

  scale_factor: f64

  Work area (monitor bounds minus taskbars/panels) in logical pixels

  work_area: LayoutRect

  Available video modes for this monitor

  video_modes: VideoModeVec

  Whether this is the primary/main monitor

  is_primary_monitor: bool

• Describes a rendering configuration for a monitor

  struct VideoMode

  size: LayoutSize

  bit_depth: u16

  refresh_rate: u16

• struct AzStringPair

  key: AzString

  value: AzString

• struct SystemCallbacks

  create_thread: *const c_void

  get_system_time: *const c_void

• enum UserAttentionType

  None

  Critical

  Informational

• Window decoration style

  enum WindowDecorations

  Full decorations: title bar with controls

  Normal

  No title text but controls visible (extended frame)

  NoTitle

  No controls visible but title bar area present

  NoControls

  No decorations at all (borderless)

  None

• Compositor blur/transparency effects for window background

  enum WindowBackgroundMaterial

  No transparency or blur

  Opaque

  Transparent without blur

  Transparent

  macOS: Sidebar material, Windows: Acrylic light

  Sidebar

  macOS: Menu material, Windows: Acrylic

  Menu

  macOS: HUD material, Windows: Acrylic dark

  HUD

  macOS: Titlebar material, Windows: Mica

  Titlebar

  Windows: Mica Alt material

  MicaAlt

• Identifies a specific monitor/display Contains both an index (for fast current-session lookup) and a stable hash (for persistence across app restarts and monitor reconfigurations). - index: Runtime index (0-based), may change if monitors are added/removed - hash: Stable identifier based on monitor properties (name, size, position) Applications can serialize hash to remember which monitor a window was on, then search for matching hash on next launch, falling back to index or PRIMARY.

  struct MonitorId

  Runtime index of the monitor (may change between sessions)

  index: usize

  Stable hash of monitor properties (for persistence)

  hash: u64

• Window type classification for behavior control

  enum WindowType

  Normal application window

  Normal

  Menu popup window (always-on-top, frameless, auto-closes on focus loss)

  Menu

  Tooltip window (always-on-top, no interaction)

  Tooltip

  Dialog window (blocks parent window)

  Dialog

Callback type definitions + struct definitions of CallbackInfos

mod callbacks:

• union enum LayoutCallback has destructor

  Raw(LayoutCallbackInner)

  Marshaled(MarshaledLayoutCallback)

• C-ABI stable wrapper over a MarshaledLayoutCallback

  struct MarshaledLayoutCallback has destructor

  marshal_data: RefAny

  cb: MarshaledLayoutCallbackInner

• C-ABI stable wrapper over a MarshaledLayoutCallbackInner

  struct MarshaledLayoutCallbackInner

  cb: MarshaledLayoutCallbackType

• In order to interact with external VMs (Java, Python, etc.) the callback is often stored as a "function object" In order to callback into external languages, the layout callback has to be able to carry some extra data (the first argument), which usually contains the function object i.e. in the Python VM a PyCallable / PyAny

  fnptr MarshaledLayoutCallbackType

  Marshal-local data (the marshal_data of the MarshaledLayoutCallback struct)

  • arg &mut RefAny

  Application state of the App

  • arg &mut RefAny

  Useful information to contitionally return the structure of the DOM based on the width / height of the window

  • arg LayoutCallbackInfo

  The styled DOM rendered from the application state

  -> StyledDom

• C-ABI stable wrapper over a LayoutCallbackType

  struct LayoutCallbackInner

  cb: LayoutCallbackType

• Callback function pointer (has to be a function pointer in order to be compatible with C APIs later on). IMPORTANT: The callback needs to deallocate the RefAnyPtr and LayoutCallbackInfoPtr, otherwise that memory is leaked. If you use the official auto-generated bindings, this is already done for you. NOTE: The original callback was fn(&self, LayoutCallbackInfo) -> Dom which then evolved to fn(&RefAny, LayoutCallbackInfo) -> Dom. The indirection is necessary because of the memory management around the C API See azul-core/ui_state.rs:298 for how the memory is managed across the callback boundary.

  fnptr LayoutCallbackType

  Application state of the App

  • arg &mut RefAny

  Useful information to contitionally return the structure of the DOM based on the width / height of the window

  • arg &mut LayoutCallbackInfo

  The styled DOM rendered from the application state

  -> StyledDom

• Stores a function pointer that is executed when the given UI element is hit Must return an Update that denotes if the screen should be redrawn.

  struct Callback

  cb: CallbackType

• Main callback type for UI event handling

  fnptr CallbackType

  Reference counted opaque pointer to the data set in the CallbackData for the hit DOM node

  • arg &mut RefAny

  Context struct to allow the callback to manipulate UI structures

  • arg &mut CallbackInfo

  Whether this callback has modified the application state in such a way that a full UI redraw is unavoidable. If any callback returns true, the LayoutCallback of the window will be called again to render the next frame.

  -> Update

• Information about the callback that is passed to the callback whenever a callback is invoked

  struct CallbackInfo

  Single reference to all readonly reference data This consolidates 8 individual parameters into 1, improving API ergonomics

  ref_data: *const c_void

  Platform-specific system style (colors, spacing, etc.) Arc allows safe cloning in callbacks without unsafe pointer manipulation

  system_style: Arc < SystemStyle >

  The ID of the DOM + the node that was hit

  hit_dom_node: DomNodeId

  The (x, y) position of the mouse cursor, relative to top left of the element that was hit

  cursor_relative_to_item: OptionLogicalPosition

  The (x, y) position of the mouse cursor, relative to top left of the window

  cursor_in_viewport: OptionLogicalPosition

  All changes made by the callback, applied atomically after callback returns

  changes: *mut c_void

  Returns the DomNodeId of the element that the callback was attached to.

  • fn get_hit_node:

    • &self

    • -> DomNodeId

  Returns the function pointer necessary to query the current time.

  • fn get_system_time_fn:

    • &self

    • -> GetSystemTimeCallback

  Returns the LayoutPoint of the cursor in the viewport (relative to the origin of the Dom). Set to None if the cursor is not in the current window.

  • fn get_cursor_relative_to_viewport:

    • &self

    • -> OptionLogicalPosition

  Returns the LayoutPoint of the cursor in the viewport (relative to the origin of the Dom). Set to None if the cursor is not hovering over the current node.

  • fn get_cursor_relative_to_node:

    • &self

    • -> OptionLogicalPosition

  Returns a copy of the current windows WindowState.

  • fn get_current_window_state:

    • &self

    • -> WindowState

  Returns a copy of the internal KeyboardState. Same as self.get_window_state().keyboard_state

  • fn get_current_keyboard_state:

    • &self

    • -> KeyboardState

  Returns a copy of the internal MouseState. Same as self.get_window_state().mouse_state

  • fn get_current_mouse_state:

    • &self

    • -> MouseState

  Returns a copy of the current windows WindowState.

  • fn get_previous_window_state:

    • &self

    • -> OptionWindowState

  Returns a copy of the internal KeyboardState. Same as self.get_window_state().keyboard_state

  • fn get_previous_keyboard_state:

    • &self

    • -> OptionKeyboardState

  Returns a copy of the internal MouseState. Same as self.get_window_state().mouse_state

  • fn get_previous_mouse_state:

    • &self

    • -> OptionMouseState

  Returns a copy of the current windows RawWindowHandle.

  • fn get_current_window_handle:

    • &self

    • -> RawWindowHandle

  Returns a reference-counted copy of the current windows' Gl (context). You can use this to render OpenGL textures.

  • fn get_gl_context:

    • &self

    • -> OptionGlContextPtr

  Returns the x / y offset that this node has been scrolled to by the user or None if the node has not been scrolled.

  • fn get_scroll_position:

    • &self

    • arg node_id: DomNodeId

    • -> OptionLogicalPosition

  Returns the dataset property of the given Node or None if the node doesn't have a dataset property.

  • fn get_dataset:

    • &mut self

    • arg node_id: DomNodeId

    • -> OptionRefAny

  Given a dataset, returns the node ID of the "root" RefAny, i.e. the RefAny with the lowest instance count that is set as a dataset on any node.

  • fn get_node_id_of_root_dataset:

    • &mut self

    • arg dataset: RefAny

    • -> OptionDomNodeId

  If the node is a Text node, returns a copy of the internal string contents.

  • fn get_string_contents:

    • &self

    • arg node_id: DomNodeId

    • -> OptionAzString

  If the node is a Text node, returns the layouted inline glyphs of the text currently rendered on the screen

  • fn get_inline_text:

    • &self

    • arg node_id: DomNodeId

    • -> OptionInlineText

  If the node is a Text node, returns the FontRef that was used to render this node. Useful for getting font metrics for a text string

  • fn get_font_ref:

    • &self

    • arg node_id: DomNodeId

    • -> OptionFontRef

  • fn get_text_layout_options:

    • &self

    • arg node_id: DomNodeId

    • -> OptionResolvedTextLayoutOptions

  Similar to get_inline_text(): If the node is a Text node, shape the text string with the same parameters as the current text and return the calculated InlineTextLayout. Necessary to calculate text cursor offsets and to detect when a line overflows content.

  • fn shape_text:

    • &self

    • arg node_id: DomNodeId

    • arg text: AzString

    • -> OptionInlineText

  Returns the index of the node relative to the parent node.

  • fn get_index_in_parent:

    • &mut self

    • arg node_id: DomNodeId

    • -> usize

  Returns the parent DomNodeId of the given DomNodeId. Returns None on an invalid NodeId.

  • fn get_parent:

    • &mut self

    • arg node_id: DomNodeId

    • -> OptionDomNodeId

  Returns the previous siblings DomNodeId of the given DomNodeId. Returns None on an invalid NodeId.

  • fn get_previous_sibling:

    • &mut self

    • arg node_id: DomNodeId

    • -> OptionDomNodeId

  Returns the next siblings DomNodeId of the given DomNodeId. Returns None on an invalid NodeId.

  • fn get_next_sibling:

    • &mut self

    • arg node_id: DomNodeId

    • -> OptionDomNodeId

  Returns the next siblings DomNodeId of the given DomNodeId. Returns None on an invalid NodeId.

  • fn get_first_child:

    • &mut self

    • arg node_id: DomNodeId

    • -> OptionDomNodeId

  Returns the next siblings DomNodeId of the given DomNodeId. Returns None on an invalid NodeId.

  • fn get_last_child:

    • &mut self

    • arg node_id: DomNodeId

    • -> OptionDomNodeId

  Returns the position of a given DOM node in the UI

  • fn get_node_position:

    • &mut self

    • arg node_id: DomNodeId

    • -> OptionPositionInfo

  Returns the size of a given DOM node in the UI

  • fn get_node_size:

    • &mut self

    • arg node_id: DomNodeId

    • -> OptionLogicalSize

  Returns the current computed CSS property of a given DOM node in the UI

  • fn get_computed_css_property:

    • &mut self

    • arg node_id: DomNodeId

    • arg property_type: CssPropertyType

    • -> OptionCssProperty

  Sets the new WindowState for the next frame. The window is updated after all callbacks are run.

  • fn set_window_state:

    • &mut self

    • arg new_state: WindowState

  Sets the new FocusTarget for the next frame. Note that this will emit a On::FocusLost and On::FocusReceived event, if the focused node has changed.

  • fn set_focus:

    • &mut self

    • arg target: FocusTarget

  Sets a CssProperty on a given node to its new value. If this property change affects the layout, this will automatically trigger a relayout and redraw of the screen.

  • fn set_css_property:

    • &mut self

    • arg node_id: DomNodeId

    • arg new_property: CssProperty

  Sets the scroll position of the node

  • fn set_scroll_position:

    • &mut self

    • arg node_id: DomNodeId

    • arg scroll_position: LogicalPosition

  If the node is a Text node, overwrites the Text content with the new string, without requiring the entire UI to be rebuilt.

  • fn set_string_contents:

    • &mut self

    • arg node_id: DomNodeId

    • arg string: AzString

  Adds a new image identified by an ID to the image cache

  • fn add_image:

    • &mut self

    • arg id: AzString

    • arg image: ImageRef

  Returns whether an image with a given CSS ID already exists

  • fn has_image:

    • &self

    • arg id: AzString

    • -> bool

  Returns the image with a given CSS ID

  • fn get_image:

    • &self

    • arg id: AzString

    • -> OptionImageRef

  If the node is an Image, exchanges the current image with a new source

  • fn update_image:

    • &mut self

    • arg node_id: DomNodeId

    • arg new_image: ImageRef

    • arg image_type: UpdateImageType

  Deletes an image identified by a CSS ID from the image cache

  • fn delete_image:

    • &mut self

    • arg id: AzString

  If the node has an ImageMask, exchanges the current mask for the new mask

  • fn update_image_mask:

    • &mut self

    • arg node_id: DomNodeId

    • arg new_mask: ImageMask

  Stops the propagation of the current callback event type to the parent. Events are bubbled from the inside out (children first, then parents), this event stops the propagation of the event to the parent.

  • fn stop_propagation:

    • &mut self

  Spawns a new window with the given WindowCreateOptions.

  • fn create_window:

    • &mut self

    • arg new_window: WindowCreateOptions

  Adds a new Timer to the runtime. See the documentation for Timer for more information.

  • fn start_timer:

    • &mut self

    • arg timer: Timer

    • -> TimerId

  Starts an animation timer on a give NodeId - same as a Timer, but uses a pre-configured interpolation function to drive the animation timer

  • fn start_animation:

    • &mut self

    • arg node: DomNodeId

    • arg animation: Animation

    • -> OptionTimerId

  Stops / cancels a Timer. See the documentation for Timer for more information.

  • fn stop_timer:

    • &mut self

    • arg timer_id: TimerId

    • Returns true if the timer was successfully stopped / removed.

      -> bool

  Starts a new Thread to the runtime. See the documentation for Thread for more information.

  • fn start_thread:

    • &mut self

    • arg thread_initialize_data: RefAny

    • arg writeback_data: RefAny

    • arg callback: ThreadCallbackType

    • -> OptionThreadId

  Sends a message to a background thread

  • fn send_thread_msg:

    • &mut self

    • arg thread_id: ThreadId

    • arg msg: ThreadSendMsg

    • Returns true if the ThreadId is valid and the message could be sent, false otherwise

      -> bool

  Stops a thread at the nearest possible opportunity. Sends a ThreadSendMsg::TerminateThread message to the thread and joins the thread.

  • fn stop_thread:

    • &mut self

    • arg thread_id: ThreadId

    • Returns true if the ThreadId is valid, false otherwise

      -> bool

• Which type of image should be updated: background image (the CSS background) or content image (the <img src=""> content)

  enum UpdateImageType

  Background

  Content

• Specifies if the screen should be updated after the callback function has returned

  enum Update

  The screen does not need to redraw after the callback has been called

  DoNothing

  After the callback is called, the screen needs to redraw (layout() function being called again)

  RefreshDom

  The layout has to be re-calculated for all windows

  RefreshDomAllWindows

• Gives the layout() function access to the RendererResources and the Window (for querying images and fonts, as well as width / height)

  struct LayoutCallbackInfo

  Single reference to all readonly reference data This consolidates 4 individual parameters into 1, improving API ergonomics

  ref_data: *const c_void

  Window size (so that apps can return a different UI depending on the window size - mobile / desktop view). Should be later removed in favor of "resize" handlers and @media queries.

  window_size: WindowSize

  Registers whether the UI is dependent on the window theme

  theme: WindowTheme

  Extension for future ABI stability (referenced data)

  _abi_ref: *const c_void

  Extension for future ABI stability (mutable data)

  _abi_mut: *mut c_void

  Returns a copy of the OpenGL context

  • fn get_gl_context:

    • &self

    • -> OptionGlContextPtr

  Returns all system-native fonts with their respective file paths as values

  • fn get_system_fonts:

    • &self

    • -> StringPairVec

  Returns an ImageRef referenced by a CSS ID

  • fn get_image:

    • &self

    • arg id: AzString

    • -> OptionImageRef

• ID of a DOM - one window can contain multiple, nested DOMs (such as iframes)

  struct DomId

  inner: usize

• Combination of node ID + DOM ID, both together can identify a node

  struct DomNodeId

  dom: DomId

  node: NodeHierarchyItemId

• union enum PositionInfo

  Static(PositionInfoInner)

  Fixed(PositionInfoInner)

  Absolute(PositionInfoInner)

  Relative(PositionInfoInner)

  • fn is_positioned:

    • &self

    • -> bool

  • fn get_static_offset:

    • &self

    • -> LogicalPosition

  • fn get_relative_offset:

    • &self

    • -> LogicalPosition

• struct PositionInfoInner

  x_offset: f32

  y_offset: f32

  static_x_offset: f32

  static_y_offset: f32

• Information about the bounds of a laid-out div rectangle. Necessary when invoking IFrameCallbacks and RenderImageCallbacks, so that they can change what their content is based on their size.

  struct HidpiAdjustedBounds

  logical_size: LogicalSize

  hidpi_factor: DpiScaleFactor

  Returns the size of the bounds in logical units

  • fn get_logical_size:

    • &self

    • -> LogicalSize

  Returns the size of the bounds in physical units

  • fn get_physical_size:

    • &self

    • -> PhysicalSizeU32

  Returns the hidpi factor of the bounds

  • fn get_hidpi_factor:

    • &self

    • -> f32

• struct InlineText has destructor

  List of lines in this text, relative to the text origin

  lines: InlineLineVec

  Content size of all text lines

  content_size: LogicalSize

  Font size in pixels used for layouting this text

  font_size_px: f32

  Index of the last Word in this text (- note that a Word can also be a Space, Return or Tab).

  last_word_index: usize

  NEGATIVE descender of the text baseline (distance from baseline of the text to the bottom of the line)

  baseline_descender_px: f32

  Hit-tests the inline text, returns detailed information about which glyph / word / line, etc. the position (usually the mouse cursor) is currently over. Result may be empty (no hits) or contain more than one result (cursor is hovering over multiple overlapping glyphs at once).

  • fn hit_test:

    • &self

    • arg position: LogicalPosition

    • -> InlineTextHitVec

• struct InlineLine has destructor

  List of words in this line (includes tabs, return and spaces)

  words: InlineWordVec

  Size and origin of the line, relative to the inline text origin (top left corner)

  bounds: LogicalRect

• union enum InlineWord has destructor

  Tab character, width depends on TextLayoutOptions.tab_width

  Tab

  Return character

  Return

  Space character

  Space

  Actual word containing renderable glyphs

  Word(InlineTextContents)

• struct InlineTextContents has destructor

  List of glyphs in this word

  glyphs: InlineGlyphVec

  origin and size of the word relative to the line origin (top left corner of the line)

  bounds: LogicalRect

• struct InlineGlyph

  bounds: LogicalRect

  unicode_codepoint: OptionChar

  glyph_index: u32

• struct InlineTextHit

  Option<char>, if the glyph was a character (as opposed to a diacritic mark), contains the unicode codepoint of the character

  unicode_codepoint: OptionChar

  Position of the hit relative to the top left corner of the inline text

  hit_relative_to_inline_text: LogicalPosition

  Position of the hit relative to the top left corner of the line

  hit_relative_to_line: LogicalPosition

  Position of the hit relative to the top left corner of the word

  hit_relative_to_text_content: LogicalPosition

  Position of the hit relative to the top left corner of the glyph

  hit_relative_to_glyph: LogicalPosition

  Index of the line in the text

  line_index_relative_to_text: usize

  Index of the word in the text (note: words include Space, Tab and Return)

  word_index_relative_to_text: usize

  Index of the text content in the text

  text_content_index_relative_to_text: usize

  Index of the hit glyph in the text (note: one glyph is not one character, glyphs include diacritic marks)

  glyph_index_relative_to_text: usize

  Index of the hit character (unicode codepoint) in the text.

  char_index_relative_to_text: usize

  Index of the hit word (note: includes Tab, Space, Return) in the hit line

  word_index_relative_to_line: usize

  Index of the hit text content ("word") in the hit line

  text_content_index_relative_to_line: usize

  Index of the hit glyph in the line (includes diacritic marks)

  glyph_index_relative_to_line: usize

  Index of the hit character (unicode codepoint) in the line

  char_index_relative_to_line: usize

  Index of the hit glyph in the word (includes diacritic marks)

  glyph_index_relative_to_word: usize

  Index of the hit character (unicode codepoint) in the word

  char_index_relative_to_word: usize

• Defines the focus_targeted node ID for the next frame

  union enum FocusTarget

  Id(DomNodeId)

  Path(FocusTargetPath)

  Previous

  Next

  First

  Last

  NoFocus

• CSS path to set the keyboard input focus

  struct FocusTargetPath

  dom: DomId

  css_path: CssPath

• enum ScriptType

  Auto-determine script type based on text content

  Mixed

  Force left-to-right layout

  LTR

  Force right-to-left layout

  RTL

• struct ResolvedTextLayoutOptions has destructor

  Font size (in pixels) that this text has been laid out with

  font_size_px: f32

  Multiplier for the line height, default to 1.0

  line_height: OptionF32

  Additional spacing between glyphs (in pixels)

  letter_spacing: OptionF32

  Additional spacing between words (in pixels)

  word_spacing: OptionF32

  How many spaces should a tab character emulate (multiplying value, i.e. 4.0 = one tab = 4 spaces)

  tab_width: OptionF32

  Maximum width of the text (in pixels) - if the text is set to overflow:visible, set this to None

  max_horizontal_width: OptionF32

  How many pixels of leading does the first line have? Note that this added onto to the holes, so for effects like :first-letter, use a hole instead of a leading

  leading: OptionF32

  This is more important for inline text layout where items can punch 'holes' into the text flow, for example text that flows around an image

  holes: LogicalRectVec

  Stop layouting text after y coordinate is reached, useful for limiting long text blocks

  max_vertical_height: OptionF32

  Whether text can break lines (white-space: wrap | pre | nowrap), default: true (wrap)

  can_break: bool

  Whether text is hyphenated (hyphens: auto), default: true

  can_hyphenate: bool

  Custom hyphenation character, necessary to calculate breaking in hyphenated texts, default '-'

  hyphenation_character: OptionChar

  Force RTL or LTR (Mixed = auto-detect)

  is_rtl: ScriptType

  Text justification mode (none = aligned depending on LTR / RTL)

  text_justify: OptionStyleTextAlign

  • constructor default:

    • -> ResolvedTextLayoutOptions

• Animation struct to start a new animation

  struct Animation

  from: CssProperty

  to: CssProperty

  duration: AzDuration

  repeat: AnimationRepeat

  repeat_times: AnimationRepeatCount

  easing: AnimationInterpolationFunction

  relayout_on_finish: bool

• How should an animation repeat (loop, ping-pong, etc.)

  enum AnimationRepeat

  NoRepeat

  Loop

  PingPong

• How many times should an animation repeat

  union enum AnimationRepeatCount

  Times(usize)

  Infinite

• Index of a Node in the internal NodeDataContainer

  struct NodeHierarchyItemId

  inner: usize

• C-ABI wrapper over an IFrameCallbackType

  struct IFrameCallback

  cb: IFrameCallbackType

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

  fnptr IFrameCallbackType

  An IFrameCallback can have some data passed along from the parent DOM - usually this would be struct containing the widget state

  • arg &mut RefAny

  Similar to LayoutCallbackInfo, but carries an additional bounds field which has information about the size / current scroll position of the IFrame.

  • arg &mut IFrameCallbackInfo

  Contains the returned StyledDom as well as information about the initial scroll position of the new DOM plus scrollbar / overflow information

  -> IFrameCallbackReturn

• struct IFrameCallbackInfo

  reason: IFrameCallbackReason

  system_fonts: *const c_void

  image_cache: *const c_void

  window_theme: WindowTheme

  bounds: HidpiAdjustedBounds

  scroll_size: LogicalSize

  scroll_offset: LogicalPosition

  virtual_scroll_size: LogicalSize

  virtual_scroll_offset: LogicalPosition

  Extension for future ABI stability (referenced data)

  _abi_ref: *const c_void

  Extension for future ABI stability (mutable data)

  _abi_mut: *mut c_void

• 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 - ✅ 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 - ✅ 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 = 800×600, scroll_size = 800×600 (perfectly covered) Frame 1: Window resizes to 1000×700 (larger) -> IFrame bounds = 1000×700 -> Bounds no longer fully covered by scroll_size (800×600) -> ✅ RE-INVOKE callback once Frame 2: Window resizes to 1100×800 (even larger) -> If callback returned scroll_size = 1100×800, fully covered again -> Do NOT re-invoke (content covers new bounds) -> If callback returned scroll_size = 1000×700, not fully covered -> ✅ RE-INVOKE again (new uncovered area) Frame 3: Window resizes to 900×650 (smaller) -> Bounds now smaller than scroll_size -> Do NOT re-invoke (content is just clipped by scrollbars) ## Scroll Near Edge Example text scroll_size = 1000×2000 (width × height) Container = 800×600 Threshold = 200px Current scroll_offset = 0×0 User scrolls to scroll_offset = 0×1500: -> Bottom edge at 1500 + 600 = 2100 -> Within 200px of scroll_size.height (2000) -> Distance from edge: 2100 - 2000 = 100px < 200px -> ✅ RE-INVOKE callback to load more content Callback returns: -> New scroll_size = 1000×4000 (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

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

• Callback that returns a rendered OpenGL texture IMPORTANT: In azul-core, this is stored as CoreRenderImageCallback with a cb: usize field. When creating callbacks in the data model, function pointers are cast to usize. This type is used in azul-layout where we can safely work with the actual function pointer type.

  struct RenderImageCallback

  cb: RenderImageCallbackType

• Callback type that renders an OpenGL texture IMPORTANT: In azul-core, this is stored as CoreRenderImageCallbackType = usize to avoid circular dependencies. The actual function pointer is cast to usize for storage in the data model, then unsafely cast back to this type when invoked.

  fnptr RenderImageCallbackType

  • arg &mut RefAny

  • arg &mut RenderImageCallbackInfo

  -> ImageRef

• Information passed to image rendering callbacks

  struct RenderImageCallbackInfo

  The ID of the DOM node that the ImageCallback was attached to

  callback_node_id: DomNodeId

  Bounds of the laid-out node

  bounds: HidpiAdjustedBounds

  Optional OpenGL context pointer

  gl_context: *const c_void

  Image cache for looking up images

  image_cache: *const c_void

  System font cache

  system_fonts: *const c_void

  Extension for future ABI stability (referenced data)

  _abi_ref: *const c_void

  Extension for future ABI stability (mutable data)

  _abi_mut: *mut c_void

  Returns a copy of the internal Gl

  • fn get_gl_context:

    • &self

    • -> OptionGlContextPtr

  Returns a copy of the internal HidpiAdjustedBounds

  • fn get_bounds:

    • &self

    • -> HidpiAdjustedBounds

  Returns the DomNodeId that this callback was called on

  • fn get_callback_node_id:

    • &self

    • -> DomNodeId

  If the node is a Text node, returns the layouted inline glyphs

  • fn get_inline_text:

    • &self

    • arg node_id: DomNodeId

    • -> OptionInlineText

  Returns the index of the node relative to the parent node.

  • fn get_index_in_parent:

    • &mut self

    • arg node_id: DomNodeId

    • -> usize

  Returns the parent DomNodeId of the given DomNodeId. Returns None on an invalid NodeId.

  • fn get_parent:

    • &mut self

    • arg node_id: DomNodeId

    • -> OptionDomNodeId

  Returns the previous siblings DomNodeId of the given DomNodeId. Returns None on an invalid NodeId.

  • fn get_previous_sibling:

    • &mut self

    • arg node_id: DomNodeId

    • -> OptionDomNodeId

  Returns the next siblings DomNodeId of the given DomNodeId. Returns None on an invalid NodeId.

  • fn get_next_sibling:

    • &mut self

    • arg node_id: DomNodeId

    • -> OptionDomNodeId

  Returns the next siblings DomNodeId of the given DomNodeId. Returns None on an invalid NodeId.

  • fn get_first_child:

    • &mut self

    • arg node_id: DomNodeId

    • -> OptionDomNodeId

  Returns the next siblings DomNodeId of the given DomNodeId. Returns None on an invalid NodeId.

  • fn get_last_child:

    • &mut self

    • arg node_id: DomNodeId

    • -> OptionDomNodeId

• struct TimerCallback

  cb: TimerCallbackType

• fnptr TimerCallbackType

  • arg &mut RefAny

  • arg &mut TimerCallbackInfo

  -> TimerCallbackReturn

• struct TimerCallbackInfo has destructor

  callback_info: CallbackInfo

  node_id: OptionDomNodeId

  frame_start: Instant

  call_count: usize

  is_about_to_finish: bool

  _abi_ref: *const c_void

  _abi_mut: *mut c_void

• struct TimerCallbackReturn

  should_update: Update

  should_terminate: TerminateTimer

• fnptr WriteBackCallbackType

  • arg &mut RefAny

  • arg &mut RefAny

  • arg &mut CallbackInfo

  -> Update

• struct WriteBackCallback

  cb: WriteBackCallbackType

• struct ThreadCallback

  cb: ThreadCallbackType

• fnptr ThreadCallbackType

  • arg RefAny

  • arg ThreadSender

  • arg ThreadReceiver

• fnptr RefAnyDestructorType

  • arg c_void

• struct RefCount has destructor

  ptr: *const RefCountInner

  run_destructor: bool

  • fn can_be_shared:

    • &self

    • -> bool

  • fn can_be_shared_mut:

    • &self

    • -> bool

  • fn increase_ref:

    • &mut self

  • fn decrease_ref:

    • &mut self

  • fn increase_refmut:

    • &mut self

  • fn decrease_refmut:

    • &mut self

• RefAny is a reference-counted, opaque pointer, which stores a reference to a struct. RefAny can be up- and downcasted (this usually done via generics and can't be expressed in the Rust API)

  struct RefAny has destructor

  void* to a boxed struct or enum of type "T". RefCount stores the RTTI for this opaque type (can be downcasted by the user)

  _internal_ptr: *const c_void

  All the metadata information is set on the refcount, so that the metadata has to only be created once per object, not once per copy

  sharing_info: RefCount

  Instance of this copy (root = 0th copy). Necessary to distinguish between the original copy and all other clones

  instance_id: u64

  run_destructor: bool

  • constructor new_c:

    • arg ptr: *const c_void

    • arg len: usize

    • arg align: usize

    • arg type_id: u64

    • arg type_name: AzString

    • arg destructor: RefAnyDestructorType

    • -> RefAny

  • fn get_type_id:

    • &self

    • -> u64

  • fn get_type_name:

    • &self

    • -> AzString

• Which edge triggered a scroll-based re-invocation

  enum EdgeType

  Top

  Bottom

  Left

  Right

• Config necessary for threading + animations to work in no_std environments

  struct ExternalSystemCallbacks

  create_thread_fn: CreateThreadCallback

  get_system_time_fn: GetSystemTimeCallback

• Menu callback: What data / function pointer should be called when the menu item is clicked?

  struct MenuCallback has destructor

  callback: Callback

  data: RefAny

• Reason why an IFrame callback is being invoked. This helps the callback optimize its behavior based on why it's being called.

  union enum IFrameCallbackReason

  Initial render - first time the IFrame appears

  InitialRender

  Parent DOM was recreated (cache invalidated)

  DomRecreated

  Window/IFrame bounds expanded beyond current scroll_size

  BoundsExpanded

  Scroll position is near an edge (within 200px threshold)

  EdgeScrolled(EdgeType)

  Scroll position extends beyond current scroll_size

  ScrollBeyondContent

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

    • arg node_type: NodeType

    • -> Dom

  • constructor body:

    • -> Dom

  • constructor div:

    • -> Dom

  • constructor br:

    • -> Dom

  • constructor text:

    • arg string: AzString

    • -> Dom

  • constructor image:

    • arg image: ImageRef

    • -> Dom

  • constructor iframe:

    • arg data: RefAny

    • arg callback: IFrameCallbackType

    • -> Dom

  • fn set_node_type:

    • &mut self

    • arg node_type: NodeType

  • fn with_node_type:

    • &mut self

    • arg node_type: NodeType

    • -> Dom

  • fn set_dataset:

    • &mut self

    • arg dataset: RefAny

  • fn with_dataset:

    • &mut self

    • arg dataset: RefAny

    • -> Dom

  • fn set_ids_and_classes:

    • &mut self

    • arg ids_and_classes: IdOrClassVec

  • fn with_ids_and_classes:

    • &mut self

    • arg ids_and_classes: IdOrClassVec

    • -> Dom

  • fn set_callbacks:

    • &mut self

    • arg callbacks: CallbackDataVec

  • fn with_callbacks:

    • &mut self

    • arg callbacks: CallbackDataVec

    • -> Dom

  • fn set_inline_css_props:

    • &mut self

    • arg css_properties: NodeDataInlineCssPropertyVec

  • fn with_inline_css_props:

    • &mut self

    • arg css_properties: NodeDataInlineCssPropertyVec

    • -> Dom

  Adds a child node to this DOM (potentially heap-allocates in Rust code). Swaps self with a default Dom in order to prevent accidental copies.

  • fn add_callback:

    • &mut self

    • arg event: EventFilter

    • arg data: RefAny

    • arg callback: CallbackType

  Same as add_child, but as a builder method.

  • fn with_callback:

    • &mut self

    • arg event: EventFilter

    • arg data: RefAny

    • arg callback: CallbackType

    • -> Dom

  Adds a child node to this DOM (potentially heap-allocates in Rust code). Swaps self with a default Dom in order to prevent accidental copies.

  • fn add_child:

    • &mut self

    • arg child: Dom

  Same as add_child, but as a builder method.

  • fn with_child:

    • &mut self

    • arg child: Dom

    • -> Dom

  Adds a child node to this DOM (potentially heap-allocates in Rust code). Swaps self with a default Dom in order to prevent accidental copies.

  • fn set_children:

    • &mut self

    • arg children: DomVec

  Same as set_children, but as a builder method.

  • fn with_children:

    • &mut self

    • arg children: DomVec

    • -> Dom

  Adds an CSS ID to the DOM root node.

  • fn add_id:

    • &mut self

    • arg id: AzString

  Same as add_id, but as a builder method

  • fn with_id:

    • &mut self

    • arg id: AzString

    • -> Dom

  Adds a CSS class to the DOM root node.

  • fn add_class:

    • &mut self

    • arg class: AzString

  Same as add_class, but as a builder method

  • fn with_class:

    • &mut self

    • arg class: AzString

    • -> Dom

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

  • fn add_css_property:

    • &mut self

    • arg prop: CssProperty

  Same as add_class, but as a builder method

  • fn with_css_property:

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

  Same as add_class, but as a builder method

  • fn with_hover_css_property:

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

  Same as add_class, but as a builder method

  • fn with_active_css_property:

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

  Same as add_class, but as a builder method

  • fn with_focus_css_property:

    • &mut self

    • arg prop: CssProperty

    • -> Dom

  • fn set_inline_style:

    • &mut self

    • arg style: AzString

  • fn with_inline_style:

    • &mut self

    • arg style: AzString

    • -> Dom

  • fn set_inline_hover_style:

    • &mut self

    • arg style: AzString

  • fn with_inline_hover_style:

    • &mut self

    • arg style: AzString

    • -> Dom

  • fn set_inline_active_style:

    • &mut self

    • arg style: AzString

  • fn with_inline_active_style:

    • &mut self

    • arg style: AzString

    • -> Dom

  • fn set_inline_focus_style:

    • &mut self

    • arg style: AzString

  • fn with_inline_focus_style:

    • &mut self

    • arg style: AzString

    • -> Dom

  Sets the clip mask for the DOM root node.

  • fn set_clip_mask:

    • &mut self

    • arg clip_mask: ImageMask

  Same as set_clip_mask, but as a builder method

  • fn with_clip_mask:

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

  Same as set_tab_index, but as a builder method

  • fn with_tab_index:

    • &mut self

    • arg tab_index: TabIndex

    • -> Dom

  Sets accessibility attributes for the DOM root node.

  • fn set_accessibility_info:

    • &mut self

    • arg accessibility_info: AccessibilityInfo

  Same as set_accessibility_info, but as a builder method

  • fn with_accessibility_info:

    • &mut self

    • arg accessibility_info: AccessibilityInfo

    • -> Dom

  Sets the menu bar for the DOM root node. See NodeData::set_menu_bar for more information.

  • fn set_menu_bar:

    • &mut self

    • arg menu_bar: Menu

  Same as set_accessibility_info, but as a builder method

  • fn with_menu_bar:

    • &mut self

    • arg menu_bar: Menu

    • -> Dom

  Sets the context menu for the DOM root node. See NodeData::set_context_menu for more information.

  • fn set_context_menu:

    • &mut self

    • arg context_menu: Menu

  Same as set_context_menu, but as a builder method

  • fn with_context_menu:

    • &mut self

    • arg context_menu: Menu

    • -> Dom

  Calculates the hash of this node (note: in order to be truly unique, you also have to hash the DOM and Node ID).

  • fn hash:

    • &self

    • -> u64

  Returns the number of nodes in the DOM, including all child DOM trees. Result is equal to self.total_children + 1 (count of all child trees + the root node)

  • fn node_count:

    • &self

    • -> usize

  Returns a HTML string that you can write to a file in order to debug the UI structure and debug potential cascading issues

  • fn get_html_string:

    • &mut self

    • -> AzString

  Returns a HTML for unit testing

  • fn get_html_string_test:

    • &mut self

    • -> AzString

  Same as StyledDom::new(dom, css): NOTE - replaces self with an empty DOM, in order to prevent cloning the DOM entirely

  • fn style:

    • &mut self

    • arg css: Css

    • -> StyledDom

• Contains the necessary information to render an embedded IFrame node.

  struct IFrameNode has destructor

  The callback function that returns the DOM for the iframe's content.

  callback: IFrameCallback

  The application data passed to the iframe's layout callback.

  data: RefAny

• struct CallbackData has destructor

  event: EventFilter

  callback: Callback

  data: RefAny

• Represents all data associated with a single DOM node, such as its type, classes, IDs, callbacks, and inline styles.

  struct NodeData has destructor

  div, p, img, etc.

  node_type: NodeType

  data-* attributes for this node, useful to store UI-related data on the node itself.

  dataset: OptionRefAny

  Stores all ids and classes as one vec - size optimization since most nodes don't have any classes or IDs.

  ids_and_classes: IdOrClassVec

  Strongly-typed HTML attributes (aria-*, href, alt, etc.)

  attributes: AttributeVec

  Callbacks attached to this node: On::MouseUp -> Callback(my_button_click_handler)

  callbacks: CoreCallbackDataVec

  Stores the inline CSS properties, same as in HTML.

  inline_css_props: NodeDataInlineCssPropertyVec

  Tab index (commonly used property).

  tab_index: OptionTabIndex

  Stores "extra", not commonly used data of the node: accessibility, clip-mask, tab-index, etc. SHOULD NOT EXPOSED IN THE API - necessary to retroactively add functionality to the node without breaking the ABI.

  extra: *const c_void

  Creates an new, empty NodeData struct

  • constructor new:

    • arg node_type: NodeType

    • -> NodeData

  • constructor body:

    • -> NodeData

  • constructor div:

    • -> NodeData

  • constructor br:

    • -> NodeData

  • constructor text:

    • arg string: AzString

    • -> NodeData

  • constructor image:

    • arg image: ImageRef

    • -> NodeData

  • constructor iframe:

    • arg data: RefAny

    • arg callback: IFrameCallbackType

    • -> NodeData

  • fn set_node_type:

    • &mut self

    • arg node_type: NodeType

  • fn with_node_type:

    • &mut self

    • arg node_type: NodeType

    • -> NodeData

  • fn set_dataset:

    • &mut self

    • arg dataset: RefAny

  • fn with_dataset:

    • &mut self

    • arg dataset: RefAny

    • -> NodeData

  • fn set_ids_and_classes:

    • &mut self

    • arg ids_and_classes: IdOrClassVec

  • fn with_ids_and_classes:

    • &mut self

    • arg ids_and_classes: IdOrClassVec

    • -> NodeData

  Adds a callback this DOM (potentially heap-allocates in Rust code)

  • fn add_callback:

    • &mut self

    • arg event: EventFilter

    • arg data: RefAny

    • arg callback: CallbackType

  Same as add_child, but as a builder method.

  • fn with_callback:

    • &mut self

    • arg event: EventFilter

    • arg data: RefAny

    • arg callback: CallbackType

    • -> NodeData

  • fn set_callbacks:

    • &mut self

    • arg callbacks: CallbackDataVec

  • fn with_callbacks:

    • &mut self

    • arg callbacks: CallbackDataVec

    • -> NodeData

  • fn set_inline_css_props:

    • &mut self

    • arg css_properties: NodeDataInlineCssPropertyVec

  • fn with_inline_css_props:

    • &mut self

    • arg css_properties: NodeDataInlineCssPropertyVec

    • -> NodeData

  • fn set_inline_style:

    • &mut self

    • arg style: AzString

  • fn with_inline_style:

    • &mut self

    • arg style: AzString

    • -> NodeData

  • fn set_inline_hover_style:

    • &mut self

    • arg style: AzString

  • fn with_inline_hover_style:

    • &mut self

    • arg style: AzString

    • -> NodeData

  • fn set_inline_active_style:

    • &mut self

    • arg style: AzString

  • fn with_inline_active_style:

    • &mut self

    • arg style: AzString

    • -> NodeData

  • fn set_inline_focus_style:

    • &mut self

    • arg style: AzString

  • fn with_inline_focus_style:

    • &mut self

    • arg style: AzString

    • -> NodeData

  Sets the extra.clip_mask field for this node

  • fn set_clip_mask:

    • &mut self

    • arg image_mask: ImageMask

  Sets the tab index for this node

  • fn set_tab_index:

    • &mut self

    • arg tab_index: TabIndex

  Sets accessibility attributes for this node

  • fn set_accessibility_info:

    • &mut self

    • arg accessibility_info: AccessibilityInfo

  Adds a (native) menu bar: If this node is the root node the menu bar will be added to the window, else it will be displayed using the width and position of the bounding rectangle

  • fn set_menu_bar:

    • &mut self

    • arg menu_bar: Menu

  Signalizes that this node has a (native) context-aware menu. If set, the user can left-click the node to open the menu

  • fn set_context_menu:

    • &mut self

    • arg context_menu: Menu

  Calculates the hash of this node (note: in order to be truly unique, you also have to hash the DOM and Node ID).

  • fn hash:

    • &self

    • -> u64

• 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(AzString)

  Image element, ::image

  Image(ImageRef)

  IFrame (embedded content)

  IFrame(IFrameNode)

• Defines the type of event that can trigger a callback action.

  enum On

  Mouse cursor is hovering over the element.

  MouseOver

  Mouse cursor has is over element and is pressed (not good for "click" events - use MouseUp instead).

  MouseDown

  (Specialization of MouseDown). Fires only if the left mouse button has been pressed while cursor was over the element.

  LeftMouseDown

  (Specialization of MouseDown). Fires only if the middle mouse button has been pressed while cursor was over the element.

  MiddleMouseDown

  (Specialization of MouseDown). Fires only if the right mouse button has been pressed while cursor was over the element.

  RightMouseDown

  Mouse button has been released while cursor was over the element.

  MouseUp

  (Specialization of MouseUp). Fires only if the left mouse button has been released while cursor was over the element.

  LeftMouseUp

  (Specialization of MouseUp). Fires only if the middle mouse button has been released while cursor was over the element.

  MiddleMouseUp

  (Specialization of MouseUp). Fires only if the right mouse button has been released while cursor was over the element.

  RightMouseUp

  Mouse cursor has entered the element.

  MouseEnter

  Mouse cursor has left the element.

  MouseLeave

  Mousewheel / touchpad scrolling.

  Scroll

  The window received a unicode character (also respects the system locale). Check keyboard_state.current_char to get the current pressed character.

  TextInput

  A virtual keycode was pressed. Note: This is only the virtual keycode, not the actual char. If you want to get the character, use TextInput instead. A virtual key does not have to map to a printable character. You can get all currently pressed virtual keycodes in the keyboard_state.current_virtual_keycodes and / or just the last keycode in the keyboard_state.latest_virtual_keycode.

  VirtualKeyDown

  A virtual keycode was release. See VirtualKeyDown for more info.

  VirtualKeyUp

  A file has been dropped on the element.

  HoveredFile

  A file is being hovered on the element.

  DroppedFile

  A file was hovered, but has exited the window.

  HoveredFileCancelled

  Equivalent to onfocus.

  FocusReceived

  Equivalent to onblur.

  FocusLost

  Default action triggered by screen reader (usually same as click/activate)

  Default

  Element should collapse (e.g., accordion panel, tree node)

  Collapse

  Element should expand (e.g., accordion panel, tree node)

  Expand

  Increment value (e.g., number input, slider)

  Increment

  Decrement value (e.g., number input, slider)

  Decrement

  Converts the On shorthand into a EventFilter

  • fn into_event_filter:

    • self

    • -> EventFilter

• union enum EventFilter

  Calls the attached callback when the mouse is actively over the given element.

  Hover(HoverEventFilter)

  Inverse of Hover - calls the attached callback if the mouse is not over the given element. This is particularly useful for popover menus where you want to close the menu when the user clicks anywhere else but the menu itself.

  Not(NotEventFilter)

  Calls the attached callback when the element is currently focused.

  Focus(FocusEventFilter)

  Calls the callback when anything related to the window is happening. The "hit item" will be the root item of the DOM. For example, this can be useful for tracking the mouse position (in relation to the window). In difference to Desktop, this only fires when the window is focused. This can also be good for capturing controller input, touch input (i.e. global gestures that aren't attached to any component, but rather the "window" itself).

  Window(WindowEventFilter)

  API stub: Something happened with the node itself (node resized, created or removed)

  Component(ComponentEventFilter)

  Something happened with the application (started, shutdown, device plugged in)

  Application(ApplicationEventFilter)

• enum HoverEventFilter

  MouseOver

  MouseDown

  LeftMouseDown

  RightMouseDown

  MiddleMouseDown

  MouseUp

  LeftMouseUp

  RightMouseUp

  MiddleMouseUp

  MouseEnter

  MouseLeave

  Scroll

  ScrollStart

  ScrollEnd

  TextInput

  VirtualKeyDown

  VirtualKeyUp

  HoveredFile

  DroppedFile

  HoveredFileCancelled

  TouchStart

  TouchMove

  TouchEnd

  TouchCancel

  DoubleClick

  Drag

  DragEnd

  DragStart

  LongPress

  PenDown

  PenEnter

  PenLeave

  PenMove

  PenUp

  PinchIn

  PinchOut

  RotateClockwise

  RotateCounterClockwise

  SwipeDown

  SwipeLeft

  SwipeRight

  SwipeUp

  SystemTextSingleClick

  SystemTextDoubleClick

  SystemTextTripleClick

• enum FocusEventFilter

  MouseOver

  MouseDown

  LeftMouseDown

  RightMouseDown

  MiddleMouseDown

  MouseUp

  LeftMouseUp

  RightMouseUp

  MiddleMouseUp

  MouseEnter

  MouseLeave

  Scroll

  ScrollStart

  ScrollEnd

  TextInput

  VirtualKeyDown

  VirtualKeyUp

  FocusReceived

  FocusLost

  DoubleClick

  Drag

  DragEnd

  DragStart

  LongPress

  PenDown

  PenMove

  PenUp

  PinchIn

  PinchOut

  RotateClockwise

  RotateCounterClockwise

  SwipeDown

  SwipeLeft

  SwipeRight

  SwipeUp

• union enum NotEventFilter

  Hover(HoverEventFilter)

  Focus(FocusEventFilter)

• 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

  DoubleClick

  Drag

  DragEnd

  DragStart

  LongPress

  PenDown

  PenEnter

  PenLeave

  PenMove

  PenUp

  PinchIn

  PinchOut

  RotateClockwise

  RotateCounterClockwise

  SwipeDown

  SwipeLeft

  SwipeRight

  SwipeUp

• enum ComponentEventFilter

  AfterMount

  BeforeUnmount

  NodeResized

  DefaultAction

  Selected

• enum ApplicationEventFilter

  DeviceConnected

  DeviceDisconnected

• 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

  Get the "name" of the IAccessible, for example the name of a button, checkbox or menu item. Try to use unique names for each item in a dialog so that voice dictation software doesn't have to deal with extra ambiguity.

  name: OptionAzString

  Get the "value" of the IAccessible, for example a number in a slider, a URL for a link, the text a user entered in a field.

  value: OptionAzString

  Get an enumerated value representing what this IAccessible is used for, for example is it a link, static text, editable text, a checkbox, or a table cell, etc.

  role: AccessibilityRole

  Possible on/off states, such as focused, focusable, selected, selectable, visible, protected (for passwords), checked, etc.

  states: AccessibilityStateVec

  Optional keyboard accelerator.

  accelerator: OptionVirtualKeyCodeCombo

  Optional "default action" description. Only used when there is at least one ComponentEventFilter::DefaultAction callback present on this node.

  default_action: OptionAzString

  A list of actions the user can perform on this element. Maps to accesskit's Action enum.

  supported_actions: AccessibilityActionVec

  For live regions that update automatically (e.g., chat messages, timers). Maps to accesskit's Live property.

  is_live_region: bool

  ID of another node that labels this one (for aria-labelledby).

  labelled_by: OptionDomNodeId

  ID of another node that describes this one (for aria-describedby).

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

• An enum that holds either a CSS ID or a class name as a string.

  union enum IdOrClass

  Id(AzString)

  Class(AzString)

• 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

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

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

    • &mut 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 of the menu

  label: AzString

  Optional accelerator combination (ex. "CTRL + X" = [VirtualKeyCode::Ctrl, VirtualKeyCode::X]) for keyboard shortcut

  accelerator: OptionVirtualKeyCodeCombo

  Optional callback to call

  callback: OptionCoreMenuCallback

  State (normal, greyed, disabled)

  state: MenuItemState

  Optional icon for the menu entry

  icon: OptionMenuItemIcon

  Sub-menus of this item (separators and line-breaks can't have sub-menus)

  children: MenuItemVec

  Creates a new menu item

  • constructor new:

    • arg label: AzString

    • -> StringMenuItem

  Adds a callback to the menu item

  • fn set_callback:

    • &mut self

    • arg data: RefAny

    • arg callback: CallbackType

  Adds a callback to the menu item

  • fn with_callback:

    • &mut self

    • arg data: RefAny

    • arg callback: CallbackType

    • -> StringMenuItem

  Adds a single child submenu to the current menu

  • fn add_child:

    • &mut self

    • arg child: MenuItem

  Adds a single child submenu to the current menu

  • fn with_child:

    • &mut self

    • arg child: MenuItem

    • -> StringMenuItem

  Sets the children of this menu

  • fn set_children:

    • &mut self

    • arg children: MenuItemVec

  Adds a child submenu to the current menu

  • fn with_children:

    • &mut self

    • arg children: MenuItemVec

    • -> StringMenuItem

• Combination of virtual key codes that have to be pressed together

  struct VirtualKeyCodeCombo has destructor

  keys: VirtualKeyCodeVec

• Similar to dom.CallbackData, stores some data + a callback to call when the menu is activated

  struct MenuCallback has destructor

  callback: Callback

  data: RefAny

  • constructor new:

    • arg data: RefAny

    • arg callback: CallbackType

    • -> MenuCallback

• 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

Css parsing module

mod css:

• One block of rules that applies a bunch of rules to a "path" in the style, i.e. div#myid.myclass -> { ("justify-content", "center") }

  struct CssRuleBlock

  The css path (full selector) of the style ruleset

  path: CssPath

  "justify-content: center" => CssDeclaration::Static(CssProperty::JustifyContent(LayoutJustifyContent::Center))

  declarations: CssDeclarationVec

• Represents a full CSS path (i.e. the "div#id.class" selector belonging to a CSS "content group" (the following key-value block)). no_run,ignore "#div > .my_class:focus" == [ CssPathSelector::Type(NodeTypeTag::Div), CssPathSelector::PseudoSelector(CssPathPseudoSelector::LimitChildren), CssPathSelector::Class("my_class"), CssPathSelector::PseudoSelector(CssPathPseudoSelector::Focus), ]

  struct CssPath

  selectors: CssPathSelectorVec

• union enum CssPathSelector

  Represents the * selector

  Global

  div, p, etc.

  Type(NodeTypeTag)

  .something

  Class(AzString)

  #something

  Id(AzString)

  :something

  PseudoSelector(CssPathPseudoSelector)

  Represents the > selector (direct child)

  DirectChildren

  Represents the selector (descendant)

  Children

  Represents the + selector (adjacent sibling)

  AdjacentSibling

  Represents the ~ selector (general sibling)

  GeneralSibling

• Represents one parsed CSS key-value pair, such as "width: 20px" => CssProperty::Width(LayoutWidth::px(20.0))

  union enum CssProperty

  CaretColor(CaretColorValue)

  CaretAnimationDuration(CaretAnimationDurationValue)

  SelectionBackgroundColor(SelectionBackgroundColorValue)

  SelectionColor(SelectionColorValue)

  SelectionRadius(SelectionRadiusValue)

  TextColor(StyleTextColorValue)

  FontSize(StyleFontSizeValue)

  FontFamily(StyleFontFamilyVecValue)

  FontWeight(StyleFontWeightValue)

  FontStyle(StyleFontStyleValue)

  TextAlign(StyleTextAlignValue)

  TextJustify(LayoutTextJustifyValue)

  VerticalAlign(StyleVerticalAlignValue)

  LetterSpacing(StyleLetterSpacingValue)

  TextIndent(StyleTextIndentValue)

  InitialLetter(StyleInitialLetterValue)

  LineClamp(StyleLineClampValue)

  HangingPunctuation(StyleHangingPunctuationValue)

  TextCombineUpright(StyleTextCombineUprightValue)

  ExclusionMargin(StyleExclusionMarginValue)

  HyphenationLanguage(StyleHyphenationLanguageValue)

  LineHeight(StyleLineHeightValue)

  WordSpacing(StyleWordSpacingValue)

  TabWidth(StyleTabWidthValue)

  WhiteSpace(StyleWhiteSpaceValue)

  Hyphens(StyleHyphensValue)

  Direction(StyleDirectionValue)

  UserSelect(StyleUserSelectValue)

  TextDecoration(StyleTextDecorationValue)

  Cursor(StyleCursorValue)

  Display(LayoutDisplayValue)

  Float(LayoutFloatValue)

  BoxSizing(LayoutBoxSizingValue)

  Width(LayoutWidthValue)

  Height(LayoutHeightValue)

  MinWidth(LayoutMinWidthValue)

  MinHeight(LayoutMinHeightValue)

  MaxWidth(LayoutMaxWidthValue)

  MaxHeight(LayoutMaxHeightValue)

  Position(LayoutPositionValue)

  Top(LayoutTopValue)

  Right(LayoutRightValue)

  Left(LayoutLeftValue)

  Bottom(LayoutBottomValue)

  ZIndex(LayoutZIndexValue)

  FlexWrap(LayoutFlexWrapValue)

  FlexDirection(LayoutFlexDirectionValue)

  FlexGrow(LayoutFlexGrowValue)

  FlexShrink(LayoutFlexShrinkValue)

  FlexBasis(LayoutFlexBasisValue)

  JustifyContent(LayoutJustifyContentValue)

  AlignItems(LayoutAlignItemsValue)

  AlignContent(LayoutAlignContentValue)

  ColumnGap(LayoutColumnGapValue)

  RowGap(LayoutRowGapValue)

  GridTemplateColumns(LayoutGridTemplateColumnsValue)

  GridTemplateRows(LayoutGridTemplateRowsValue)

  GridAutoColumns(LayoutGridAutoColumnsValue)

  GridAutoRows(LayoutGridAutoRowsValue)

  GridColumn(LayoutGridColumnValue)

  GridRow(LayoutGridRowValue)

  WritingMode(LayoutWritingModeValue)

  Clear(LayoutClearValue)

  BackgroundContent(StyleBackgroundContentVecValue)

  BackgroundPosition(StyleBackgroundPositionVecValue)

  BackgroundSize(StyleBackgroundSizeVecValue)

  BackgroundRepeat(StyleBackgroundRepeatVecValue)

  OverflowX(LayoutOverflowValue)

  OverflowY(LayoutOverflowValue)

  GridAutoFlow(LayoutGridAutoFlowValue)

  JustifySelf(LayoutJustifySelfValue)

  JustifyItems(LayoutJustifyItemsValue)

  Gap(LayoutGapValue)

  GridGap(LayoutGapValue)

  AlignSelf(LayoutAlignSelfValue)

  Font(StyleFontValue)

  PaddingTop(LayoutPaddingTopValue)

  PaddingLeft(LayoutPaddingLeftValue)

  PaddingRight(LayoutPaddingRightValue)

  PaddingBottom(LayoutPaddingBottomValue)

  PaddingInlineStart(LayoutPaddingInlineStartValue)

  PaddingInlineEnd(LayoutPaddingInlineEndValue)

  MarginTop(LayoutMarginTopValue)

  MarginLeft(LayoutMarginLeftValue)

  MarginRight(LayoutMarginRightValue)

  MarginBottom(LayoutMarginBottomValue)

  BorderTopLeftRadius(StyleBorderTopLeftRadiusValue)

  LayoutTextJustify(LayoutTextJustifyValue)

  BorderTopRightRadius(StyleBorderTopRightRadiusValue)

  BorderBottomLeftRadius(StyleBorderBottomLeftRadiusValue)

  BorderBottomRightRadius(StyleBorderBottomRightRadiusValue)

  BorderTopColor(StyleBorderTopColorValue)

  BorderRightColor(StyleBorderRightColorValue)

  BorderLeftColor(StyleBorderLeftColorValue)

  BorderBottomColor(StyleBorderBottomColorValue)

  BorderTopStyle(StyleBorderTopStyleValue)

  BorderRightStyle(StyleBorderRightStyleValue)

  BorderLeftStyle(StyleBorderLeftStyleValue)

  BorderBottomStyle(StyleBorderBottomStyleValue)

  BorderTopWidth(LayoutBorderTopWidthValue)

  BorderRightWidth(LayoutBorderRightWidthValue)

  BorderLeftWidth(LayoutBorderLeftWidthValue)

  BorderBottomWidth(LayoutBorderBottomWidthValue)

  BoxShadowLeft(StyleBoxShadowValue)

  BoxShadowRight(StyleBoxShadowValue)

  BoxShadowTop(StyleBoxShadowValue)

  BoxShadowBottom(StyleBoxShadowValue)

  Scrollbar(ScrollbarStyleValue)

  ScrollbarWidth(LayoutScrollbarWidthValue)

  ScrollbarColor(StyleScrollbarColorValue)

  Opacity(StyleOpacityValue)

  Visibility(StyleVisibilityValue)

  Transform(StyleTransformVecValue)

  TransformOrigin(StyleTransformOriginValue)

  PerspectiveOrigin(StylePerspectiveOriginValue)

  BackfaceVisibility(StyleBackfaceVisibilityValue)

  MixBlendMode(StyleMixBlendModeValue)

  Filter(StyleFilterVecValue)

  BackdropFilter(StyleFilterVecValue)

  TextShadow(StyleBoxShadowValue)

  BreakBefore(PageBreakValue)

  BreakAfter(PageBreakValue)

  BreakInside(BreakInsideValue)

  Orphans(OrphansValue)

  Widows(WidowsValue)

  BoxDecorationBreak(BoxDecorationBreakValue)

  ColumnCount(ColumnCountValue)

  ColumnWidth(ColumnWidthValue)

  ColumnSpan(ColumnSpanValue)

  ColumnFill(ColumnFillValue)

  ColumnRuleWidth(ColumnRuleWidthValue)

  ColumnRuleStyle(ColumnRuleStyleValue)

  ColumnRuleColor(ColumnRuleColorValue)

  FlowInto(FlowIntoValue)

  FlowFrom(FlowFromValue)

  ShapeOutside(ShapeOutsideValue)

  ShapeInside(ShapeInsideValue)

  ClipPath(ClipPathValue)

  ShapeMargin(ShapeMarginValue)

  ShapeImageThreshold(ShapeImageThresholdValue)

  TableLayout(LayoutTableLayoutValue)

  BorderCollapse(StyleBorderCollapseValue)

  BorderSpacing(LayoutBorderSpacingValue)

  CaptionSide(StyleCaptionSideValue)

  EmptyCells(StyleEmptyCellsValue)

  Content(ContentValue)

  CounterReset(CounterResetValue)

  CounterIncrement(CounterIncrementValue)

  ListStyleType(StyleListStyleTypeValue)

  ListStylePosition(StyleListStylePositionValue)

  StringSet(StringSetValue)

  Returns the key of the CSS property as a string, i.e. background

  • fn get_key_string:

    • &self

    • -> AzString

  Returns the value of the CSS property as a string, i.e. linear-gradient(red, blue)

  • fn get_value_string:

    • &self

    • -> AzString

  Returns the CSS key-value pair as a string, i.e. background: linear-gradient(red, blue)

  • fn get_key_value_string:

    • &self

    • -> AzString

  Interpolates two CSS properties given a value t ranging from 0.0 to 1.0. The interpolation function can be set on the context (Ease, Linear, etc.).

  • fn interpolate:

    • &self

    • arg other: CssProperty

    • arg t: f32

    • arg context: InterpolateResolver

    • -> CssProperty

• union enum CssPathPseudoSelector

  :first

  First

  :last

  Last

  :nth-child

  NthChild(CssNthChildSelector)

  :hover - mouse is over element

  Hover

  :active - mouse is pressed and over element

  Active

  :focus - element has received focus

  Focus

• union enum CssNthChildSelector

  Number(u32)

  Even

  Odd

  Pattern(CssNthChildPattern)

• struct CssNthChildPattern

  repeat: u32

  offset: u32

• struct Stylesheet

  The style rules making up the document - for example, de-duplicated CSS rules

  rules: CssRuleBlockVec

• Css stylesheet - contains a parsed CSS stylesheet in "rule blocks", i.e. blocks of key-value pairs associated with a selector path.

  struct Css

  One CSS stylesheet can hold more than one sub-stylesheet: For example, when overriding native styles, the .sort_by_specificy() function should not mix the two stylesheets during sorting.

  stylesheets: StylesheetVec

  Returns an empty CSS style

  • constructor empty:

    • -> Css

  Returns a CSS style parsed from a String

  • constructor from_string:

    • arg s: AzString

    • -> Css

• Contains one parsed key: value pair, static or dynamic

  union enum CssDeclaration

  Static key-value pair, such as width: 500px

  Static(CssProperty)

  Dynamic key-value pair with default value, such as width: [[ my_id | 500px ]]

  Dynamic(DynamicCssProperty)

• A DynamicCssProperty is a type of css property that can be changed on possibly every frame by the Rust code - for example to implement an On::Hover behaviour. The syntax for such a property looks like this: no_run,ignore #my_div { padding: var(--my_dynamic_property_id, 400px); } Azul will register a dynamic property with the key "my_dynamic_property_id" and the default value of 400px. If the property gets overridden during one frame, the overridden property takes precedence. At runtime the style is immutable (which is a performance optimization - if we can assume that the property never changes at runtime), we can do some optimizations on it. Dynamic style properties can also be used for animations and conditional styles (i.e. hover, focus, etc.), thereby leading to cleaner code, since all of these special cases now use one single API.

  struct DynamicCssProperty

  The stringified ID of this property, i.e. the "my_id" in width: var(--my_id, 500px).

  dynamic_id: AzString

  Default values for this properties - one single value can control multiple properties!

  default_value: CssProperty

• Represents a CSS key (for example "border-radius" => BorderRadius). You can also derive this key from a CssProperty by calling CssProperty::get_type().

  enum CssPropertyType

  CaretColor

  CaretAnimationDuration

  SelectionBackgroundColor

  SelectionColor

  SelectionRadius

  TextColor

  FontSize

  FontFamily

  FontWeight

  FontStyle

  TextAlign

  TextJustify

  VerticalAlign

  LetterSpacing

  TextIndent

  InitialLetter

  LineClamp

  HangingPunctuation

  TextCombineUpright

  ExclusionMargin

  HyphenationLanguage

  LineHeight

  WordSpacing

  TabWidth

  WhiteSpace

  Hyphens

  Direction

  UserSelect

  TextDecoration

  Cursor

  Display

  Float

  BoxSizing

  Width

  Height

  MinWidth

  MinHeight

  MaxWidth

  MaxHeight

  Position

  Top

  Right

  Left

  Bottom

  ZIndex

  FlexWrap

  FlexDirection

  FlexGrow

  FlexShrink

  FlexBasis

  JustifyContent

  AlignItems

  AlignContent

  ColumnGap

  RowGap

  GridTemplateColumns

  GridTemplateRows

  GridAutoColumns

  GridAutoRows

  GridColumn

  GridRow

  GridAutoFlow

  JustifySelf

  JustifyItems

  Gap

  GridGap

  AlignSelf

  Font

  WritingMode

  Clear

  BackgroundContent

  BackgroundPosition

  BackgroundSize

  BackgroundRepeat

  OverflowX

  OverflowY

  PaddingTop

  PaddingLeft

  PaddingRight

  PaddingBottom

  PaddingInlineStart

  PaddingInlineEnd

  MarginTop

  MarginLeft

  MarginRight

  MarginBottom

  BorderTopLeftRadius

  BorderTopRightRadius

  BorderBottomLeftRadius

  BorderBottomRightRadius

  BorderTopColor

  BorderRightColor

  BorderLeftColor

  BorderBottomColor

  BorderTopStyle

  BorderRightStyle

  BorderLeftStyle

  BorderBottomStyle

  BorderTopWidth

  BorderRightWidth

  BorderLeftWidth

  BorderBottomWidth

  BoxShadowLeft

  BoxShadowRight

  BoxShadowTop

  BoxShadowBottom

  Scrollbar

  ScrollbarWidth

  ScrollbarColor

  Opacity

  Visibility

  Transform

  TransformOrigin

  PerspectiveOrigin

  BackfaceVisibility

  MixBlendMode

  Filter

  BackdropFilter

  TextShadow

  BreakBefore

  BreakAfter

  BreakInside

  Orphans

  Widows

  BoxDecorationBreak

  ColumnCount

  ColumnWidth

  ColumnSpan

  ColumnFill

  ColumnRuleWidth

  ColumnRuleStyle

  ColumnRuleColor

  FlowInto

  FlowFrom

  ShapeOutside

  ShapeInside

  ClipPath

  ShapeMargin

  ShapeImageThreshold

  TableLayout

  BorderCollapse

  BorderSpacing

  CaptionSide

  EmptyCells

  Content

  CounterReset

  CounterIncrement

  ListStyleType

  ListStylePosition

  StringSet

• Represents an animation timing function.

  union enum AnimationInterpolationFunction

  Ease

  Linear

  EaseIn

  EaseOut

  EaseInOut

  CubicBezier(SvgCubicCurve)

• Signifies the type of a DOM node without carrying any associated data

  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

• u8-based color, range 0 to 255 (similar to webrenders ColorU)

  struct ColorU

  r: u8

  g: u8

  b: u8

  a: u8

  • constructor from_str:

    • arg string: AzString

    • -> ColorU

  • constructor transparent:

    • -> ColorU

  • constructor white:

    • -> ColorU

  • constructor black:

    • -> ColorU

  • fn to_hash:

    • &self

    • -> AzString

• Enum representing the metric associated with a number (px, pt, em, etc.)

  enum SizeMetric

  Px

  Pt

  Em

  Rem

  In

  Cm

  Mm

  Percent

  Viewport width: 1vw = 1% of viewport width

  Vw

  Viewport height: 1vh = 1% of viewport height

  Vh

  Viewport minimum: 1vmin = 1% of smaller viewport dimension

  Vmin

  Viewport maximum: 1vmax = 1% of larger viewport dimension

  Vmax

• struct PixelValue

  metric: SizeMetric

  number: FloatValue

• Same as PixelValue, but doesn't allow a "%" sign

  struct PixelValueNoPercent

  inner: PixelValue

• What direction should a box-shadow be clipped in (inset or outset).

  enum BoxShadowClipMode

  Outset

  Inset

• Represents a box-shadow or text-shadow property.

  struct StyleBoxShadow

  offset: [PixelValueNoPercent; 2]

  color: ColorU

  blur_radius: PixelValueNoPercent

  spread_radius: PixelValueNoPercent

  clip_mode: BoxShadowClipMode

• Represents a mix-blend-mode attribute, which determines how an element's content should blend with the content of the element's parent.

  enum StyleMixBlendMode

  Normal

  Multiply

  Screen

  Overlay

  Darken

  Lighten

  ColorDodge

  ColorBurn

  HardLight

  SoftLight

  Difference

  Exclusion

  Hue

  Saturation

  Color

  Luminosity

• union enum StyleFilter

  Blend(StyleMixBlendMode)

  Flood(ColorU)

  Blur(StyleBlur)

  Opacity(PercentageValue)

  ColorMatrix(StyleColorMatrix)

  DropShadow(StyleBoxShadow)

  ComponentTransfer

  Offset(StyleFilterOffset)

  Composite(StyleCompositeFilter)

• struct StyleBlur

  width: PixelValue

  height: PixelValue

• struct StyleColorMatrix

  matrix: [FloatValue; 20]

• struct StyleFilterOffset

  x: PixelValue

  y: PixelValue

• union enum StyleCompositeFilter

  Over

  In

  Atop

  Out

  Xor

  Lighter

  Arithmetic([FloatValue; 4])

• Represents an align-content attribute, which aligns a flex container's lines within it when there is extra space in the cross-axis. Default: Stretch

  enum LayoutAlignContent

  Stretch

  Center

  Start

  End

  SpaceBetween

  SpaceAround

• Represents an align-items attribute, which defines the default behavior for how flex items are laid out along the cross axis on the current line. Default: Stretch

  enum LayoutAlignItems

  Stretch

  Center

  Start

  End

  Baseline

• struct LayoutBottom

  inner: PixelValue

• Represents a box-sizing attribute

  enum LayoutBoxSizing

  ContentBox

  BorderBox

• Represents a flex-direction attribute, which establishes the main-axis, thus defining the direction flex items are placed in the flex container. Default: Row

  enum LayoutFlexDirection

  Row

  RowReverse

  Column

  ColumnReverse

• Represents a display CSS property value

  enum LayoutDisplay

  None

  Block

  Inline

  InlineBlock

  Flex

  InlineFlex

  Table

  InlineTable

  TableRowGroup

  TableHeaderGroup

  TableFooterGroup

  TableRow

  TableColumnGroup

  TableColumn

  TableCell

  TableCaption

  FlowRoot

  ListItem

  RunIn

  Marker

  Grid

  InlineGrid

• Represents a flex-grow attribute, which dictates what proportion of the remaining space in the flex container should be assigned to the item. Default: 0

  struct LayoutFlexGrow

  inner: FloatValue

• Represents a flex-shrink attribute, which dictates what proportion of the negative space in the flex container should be removed from the item. Default: 1

  struct LayoutFlexShrink

  inner: FloatValue

• Represents a float attribute

  enum LayoutFloat

  Left

  Right

  None

• union enum LayoutHeight

  Auto

  Px(PixelValue)

  MinContent

  MaxContent

• Represents a justify-content attribute, which defines the alignment along the main axis. Default: Start (flex-start)

  enum LayoutJustifyContent

  FlexStart

  FlexEnd

  Start

  End

  Center

  SpaceBetween

  SpaceAround

  SpaceEvenly

• struct LayoutLeft

  inner: PixelValue

• struct LayoutMarginBottom

  inner: PixelValue

• struct LayoutMarginLeft

  inner: PixelValue

• struct LayoutMarginRight

  inner: PixelValue

• struct LayoutMarginTop

  inner: PixelValue

• struct LayoutMaxHeight

  inner: PixelValue

• struct LayoutMaxWidth

  inner: PixelValue

• struct LayoutMinHeight

  inner: PixelValue

• struct LayoutMinWidth

  inner: PixelValue

• struct LayoutPaddingBottom

  inner: PixelValue

• struct LayoutPaddingLeft

  inner: PixelValue

• struct LayoutPaddingRight

  inner: PixelValue

• struct LayoutPaddingTop

  inner: PixelValue

• Represents a position attribute - default: Static

  enum LayoutPosition

  Static

  Relative

  Absolute

  Fixed

  Sticky

• struct LayoutRight

  inner: PixelValue

• struct LayoutTop

  inner: PixelValue

• union enum LayoutWidth

  Auto

  Px(PixelValue)

  MinContent

  MaxContent

• Represents a flex-wrap attribute, which determines whether flex items are forced onto one line or can wrap onto multiple lines. Default: NoWrap

  enum LayoutFlexWrap

  Wrap

  NoWrap

  WrapReverse

• Represents an overflow-x or overflow-y property. Determines what to do when content overflows an element's box.

  enum LayoutOverflow

  Always shows a scroll bar, overflows on scroll.

  Scroll

  Shows a scroll bar only when content overflows. This is the default.

  Auto

  Clips overflowing content. The rest of the content will be invisible.

  Hidden

  Content is not clipped and renders outside the element's box.

  Visible

  Similar to hidden, clips the content at the box's edge.

  Clip

• Wrapper around an f32 value that is internally casted to an isize, in order to provide hash-ability (to avoid numerical instability).

  struct FloatValue

  number: isize

• Wrapper around FloatValue, represents a percentage instead of just being a regular floating-point value, i.e 5 = 5%

  struct PercentageValue

  number: FloatValue

• Enum representing the metric associated with an angle (deg, rad, etc.)

  enum AngleMetric

  Degree

  Radians

  Grad

  Turn

  Percent

• FloatValue, but associated with a certain metric (i.e. deg, rad, etc.)

  struct AngleValue

  metric: AngleMetric

  number: FloatValue

  • fn get_degrees:

    • &self

    • -> f32

• struct NormalizedLinearColorStop

  offset: PercentageValue

  color: ColorU

• struct NormalizedRadialColorStop

  angle: AngleValue

  color: ColorU

• enum DirectionCorner

  Right

  Left

  Top

  Bottom

  TopRight

  TopLeft

  BottomRight

  BottomLeft

• struct DirectionCorners

  from: DirectionCorner

  to: DirectionCorner

• CSS direction (necessary for gradients). Can either be a fixed angle or a direction ("to right" / "to left", etc.).

  union enum Direction

  Angle(AngleValue)

  FromTo(DirectionCorners)

• Whether a gradient should be repeated or clamped to the edges.

  enum ExtendMode

  Clamp

  Repeat

• struct LinearGradient

  direction: Direction

  extend_mode: ExtendMode

  stops: NormalizedLinearColorStopVec

• enum Shape

  Ellipse

  Circle

• enum RadialGradientSize

  ClosestSide

  ClosestCorner

  FarthestSide

  FarthestCorner

• struct RadialGradient

  shape: Shape

  size: RadialGradientSize

  position: StyleBackgroundPosition

  extend_mode: ExtendMode

  stops: NormalizedLinearColorStopVec

• struct ConicGradient

  extend_mode: ExtendMode

  center: StyleBackgroundPosition

  angle: AngleValue

  stops: NormalizedRadialColorStopVec

• union enum StyleBackgroundContent

  LinearGradient(LinearGradient)

  RadialGradient(RadialGradient)

  ConicGradient(ConicGradient)

  Image(AzString)

  Color(ColorU)

• union enum BackgroundPositionHorizontal

  Left

  Center

  Right

  Exact(PixelValue)

• union enum BackgroundPositionVertical

  Top

  Center

  Bottom

  Exact(PixelValue)

• struct StyleBackgroundPosition

  horizontal: BackgroundPositionHorizontal

  vertical: BackgroundPositionVertical

• enum StyleBackgroundRepeat

  NoRepeat

  Repeat

  RepeatX

  RepeatY

• union enum StyleBackgroundSize

  ExactSize([PixelValue; 2])

  Contain

  Cover

• struct StyleBorderBottomColor

  inner: ColorU

• struct StyleBorderBottomLeftRadius

  inner: PixelValue

• struct StyleBorderBottomRightRadius

  inner: PixelValue

• Style of a border: solid, double, dash, ridge, etc.

  enum BorderStyle

  None

  Solid

  Double

  Dotted

  Dashed

  Hidden

  Groove

  Ridge

  Inset

  Outset

• struct StyleBorderBottomStyle

  inner: BorderStyle

• struct LayoutBorderBottomWidth

  inner: PixelValue

• struct StyleBorderLeftColor

  inner: ColorU

• struct StyleBorderLeftStyle

  inner: BorderStyle

• struct LayoutBorderLeftWidth

  inner: PixelValue

• struct StyleBorderRightColor

  inner: ColorU

• struct StyleBorderRightStyle

  inner: BorderStyle

• struct LayoutBorderRightWidth

  inner: PixelValue

• struct StyleBorderTopColor

  inner: ColorU

• struct StyleBorderTopLeftRadius

  inner: PixelValue

• struct StyleBorderTopRightRadius

  inner: PixelValue

• struct StyleBorderTopStyle

  inner: BorderStyle

• struct LayoutBorderTopWidth

  inner: PixelValue

• Holds info necessary for layouting / styling -webkit-scrollbar properties.

  struct ScrollbarInfo

  Total width (or height for vertical scrollbars) of the scrollbar in pixels

  width: LayoutWidth

  Padding of the scrollbar tracker, in pixels. The inner bar is width - padding pixels wide.

  padding_left: LayoutPaddingLeft

  Padding of the scrollbar (right)

  padding_right: LayoutPaddingRight

  Style of the scrollbar background (-webkit-scrollbar / -webkit-scrollbar-track / -webkit-scrollbar-track-piece combined)

  track: StyleBackgroundContent

  Style of the scrollbar thumbs (the "up" / "down" arrows), (-webkit-scrollbar-thumb)

  thumb: StyleBackgroundContent

  Styles the directional buttons on the scrollbar (-webkit-scrollbar-button)

  button: StyleBackgroundContent

  If two scrollbars are present, addresses the (usually) bottom corner of the scrollable element, where two scrollbars might meet (-webkit-scrollbar-corner)

  corner: StyleBackgroundContent

  Addresses the draggable resizing handle that appears above the corner at the bottom corner of some elements (-webkit-resizer)

  resizer: StyleBackgroundContent

• Scrollbar style for both horizontal and vertical scrollbars.

  struct ScrollbarStyle

  Horizontal scrollbar style, if any

  horizontal: ScrollbarInfo

  Vertical scrollbar style, if any

  vertical: ScrollbarInfo

• Represents a cursor attribute, defining the mouse cursor to be displayed when pointing over an element.

  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

• Represents a font-family attribute

  union enum StyleFontFamily

  System(AzString)

  File(AzString)

  Ref(FontRef)

• Represents a font-size attribute

  struct StyleFontSize

  inner: PixelValue

• Represents a letter-spacing attribute

  struct StyleLetterSpacing

  inner: PixelValue

• Represents a line-height attribute

  struct StyleLineHeight

  inner: PercentageValue

• Represents a tab-width attribute

  struct StyleTabWidth

  inner: PixelValue

• Represents an opacity attribute, a value from 0.0 to 1.0.

  struct StyleOpacity

  inner: PercentageValue

• Represents a transform-origin attribute

  struct StyleTransformOrigin

  x: PixelValue

  y: PixelValue

• struct InterpolateResolver

  interpolate_func: AnimationInterpolationFunction

  parent_rect_width: f32

  parent_rect_height: f32

  current_rect_width: f32

  current_rect_height: f32

• Represents a backface-visibility attribute

  enum StyleBackfaceVisibility

  Visible

  Hidden

• Represents one component of a transform attribute

  union enum StyleTransform

  Matrix(StyleTransformMatrix2D)

  Matrix3D(StyleTransformMatrix3D)

  Translate(StyleTransformTranslate2D)

  Translate3D(StyleTransformTranslate3D)

  TranslateX(PixelValue)

  TranslateY(PixelValue)

  TranslateZ(PixelValue)

  Rotate(AngleValue)

  Rotate3D(StyleTransformRotate3D)

  RotateX(AngleValue)

  RotateY(AngleValue)

  RotateZ(AngleValue)

  Scale(StyleTransformScale2D)

  Scale3D(StyleTransformScale3D)

  ScaleX(PercentageValue)

  ScaleY(PercentageValue)

  ScaleZ(PercentageValue)

  Skew(StyleTransformSkew2D)

  SkewX(AngleValue)

  SkewY(AngleValue)

  Perspective(PixelValue)

• struct StyleTransformMatrix2D

  a: FloatValue

  b: FloatValue

  c: FloatValue

  d: FloatValue

  tx: FloatValue

  ty: FloatValue

• struct StyleTransformMatrix3D

  m11: FloatValue

  m12: FloatValue

  m13: FloatValue

  m14: FloatValue

  m21: FloatValue

  m22: FloatValue

  m23: FloatValue

  m24: FloatValue

  m31: FloatValue

  m32: FloatValue

  m33: FloatValue

  m34: FloatValue

  m41: FloatValue

  m42: FloatValue

  m43: FloatValue

  m44: FloatValue

• struct StyleTransformTranslate2D

  x: PixelValue

  y: PixelValue

• struct StyleTransformTranslate3D

  x: PixelValue

  y: PixelValue

  z: PixelValue

• struct StyleTransformRotate3D

  x: FloatValue

  y: FloatValue

  z: FloatValue

  angle: AngleValue

• struct StyleTransformScale2D

  x: FloatValue

  y: FloatValue

• struct StyleTransformScale3D

  x: FloatValue

  y: FloatValue

  z: FloatValue

• struct StyleTransformSkew2D

  x: AngleValue

  y: AngleValue

• Horizontal text alignment enum (left, center, right) - default: Left

  enum StyleTextAlign

  Left

  Center

  Right

  Justify

  Start

  End

• Represents a color attribute.

  struct StyleTextColor

  inner: ColorU

• Represents a word-spacing attribute

  struct StyleWordSpacing

  inner: PixelValue

• Type alias for CssPropertyValue < StyleBoxShadow >

  union enum StyleBoxShadowValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleBoxShadow)

• Type alias for CssPropertyValue < LayoutAlignContent >

  union enum LayoutAlignContentValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutAlignContent)

• Type alias for CssPropertyValue < LayoutAlignItems >

  union enum LayoutAlignItemsValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutAlignItems)

• Type alias for CssPropertyValue < LayoutBottom >

  union enum LayoutBottomValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutBottom)

• Type alias for CssPropertyValue < LayoutBoxSizing >

  union enum LayoutBoxSizingValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutBoxSizing)

• Type alias for CssPropertyValue < LayoutFlexDirection >

  union enum LayoutFlexDirectionValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutFlexDirection)

• Type alias for CssPropertyValue < LayoutDisplay >

  union enum LayoutDisplayValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutDisplay)

• Type alias for CssPropertyValue < LayoutFlexGrow >

  union enum LayoutFlexGrowValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutFlexGrow)

• Type alias for CssPropertyValue < LayoutFlexShrink >

  union enum LayoutFlexShrinkValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutFlexShrink)

• Type alias for CssPropertyValue < LayoutFloat >

  union enum LayoutFloatValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutFloat)

• Type alias for CssPropertyValue < LayoutHeight >

  union enum LayoutHeightValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutHeight)

• Type alias for CssPropertyValue < LayoutJustifyContent >

  union enum LayoutJustifyContentValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutJustifyContent)

• Type alias for CssPropertyValue < LayoutLeft >

  union enum LayoutLeftValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutLeft)

• Type alias for CssPropertyValue < LayoutMarginBottom >

  union enum LayoutMarginBottomValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutMarginBottom)

• Type alias for CssPropertyValue < LayoutMarginLeft >

  union enum LayoutMarginLeftValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutMarginLeft)

• Type alias for CssPropertyValue < LayoutMarginRight >

  union enum LayoutMarginRightValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutMarginRight)

• Type alias for CssPropertyValue < LayoutMarginTop >

  union enum LayoutMarginTopValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutMarginTop)

• Type alias for CssPropertyValue < LayoutMaxHeight >

  union enum LayoutMaxHeightValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutMaxHeight)

• Type alias for CssPropertyValue < LayoutMaxWidth >

  union enum LayoutMaxWidthValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutMaxWidth)

• Type alias for CssPropertyValue < LayoutMinHeight >

  union enum LayoutMinHeightValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutMinHeight)

• Type alias for CssPropertyValue < LayoutMinWidth >

  union enum LayoutMinWidthValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutMinWidth)

• Type alias for CssPropertyValue < LayoutPaddingBottom >

  union enum LayoutPaddingBottomValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutPaddingBottom)

• Type alias for CssPropertyValue < LayoutPaddingLeft >

  union enum LayoutPaddingLeftValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutPaddingLeft)

• Type alias for CssPropertyValue < LayoutPaddingRight >

  union enum LayoutPaddingRightValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutPaddingRight)

• Type alias for CssPropertyValue < LayoutPaddingTop >

  union enum LayoutPaddingTopValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutPaddingTop)

• Type alias for CssPropertyValue < LayoutPosition >

  union enum LayoutPositionValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutPosition)

• Type alias for CssPropertyValue < LayoutRight >

  union enum LayoutRightValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutRight)

• Type alias for CssPropertyValue < LayoutTop >

  union enum LayoutTopValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutTop)

• Type alias for CssPropertyValue < LayoutWidth >

  union enum LayoutWidthValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutWidth)

• Type alias for CssPropertyValue < LayoutFlexWrap >

  union enum LayoutFlexWrapValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutFlexWrap)

• Type alias for CssPropertyValue < LayoutOverflow >

  union enum LayoutOverflowValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutOverflow)

• Type alias for CssPropertyValue < ScrollbarStyle >

  union enum ScrollbarStyleValue

  Auto

  None

  Inherit

  Initial

  Exact(ScrollbarStyle)

• Type alias for CssPropertyValue < StyleBackgroundContentVec >

  union enum StyleBackgroundContentVecValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleBackgroundContentVec)

• Type alias for CssPropertyValue < StyleBackgroundPositionVec >

  union enum StyleBackgroundPositionVecValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleBackgroundPositionVec)

• Type alias for CssPropertyValue < StyleBackgroundRepeatVec >

  union enum StyleBackgroundRepeatVecValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleBackgroundRepeatVec)

• Type alias for CssPropertyValue < StyleBackgroundSizeVec >

  union enum StyleBackgroundSizeVecValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleBackgroundSizeVec)

• Type alias for CssPropertyValue < StyleBorderBottomColor >

  union enum StyleBorderBottomColorValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleBorderBottomColor)

• Type alias for CssPropertyValue < StyleBorderBottomLeftRadius >

  union enum StyleBorderBottomLeftRadiusValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleBorderBottomLeftRadius)

• Type alias for CssPropertyValue < StyleBorderBottomRightRadius >

  union enum StyleBorderBottomRightRadiusValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleBorderBottomRightRadius)

• Type alias for CssPropertyValue < StyleBorderBottomStyle >

  union enum StyleBorderBottomStyleValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleBorderBottomStyle)

• Type alias for CssPropertyValue < LayoutBorderBottomWidth >

  union enum LayoutBorderBottomWidthValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutBorderBottomWidth)

• Type alias for CssPropertyValue < StyleBorderLeftColor >

  union enum StyleBorderLeftColorValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleBorderLeftColor)

• Type alias for CssPropertyValue < StyleBorderLeftStyle >

  union enum StyleBorderLeftStyleValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleBorderLeftStyle)

• Type alias for CssPropertyValue < LayoutBorderLeftWidth >

  union enum LayoutBorderLeftWidthValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutBorderLeftWidth)

• Type alias for CssPropertyValue < StyleBorderRightColor >

  union enum StyleBorderRightColorValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleBorderRightColor)

• Type alias for CssPropertyValue < StyleBorderRightStyle >

  union enum StyleBorderRightStyleValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleBorderRightStyle)

• Type alias for CssPropertyValue < LayoutBorderRightWidth >

  union enum LayoutBorderRightWidthValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutBorderRightWidth)

• Type alias for CssPropertyValue < StyleBorderTopColor >

  union enum StyleBorderTopColorValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleBorderTopColor)

• Type alias for CssPropertyValue < StyleBorderTopLeftRadius >

  union enum StyleBorderTopLeftRadiusValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleBorderTopLeftRadius)

• Type alias for CssPropertyValue < StyleBorderTopRightRadius >

  union enum StyleBorderTopRightRadiusValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleBorderTopRightRadius)

• Type alias for CssPropertyValue < StyleBorderTopStyle >

  union enum StyleBorderTopStyleValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleBorderTopStyle)

• Type alias for CssPropertyValue < LayoutBorderTopWidth >

  union enum LayoutBorderTopWidthValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutBorderTopWidth)

• Type alias for CssPropertyValue < StyleCursor >

  union enum StyleCursorValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleCursor)

• Type alias for CssPropertyValue < StyleFontFamilyVec >

  union enum StyleFontFamilyVecValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleFontFamilyVec)

• Type alias for CssPropertyValue < StyleFontSize >

  union enum StyleFontSizeValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleFontSize)

• Type alias for CssPropertyValue < StyleLetterSpacing >

  union enum StyleLetterSpacingValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleLetterSpacing)

• Type alias for CssPropertyValue < StyleLineHeight >

  union enum StyleLineHeightValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleLineHeight)

• Type alias for CssPropertyValue < StyleTabWidth >

  union enum StyleTabWidthValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleTabWidth)

• Type alias for CssPropertyValue < StyleTextAlign >

  union enum StyleTextAlignValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleTextAlign)

• Type alias for CssPropertyValue < StyleTextColor >

  union enum StyleTextColorValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleTextColor)

• Type alias for CssPropertyValue < StyleWordSpacing >

  union enum StyleWordSpacingValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleWordSpacing)

• Type alias for CssPropertyValue < StyleOpacity >

  union enum StyleOpacityValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleOpacity)

• Type alias for CssPropertyValue < StyleTransformVec >

  union enum StyleTransformVecValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleTransformVec)

• Type alias for CssPropertyValue < StyleTransformOrigin >

  union enum StyleTransformOriginValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleTransformOrigin)

• Type alias for CssPropertyValue < StylePerspectiveOrigin >

  union enum StylePerspectiveOriginValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleTransformOrigin)

• Type alias for CssPropertyValue < StyleBackfaceVisibility >

  union enum StyleBackfaceVisibilityValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleBackfaceVisibility)

• Type alias for CssPropertyValue < StyleMixBlendMode >

  union enum StyleMixBlendModeValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleMixBlendMode)

• Type alias for CssPropertyValue < StyleFilterVec >

  union enum StyleFilterVecValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleFilterVec)

• Generic CSS property value that can be Auto, None, Initial, Inherit, or an exact value

  union enum CssPropertyValue

  Auto

  None

  Initial

  Inherit

  Revert

  Unset

  Exact(T)

• struct CounterReset

  counter_name: AzString

  value: i32

• Represents a grid line position (start or end)

  union enum GridLine

  auto

  Auto

  Line number (1-based, negative for counting from end)

  Line(i32)

  Named line with optional span count

  Named(String, Option < i32 >)

  span N

  Span(i32)

• Represents a perspective-origin attribute

  struct StylePerspectiveOrigin

  x: PixelValue

  y: PixelValue

• Represents a z-index attribute - controls stacking order of positioned elements

  union enum LayoutZIndex

  Auto

  Integer(i32)

• Represents justify-items for grid containers

  enum LayoutJustifyItems

  Start

  End

  Center

  Stretch

• struct SelectionBackgroundColor

  inner: ColorU

• struct ColumnRuleColor

  inner: ColorU

• FontRef is a reference-counted pointer to a parsed font. It holds a *const c_void that points to the actual parsed font data (typically a ParsedFont from the layout crate). The parsed data is managed via atomic reference counting, allowing safe sharing across threads without duplicating the font data.

  struct FontRef

  Pointer to the parsed font data (e.g., ParsedFont)

  parsed: *const c_void

  Reference counter for memory management

  copies: *const c_void

  Whether to run the destructor on drop

  run_destructor: bool

  Destructor function for the parsed data

  parsed_destructor: fn (*mut c_void)

• Represents the detected platform.

  union enum Platform

  Windows

  MacOs

  Linux(DesktopEnvironment)

  Android

  Ios

  Unknown

• enum ColumnSpan

  None

  All

• Represents a clear attribute

  enum LayoutClear

  None

  Left

  Right

  Both

• Only used for calculations: Point coordinate (x, y) in layout space.

  struct LayoutPoint

  x: isize

  y: isize

• How to handle white space inside an element.

  enum StyleWhiteSpace

  Normal

  Pre

  Nowrap

• Common system metrics for UI element sizing and spacing.

  struct SystemMetrics

  The corner radius for standard elements like buttons.

  corner_radius: OptionPixelValue

  The width of standard borders.

  border_width: OptionPixelValue

• A unified collection of discovered system style properties.

  struct SystemStyle

  theme: Theme

  platform: Platform

  colors: SystemColors

  fonts: SystemFonts

  metrics: SystemMetrics

  scrollbar: OptionComputedScrollbarStyle

  An optional, user-provided stylesheet loaded from a conventional location (~/.config/azul/styles/<app_name>.css), allowing for application-specific "ricing". This is only loaded when the "io" feature is enabled and not disabled by the AZUL_DISABLE_RICING env var.

  app_specific_stylesheet: *const c_void

• Font metrics structure containing all font-related measurements from the font file tables (head, hhea, and os/2 tables).

  struct FontMetrics

  units_per_em: u16

  font_flags: u16

  x_min: i16

  y_min: i16

  x_max: i16

  y_max: i16

  ascender: i16

  descender: i16

  line_gap: i16

  advance_width_max: u16

  min_left_side_bearing: i16

  min_right_side_bearing: i16

  x_max_extent: i16

  caret_slope_rise: i16

  caret_slope_run: i16

  caret_offset: i16

  num_h_metrics: u16

  x_avg_char_width: i16

  us_weight_class: u16

  us_width_class: u16

  fs_type: u16

  y_subscript_x_size: i16

  y_subscript_y_size: i16

  y_subscript_x_offset: i16

  y_subscript_y_offset: i16

  y_superscript_x_size: i16

  y_superscript_y_size: i16

  y_superscript_x_offset: i16

  y_superscript_y_offset: i16

  y_strikeout_size: i16

  y_strikeout_position: i16

  s_family_class: i16

  panose: [u8;10]

  ul_unicode_range1: u32

  ul_unicode_range2: u32

  ul_unicode_range3: u32

  ul_unicode_range4: u32

  ach_vend_id: u32

  fs_selection: u16

  us_first_char_index: u16

  us_last_char_index: u16

  s_typo_ascender: OptionI16

  s_typo_descender: OptionI16

  s_typo_line_gap: OptionI16

  us_win_ascent: OptionU16

  us_win_descent: OptionU16

  ul_code_page_range1: OptionU32

  ul_code_page_range2: OptionU32

  sx_height: OptionI16

  s_cap_height: OptionI16

  us_default_char: OptionU16

  us_break_char: OptionU16

  us_max_context: OptionU16

  us_lower_optical_point_size: OptionU16

  us_upper_optical_point_size: OptionU16

• Represents a break-inside CSS property value.

  enum BreakInside

  Auto

  Avoid

  AvoidPage

  AvoidColumn

• Represents an align-self attribute, which allows the default alignment (or the one specified by align-items) to be overridden for individual flex items. Default: Auto

  enum LayoutAlignSelf

  Auto

  Stretch

  Center

  Start

  End

  Baseline

• struct CaretAnimationDuration

  inner: Duration

• struct ColumnRuleStyle

  inner: BorderStyle

• struct SvgPoint

  x: f32

  y: f32

• Represents grid-row or grid-column (start / end)

  struct GridPlacement

  start: GridLine

  end: GridLine

• struct StringSet

  inner: AzString

• union enum ShapeOutside

  None

  Shape(String)

• struct SvgVector

  x: f64

  y: f64

• Represents the detected Linux Desktop Environment.

  union enum DesktopEnvironment

  Gnome

  Kde

  Other(AzString)

• union enum ColumnCount

  Auto

  Integer(u32)

• Represents a writing-mode attribute

  enum LayoutWritingMode

  HorizontalTb

  VerticalRl

  VerticalLr

• struct SvgRect

  width: f32

  height: f32

  x: f32

  y: f32

  radius_top_left: f32

  radius_top_right: f32

  radius_bottom_left: f32

  radius_bottom_right: f32

• Common system colors used for UI elements.

  struct SystemColors

  text: OptionColorU

  background: OptionColorU

  accent: OptionColorU

  accent_text: OptionColorU

  button_face: OptionColorU

  button_text: OptionColorU

  window_background: OptionColorU

  selection_background: OptionColorU

  selection_text: OptionColorU

• Only used for calculations: Rectangle (x, y, width, height) in layout space.

  struct LayoutRect

  origin: LayoutPoint

  size: LayoutSize

• Controls whether the user can select text. Used to prevent accidental text selection on UI controls like buttons.

  enum StyleUserSelect

  Browser determines selectability (default)

  Auto

  Text is selectable

  Text

  Text is not selectable

  None

  User can select all text with a single action

  All

• union enum FlowInto

  None

  Named(AzString)

• Represents grid-template-columns or grid-template-rows

  struct GridTemplate

  tracks: GridTrackSizingVec

• Represents justify-self for grid items

  enum LayoutJustifySelf

  Auto

  Start

  End

  Center

  Stretch

• struct Content

  inner: AzString

• Hyphenation rules.

  enum StyleHyphens

  Auto

  None

• struct LayoutGap

  inner: PixelValue

• Text direction.

  enum StyleDirection

  Ltr

  Rtl

• Represents a flex-basis attribute

  union enum LayoutFlexBasis

  auto

  Auto

  Fixed size

  Exact(PixelValue)

• struct ShapeMargin

  inner: PixelValue

• enum LayoutTextJustify

  Auto

  None

  InterWord

  InterCharacter

  Distribute

• union enum ColumnWidth

  Auto

  Length(PixelValue)

• struct CounterIncrement

  counter_name: AzString

  value: i32

• Represents a box-decoration-break CSS property value.

  enum BoxDecorationBreak

  Slice

  Clone

• struct SvgCubicCurve

  start: SvgPoint

  ctrl_1: SvgPoint

  ctrl_2: SvgPoint

  end: SvgPoint

• struct SvgQuadraticCurve

  start: SvgPoint

  ctrl: SvgPoint

  end: SvgPoint

• struct SelectionColor

  inner: ColorU

• Represents a visibility attribute, controlling element visibility.

  enum StyleVisibility

  Visible

  Hidden

  Collapse

• The overall theme type.

  enum Theme

  Light

  Dark

• struct ShapeImageThreshold

  inner: FloatValue

• Represents the grid-auto-flow property

  enum LayoutGridAutoFlow

  Row

  Column

  RowDense

  ColumnDense

• struct ColumnRuleWidth

  inner: PixelValue

• struct AzString

  vec: U8Vec

• Text decoration (underline, overline, line-through).

  enum StyleTextDecoration

  No decoration

  None

  Underline

  Underline

  Line above text

  Overline

  Strike-through line

  LineThrough

• struct CaretColor

  inner: ColorU

• Only used for calculations: Size (width, height) in layout space.

  struct LayoutSize

  width: isize

  height: isize

• enum ColumnFill

  Auto

  Balance

• Common system font settings.

  struct SystemFonts

  The primary font used for UI elements like buttons and labels.

  ui_font: OptionAzString

  The default font size for UI elements, in points.

  ui_font_size: OptionF32

  The font used for code or other monospaced text.

  monospace_font: OptionAzString

• union enum FlowFrom

  None

  Named(AzString)

• Represents a break-before or break-after CSS property value.

  enum PageBreak

  Auto

  Avoid

  Always

  All

  Page

  AvoidPage

  Left

  Right

  Recto

  Verso

  Column

  AvoidColumn

• Represents the standard scrollbar-width property.

  enum LayoutScrollbarWidth

  Auto

  Thin

  None

• Represents the standard scrollbar-color property.

  union enum StyleScrollbarColor

  Auto

  Custom(ColorU, ColorU)

• Vertical text alignment enum (top, center, bottom) - default: Top

  enum StyleVerticalAlign

  Top

  Center

  Bottom

• line-clamp property for limiting visible lines

  struct StyleLineClamp

  max_lines: usize

• CSS shape-inside property for flowing text within shapes

  union enum ShapeInside

  None

  Shape(Shape)

• struct SelectionRadius

  inner: PixelValue

• Represents a text-indent attribute (indentation of first line in a block).

  struct StyleTextIndent

  inner: PixelValue

• Sets the distance between the borders of adjacent cells. The border-spacing property is only applicable when border-collapse is set to separate. It can have one or two values: - One value: Sets both horizontal and vertical spacing - Two values: First is horizontal, second is vertical This struct represents a single spacing value (either horizontal or vertical).

  struct LayoutBorderSpacing

  Horizontal spacing between cell borders

  horizontal: PixelValue

  Vertical spacing between cell borders

  vertical: PixelValue

• Represents the font-weight property.

  enum StyleFontWeight

  Lighter

  W100

  W200

  W300

  Normal

  W500

  W600

  Bold

  W800

  W900

  Bolder

• -azul-exclusion-margin property: defines margin around shape exclusions This property controls the spacing between text and shapes that text flows around. It's similar to shape-margin but specifically for exclusions (text wrapping). # Example css .element { -azul-exclusion-margin: 10.5; }

  struct StyleExclusionMargin

  inner: FloatValue

• enum StyleListStyleType

  None

  Disc

  Circle

  Square

  Decimal

  DecimalLeadingZero

  LowerRoman

  UpperRoman

  LowerGreek

  UpperGreek

  LowerAlpha

  UpperAlpha

• CSS clip-path property for clipping element rendering

  union enum ClipPath

  None

  Shape(Shape)

• -azul-hyphenation-language property: specifies language for hyphenation This property defines the language code (BCP 47 format) used for automatic hyphenation. Examples: "en-US", "de-DE", "fr-FR" # Example css .element { -azul-hyphenation-language: "en-US"; }

  struct StyleHyphenationLanguage

  inner: AzString

• enum StyleListStylePosition

  Inside

  Outside

• Specifies whether cell borders are collapsed into a single border or separated. The border-collapse property determines the border rendering model: - separate: Each cell has its own border (default, uses border-spacing) - collapse: Adjacent cells share borders (ignores border-spacing)

  enum StyleBorderCollapse

  Borders are separated (default). Each cell has its own border. The border-spacing property defines the distance between borders.

  Separate

  Borders are collapsed. Adjacent cells share a single border. Border conflict resolution rules apply when borders differ.

  Collapse

• Specifies the placement of a table caption. The caption-side property positions the caption either above or below the table.

  enum StyleCaptionSide

  Caption is placed above the table (default)

  Top

  Caption is placed below the table

  Bottom

• hanging-punctuation property for hanging punctuation marks

  struct StyleHangingPunctuation

  enabled: bool

• Controls the algorithm used to lay out table cells, rows, and columns. The table-layout property determines whether the browser should use: - auto: Column widths are determined by the content (slower but flexible) - fixed: Column widths are determined by the first row (faster and predictable)

  enum LayoutTableLayout

  Use automatic table layout algorithm (content-based, default). Column width is set by the widest unbreakable content in the cells.

  Auto

  Use fixed table layout algorithm (first-row-based). Column width is set by the width property of the column or first-row cell. Renders faster than auto.

  Fixed

• initial-letter property for drop caps

  struct StyleInitialLetter

  size: usize

  sink: Optionusize

• Specifies whether or not to display borders and background on empty cells. The empty-cells property only applies when border-collapse is set to separate. A cell is considered empty if it contains no visible content.

  enum StyleEmptyCells

  Show borders and background on empty cells (default)

  Show

  Hide borders and background on empty cells

  Hide

• Represents the font-style property.

  enum StyleFontStyle

  Normal

  Italic

  Oblique

• text-combine-upright property for combining horizontal text in vertical layout

  union enum StyleTextCombineUpright

  None

  All

  Digits(u8)