[go: up one dir, main page]

Module i_slint_core::items

source ·
Expand description

This module contains the builtin items, either in this file or in sub-modules.

When adding an item or a property, it needs to be kept in sync with different place. (This is less than ideal and maybe we can have some automation later)

  • It needs to be changed in this module
  • In the compiler: builtins.slint
  • In the interpreter (new item only): dynamic_component.rs
  • For the C++ code (new item only): the cbindgen.rs to export the new item
  • Don’t forget to update the documentation

Re-exports

  • pub use crate::item_tree::ItemRc;

Structs

Enums

  • AccessibleRole
    This enum represents the different values for the accessible-role property, used to describe the role of an element in the context of assistive technology such as screen readers.
  • DialogButtonRole
    This enum represents the value of the dialog-button-role property which can be added to any element within a Dialog to put that item in the button row, and its exact position depends on the role and the platform.
  • EventResult
    This enum describes whether an event was rejected or accepted by an event handler.
  • FillRule
    This enum describes the different ways of deciding what the inside of a shape described by a path shall be.
  • ImageFit
    This enum defines how the source image shall fit into an Image element.
  • ImageRendering
    This enum specifies how the source image will be scaled.
  • InputType
    This enum is used to define the type of the input field.
  • LayoutAlignment
    Enum representing the alignment property of a HorizontalBox, a VerticalBox, a HorizontalLayout, or VerticalLayout.
  • MouseCursor
    This enum represents different types of mouse cursors. It’s a subset of the mouse cursors available in CSS. For details and pictograms see the MDN Documentation for cursor. Depending on the backend and used OS unidirectional resize cursors may be replaced with bidirectional ones.
  • Orientation
    Represents the orientation of an element or widget such as the Slider.
  • PathEvent
    PathEvent is a low-level data structure describing the composition of a path. Typically it is generated at compile time from a higher-level description, such as SVG commands.
  • PointerEventButton
    This enum describes the different types of buttons for a pointer event, typically on a mouse or a pencil.
  • PointerEventKind
    The enum reports what happened to the PointerEventButton in the event
  • RenderingResult
    Returned by the render() function on items to indicate whether the rendering of children should be handled by the caller, of if the item took care of that (for example through layer indirection)
  • SortOrder
    This enum represents the different values of the sort-order property. It’s used to sort a StandardTableView by a column.
  • StandardButtonKind
    Use this enum to add standard buttons to a Dialog. The look and positioning of these StandardButtons depends on the environment (OS, UI environment, etc.) the application runs in.
  • TextCursorDirection
  • TextHorizontalAlignment
    This enum describes the different types of alignment of text along the horizontal axis of a Text element.
  • TextOverflow
    This enum describes the how the text appear if it is too wide to fit in the Text width.
  • TextVerticalAlignment
    This enum describes the different types of alignment of text along the vertical axis of a Text element.
  • TextWrap
    This enum describes the how the text wrap if it is too wide to fit in the Text width.

Statics

Traits

  • Item
    Items are the nodes in the render tree. Note: Was generated from the #[vtable] macro on ItemVTable
  • ItemConsts
    Trait containing the associated constant relative to the trait Item.

Type Aliases

  • ItemRef
    Alias for vtable::VRef<ItemVTable> which represent a pointer to a dyn Item with the associated vtable
  • KeyEventArg
  • VoidArg
    Workarounds for cbindgen