Module items

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_item_tree.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;

Macros

• ItemVTable_static
  Instantiate a static ItemVTable for a given type and implements vtable::HasStaticVTable<ItemVTable> for it.

Structs

• BasicBorderRectangle
  The implementation of the BasicBorderRectangle element
• BasicBorderRectangleFieldsOffsets
  Helper struct containing the offsets of the fields of the struct BasicBorderRectangle
• BorderRectangle
  The implementation of the BorderRectangle element
• BorderRectangleFieldsOffsets
  Helper struct containing the offsets of the fields of the struct BorderRectangle
• BoxShadow
  The implementation of the BoxShadow element
• BoxShadowFieldsOffsets
  Helper struct containing the offsets of the fields of the struct BoxShadow
• Clip
  The implementation of the Clip element
• ClipFieldsOffsets
  Helper struct containing the offsets of the fields of the struct Clip
• ClippedImage
  The implementation of the ClippedImage element
• ClippedImageFieldsOffsets
  Helper struct containing the offsets of the fields of the struct ClippedImage
• ComplexText
  The implementation of the Text element
• ComplexTextFieldsOffsets
  Helper struct containing the offsets of the fields of the struct ComplexText
• ComponentContainer
  The implementation of the ComponentContainer element
• ComponentContainerFieldsOffsets
  Helper struct containing the offsets of the fields of the struct ComponentContainer
• ContextMenu
  The implementation of the Window element
• ContextMenuFieldsOffsets
  Helper struct containing the offsets of the fields of the struct ContextMenu
• Empty
  The implementation of an empty items that does nothing
• EmptyFieldsOffsets
  Helper struct containing the offsets of the fields of the struct Empty
• Flickable
  The implementation of the Flickable element
• FocusScope
  A runtime item that exposes key
• FocusScopeFieldsOffsets
  Helper struct containing the offsets of the fields of the struct FocusScope
• FontMetrics
  A structure to hold metrics of a font for a specified pixel size.
• ImageItem
  The implementation of the Image element
• ImageItemFieldsOffsets
  Helper struct containing the offsets of the fields of the struct ImageItem
• ItemTO
  Invariant, same as vtable::Inner: vtable and ptr has to be valid and ptr an instance matching the vtable
• ItemVTable
  Items are the nodes in the render tree.
• KeyEvent
  This structure is generated and passed to the key press and release callbacks of the FocusScope element.
• KeyboardModifiers
  The KeyboardModifiers struct provides booleans to indicate possible modifier keys on a keyboard, such as Shift, Control, etc. It is provided as part of KeyEvent’s modifiers field.
• Layer
  The Layer Item is not meant to be used directly by the .slint code, instead, the layer: xxx property should be used
• LayerFieldsOffsets
  Helper struct containing the offsets of the fields of the struct Layer
• MenuEntry
  An item in the menu of a menu bar or context menu
• Opacity
  The Opacity Item is not meant to be used directly by the .slint code, instead, the opacity: xxx or visible: false should be used
• OpacityFieldsOffsets
  Helper struct containing the offsets of the fields of the struct Opacity
• Path
  The implementation of the Path element
• PathFieldsOffsets
  Helper struct containing the offsets of the fields of the struct Path
• PointerEvent
  Represents a Pointer event sent by the windowing system. This structure is passed to the pointer-event callback of the TouchArea element.
• PointerScrollEvent
  Represents a Pointer scroll (or wheel) event sent by the windowing system. This structure is passed to the scroll-event callback of the TouchArea element.
• PropertyAnimation
  The implementation of the PropertyAnimation element
• PropertyAnimationFieldsOffsets
  Helper struct containing the offsets of the fields of the struct PropertyAnimation
• Rectangle
  The implementation of the Rectangle element
• RectangleFieldsOffsets
  Helper struct containing the offsets of the fields of the struct Rectangle
• Rotate
  The implementation of the Rotate element
• RotateFieldsOffsets
  Helper struct containing the offsets of the fields of the struct Rotate
• SimpleText
  The implementation of the Text element
• SimpleTextFieldsOffsets
  Helper struct containing the offsets of the fields of the struct SimpleText
• StandardListViewItem
  Represents an item in a StandardListView and a StandardTableView.
• StateInfo
  Value of the state property A state is just the current state, but also has information about the previous state and the moment it changed
• SwipeGestureHandler
• SwipeGestureHandlerFieldsOffsets
  Helper struct containing the offsets of the fields of the struct SwipeGestureHandler
• TableColumn
  This is used to define the column and the column header of a TableView
• TextInput
  The implementation of the TextInput element
• TextInputFieldsOffsets
  Helper struct containing the offsets of the fields of the struct TextInput
• TextInputVisualRepresentation
  This struct holds the fields needed for rendering a TextInput item after applying any on-going composition. This way the renderer’s don’t have to duplicate the code for extracting and applying the pre-edit text, cursor placement within, etc.
• TouchArea
  The implementation of the TouchArea element
• TouchAreaFieldsOffsets
  Helper struct containing the offsets of the fields of the struct TouchArea
• WindowItem
  The implementation of the Window element
• WindowItemFieldsOffsets
  Helper struct containing the offsets of the fields of the struct WindowItem

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.
• AnimationDirection
  This enum describes the direction of an animation.
• ColorScheme
  This enum indicates the color scheme used by the widget style. Use this to explicitly switch between dark and light schemes, or choose Unknown to fall back to the system default.
• 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.
• ImageHorizontalAlignment
  This enum specifies the horizontal alignment of the source image.
• ImageRendering
  This enum specifies how the source image will be scaled.
• ImageTiling
  This enum specifies how the source image will be tiled.
• ImageVerticalAlignment
  This enum specifies the vertical alignment of the source image.
• 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
• PopupClosePolicy
• 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)
• ScrollBarPolicy
  This enum describes the scrollbar visibility
• 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.
• TextChangeNotify
  Argument to TextInput::delete_selection that determines whether to trigger the edited and cursor position callbacks and issue an input method request update.
• 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.
• TextStrokeStyle
  This enum describes the positioning of a text stroke relative to the border of the glyphs in a Text.
• 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

• BasicBorderRectangleVTable
• BorderRectangleVTable
• BoxShadowVTable
• ClipVTable
• ClippedImageVTable
• ComplexTextVTable
• ComponentContainerVTable
• ContextMenuVTable
• EmptyVTable
• FlickableVTable
• FocusScopeVTable
• ImageItemVTable
• LayerVTable
• OpacityVTable
• PathVTable
• RectangleVTable
• RotateVTable
• SimpleTextVTable
• SwipeGestureHandlerVTable
• TextInputVTable
• TouchAreaVTable
• WindowItemVTable

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.

Functions

• slint_text_item_fontmetrics

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