Module prelude

Source

Modules§

badge_derived_lenses
Derived lenses for Badge.
chip_derived_lenses
Derived lenses for Chip.
collapsible_derived_lenses
Derived lenses for Collapsible.
combo_box_derived_lenses
Derived lenses for ComboBox.
datepicker_derived_lenses
Derived lenses for Datepicker.
dropdown_derived_lenses
Derived lenses for Dropdown.
list_derived_lenses
Derived lenses for List.
menu_bar_derived_lenses
Derived lenses for MenuBar.
menu_button_derived_lenses
Derived lenses for MenuButton.
pick_list_derived_lenses
Derived lenses for PickList.
popup_data_derived_lenses
Derived lenses for PopupData.
popup_derived_lenses
Derived lenses for Popup.
rating_derived_lenses
Derived lenses for Rating.
resizable_stack_derived_lenses
Derived lenses for ResizableStack.
scroll_view_derived_lenses
Derived lenses for ScrollView.
slider_derived_lenses
Derived lenses for Slider.
spinbox_derived_lenses
Derived lenses for Spinbox.
submenu_derived_lenses
Derived lenses for Submenu.
tab_view_derived_lenses
Derived lenses for TabView.
textbox_derived_lenses
Derived lenses for Textbox.
tooltip_derived_lenses
Derived lenses for Tooltip.
virtual_list_derived_lenses
Derived lenses for VirtualList.

Macros§

impl_res_simple
A macro for implementing the Res trait for simple Copy types.
include_style
A macro which parses CSS from a file at runtime in debug mode, and includes the file in the binary in release mode.
langid

Structs§

AccessContext
A context used for configuring the accessibility features of a view.
AccessNode
Wrapper around an accesskit node builder, a node id, and a list of children to be added to the node.
Animation
An ID used to reference style animations stored in the style store.
AnimationBuilder
A builder for constructing animations.
Application
Creating a new application creates a root Window and a Context. Views declared within the closure passed to Application::new() are added to the context and rendered into the root window.
ArcTrack
Makes a knob that represents the current value with an arc
Avatar
An avatar view is used to visually represent a person or entity and can contain text, an icon, or an image.
AvatarGroup
The AvatarGroup view can be used to group a series of avatars together.
Badge
A Badge view for showing notifications, counts, or status information.
Binding
A view with a binding which rebuilds its contents when the observed data changes.
BoundingBox
Represents an axis-aligned bounding box.
Button
A simple push button with a contained view.
ButtonGroup
A view which represents a group of buttons.
Canvas
Canvas provides an interface for drawing, and how the drawing is clipped and transformed. Canvas contains a stack of Matrix and clip values.
Checkbox
A checkbox used to display and toggle a boolean state.
Chip
A visual indicator such as a tag.
Collapsible
A collapsible view that can be opened or closed to hide content.
ComboBox
A ComboBox view which combines a textbox with a picklist, allowing users to filter to only the options matching a query.
Context
The main storage and control object for a Vizia application.
ContextProxy
A bundle of data representing a snapshot of the context when a thread was spawned.
Datepicker
A control used to select a date.
Divider
The Divider view provides a thin, unobtrusive line for visually separating views.
DrawContext
A context used when drawing a view.
Dropdown
A dropdown is used to display some state with the ability to open a popup with options to change that state.
Duration
A Duration type to represent a span of time, typically used for system timeouts.
Element
A basic element with no interactivity.
Entity
An entity is an identifier used to reference a view; to get/set properties in the context.
Environment
A model for system specific state which can be accessed by any model or view.
Event
A wrapper around a message, providing metadata on how the event travels through the view tree.
EventContext
A context used when handling events.
FontSize
A font size value.
FontVariation
FontWeight
A font weight value.
GeoChanged
Bitflag representing whether the bounds of a view has changed after relayout.
Grid
A view which arranges its children into a grid.
HStack
A view which arranges its children into a horizontal stack (row).
Handle
A handle to a view which has been built into the tree.
Image
A view which presents an image.
ImageId
An ID used to reference images in the resource manager.
Index
Instant
A measurement of a monotonically nondecreasing clock. Opaque and useful only with Duration.
KeyChord
A key chord used inside of a Keymap.
KeyframeBuilder
A builder for constructing keyframes.
Keymap
A keymap that associates key chords with actions.
KeymapEntry
An entry inside of a Keymap.
Knob
A circular view which represents a value.
Label
A label used to display text.
LanguageIdentifier
LanguageIdentifier is a core struct representing a Unicode Language Identifier.
LineClamp
LinearGradient
LinearGradientBuilder
A builder for constructing linear gradients.
List
A view for creating a list of items from a binding to an iteratable list.
ListItem
A view which represents a selectable item within a list.
Localized
A type which formats a localized message with any number of named arguments.
Map
MapRef
Markdown
A view which parses and displays markdown as rich text.
Matrix
A 2D matrix.
MenuBar
A view which represents a horizontal group of menus.
MenuButton
A view which represents a pressable item within a menu.
Modifiers
The state of the modifier keys.
Opacity
An opacity value in the range of 0 to 1.
PickList
A view which allows the user to select an item from a dropdown list.
Popup
A view for displaying popup content.
PopupData
A model which can be used by views which contain a popup.
Position
ProgressBar
A simple progress bar that can be used to show the progress of something.
RGBA
A color with red, green, blue, and alpha components, in a byte each.
RadioButton
A radio button used to display and toggle boolean state.
Rating
A view which represents a rating as a number of filled stars.
ResizableStack
A view that can be resized by clicking and dragging from the right or bottom edge.
ResizeHandle
Scale
A scale defining a scale value on the x and the y axis.
ScrollView
A container a view which allows the user to scroll any overflowed content.
Scrollbar
A view which represents a bar that can be dragged to manipulate a scrollview.
Shadow
A box shadow adding a shadow effect around an element’s frame.
ShadowBuilder
A builder for constructing a shadow.
Slider
The slider control can be used to select from a continuous set of values.
SliderDataInternal
Internal data used by the slider.
Spacer
A view which can be used to add stretch space between two other views.
Spinbox
A view which represents a value which can be incremented or decremented.
StaticLens
Style
Stores the style properties of all entities in the application.
Submenu
A view which represents a submenu within a menu.
Svg
A view which presents an SVG image.
Switch
A Switch used to display and toggle a boolean state.
TabBar
TabHeader
TabPair
TabView
TextDecorationLine
TextSpan
A view which represents a span of text within a label.
TextStroke
Textbox
The Textbox view provides an input control for editing a value as a string.
Then
Lens composed of two lenses joined together
TickKnob
Makes a round knob with a tick to show the current value
Ticks
Adds tickmarks to a knob to show the steps that a knob can be set to. When added to a knob, the knob should be made smaller (depending on span), so the knob doesn’t overlap with the tick marks
Timer
A handle used to start, stop, and check the running status of a timer added with cx.add_timer().
ToggleButton
A button which can be toggled between two states.
Tooltip
A tooltip view.
Transition
Defines a transition that allows to change property values smoothly, over a given duration.
Translate
A translate defining a translate value on the x and the y axis.
Tree
The Tree describes the tree of entities.
UnwrapLens
VStack
A view which arranges its children into a vertical stack (column).
VirtualList
A view for creating a list of items from a binding to an iteratable list. Rather than creating a view for each item, items are recycled in the list.
Window
WindowButtons
WindowPosition
The logical position of a window in screen coordinates.
WindowSize
The logical size of an application window.
WindowState
Wrapper
XYPad
A view which allows the user to manipulate 2 floating point values simultaneously on a two dimensional pane.
ZStack
A view which overlays its children on top of each other.

Enums§

Action
An action to be taken on an accessibility node.
Alignment
Anchor
AnchorTarget
Angle
A value representing an angle expressed in degrees, gradians, radians, or turns.
AppTheme
Represents the theme used by the application.
ApplicationError
AvatarVariant
Enum which represents the geometric variants of an avatar view.
BackgroundImage
BackgroundSize
BadgePlacement
Enum which represents the placement of a badge on its parent.
BorderStyleKeyword
The keyword of a single border style.
ButtonVariant
Used in conjunction with the variant modifier for selecting the style variant of a button or button group.
ChipVariant
Used in conjunction with the variant modifier for selecting the style variant of a chip.
ClipPath
Code
Code is the physical position of a key.
CollapsibleEvent
Events that can be triggered by the collapsible view.
Color
A color value.
CornerShape
The shape the default view drawing algorithm should use for handling borders.
CssRule
CursorIcon
An icon of a cursor.
Display
Determines whether an entity will be rendered and acted on by the layout system. To make an entity invisible to rendering but still visible to layout, see Visibility.
DropData
Data associated with a drop event.
EnvironmentEvent
Events for setting the state in the Environment.
FamilyOwned
A font-family.
Filter
FontFamily
FontSlant
FontWeightKeyword
A font weight keyword corresponding to a specific font weight.
FontWidth
A font stretch value.
GenericFontFamily
Gradient
HorizontalPositionKeyword
A horizontal position keyword.
ImageOrGradient
An enum which represents an image or a gradient.
ImageRetentionPolicy
An image should be stored in the resource manager.
Key
Key represents the meaning of a keypress.
KeymapEvent
An event used to interact with a Keymap at runtime.
KnobMode
LayoutType
The layout type determines how the nodes will position its parent-directed children.
Length
LengthOrPercentage
A length or a percentage value.
LengthValue
A length value.
LensValue
A type returned by Lens::view() which contains either a reference to model data or an owned value.
LineDirection
ListEvent
Events used by the List view
Live
MenuEvent
Events used by menus.
MouseButton
A mouse button.
MouseButtonState
The state of a mouse button.
Orientation
The orientation of a widget, such as a slider or scrollbar
Overflow
Determines how to deal with content that overflows the bounding box of the element.
Placement
Describes the placement of a view relative to its parent element.
PointerEvents
Determines whether an entity will receive pointer events.
PopupEvent
Events used by the Popup view.
PositionType
The position type determines whether a node will be positioned in-line with its siblings or out-of-line / independently of its siblings.
Propagation
Determines how an event propagates through the tree.
ProxyEmitError
Errors that might occur when emitting an event via a ContextProxy.
ResizableStackEvent
Events emitted by the ResizableStack view to indicate changes in dragging state.
ResizeStackDirection
A direction for resizing a resizable stack, either horizontally (right) or vertically (bottom).
Role
The type of an accessibility node.
ScrollEvent
Events for setting the properties of a scroll view.
Selectable
Represents how items can be selected in a list.
SpinboxIcons
And enum which represents the icons that can be used for the increment and decrement buttons of the Spinbox.
TabEvent
TextAlign
Determines how overflowed content that is not displayed should be signaled to the user.
TextDecorationStyle
TextEvent
Events for modifying a textbox.
TextOverflow
Determines how overflowed content that is not displayed should be signaled to the user.
TextStrokeStyle
ThemeMode
And enum which represents the current built-in theme mode.
TimerAction
Enum which can be used to determine the reason a timer callback was called.
Transform
An individual transform function.
Units
Units which describe spacing and size.
VerticalPositionKeyword
A vertical position keyword.
Visibility
Determines whether an entity will be rendered.
WindowEvent
Events generated by the application in response to OS events as well as events that can be used to set properties of the window.

Traits§

AbilityModifiers
Modifiers for changing the abilities of a view.
AccessibilityModifiers
Modifiers for changing the accessibility properties of a view.
ActionModifiers
Modifiers which add an action callback to a view.
ButtonModifiers
Modifiers for changing the appearance of buttons.
Data
A trait for fast comparisons of data. Implemented by any type which can be bound to, i.e. can be cached and compared against previous versions.
DataContext
A trait for any Context-like object that lets you access stored model data.
EmitContext
A trait for any Context-like object that lets you emit events.
GenerationalId
A trait implemented by any generational id.
IntoCssStr
Helper trait for getting CSS from a string or path.
LayoutModifiers
Modifiers for changing the layout properties of a view.
Lens
A Lens allows the construction of a reference to a piece of some data, e.g. a field of a struct.
LensExt
Helpers for constructing more complex Lenses.
Model
A trait implemented by application data in order to respond to events and mutate state.
ModifyWindow
Res
A trait which allows passing a value or a lens to a view or modifier.
ResGet
A trait for retrieving the value of a lens.
StyleModifiers
Modifiers for changing the style properties of a view.
TextModifiers
Modifiers for changing the text properties of a view.
ToStringLocalized
A trait for converting from Localized to a String via a translation using fluent.
TreeExt
Trait which provides methods for querying the tree.
View
A view is any object which can be displayed on the screen.
WindowModifiers
Modifiers for setting the properties of a window.

Type Aliases§

HorizontalPosition
VerticalPosition

Derive Macros§

Data
Lens