Skip to main content

ferroui_designer_tools/
lib.rs

1//! Portable editor tools that produce source transactions. A host supplies measured geometry;
2//! layout, property and selection commands never mutate preview objects directly.
3mod components;
4mod geometry;
5mod grid_tracks;
6mod layout;
7mod layout_attributes;
8mod layout_helpers;
9mod properties;
10mod selection;
11
12pub use components::{
13    ComponentAction, ComponentCatalog, ComponentEntry, ComponentKind, ComponentReference,
14    ComponentResourceContext, ComponentResourceResolution, component_fragment,
15    component_property_attribute, component_property_elements, component_property_object,
16    component_resource_expression, component_resource_references, component_resource_resolution,
17    plan_component_action, plan_component_action_in_context, plan_property_object,
18    resolve_component_resource, resolve_component_resource_in_context, visible_component_resources,
19    visible_component_resources_in_context,
20};
21pub use geometry::{
22    Affine, Alignment, Axis, Point, Rect, SnapGuide, SnapIndex, SnapResult, SnapSettings, align,
23    distribute,
24};
25pub use grid_tracks::{
26    GridTrackChange, GridTrackPlacement, grid_track_values, plan_grid_track_change,
27    plan_grid_track_change_with_placements,
28};
29pub use layout::{
30    DockSide, GridLength, GridLines, LayoutAction, LayoutAdapter, LayoutCapabilities,
31    LayoutContext, LayoutRegistry, RelativeRelation, ResolvedLayout,
32};
33pub use layout_attributes::plan_layout_attributes;
34pub use layout_helpers::{
35    LayoutGuide, LayoutGuideGeometry, LayoutGuideRole, LayoutHandle, LayoutHandleAction,
36    LayoutHelperRequest, LayoutHelperScene, LayoutPlacement,
37};
38pub use properties::{
39    EditorRegistry, ExpressionPolicy, PropertyDescriptor, PropertyKind, PropertyRegistry,
40    PropertyState, PropertyValueShape, ValueEditor,
41};
42pub use selection::{MoveGesture, Selection, SelectionMode, outermost};
43
44#[derive(Clone, Debug, PartialEq, Eq)]
45pub struct ToolError(pub String);
46impl std::fmt::Display for ToolError {
47    fn fmt(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
48        formatter.write_str(&self.0)
49    }
50}
51impl std::error::Error for ToolError {}
52pub type Result<T> = std::result::Result<T, ToolError>;
53pub(crate) fn require(condition: bool, message: impl Into<String>) -> Result<()> {
54    if condition {
55        Ok(())
56    } else {
57        Err(ToolError(message.into()))
58    }
59}
60pub(crate) fn error(error: impl std::fmt::Display) -> ToolError {
61    ToolError(error.to_string())
62}
63
64#[cfg(test)]
65mod tests;