Struct MouseSelectOptions 

pub struct MouseSelectOptions { /* private fields */ }

Configuration options for mouse-based text selection.

Use the builder pattern to configure selection behavior:

use beamterm_renderer::mouse::{MouseSelectOptions, ModifierKeys};
use beamterm_renderer::SelectionMode;

let options = MouseSelectOptions::new()
    .selection_mode(SelectionMode::Block)
    .require_modifier_keys(ModifierKeys::SHIFT)
    .trim_trailing_whitespace(true);

Implementations

impl MouseSelectOptions

pub fn new() -> Self

Creates a new MouseSelectOptions with default settings.

Defaults:

• Selection mode: Block
• Required modifier keys: none
• Trim trailing whitespace: false

pub fn selection_mode(self, mode: SelectionMode) -> Self

Sets the selection mode (Linear or Block).

• Linear: Selects text following the natural reading order
• Block: Selects a rectangular region of cells

pub fn require_modifier_keys(self, require_modifier_keys: ModifierKeys) -> Self

Sets modifier keys that must be held for selection to activate.

When set, mouse selection only begins if the specified modifier keys are pressed during the initial click. Use ModifierKeys::empty() to allow selection without any modifiers (the default).

Example

use beamterm_renderer::mouse::{MouseSelectOptions, ModifierKeys};

// Require Shift+Click to start selection
let options = MouseSelectOptions::new()
    .require_modifier_keys(ModifierKeys::SHIFT);

// Require Ctrl+Shift+Click
let options = MouseSelectOptions::new()
    .require_modifier_keys(ModifierKeys::CONTROL | ModifierKeys::SHIFT);

pub fn trim_trailing_whitespace(self, trim: bool) -> Self

Sets whether to trim trailing whitespace from selected text.

When enabled, trailing spaces at the end of each line are removed from the copied text.

Trait Implementations

impl Clone for MouseSelectOptions

fn clone(&self) -> MouseSelectOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MouseSelectOptions

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

Formats the value using the given formatter.

impl Default for MouseSelectOptions

fn default() -> MouseSelectOptions

Returns the “default value” for a type.

impl Copy for MouseSelectOptions