Module callbacks

Source
Expand description

Type definitions for various types of callbacks, as well as focus and scroll handling

Structs§

Callback
Stores a function pointer that is executed when the given UI element is hit
CallbackInfo
Information about the callback that is passed to the callback whenever a callback is invoked
DocumentId
GlCallback
Callbacks that returns a rendered OpenGL texture
GlCallbackInfo
HidpiAdjustedBounds
Information about the bounds of a laid-out div rectangle.
HitTestItem
IFrameCallback
Callback that, given a rectangle area on the screen, returns the DOM appropriate for that bounds (useful for infinite lists)
IFrameCallbackInfo
LayoutInfo
Gives the layout() function access to the AppResources and the Window (for querying images and fonts, as well as width / height)
LayoutInfoPtr
Pointer to rust-allocated Box<LayoutInfo<'a>> struct
ParentNodesIterator
Iterator that, starting from a certain starting point, returns the parent node until it gets to the root node.
PipelineId
Ref
The two-way binding system
RefAny
RefAnyPtr
Pointer to rust-allocated Box<RefAny> struct
ScrollPosition
Information about a scroll frame, given to the user by the framework
TimerCallback
Callback that can runs on every frame on the main thread - can modify the app data model
TimerCallbackInfo

Enums§

FocusTarget
Defines the focus_targeted node ID for the next frame

Constants§

DontRedraw
The screen does not need to redraw after the callback has been called.
Redraw
After the callback is called, the screen needs to redraw (layout() function being called again).

Functions§

call_callbacks
The actual function that calls the callback in their proper hierarchy and order

Type Aliases§

CallbackReturn
CallbackType
GlCallbackReturn
GlCallbackType
IFrameCallbackReturn
IFrameCallbackType
LayoutCallback
Callback function pointer (has to be a function pointer in order to be compatible with C APIs later on).
PipelineSourceId
This type carries no valuable semantics for WR. However, it reflects the fact that clients (Servo) may generate pipelines by different semi-independent sources. These pipelines still belong to the same IdNamespace and the same DocumentId. Having this extra Id field enables them to generate PipelineId without collision.
TimerCallbackReturn
TimerCallbackType
UpdateScreen
A callback function has to return if the screen should be updated after the function has run.