Skip to main content

PlanningForm

Struct PlanningForm 

Source
pub struct PlanningForm {
    pub kind: PlanningKind,
    pub rows: Vec<(String, String)>,
    pub cursor: usize,
    pub editing: Option<String>,
}
Expand description

The create/edit form for a cycle or milestone: a list of labelled field rows with a focused cursor. editing is Some(old name) when the form edits an existing item (a changed name triggers the rename cascade).

Fields§

§kind: PlanningKind§rows: Vec<(String, String)>§cursor: usize§editing: Option<String>

Implementations§

Source§

impl PlanningForm

Source

pub fn new(kind: PlanningKind) -> Self

A blank create form for kind.

Source

pub fn from_cycle(name: &str, cycle: &PlanningCycle) -> Self

An edit form for a cycle, prefilled from name + cycle.

Source

pub fn from_milestone(m: &Milestone) -> Self

An edit form for a milestone, prefilled from m.

Source

pub fn is_new(&self) -> bool

Source

pub fn name(&self) -> &str

The focused field’s typed value.

Source

pub fn description(&self) -> &str

Source

pub fn date_a(&self) -> &str

Cycle start date / milestone target date.

Source

pub fn date_b(&self) -> &str

Cycle due date (empty for milestones).

Source

pub fn focused_label(&self) -> &str

Source

pub fn focused_value(&self) -> &str

The focused field’s typed value.

Source

pub fn focused_is_date(&self) -> bool

Whether the focused field is a picker-only date field. Date fields are always the rows after Name and Description.

Source

pub fn focused_date_is_complete(&self) -> bool

Whether the focused date field already holds a complete, valid date.

Source

pub fn set_focused_date(&mut self, value: &str)

Overwrite the focused date field (no-op when it isn’t a date field).

Source

pub fn focus_next(&mut self)

Source

pub fn focus_prev(&mut self)

Source

pub fn insert_char(&mut self, c: char)

Source

pub fn delete_char(&mut self)

Source

pub fn render(&self, f: &mut Frame<'_>, area: Rect)

Render the form over area.

Source

pub fn render_with_bindings( &self, f: &mut Frame<'_>, area: Rect, bindings: &EffectiveBindings, context: InputContext, )

Trait Implementations§

Source§

impl Clone for PlanningForm

Source§

fn clone(&self) -> Self

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 PlanningForm

Source§

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

Formats the value using the given formatter. Read more

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<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.