Crate raui_core[][src]

Expand description

RAUI core types and components

The things that most users will be interested in here are the components and the widget! macro. Those have more documentation on how to use widgets, components, etc. in your app.

Modules

animator

Animation engine

application

Application foundation used to drive the RAUI interface

data_binding

Mechanism for integrating external data into the UI

interactive

Interactivity traits

layout

Layout engine

messenger

Widget messaging

props

Widget property types

renderer

Renderer traits

signals

Widget signals

state

Widget state types

widget

Widget types and the core component collection

Macros

implement_message_data

Macro for implementing MessageData.

implement_props_data

Macro for implementing PropsData.

make_widget

Helper to manually create a WidgetComponent struct from a function.

unpack_named_slots

A helper for getting the named children out of a widget context

widget

Create a WidgetNode struct from a custom widget tree DSL

Structs

PrefabNumber

Represents a YAML number, whether integer or floating point.

PrintLogger

Prints log messages to terminal via println! macro.

Enums

LogKind
PrefabError

An error that can occur while processing a Prefab

PrefabValue

Represents any valid YAML value.

Traits

Logger

Common logging interface that custom log engines should follow to enable their reusability across different modules that will log messages to text output targets. Objects that implement this trait should be considered text output targets, for example text streams, terminal, network-based loggers, even application screen.

Prefab

The Prefab trait is implemented for types that are able to translate to and from PrefabValue’s

Type Definitions

Integer

An integer, scalar value define as a type alias to allow switching between 32 and 64 bit integers

Scalar

A floating point, scalar value define as a type alias to allow switching between 32 and 64 bit floats

UnsignedInteger

An unsigned, integer, scalar value define as a type alias to allow switching between 32 and 64 bit integers

Attribute Macros

post_hooks

Allows you to execute re-usable logic after your component body

pre_hooks

An attribute macro that allows you to add hooks that will execute before your component body

Derive Macros

MessageData

Derive macro for the [MessageData][raui_core::messenger::MessageData] trait

PropsData

Derive macro for the [PropsData][raui_core::props::PropsData] trait