Month

Struct Month 

Source
pub struct Month<'a, Selection> { /* private fields */ }
Expand description

Month widget.

Renders one month of a calendar.

There is movement and selection support within the month, but no scrolling. Use a Calendar for full calendar features.

Month::new()
    .locale(Locale::de_AT_euro)
    .styles(THEME.month_style())
    .title_align(Alignment::Left)
    .day_styles(&date_styles)
    .show_weekdays()
    .block(Block::bordered().borders(Borders::TOP))
    .render(l2[2], frame.buffer_mut(), &mut state.month1);
match state.month1.handle(event, Regular) {
    CalOutcome::Selected => {
        // doit
        Outcome::Changed
    }
    r => r.into()
}

Implementations§

Source§

impl<'a, Selection> Month<'a, Selection>

Source

pub fn new() -> Self

New calendar.

Source

pub fn date(self, s: NaiveDate) -> Self

Sets the starting date. This can be any date of the month. If no date is set, the start_date of the state is used.

Source

pub fn locale(self, loc: Locale) -> Self

Locale for month-names, day-names.

Source

pub fn hide_year(self) -> Self

Show year title

Source

pub fn hide_month(self) -> Self

Show month title

Source

pub fn show_year(self) -> Self

Show month title

Source

pub fn show_show_month(self) -> Self

👎Deprecated since 2.3.0: typo, use show_month()

Show month title

Source

pub fn show_month(self) -> Self

Show month title

Source

pub fn hide_weekdays(self) -> Self

Show weekday titles

Source

pub fn show_weekdays(self) -> Self

Show weekday titles

Source

pub fn styles(self, styles: CalendarStyle) -> Self

Set the composite style.

Source

pub fn style(self, style: Style) -> Self

Base style.

Source

pub fn select_style(self, style: Style) -> Self

Style for the selection

Source

pub fn focus_style(self, style: Style) -> Self

Style for the focus.

Source

pub fn day_style(self, s: impl Into<Style>) -> Self

Sets the default day-style.

Source

pub fn day_styles(self, styles: &'a HashMap<NaiveDate, Style>) -> Self

Set a map date->Style for highlighting some dates.

Source

pub fn week_style(self, s: impl Into<Style>) -> Self

Set the week number style.

Source

pub fn weekday_style(self, s: impl Into<Style>) -> Self

Set the week day style.

Source

pub fn title_style(self, s: impl Into<Style>) -> Self

Set the month-name style.

Source

pub fn title_align(self, a: Alignment) -> Self

Set the month-name align.

Source

pub fn block(self, b: Block<'a>) -> Self

Block

Source

pub fn width(&self) -> u16

Inherent width of the widget.

Source

pub fn height(&self, state: &MonthState<Selection>) -> u16

Inherent height for the widget. This is not a fixed value, depends on the month.

Trait Implementations§

Source§

impl<'a, Selection: Clone> Clone for Month<'a, Selection>

Source§

fn clone(&self) -> Month<'a, Selection>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a, Selection: Debug> Debug for Month<'a, Selection>

Source§

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

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

impl<Selection> Default for Month<'_, Selection>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'a, Selection> StatefulWidget for &Month<'a, Selection>
where Selection: CalendarSelection,

Source§

type State = MonthState<Selection>

State associated with the stateful widget. Read more
Source§

fn render(self, area: Rect, buf: &mut Buffer, state: &mut Self::State)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom stateful widget.
Source§

impl<Selection> StatefulWidget for Month<'_, Selection>
where Selection: CalendarSelection,

Source§

type State = MonthState<Selection>

State associated with the stateful widget. Read more
Source§

fn render(self, area: Rect, buf: &mut Buffer, state: &mut Self::State)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom stateful widget.

Auto Trait Implementations§

§

impl<'a, Selection> Freeze for Month<'a, Selection>

§

impl<'a, Selection> RefUnwindSafe for Month<'a, Selection>
where Selection: RefUnwindSafe,

§

impl<'a, Selection> Send for Month<'a, Selection>
where Selection: Send,

§

impl<'a, Selection> Sync for Month<'a, Selection>
where Selection: Sync,

§

impl<'a, Selection> Unpin for Month<'a, Selection>
where Selection: Unpin,

§

impl<'a, Selection> UnwindSafe for Month<'a, Selection>
where Selection: UnwindSafe,

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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