Struct FormControl 

pub struct FormControl {

    pub id: u32,
    pub kind: ControlKind,
    pub anchor: Anchor,
    pub name: String,
    pub text: String,
    pub link: Option<String>,
    pub value: u32,
    pub min: u32,
    pub max: u32,
    pub step: u32,
    pub page: u32,
    pub horizontal: bool,
    pub action: Option<ControlAction>,
    pub print: bool,
    pub locked: bool,
}

A form control (button, slider, spin button) floating over the sheet.

Fields

id: u32

kind: ControlKind

anchor: Anchor

name: String

The name shown in the Selection Pane (Button 3); empty means the kind and id.

text: String

The caption of a button.

link: Option<String>

The linked cell as reference text: $B$2 on the control’s own sheet, or Sheet2!$B$2. Structural edits rewrite it like a formula reference.

value: u32

The current value of a slider or spin button (the linked cell holds it too).

min: u32

max: u32

step: u32

Incremental change: one arrow click or arrow key.

page: u32

Page change (sliders): a click on the track, or Page Up / Page Down.

horizontal: bool

A slider lies horizontally (false: vertically).

action: Option<ControlAction>

What a button runs.

print: bool

Printed with the sheet.

locked: bool

Locked when the sheet is protected.

Implementations

impl FormControl

pub fn display_name(&self) -> String

The name shown for the control: its own, else Button 3, Slider 4, Spin Button 5.

pub fn check_numbers(&self) -> Result<(), String>

Checks the numbers of a slider or spin button: 0 ≤ min < max ≤ 30000, 1 ≤ step ≤ max − min, and (sliders) page ≥ step. Each rule has its own message.

pub fn snap(&self, v: f64) -> u32

v clamped to min..max and snapped to the nearest step from min (max stays reachable).

Trait Implementations

impl Clone for FormControl

fn clone(&self) -> FormControl

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FormControl

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

Formats the value using the given formatter.

impl Default for FormControl

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FormControl

where FormControl: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FormControl

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for FormControl

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FormControl