pub struct RichDocumentView { /* private fields */ }Expand description
Retained, selectable, incrementally updating rich-document widget.
Implementations§
Source§impl RichDocumentView
impl RichDocumentView
Sourcepub fn new(model: RichDocumentModel) -> RichDocumentView
pub fn new(model: RichDocumentModel) -> RichDocumentView
Examples found in repository?
examples/rich_document.rs (line 27)
3fn main() -> Result<()> {
4 let theme = DefaultTheme::dark();
5 let document = RichDocumentModel::from_markdown(
6 r#"# Deployment report
7
8SUI keeps this document selectable across blocks. Follow the [runbook](https://example.test/runbook) for details.
9
10- [x] Build artifacts
11- [x] Run tests
12- [ ] Publish release
13
14```rust
15let status = deploy().await?;
16assert!(status.ready());
17```
18"#,
19 );
20
21 let mut operation = RichExtensionBlock::new("operation-log", "Release operation");
22 operation.status = RichDocumentStatus::Running;
23 operation.summary = Some("2 of 3 stages complete".into());
24 operation.body = "build complete\ntest complete\npublish running".into();
25 document.append_extension(operation);
26
27 let view = RichDocumentView::new(document)
28 .theme(theme)
29 .on_link(|destination| println!("Application URL policy received: {destination}"));
30 let root = Surface::window(ScrollView::vertical(view).retain_content_layer())
31 .theme(theme)
32 .padding(Insets::all(24.0))
33 .fill();
34
35 App::new()
36 .window(Window::new("SUI Rich Document").root(root))
37 .run()
38}pub fn state(self, state: RichDocumentViewState) -> RichDocumentView
pub fn renderer_registry( self, registry: RichDocumentRendererRegistry, ) -> RichDocumentView
Sourcepub fn theme(self, theme: DefaultTheme) -> RichDocumentView
pub fn theme(self, theme: DefaultTheme) -> RichDocumentView
Examples found in repository?
examples/rich_document.rs (line 28)
3fn main() -> Result<()> {
4 let theme = DefaultTheme::dark();
5 let document = RichDocumentModel::from_markdown(
6 r#"# Deployment report
7
8SUI keeps this document selectable across blocks. Follow the [runbook](https://example.test/runbook) for details.
9
10- [x] Build artifacts
11- [x] Run tests
12- [ ] Publish release
13
14```rust
15let status = deploy().await?;
16assert!(status.ready());
17```
18"#,
19 );
20
21 let mut operation = RichExtensionBlock::new("operation-log", "Release operation");
22 operation.status = RichDocumentStatus::Running;
23 operation.summary = Some("2 of 3 stages complete".into());
24 operation.body = "build complete\ntest complete\npublish running".into();
25 document.append_extension(operation);
26
27 let view = RichDocumentView::new(document)
28 .theme(theme)
29 .on_link(|destination| println!("Application URL policy received: {destination}"));
30 let root = Surface::window(ScrollView::vertical(view).retain_content_layer())
31 .theme(theme)
32 .padding(Insets::all(24.0))
33 .fill();
34
35 App::new()
36 .window(Window::new("SUI Rich Document").root(root))
37 .run()
38}pub fn theme_when<F>(self, theme: F) -> RichDocumentViewwhere
F: Fn() -> DefaultTheme + 'static,
pub fn syntax_highlighter<H>(self, highlighter: H) -> RichDocumentViewwhere
H: RichSyntaxHighlighter + 'static,
Sourcepub fn on_link<F>(self, callback: F) -> RichDocumentView
pub fn on_link<F>(self, callback: F) -> RichDocumentView
Examples found in repository?
examples/rich_document.rs (line 29)
3fn main() -> Result<()> {
4 let theme = DefaultTheme::dark();
5 let document = RichDocumentModel::from_markdown(
6 r#"# Deployment report
7
8SUI keeps this document selectable across blocks. Follow the [runbook](https://example.test/runbook) for details.
9
10- [x] Build artifacts
11- [x] Run tests
12- [ ] Publish release
13
14```rust
15let status = deploy().await?;
16assert!(status.ready());
17```
18"#,
19 );
20
21 let mut operation = RichExtensionBlock::new("operation-log", "Release operation");
22 operation.status = RichDocumentStatus::Running;
23 operation.summary = Some("2 of 3 stages complete".into());
24 operation.body = "build complete\ntest complete\npublish running".into();
25 document.append_extension(operation);
26
27 let view = RichDocumentView::new(document)
28 .theme(theme)
29 .on_link(|destination| println!("Application URL policy received: {destination}"));
30 let root = Surface::window(ScrollView::vertical(view).retain_content_layer())
31 .theme(theme)
32 .padding(Insets::all(24.0))
33 .fill();
34
35 App::new()
36 .window(Window::new("SUI Rich Document").root(root))
37 .run()
38}pub fn on_image<F>(self, callback: F) -> RichDocumentView
Sourcepub fn image_resolver<F>(self, resolver: F) -> RichDocumentView
pub fn image_resolver<F>(self, resolver: F) -> RichDocumentView
Resolve Markdown image sources to images registered with the runtime.
Until a source resolves, the default renderer keeps the image’s alt text as an inline placeholder with full image semantics.
pub fn on_attachment<F>(self, callback: F) -> RichDocumentViewwhere
F: FnMut(RichBlockId) + 'static,
pub fn model(&self) -> &RichDocumentModel
pub fn view_state(&self) -> &RichDocumentViewState
Trait Implementations§
Source§impl Widget for RichDocumentView
impl Widget for RichDocumentView
fn event(&mut self, ctx: &mut EventCtx, event: &Event)
Source§fn command(&mut self, ctx: &mut EventCtx, command: &Command<'_>)
fn command(&mut self, ctx: &mut EventCtx, command: &Command<'_>)
Receive a typed command addressed directly to this widget. Commands are
target-only and do not capture or bubble through the widget tree.
fn measure(&mut self, ctx: &mut MeasureCtx, constraints: Constraints) -> Size
fn arrange(&mut self, ctx: &mut ArrangeCtx, bounds: Rect)
fn paint(&self, ctx: &mut PaintCtx)
fn accepts_focus(&self) -> bool
fn semantics(&self, ctx: &mut SemanticsCtx)
Source§fn visit_children(&self, visitor: &mut dyn WidgetPodVisitor)
fn visit_children(&self, visitor: &mut dyn WidgetPodVisitor)
Visit this widget’s logical children. Read more
Source§fn visit_children_mut(&mut self, visitor: &mut dyn WidgetPodMutVisitor)
fn visit_children_mut(&mut self, visitor: &mut dyn WidgetPodMutVisitor)
Mutably visit this widget’s logical children. Read more
fn debug_name(&self) -> &'static str
Source§fn diagnostics(&self, _ctx: &mut WidgetDiagnosticsCtx)
fn diagnostics(&self, _ctx: &mut WidgetDiagnosticsCtx)
Publish widget-specific state for an inspector snapshot. Read more
Source§fn measure_size(
&mut self,
ctx: &mut MeasureCtx,
constraints: Constraints,
) -> Size
fn measure_size( &mut self, ctx: &mut MeasureCtx, constraints: Constraints, ) -> Size
Compute a provisional size. Containers can override this to query child
sizes without committing their final layouts. The default preserves
existing custom widgets by delegating to
measure; it may mutate state.
Child measure calls still commit state. Use child size probes explicitly
when only their scalar results are needed.
Results must match measure for the same content and constraints.
A final measure is still required before arrangement after a probe miss.Source§fn measure_axis(
&mut self,
ctx: &mut MeasureCtx,
constraints: Constraints,
axis: Axis,
) -> f32
fn measure_axis( &mut self, ctx: &mut MeasureCtx, constraints: Constraints, axis: Axis, ) -> f32
Query one component of
measure_size under exactly the same constraints.
Overrides may avoid computing the other component, but must return the
same extent. Like size probes, this does not replace final measurement.Source§fn intrinsic_size(
&mut self,
ctx: &mut MeasureCtx,
axis: Axis,
available_cross: f32,
) -> IntrinsicSize
fn intrinsic_size( &mut self, ctx: &mut MeasureCtx, axis: Axis, available_cross: f32, ) -> IntrinsicSize
Report the smallest and preferred extent along one axis. Read more
Source§fn supports_output_reuse(&self) -> bool
fn supports_output_reuse(&self) -> bool
Opt into retaining paint and semantics between targeted invalidations.
Output must depend only on widget state, context, and observed sources;
changes must invalidate the widget. Untracked readers and callbacks with
side effects should keep the default. An opaque descendant also prevents
caching its ancestors. Explicit subtree/window requests always rerun them.
A source observed only in paint or semantics invalidates that callback,
not its descendants. Mutating child state requires a child/subtree request.
fn layer_options(&self) -> LayerOptions
fn layer_properties(&self) -> LayerProperties
fn stack_host_options(&self) -> Option<StackHostOptions>
fn stack_surface_options(&self) -> Option<StackSurfaceOptions>
Source§fn overlay_options(&self) -> Option<OverlayOptions>
fn overlay_options(&self) -> Option<OverlayOptions>
Describe this widget as the logical owner of a presented overlay. Read more
fn focus_changed(&mut self, _ctx: &mut EventCtx, _focused: bool)
Auto Trait Implementations§
impl !RefUnwindSafe for RichDocumentView
impl !Send for RichDocumentView
impl !Sync for RichDocumentView
impl !UnwindSafe for RichDocumentView
impl Freeze for RichDocumentView
impl Unpin for RichDocumentView
impl UnsafeUnpin for RichDocumentView
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Convert
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.