calendar

Documentation

Overview

Package calendar provides Calendar — a text-mode month grid with keyboard / mouse date selection, and CalendarDialog — a modal "pick a date" wrapper.

Index

• func ShowDialog(host *views.Group, initial time.Time, title string) (time.Time, bool)
• type Calendar
  • func New(bounds geom.Rect) *Calendar
  • func (c *Calendar) Draw()
  • func (c *Calendar) GetTypeID() string
  • func (c *Calendar) HandleEvent(ev *drivers.Event)
  • func (c *Calendar) Move(deltaDays int)
  • func (c *Calendar) MoveMonth(m int)
  • func (c *Calendar) SetDate(d time.Time)

Functions

func ShowDialog

func ShowDialog(host *views.Group, initial time.Time, title string) (time.Time, bool)

ShowDialog runs a date picker dialog and returns the chosen date, or zero time if cancelled.

Types

type Calendar

type Calendar struct {
	views.Base

	Selected time.Time
	View     time.Time // first of the visible month

	HeaderColor uint16
	WeekColor   uint16
	DayColor    uint16
	FocusColor  uint16
	OtherMonth  uint16
}

Calendar paints one month with a focused date.

func New

func New(bounds geom.Rect) *Calendar

New constructs a Calendar focused on today.

func (*Calendar) Draw

func (c *Calendar) Draw()

Draw paints title row, weekday header, and the day grid.

func (*Calendar) GetTypeID

func (c *Calendar) GetTypeID() string

GetTypeID for serial registry.

func (*Calendar) HandleEvent

func (c *Calendar) HandleEvent(ev *drivers.Event)

HandleEvent: arrows / pageup-down / Home / End for navigation, plus click-to-pick on any cell of the day grid.

func (*Calendar) Move

func (c *Calendar) Move(deltaDays int)

Move adds delta days to Selected.

func (*Calendar) MoveMonth

func (c *Calendar) MoveMonth(m int)

MoveMonth shifts the calendar by m months without changing the day.

func (*Calendar) SetDate

func (c *Calendar) SetDate(d time.Time)

SetDate moves the selected date and shifts the visible month if needed.