Struct CalendarState 

pub struct CalendarState<const N: usize, Selection> {
    pub area: Rect,
    pub inner: Rect,
    pub widget_area: Rect,
    pub months: [MonthState<Selection>; N],
    pub selection: Rc<RefCell<Selection>>,
    pub focus: FocusFlag,
    pub non_exhaustive: NonExhaustive,
    /* private fields */
}

A struct that contains an array of MonthState to get a true calendar behaviour. There is no Widget for this, the exact layout is left to the user. This takes care of all the rest.

Fields

area: Rect

Complete area read only. renewed for each render.

inner: Rect

Area inside the block. read only. renewed for each render.

widget_area: Rect

👎Deprecated since 2.3.0: use inner instead

Area inside the block. read only. renewed for each render.

months: [MonthState<Selection>; N]

Months.

selection: Rc<RefCell<Selection>>

Selection model.

focus: FocusFlag

Calendar focus

non_exhaustive: NonExhaustive

Implementations

impl<const N: usize, Selection> CalendarState<N, Selection>

pub fn new() -> Self

where Selection: Default,

pub fn named(name: &str) -> Self

where Selection: Default,

pub fn set_step(&mut self, step: usize)

Step-size when navigating outside the displayed calendar.

You can do a rolling calendar which goes back 1 month or a yearly calendar which goes back 12 months. Or any other value you like.

If you set step to 0 this kind of navigation is deactivated.

Default is 1.

pub fn step(&self) -> usize

Step-size when navigating outside the displayed calendar.

You can do a rolling calendar which goes back 1 month or a yearly calendar which goes back 12 months. Or any other value you like.

If you set step to 0 this kind of navigation is deactivated.

Default is 1.

pub fn set_today_policy(&mut self, home: TodayPolicy)

How should move_to_today() work.

pub fn today_policy(&mut self) -> TodayPolicy

How should move_to_today() work.

pub fn set_primary_idx(&mut self, primary: usize)

Set the primary month for the calendar.

The primary month will be focused with Tab navigation. That means you can jump over all calendar months with just one Tab.

Movement within the calendar is possible with the arrow-keys. This will change the primary month for future Tab navigation.

pub fn primary_idx(&self) -> usize

The primary month for the calendar.

The primary month will be focused with Tab navigation. That means you can jump over all calendar months with just one Tab.

Movement within the calendar is possible with the arrow-keys. This will change the primary month for future Tab navigation.

pub fn set_start_date(&mut self, date: NaiveDate)

Set the start-date for the calendar. This will set the start-date for each month.

pub fn start_date(&self) -> NaiveDate

Start-date of the calendar.

pub fn end_date(&self) -> NaiveDate

End-date of the calendar.

pub fn scroll_forward(&mut self, n: usize) -> CalOutcome

Changes the start-date for each month. Doesn’t change any selection.

pub fn scroll_back(&mut self, n: usize) -> CalOutcome

Changes the start-date for each month. Doesn’t change any selection.

pub fn scroll_to(&mut self, date: NaiveDate) -> CalOutcome

Changes the start-date for each month. Doesn’t change any selection.

pub fn screen_cursor(&self) -> Option<(u16, u16)>

Returns None

impl<const N: usize, Selection> CalendarState<N, Selection>

where Selection: CalendarSelection,

pub fn is_selected(&self, date: NaiveDate) -> bool

Is the date selected?

pub fn lead_selection(&self) -> Option<NaiveDate>

Lead selection.

impl<const N: usize> CalendarState<N, NoSelection>

pub fn prev_month(&mut self, n: usize) -> CalOutcome

Move to the previous month. Scrolls the calendar if necessary.

pub fn next_month(&mut self, n: usize) -> CalOutcome

Move to the next month. Scrolls the calendar if necessary.

pub fn move_to_today(&mut self) -> CalOutcome

Move the calendar to show the current date.

Resets the start-dates according to TodayPolicy. Focuses the primary index and selects the current day.

pub fn move_to(&mut self, date: NaiveDate) -> CalOutcome

impl<const N: usize> CalendarState<N, SingleSelection>

pub fn clear_selection(&mut self)

Clear the selection.

pub fn select(&mut self, date: NaiveDate) -> bool

Select the given date. Doesn’t scroll the calendar.

pub fn selected(&self) -> Option<NaiveDate>

Selected date.

pub fn move_to_today(&mut self) -> CalOutcome

Move the calendar to show the current date.

Resets the start-dates according to TodayPolicy. Focuses the primary index and selects the current day.

pub fn move_to(&mut self, date: NaiveDate) -> CalOutcome

Move the calendar to show the given date.

Resets the start-dates according to TodayPolicy. Focuses the primary index and selects the current day.

pub fn prev_day(&mut self, n: usize) -> CalOutcome

Select previous day. Scrolls the calendar if necessary.

pub fn next_day(&mut self, n: usize) -> CalOutcome

Select previous week. Scrolls the calendar if necessary.

pub fn prev_month(&mut self, n: usize) -> CalOutcome

Select the same day in the previous month.

This may shift the date a bit if it’s out of range of the new month.

pub fn next_month(&mut self, n: usize) -> CalOutcome

Select the same day in the next month.

This may shift the date a bit if it’s out of range of the new month.

impl<const N: usize> CalendarState<N, RangeSelection>

pub fn clear_selection(&mut self)

Clear the selection.

pub fn select_month(&mut self, date: NaiveDate, extend: bool) -> bool

Select the full month of the date. Any date of the month will do. Can extend the selection to encompass the month. Any existing selection is buffed up to fill one month.

pub fn select_week(&mut self, date: NaiveDate, extend: bool) -> bool

Select the week of the given date. Any date of the week will do. Can extend the selection to encompass the week. Any existing selection is buffed up to fill one week.

pub fn select_day(&mut self, date: NaiveDate, extend: bool) -> bool

Select the given date. Can extend the selection to the given date.

pub fn select(&mut self, selection: (NaiveDate, NaiveDate)) -> bool

Set the selection as (anchor, lead) pair.

pub fn selected(&self) -> Option<(NaiveDate, NaiveDate)>

Selection as (anchor, lead) pair.

pub fn selected_range(&self) -> Option<RangeInclusive<NaiveDate>>

Selection as NaiveDate range.

pub fn move_to_today(&mut self) -> CalOutcome

Move the calendar to today.

Uses TodayPolicy to build the new calendar and focuses and selects the given date.

pub fn move_to(&mut self, date: NaiveDate) -> CalOutcome

Move the calendar the given day.

Uses TodayPolicy to build the new calendar and focuses and selects the given date.

pub fn move_to_prev(&mut self, months: Months, days: Days) -> CalOutcome

Move the lead selection back by months/days. Clears the current selection and scrolls if necessary.

pub fn move_to_next(&mut self, months: Months, days: Days) -> CalOutcome

Move the lead selection forward by months/days. Clears the current selection and scrolls if necessary.

pub fn prev_day(&mut self, n: usize, extend: bool) -> CalOutcome

Select previous day.

Can extend the selection to include the new date.

pub fn next_day(&mut self, n: usize, extend: bool) -> CalOutcome

Select next day.

Can extend the selection to include the new date.

pub fn prev_week(&mut self, n: usize, extend: bool) -> CalOutcome

Select the previous week.

When extending a selection, the current selection buffs up to fill one week.

pub fn next_week(&mut self, n: usize, extend: bool) -> CalOutcome

Select the next week.

When extending a selection, the current selection buffs up to fill one week.

pub fn prev_month(&mut self, n: usize, extend: bool) -> CalOutcome

Select the previous month.

When extending a selection, the current selection buffs up to fill one month.

pub fn next_month(&mut self, n: usize, extend: bool) -> CalOutcome

Select the previous month.

When extending a selection, the current selection buffs up to fill one month.

Trait Implementations

impl<const N: usize, Selection: Clone> Clone for CalendarState<N, Selection>

fn clone(&self) -> CalendarState<N, Selection>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: usize, Selection: Debug> Debug for CalendarState<N, Selection>

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

Formats the value using the given formatter.

impl<const N: usize, Selection> Default for CalendarState<N, Selection>

where Selection: Default,

fn default() -> Self

Returns the “default value” for a type.

impl<const N: usize> HandleEvent<Event, MouseOnly, CalOutcome> for CalendarState<N, NoSelection>

fn handle(&mut self, event: &Event, _qualifier: MouseOnly) -> CalOutcome

Handle an event.

impl<const N: usize> HandleEvent<Event, MouseOnly, CalOutcome> for CalendarState<N, RangeSelection>

fn handle(&mut self, event: &Event, _qualifier: MouseOnly) -> CalOutcome

Handle an event.

impl<const N: usize> HandleEvent<Event, MouseOnly, CalOutcome> for CalendarState<N, SingleSelection>

fn handle(&mut self, event: &Event, _qualifier: MouseOnly) -> CalOutcome

Handle an event.

impl<const N: usize> HandleEvent<Event, Regular, CalOutcome> for CalendarState<N, NoSelection>

fn handle(&mut self, event: &Event, _qualifier: Regular) -> CalOutcome

Handle an event.

impl<const N: usize> HandleEvent<Event, Regular, CalOutcome> for CalendarState<N, RangeSelection>

fn handle(&mut self, event: &Event, _qualifier: Regular) -> CalOutcome

Handle an event.

impl<const N: usize> HandleEvent<Event, Regular, CalOutcome> for CalendarState<N, SingleSelection>

fn handle(&mut self, event: &Event, _qualifier: Regular) -> CalOutcome

Handle an event.

impl<const N: usize, Selection> HasFocus for CalendarState<N, Selection>

fn build(&self, builder: &mut FocusBuilder)

Build the focus-structure for the container/widget.

fn focus(&self) -> FocusFlag

Access to the flag for the rest.

fn area(&self) -> Rect

Area for mouse focus.

fn build_nav(&self, navigable: Navigation, builder: &mut FocusBuilder)

Build the focus-structure for the container/widget. This is called when the default navigation will be overridden by the builder.

fn id(&self) -> usize

Provide a unique id for the widget.

fn area_z(&self) -> u16

Z value for the area.

fn navigable(&self) -> Navigation

Declares how the widget interacts with focus.

fn is_focused(&self) -> bool

Focused?

fn lost_focus(&self) -> bool

Just lost focus.

fn gained_focus(&self) -> bool

Just gained focus.

impl<const N: usize, Selection> HasScreenCursor for CalendarState<N, Selection>

fn screen_cursor(&self) -> Option<(u16, u16)>

This returns the cursor position if

impl<const N: usize, Selection> RelocatableState for CalendarState<N, Selection>

fn relocate(&mut self, shift: (i16, i16), clip: Rect)

Relocate the areas in this widgets state.

fn relocate_popup(&mut self, shift: (i16, i16), clip: Rect)

Relocate only popup areas. As rendering the popups is a separate render, this has to be separate too.

fn relocate_popup_hidden(&mut self)

Relocate all popup areas to a clip-rect (0,0+0x0).

fn relocate_hidden(&mut self)

Relocate all areas to a clip-rect (0,0+0x0).