Skip to main content

Calendar

Struct Calendar 

Source
pub struct Calendar { /* private fields */ }
Expand description

A month of days.

Implementations§

Source§

impl Calendar

Source

pub fn new( ident: impl Into<Ident>, adapter: SharedDateAdapter, _window: &mut Window, cx: &mut Context<'_, Self>, ) -> Self

Source

pub fn selected(self, days: impl IntoIterator<Item = Day>) -> Self

Seeds the days the caller says are chosen.

Source

pub fn multi(self, multi: bool) -> Self

Whether more than one day may be chosen. The calendar reports either way; this only decides what it draws and publishes.

Source

pub fn month(self, month: MonthKey) -> Self

The month to open on, for a calendar whose host knows where it wants to start but has nothing selected and no today.

Source

pub fn overlay(self, overlay: impl Fn(Day) -> Option<DayMark> + 'static) -> Self

Marks days with a dot the host supplies.

Source

pub fn range(self, range: DayRange) -> Self

Draws a range across the grid, with its endpoints picked out.

Source

pub fn set_selection(&mut self, days: Vec<Day>, cx: &mut Context<'_, Self>)

Source

pub fn set_overlay( &mut self, overlay: impl Fn(Day) -> Option<DayMark> + 'static, cx: &mut Context<'_, Self>, )

Source

pub fn set_range(&mut self, range: Option<DayRange>, cx: &mut Context<'_, Self>)

A RangePicker pushes its caller’s range down on every frame, so this has to be quiet when nothing moved or the two of them redraw each other forever.

Source

pub fn set_disabled(&mut self, disabled: bool, cx: &mut Context<'_, Self>)

Source

pub fn set_hovered_day(&mut self, day: Option<Day>, cx: &mut Context<'_, Self>)

Pins what the pointer is over, so a range preview can be staged for review without a pointer in the window.

Source

pub fn adapter(&self) -> &SharedDateAdapter

Source

pub fn selection(&self) -> &[Day]

Source

pub fn cursor(&self) -> Option<Day>

Source

pub fn hovered_day(&self) -> Option<Day>

Source

pub fn shown_month(&self) -> Option<MonthKey>

The month on screen, or None when nothing has established one.

Navigation, then the caller’s month, then the first selected day, then today. A calendar with none of those does not invent one.

Source

pub fn shift(&mut self, delta: i32, cx: &mut Context<'_, Self>)

Moves the month through the adapter. Nothing here adds or subtracts.

Source

pub fn show_month(&mut self, month: MonthKey, cx: &mut Context<'_, Self>)

Trait Implementations§

Source§

impl Debug for Calendar

Source§

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

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

impl Disableable for Calendar

Source§

fn disabled(self, disabled: bool) -> Self

Source§

impl EventEmitter<CalendarEvent> for Calendar

Source§

impl Focusable for Calendar

Source§

fn focus_handle(&self, _cx: &App) -> FocusHandle

Returns the focus handle associated with this view.
Source§

impl Render for Calendar

Source§

fn render( &mut self, _window: &mut Window, cx: &mut Context<'_, Self>, ) -> impl IntoElement

Render this view into an element tree.

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more