Skip to main content

Action

Enum Action 

Source
pub enum Action {
Show 30 variants NextSlide, PreviousSlide, NextOverlay, PreviousOverlay, FirstSlide, LastSlide, GoToSlide, ToggleFreeze, ToggleBlackout, ToggleWhiteboard, ToggleLaser, CycleLaserStyle, ToggleInk, ClearInk, CycleInkColor, CycleInkWidth, ToggleSpotlight, ToggleZoom, ToggleOverview, ToggleNotes, ToggleNotesEdit, StartPauseTimer, ResetTimer, IncrementNotesFont, DecrementNotesFont, ToggleScreenShare, TogglePresentationMode, ToggleTextBoxMode, Quit, SaveSidecar,
}
Expand description

Named actions that can be bound to keys.

These names are the public API for keybinding configuration — they appear in the TOML config file and in documentation. Renaming one is a breaking change.

Variants§

§

NextSlide

Advance to the next logical slide or overlay-aware build step.

§

PreviousSlide

Move to the previous logical slide or overlay-aware build step.

§

NextOverlay

Advance by one raw PDF page.

§

PreviousOverlay

Move back by one raw PDF page.

§

FirstSlide

Jump to the first logical slide.

§

LastSlide

Jump to the last logical slide.

§

GoToSlide

Enter a numeric slide jump.

§

ToggleFreeze

Freeze or unfreeze the audience display.

§

ToggleBlackout

Black out or restore the audience display.

§

ToggleWhiteboard

Show or hide the whiteboard canvas.

§

ToggleLaser

Enable or disable the laser pointer.

§

CycleLaserStyle

Rotate through configured laser pointer styles.

§

ToggleInk

Enable or disable freehand ink mode.

§

ClearInk

Clear ink from the active slide or whiteboard.

§

CycleInkColor

Rotate through configured ink colors.

§

CycleInkWidth

Rotate through configured ink widths.

§

ToggleSpotlight

Enable or disable the spotlight overlay.

§

ToggleZoom

Enable or disable the zoom overlay.

§

ToggleOverview

Show or hide the slide overview.

§

ToggleNotes

Show or hide slide notes.

§

ToggleNotesEdit

Toggle markdown editing for slide notes.

§

StartPauseTimer

Start, pause, or resume the main timer.

§

ResetTimer

Reset the main timer.

§

IncrementNotesFont

Increase the notes font size.

§

DecrementNotesFont

Decrease the notes font size.

§

ToggleScreenShare

Toggle screen-share window mode.

§

TogglePresentationMode

Toggle the single-monitor presentation surface.

§

ToggleTextBoxMode

Enable or disable text box placement mode.

§

Quit

Request application shutdown.

§

SaveSidecar

Save the active sidecar file.

Implementations§

Source§

impl Action

Source

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

The config-file name for this action (e.g., next_slide).

Source

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

Human-readable description for the help overlay.

Source

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

Grouping label for the help overlay.

Source

pub fn all() -> &'static [Action]

All known actions.

Trait Implementations§

Source§

impl Clone for Action

Source§

fn clone(&self) -> Action

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Action

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Hash for Action

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Action

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Copy for Action

Source§

impl Eq for Action

Source§

impl StructuralPartialEq for Action

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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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<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