Enum ToolName 

pub enum ToolName {
    NewBlock,
    NewArea,
    AddPin,
    AddPort,
    NewImage,
    Icon,
    AddText,
    EditTextBox,
    MovePin,
    RenamePin,
    RetypePin,
    MoveTitle,
    MoveBlockType,
    RenameTitle,
    RenameBlockType,
    Route,
    MoveBlock,
    ResizeBlock,
    EditRoute,
    AddRouteLabel,
    RenameRoute,
    MoveLabel,
    Select,
    SelectPin,
    MultiSelect,
    MultiPinSelect,
    MoveMultiPin,
}

Variants

NewBlock

NewArea

AddPin

AddPort

NewImage

Names no tool: the verb an image is placed under (Action::PlaceImage), which the rail’s image cell raises by opening a picker. It keeps its cell on the band all the same.

Icon

Names no tool: the verb an icon is attached under (Action::SetIcon), which the Add-icon command raises directly.

AddText

EditTextBox

MovePin

RenamePin

RetypePin

MoveTitle

MoveBlockType

RenameTitle

RenameBlockType

Route

MoveBlock

ResizeBlock

EditRoute

AddRouteLabel

RenameRoute

MoveLabel

Select

SelectPin

MultiSelect

MultiPinSelect

MoveMultiPin

Implementations

impl ToolName

pub fn label(self) -> &'static str

pub fn command_name(self) -> Option<&'static str>

The stable spelling a command types this tool by. None for the tools no command arms — the sub-tools a gesture hands off to, which are reached by the gesture and never by name.

pub fn verb(self) -> &'static str

What this tool’s gesture did, as a bare verb.

Not Self::label with a word removed: a label names the tool on the toolbar (“Resize Block”), and a commit label names the verb and then the entity the ops turned out to touch — so repeating the noun here would read as “Resize Block block Filter”. The compiler keeps the two lists in step; nothing else needs to.

pub fn arming_writes_the_document(self) -> bool

Whether arming this tool is itself an intent to write — the tool layer’s half of CommandId::writes_the_document, and the one list a read-only session refuses tools by. Consumed by the registry (which withholds the arming command, so the toolbar button draws disabled) and by the tool switch itself, so a chord, a script, or a tool’s own hand-off cannot reach what the button will not.

The selection family answers false even though each of its members has a drag that writes: one tool state both selects and drags, so a blanket refusal would take the selection away with the edit. Those gestures are refused where they begin instead — see Drawing::authoring.

Trait Implementations

impl Clone for ToolName

fn clone(&self) -> ToolName

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ToolName

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolName

fn deserialize<__D>( __deserializer: __D, ) -> Result<ToolName, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ToolName

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Hash for ToolName

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ToolName

fn eq(&self, other: &ToolName) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ToolName

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for ToolName

impl Eq for ToolName

impl StructuralPartialEq for ToolName