GI.Gtk.Objects.Calendar

Calendar is a widget that displays a Gregorian calendar, one month at a time. It can be created with calendarNew.

The month and year currently displayed can be altered with calendarSelectMonth. The exact day can be selected from the displayed month using calendarSelectDay.

To place a visual marker on a particular day, use calendarMarkDay and to remove the marker, calendarUnmarkDay. Alternative, all marks can be cleared with calendarClearMarks.

The way in which the calendar itself is displayed can be altered using calendarSetDisplayOptions.

The selected date can be retrieved from a Calendar using calendarGetDate.

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.

Exported types

newtype Calendar

Constructors

Calendar (ManagedPtr Calendar)

Instances

GObject Calendar

Methods

gobjectType :: Calendar -> IO GType

IsImplementorIface Calendar

IsObject Calendar

IsWidget Calendar

IsCalendar Calendar

IsBuildable Calendar

class GObject o => IsCalendar o

Instances

(GObject a, UnknownAncestorError Constraint Calendar a) => IsCalendar a

IsCalendar Calendar

toCalendar :: (MonadIO m, IsCalendar o) => o -> m Calendar

noCalendar :: Maybe Calendar

Methods

clearMarks

calendarClearMarks

Arguments

:: (HasCallStack, MonadIO m, IsCalendar a)

=> a

calendar: a Calendar

-> m ()

Remove all visual markers.

getDate

calendarGetDate

Arguments

:: (HasCallStack, MonadIO m, IsCalendar a)

=> a

calendar: a Calendar

-> m (Word32, Word32, Word32)

Obtains the selected date from a Calendar.

getDayIsMarked

calendarGetDayIsMarked

Arguments

:: (HasCallStack, MonadIO m, IsCalendar a)

=> a

calendar: a Calendar

-> Word32

day: the day number between 1 and 31.

-> m Bool

Returns: whether the day is marked.

Returns if the day of the calendar is already marked.

Since: 3.0

getDetailHeightRows

calendarGetDetailHeightRows

Arguments

:: (HasCallStack, MonadIO m, IsCalendar a)

=> a

calendar: a Calendar.

-> m Int32

Returns: The height of detail cells, in rows.

Queries the height of detail cells, in rows. See Calendar:detail-width-chars.

Since: 2.14

getDetailWidthChars

calendarGetDetailWidthChars

Arguments

:: (HasCallStack, MonadIO m, IsCalendar a)

=> a

calendar: a Calendar.

-> m Int32

Returns: The width of detail cells, in characters.

Queries the width of detail cells, in characters. See Calendar:detail-width-chars.

Since: 2.14

getDisplayOptions

calendarGetDisplayOptions

Arguments

:: (HasCallStack, MonadIO m, IsCalendar a)

=> a

calendar: a Calendar

-> m [CalendarDisplayOptions]

Returns: the display options.

Returns the current display options of calendar.

Since: 2.4

markDay

calendarMarkDay

Arguments

:: (HasCallStack, MonadIO m, IsCalendar a)

=> a

calendar: a Calendar

-> Word32

day: the day number to mark between 1 and 31.

-> m ()

Places a visual marker on a particular day.

new

calendarNew

Arguments

:: (HasCallStack, MonadIO m)

=> m Calendar

Returns: a newly Calendar widget

Creates a new calendar, with the current date being selected.

selectDay

calendarSelectDay

Arguments

:: (HasCallStack, MonadIO m, IsCalendar a)

=> a

calendar: a Calendar.

-> Word32

day: the day number between 1 and 31, or 0 to unselect the currently selected day.

-> m ()

Selects a day from the current month.

selectMonth

calendarSelectMonth

Arguments

:: (HasCallStack, MonadIO m, IsCalendar a)

=> a

calendar: a Calendar

-> Word32

month: a month number between 0 and 11.

-> Word32

year: the year the month is in.

-> m ()

Shifts the calendar to a different month.

setDetailFunc

calendarSetDetailFunc

Arguments

:: (HasCallStack, MonadIO m, IsCalendar a)

=> a

calendar: a Calendar.

-> CalendarDetailFunc

func: a function providing details for each day.

-> m ()

Installs a function which provides Pango markup with detail information for each day. Examples for such details are holidays or appointments. That information is shown below each day when Calendar:show-details is set. A tooltip containing with full detail information is provided, if the entire text should not fit into the details area, or if Calendar:show-details is not set.

The size of the details area can be restricted by setting the Calendar:detail-width-chars and Calendar:detail-height-rows properties.

Since: 2.14

setDetailHeightRows

calendarSetDetailHeightRows

Arguments

:: (HasCallStack, MonadIO m, IsCalendar a)

=> a

calendar: a Calendar.

-> Int32

rows: detail height in rows.

-> m ()

Updates the height of detail cells. See Calendar:detail-height-rows.

Since: 2.14

setDetailWidthChars

calendarSetDetailWidthChars

Arguments

:: (HasCallStack, MonadIO m, IsCalendar a)

=> a

calendar: a Calendar.

-> Int32

chars: detail width in characters.

-> m ()

Updates the width of detail cells. See Calendar:detail-width-chars.

Since: 2.14

setDisplayOptions

calendarSetDisplayOptions

Arguments

:: (HasCallStack, MonadIO m, IsCalendar a)

=> a

calendar: a Calendar

-> [CalendarDisplayOptions]

flags: the display options to set

-> m ()

Sets display options (whether to display the heading and the month headings).

Since: 2.4

unmarkDay

calendarUnmarkDay

Arguments

:: (HasCallStack, MonadIO m, IsCalendar a)

=> a

calendar: a Calendar.

-> Word32

day: the day number to unmark between 1 and 31.

-> m ()

Removes the visual marker from a particular day.

Properties

day

constructCalendarDay :: IsCalendar o => Int32 -> IO (GValueConstruct o)

getCalendarDay :: (MonadIO m, IsCalendar o) => o -> m Int32

setCalendarDay :: (MonadIO m, IsCalendar o) => o -> Int32 -> m ()

detailHeightRows

constructCalendarDetailHeightRows :: IsCalendar o => Int32 -> IO (GValueConstruct o)

getCalendarDetailHeightRows :: (MonadIO m, IsCalendar o) => o -> m Int32

setCalendarDetailHeightRows :: (MonadIO m, IsCalendar o) => o -> Int32 -> m ()

detailWidthChars

constructCalendarDetailWidthChars :: IsCalendar o => Int32 -> IO (GValueConstruct o)

getCalendarDetailWidthChars :: (MonadIO m, IsCalendar o) => o -> m Int32

setCalendarDetailWidthChars :: (MonadIO m, IsCalendar o) => o -> Int32 -> m ()

month

constructCalendarMonth :: IsCalendar o => Int32 -> IO (GValueConstruct o)

getCalendarMonth :: (MonadIO m, IsCalendar o) => o -> m Int32

setCalendarMonth :: (MonadIO m, IsCalendar o) => o -> Int32 -> m ()

noMonthChange

constructCalendarNoMonthChange :: IsCalendar o => Bool -> IO (GValueConstruct o)

getCalendarNoMonthChange :: (MonadIO m, IsCalendar o) => o -> m Bool

setCalendarNoMonthChange :: (MonadIO m, IsCalendar o) => o -> Bool -> m ()

showDayNames

constructCalendarShowDayNames :: IsCalendar o => Bool -> IO (GValueConstruct o)

getCalendarShowDayNames :: (MonadIO m, IsCalendar o) => o -> m Bool

setCalendarShowDayNames :: (MonadIO m, IsCalendar o) => o -> Bool -> m ()

showDetails

constructCalendarShowDetails :: IsCalendar o => Bool -> IO (GValueConstruct o)

getCalendarShowDetails :: (MonadIO m, IsCalendar o) => o -> m Bool

setCalendarShowDetails :: (MonadIO m, IsCalendar o) => o -> Bool -> m ()

showHeading

constructCalendarShowHeading :: IsCalendar o => Bool -> IO (GValueConstruct o)

getCalendarShowHeading :: (MonadIO m, IsCalendar o) => o -> m Bool

setCalendarShowHeading :: (MonadIO m, IsCalendar o) => o -> Bool -> m ()

showWeekNumbers

constructCalendarShowWeekNumbers :: IsCalendar o => Bool -> IO (GValueConstruct o)

getCalendarShowWeekNumbers :: (MonadIO m, IsCalendar o) => o -> m Bool

setCalendarShowWeekNumbers :: (MonadIO m, IsCalendar o) => o -> Bool -> m ()

year

constructCalendarYear :: IsCalendar o => Int32 -> IO (GValueConstruct o)

getCalendarYear :: (MonadIO m, IsCalendar o) => o -> m Int32

setCalendarYear :: (MonadIO m, IsCalendar o) => o -> Int32 -> m ()

Signals

daySelected

type C_CalendarDaySelectedCallback = Ptr () -> Ptr () -> IO ()

type CalendarDaySelectedCallback = IO ()

afterCalendarDaySelected :: (IsCalendar a, MonadIO m) => a -> CalendarDaySelectedCallback -> m SignalHandlerId

genClosure_CalendarDaySelected :: CalendarDaySelectedCallback -> IO Closure

mk_CalendarDaySelectedCallback :: C_CalendarDaySelectedCallback -> IO (FunPtr C_CalendarDaySelectedCallback)

noCalendarDaySelectedCallback :: Maybe CalendarDaySelectedCallback

onCalendarDaySelected :: (IsCalendar a, MonadIO m) => a -> CalendarDaySelectedCallback -> m SignalHandlerId

wrap_CalendarDaySelectedCallback :: CalendarDaySelectedCallback -> Ptr () -> Ptr () -> IO ()

daySelectedDoubleClick

type C_CalendarDaySelectedDoubleClickCallback = Ptr () -> Ptr () -> IO ()

type CalendarDaySelectedDoubleClickCallback = IO ()

afterCalendarDaySelectedDoubleClick :: (IsCalendar a, MonadIO m) => a -> CalendarDaySelectedDoubleClickCallback -> m SignalHandlerId

genClosure_CalendarDaySelectedDoubleClick :: CalendarDaySelectedDoubleClickCallback -> IO Closure

mk_CalendarDaySelectedDoubleClickCallback :: C_CalendarDaySelectedDoubleClickCallback -> IO (FunPtr C_CalendarDaySelectedDoubleClickCallback)

noCalendarDaySelectedDoubleClickCallback :: Maybe CalendarDaySelectedDoubleClickCallback

onCalendarDaySelectedDoubleClick :: (IsCalendar a, MonadIO m) => a -> CalendarDaySelectedDoubleClickCallback -> m SignalHandlerId

wrap_CalendarDaySelectedDoubleClickCallback :: CalendarDaySelectedDoubleClickCallback -> Ptr () -> Ptr () -> IO ()

monthChanged

type C_CalendarMonthChangedCallback = Ptr () -> Ptr () -> IO ()

type CalendarMonthChangedCallback = IO ()

afterCalendarMonthChanged :: (IsCalendar a, MonadIO m) => a -> CalendarMonthChangedCallback -> m SignalHandlerId

genClosure_CalendarMonthChanged :: CalendarMonthChangedCallback -> IO Closure

mk_CalendarMonthChangedCallback :: C_CalendarMonthChangedCallback -> IO (FunPtr C_CalendarMonthChangedCallback)

noCalendarMonthChangedCallback :: Maybe CalendarMonthChangedCallback

onCalendarMonthChanged :: (IsCalendar a, MonadIO m) => a -> CalendarMonthChangedCallback -> m SignalHandlerId

wrap_CalendarMonthChangedCallback :: CalendarMonthChangedCallback -> Ptr () -> Ptr () -> IO ()

nextMonth

type C_CalendarNextMonthCallback = Ptr () -> Ptr () -> IO ()

type CalendarNextMonthCallback = IO ()

afterCalendarNextMonth :: (IsCalendar a, MonadIO m) => a -> CalendarNextMonthCallback -> m SignalHandlerId

genClosure_CalendarNextMonth :: CalendarNextMonthCallback -> IO Closure

mk_CalendarNextMonthCallback :: C_CalendarNextMonthCallback -> IO (FunPtr C_CalendarNextMonthCallback)

noCalendarNextMonthCallback :: Maybe CalendarNextMonthCallback

onCalendarNextMonth :: (IsCalendar a, MonadIO m) => a -> CalendarNextMonthCallback -> m SignalHandlerId

wrap_CalendarNextMonthCallback :: CalendarNextMonthCallback -> Ptr () -> Ptr () -> IO ()

nextYear

type C_CalendarNextYearCallback = Ptr () -> Ptr () -> IO ()

type CalendarNextYearCallback = IO ()

afterCalendarNextYear :: (IsCalendar a, MonadIO m) => a -> CalendarNextYearCallback -> m SignalHandlerId

genClosure_CalendarNextYear :: CalendarNextYearCallback -> IO Closure

mk_CalendarNextYearCallback :: C_CalendarNextYearCallback -> IO (FunPtr C_CalendarNextYearCallback)

noCalendarNextYearCallback :: Maybe CalendarNextYearCallback

onCalendarNextYear :: (IsCalendar a, MonadIO m) => a -> CalendarNextYearCallback -> m SignalHandlerId

wrap_CalendarNextYearCallback :: CalendarNextYearCallback -> Ptr () -> Ptr () -> IO ()

prevMonth

type C_CalendarPrevMonthCallback = Ptr () -> Ptr () -> IO ()

type CalendarPrevMonthCallback = IO ()

afterCalendarPrevMonth :: (IsCalendar a, MonadIO m) => a -> CalendarPrevMonthCallback -> m SignalHandlerId

genClosure_CalendarPrevMonth :: CalendarPrevMonthCallback -> IO Closure

mk_CalendarPrevMonthCallback :: C_CalendarPrevMonthCallback -> IO (FunPtr C_CalendarPrevMonthCallback)

noCalendarPrevMonthCallback :: Maybe CalendarPrevMonthCallback

onCalendarPrevMonth :: (IsCalendar a, MonadIO m) => a -> CalendarPrevMonthCallback -> m SignalHandlerId

wrap_CalendarPrevMonthCallback :: CalendarPrevMonthCallback -> Ptr () -> Ptr () -> IO ()

prevYear

type C_CalendarPrevYearCallback = Ptr () -> Ptr () -> IO ()

type CalendarPrevYearCallback = IO ()

afterCalendarPrevYear :: (IsCalendar a, MonadIO m) => a -> CalendarPrevYearCallback -> m SignalHandlerId

genClosure_CalendarPrevYear :: CalendarPrevYearCallback -> IO Closure

mk_CalendarPrevYearCallback :: C_CalendarPrevYearCallback -> IO (FunPtr C_CalendarPrevYearCallback)

noCalendarPrevYearCallback :: Maybe CalendarPrevYearCallback

onCalendarPrevYear :: (IsCalendar a, MonadIO m) => a -> CalendarPrevYearCallback -> m SignalHandlerId

wrap_CalendarPrevYearCallback :: CalendarPrevYearCallback -> Ptr () -> Ptr () -> IO ()