Struct gtk4::Calendar

source ·

#[repr(transparent)]
pub struct Calendar { /* private fields */ }

Expand description

Calendar is a widget that displays a Gregorian calendar, one month at a time.

A Calendar can be created with new().

The date that is currently displayed can be altered with select_day().

To place a visual marker on a particular day, use mark_day() and to remove the marker, unmark_day(). Alternative, all marks can be cleared with clear_marks().

The selected date can be retrieved from a Calendar using date().

Users should be aware that, although the Gregorian calendar is the legal calendar in most countries, it was adopted progressively between 1582 and 1929. Display before these dates is likely to be historically incorrect.

CSS nodes

calendar.view
├── header
│   ├── button
│   ├── stack.month
│   ├── button
│   ├── button
│   ├── label.year
│   ╰── button
╰── grid
    ╰── label[.day-name][.week-number][.day-number][.other-month][.today]

Calendar has a main node with name calendar. It contains a subnode called header containing the widgets for switching between years and months.

The grid subnode contains all day labels, including week numbers on the left (marked with the .week-number css class) and day names on top (marked with the .day-name css class).

Day labels that belong to the previous or next month get the .other-month style class. The label of the current day get the .today style class.

Marked day labels get the :selected state assigned.

Properties

`day`

The selected day (as a number between 1 and 31).

Readable | Writeable

`month`

The selected month (as a number between 0 and 11).

This property gets initially set to the current month.

Readable | Writeable

`show-day-names`

Determines whether day names are displayed.

Readable | Writeable

`show-heading`

Determines whether a heading is displayed.

Readable | Writeable

`show-week-numbers`

Determines whether week numbers are displayed.

Readable | Writeable

`year`

The selected year.

This property gets initially set to the current year.

Readable | Writeable

Widget

`can-focus`

Whether the widget or any of its descendents can accept the input focus.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

`can-target`

Whether the widget can receive pointer events.

Readable | Writeable

`css-classes`

A list of css classes applied to this widget.

Readable | Writeable

`css-name`

The name of this widget in the CSS tree.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable | Construct Only

`cursor`

The cursor used by @widget.

Readable | Writeable

`focus-on-click`

Whether the widget should grab focus when it is clicked with the mouse.

This property is only relevant for widgets that can take focus.

Readable | Writeable

`focusable`

Whether this widget itself will accept the input focus.

Readable | Writeable

`halign`

How to distribute horizontal space if widget gets extra space.

Readable | Writeable

`has-default`

Whether the widget is the default widget.

Readable

`has-focus`

Whether the widget has the input focus.

Readable

Enables or disables the emission of the ::query-tooltip signal on @widget.

A value of true indicates that @widget can have a tooltip, in this case the widget will be queried using query-tooltip to determine whether it will provide a tooltip or not.

Readable | Writeable

`height-request`

Override for height request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

`hexpand`

Whether to expand horizontally.

Readable | Writeable

`hexpand-set`

Whether to use the hexpand property.

Readable | Writeable

`layout-manager`

The LayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

`margin-bottom`

Margin on bottom side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

`margin-end`

Margin on end of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

`margin-start`

Margin on start of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

`margin-top`

Margin on top side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

`name`

The name of the widget.

Readable | Writeable

`opacity`

The requested opacity of the widget.

Readable | Writeable

`overflow`

How content outside the widget’s content area is treated.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

`parent`

The parent widget of this widget.

Readable

`receives-default`

Whether the widget will receive the default action when it is focused.

Readable | Writeable

`root`

The Root widget of the widget tree containing this widget.

This will be None if the widget is not contained in a root widget.

Readable

`scale-factor`

The scale factor of the widget.

Readable

`sensitive`

Whether the widget responds to input.

Readable | Writeable

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Also see Tooltip::set_markup().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

Sets the text of tooltip to be the given string.

Also see Tooltip::set_text().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

`valign`

How to distribute vertical space if widget gets extra space.

Readable | Writeable

`vexpand`

Whether to expand vertically.

Readable | Writeable

`vexpand-set`

Whether to use the vexpand property.

Readable | Writeable

`visible`

Whether the widget is visible.

Readable | Writeable

`width-request`

Override for width request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

Accessible

`accessible-role`

The accessible role of the given Accessible implementation.

The accessible role cannot be changed once set.

Readable | Writeable

Signals

`day-selected`

Emitted when the user selects a day.

`next-month`

Emitted when the user switched to the next month.

`next-year`

Emitted when user switched to the next year.

`prev-month`

Emitted when the user switched to the previous month.

`prev-year`

Emitted when user switched to the previous year.

Widget

`destroy`

Signals that all holders of a reference to the widget should release the reference that they hold.

May result in finalization of the widget if all references are released.

This signal is not suitable for saving widget state.

`direction-changed`

Emitted when the text direction of a widget changes.

`hide`

Emitted when @widget is hidden.

`keynav-failed`

Emitted if keyboard navigation fails.

See WidgetExt::keynav_failed() for details.

`map`

Emitted when @widget is going to be mapped.

A widget is mapped when the widget is visible (which is controlled with visible) and all its parents up to the toplevel widget are also visible.

The ::map signal can be used to determine whether a widget will be drawn, for instance it can resume an animation that was stopped during the emission of unmap.

`mnemonic-activate`

Emitted when a widget is activated via a mnemonic.

The default handler for this signal activates @widget if @group_cycling is false, or just makes @widget grab focus if @group_cycling is true.

`move-focus`

Emitted when the focus is moved.

The ::move-focus signal is a keybinding signal.

The default bindings for this signal are Tab to move forward, and Shift+Tab to move backward.

Action

Emitted when the widget’s tooltip is about to be shown.

This happens when the has-tooltip property is true and the hover timeout has expired with the cursor hovering “above” @widget; or emitted when @widget got focus in keyboard mode.

Using the given coordinates, the signal handler should determine whether a tooltip should be shown for @widget. If this is the case true should be returned, false otherwise. Note that if @keyboard_mode is true, the values of @x and @y are undefined and should not be used.

The signal handler is free to manipulate @tooltip with the therefore destined function calls.

`realize`

Emitted when @widget is associated with a gdk::Surface.

This means that WidgetExt::realize() has been called or the widget has been mapped (that is, it is going to be drawn).

`show`

Emitted when @widget is shown.

`state-flags-changed`

Emitted when the widget state changes.

See WidgetExt::state_flags().

`unmap`

Emitted when @widget is going to be unmapped.

A widget is unmapped when either it or any of its parents up to the toplevel widget have been set as hidden.

As ::unmap indicates that a widget will not be shown any longer, it can be used to, for example, stop an animation on the widget.

`unrealize`

Emitted when the gdk::Surface associated with @widget is destroyed.

This means that WidgetExt::unrealize() has been called or the widget has been unmapped (that is, it is going to be hidden).

Implements

WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, WidgetExtManual, AccessibleExtManual

Struct gtk4::Calendar

Widget

Accessible

Widget

Implementations§

impl Calendar

pub fn new() -> Calendar

pub fn builder() -> CalendarBuilder

pub fn clear_marks(&self)

pub fn date(&self) -> DateTime

pub fn day_is_marked(&self, day: u32) -> bool

pub fn shows_day_names(&self) -> bool

pub fn shows_heading(&self) -> bool

pub fn shows_week_numbers(&self) -> bool

pub fn mark_day(&self, day: u32)

pub fn select_day(&self, date: &DateTime)

pub fn set_show_day_names(&self, value: bool)

pub fn set_show_heading(&self, value: bool)

pub fn set_show_week_numbers(&self, value: bool)

pub fn unmark_day(&self, day: u32)

pub fn day(&self) -> i32

pub fn set_day(&self, day: i32)

pub fn month(&self) -> i32

pub fn set_month(&self, month: i32)

pub fn year(&self) -> i32

pub fn set_year(&self, year: i32)

pub fn connect_day_selected<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_next_month<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_next_year<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

pub fn connect_prev_month<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_prev_year<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

pub fn connect_day_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_month_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_show_day_names_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_show_heading_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_show_week_numbers_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_year_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Trait Implementations§

impl Clone for Calendar

fn clone(&self) -> Self

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

impl Debug for Calendar

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

impl Default for Calendar

fn default() -> Self

impl Display for Calendar

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

impl HasParamSpec for Calendar

type ParamSpec = ParamSpecObject

type SetValue = Calendar

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, Calendar>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Calendar

fn hash<H>(&self, state: &mut H)where H: Hasher,

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

impl Ord for Calendar

fn cmp(&self, other: &Self) -> Ordering

fn max(self, other: Self) -> Selfwhere Self: Sized,

fn min(self, other: Self) -> Selfwhere Self: Sized,

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

impl ParentClassIs for Calendar

type Parent = Widget

impl<OT: ObjectType> PartialEq<OT> for Calendar

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

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

impl<OT: ObjectType> PartialOrd<OT> for Calendar

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

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