Module freya::elements

source ·
Expand description

Elements, attributes and events definitions.

Modules§

Structs§

  • FileData
    Data of a Keyboard event.
  • KeyboardData
    Data of a Keyboard event.
  • Modifiers
    Pressed modifier keys.
  • MouseData
    Data of a Mouse event.
  • PointerData
    Data of a Mouse event.
  • TouchData
    Data of a Touch event.
  • WheelData
    Data of a Wheel event.
  • image
    image element let’s you show an image.
  • label
    label simply let’s you display some text.
  • paragraph
    paragraph element let’s you build texts with different styles.
  • rect
    rect is a generic element that acts as a container for other elements.
  • svg
    svg element let’s you display SVG code.
  • text
    text element is simply a text span used for the paragraph element.

Enums§

  • Code
    Code is the physical position of a key.
  • Force
    Describes the force of a touch event
  • Key
    Key represents the meaning of a keypress.
  • MouseButton
    Describes a button of a mouse controller.
  • PointerType
    The type of device that triggered a Pointer event.
  • TouchPhase
    Describes touch-screen input state.

Functions§

  • map_winit_key
    Return the equivalent Winit’s Key in keyboard_types
  • map_winit_modifiers
  • map_winit_physical_key
    Return the equivalent of Winit’s PhysicalKey in keyboard_types
  • onclick
    The click event fires when the user clicks an element with the left button of the mouse.
  • onfiledrop
    The filedrop event fires when the user drops a file over the element.
  • onglobalclick
    The globalclick event fires when the user clicks anywhere. Note that this fires for all mouse buttons. You can check the specific variant with the MouseData’s trigger_button property.
  • onglobalfilehover
    The onglobalfilehover event fires when the user hovers a file over the window.
  • onglobalfilehovercancelled
    The onglobalfilehovercancelled event fires when the user cancels the hovering of a file over the window. It’s the opposite of onglobalfilehover.
  • onglobalmousedown
    The globalmousedown event fires when the user starts clicking anywhere. Note that this fires for all mouse buttons. You can check the specific variant with the MouseData’s trigger_button property.
  • onglobalmouseover
    The globalmouseover event fires when the user moves the mouse anywhere in the app.
  • onglobalpointerup
    The globalpointerup event fires when the user releases the point anywhere in the app.
  • onkeydown
    The keydown event fires when the user starts pressing any key.
  • onkeyup
    The keyup event fires when the user releases any key being pressed.
  • onmiddleclick
    The click event fires when the user clicks an element with the middle button of the mouse.
  • onmousedown
    The mousedown event fires when the user starts clicking an element. Note that this fires for all mouse buttons. You can check the specific variant with the MouseData’s trigger_button property.
  • onmouseenter
    The mouseenter event fires when the user starts hovering an element.
  • onmouseleave
    The mouseleave event fires when the user stops hovering an element.
  • onmouseover
    The mouseover event fires when the user moves the mouse over an element. Unlike onmouseover, this fires even if the user was already hovering over the element. For that reason, it’s less efficient.
  • onpointerdown
    The pointerdown event fires when the user clicks/starts touching an element.
  • onpointerenter
    The pointerenter event fires when the user starts hovering/touching an element.
  • onpointerleave
    The pointerleave event fires when the user stops hovering/touching an element.
  • onpointerover
    The pointerover event fires when the user hovers/touches over an element. Unlike onpointerenter, this fires even if the user was already hovering over the element. For that reason, it’s less efficient.
  • onpointerup
    The pointerup event fires when the user releases their mouse button or stops touching the element.
  • onrightclick
    The click event fires when the user clicks an element with the right button of the mouse.
  • ontouchcancel
    The touchcancel event fires when the user cancels the touching, this is usually caused by the hardware or the OS. Also see ontouchend.
  • ontouchend
    The touchend event fires when the user stops touching an element.
  • ontouchmove
    The touchmove event fires when the user is touching over an element.
  • ontouchstart
    The touchstart event fires when the user starts touching an element.
  • onwheel
    The wheel event fires when the user scrolls the mouse wheel while hovering over the element.

Type Aliases§