Skip to main content

CanvasEditor

Struct CanvasEditor 

Source
pub struct CanvasEditor { /* private fields */ }

Implementations§

Source§

impl CanvasEditor

Source

pub fn new(document: CanvasDocument) -> Self

Source

pub fn new_with_router<R>(document: CanvasDocument, edge_router: R) -> Self
where R: CanvasEdgeRouter + Send + Sync + 'static,

Source

pub fn try_new_with_kind_registry( document: CanvasDocument, kind_registry: CanvasKindRegistry, ) -> Result<Self, DocumentError>

Source

pub fn try_new_with_router_and_kind_registry<R>( document: CanvasDocument, edge_router: R, kind_registry: CanvasKindRegistry, ) -> Result<Self, DocumentError>
where R: CanvasEdgeRouter + Send + Sync + 'static,

Source

pub fn apply(&mut self, command: DocumentCommand) -> Result<(), DocumentError>

Source

pub fn apply_all( &mut self, commands: impl IntoIterator<Item = DocumentCommand>, ) -> Result<(), DocumentError>

Source

pub fn document(&self) -> &CanvasDocument

Source

pub fn viewport(&self) -> CanvasViewport

Source

pub fn tool(&self) -> &CanvasTool

Source

pub fn runtime(&self) -> &CanvasRuntime

Source

pub fn edge_router(&self) -> &(dyn CanvasEdgeRouter + Send + Sync)

Source

pub fn kind_registry(&self) -> &CanvasKindRegistry

Source

pub fn selection(&self) -> &CanvasSelection

Source

pub fn history(&self) -> &CanvasHistory

Source

pub fn store(&self) -> &CanvasStore

Source

pub fn listen( &mut self, listener: impl Fn(&CanvasStoreChange) + Send + Sync + 'static, ) -> CanvasStoreListenerId

Source

pub fn remove_listener(&mut self, id: CanvasStoreListenerId) -> bool

Source

pub fn apply_transaction( &mut self, transaction: CanvasTransaction, ) -> Result<(), DocumentError>

Source

pub fn apply_transaction_with_diff( &mut self, transaction: CanvasTransaction, ) -> Result<CanvasDocumentDiff, DocumentError>

Source

pub fn apply_tool_intent( &mut self, intent: CanvasToolIntent, ) -> Result<(), DocumentError>

Source

pub fn undo(&mut self) -> Result<bool, DocumentError>

Source

pub fn redo(&mut self) -> Result<bool, DocumentError>

Source

pub fn rebuild_index(&mut self)

Source

pub fn rebuild_runtime(&mut self)

Source

pub fn set_edge_router<R>(&mut self, edge_router: R)
where R: CanvasEdgeRouter + Send + Sync + 'static,

Source

pub fn set_kind_registry( &mut self, kind_registry: CanvasKindRegistry, ) -> Result<(), DocumentError>

Source

pub fn set_tool(&mut self, tool: CanvasTool) -> Result<(), DocumentError>

Source

pub fn set_viewport(&mut self, viewport: CanvasViewport)

Source

pub fn is_tool_state_idle(&self) -> bool

Source

pub fn connection_drag_state(&self) -> Option<CanvasConnectionDragState>

Source

pub fn take_connection_release(&mut self) -> Option<CanvasConnectionRelease>

Source

pub fn tool_context(&self) -> CanvasToolContext<'_>

Source

pub fn handle_event(&mut self, event: CanvasEvent) -> Result<(), DocumentError>

Source

pub fn delete_selection(&mut self) -> Result<bool, DocumentError>

Source

pub fn copy_selection(&self) -> Option<CanvasClipboardPayload>

Source

pub fn cut_selection( &mut self, ) -> Result<Option<CanvasClipboardPayload>, DocumentError>

Source

pub fn paste_clipboard( &mut self, payload: &CanvasClipboardPayload, offset: Point<Pixels>, ) -> Result<bool, DocumentError>

Source

pub fn duplicate_selection( &mut self, offset: Point<Pixels>, ) -> Result<bool, DocumentError>

Source

pub fn group_selection( &mut self, group_id: impl Into<ShapeId>, ) -> Result<bool, DocumentError>

Source

pub fn ungroup_selection(&mut self) -> Result<bool, DocumentError>

Source

pub fn reorder_selection( &mut self, command: CanvasZOrderCommand, ) -> Result<bool, DocumentError>

Source

pub fn handle_event_with_custom_tool<T>( &mut self, event: CanvasEvent, custom_tool: &mut T, ) -> Result<(), DocumentError>

Source

pub fn handle_event_with_tool_registry( &mut self, event: CanvasEvent, registry: &mut CanvasToolRegistry, ) -> Result<(), CanvasToolRegistryError>

Trait Implementations§

Source§

impl Default for CanvasEditor

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl From<&CanvasEditor> for CanvasPaintModel

Source§

fn from(editor: &CanvasEditor) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more