PtCalendar

A calendar

Class hierarchy:

PtWidget → PtBasic → PtCalendar

For more information, see the diagram of the widget hierarchy.

PhAB icon:

Public header:

<photon/PtCalendar.h>

Description:

PtCalendar draws a calendar showing the day of the week, month and year. You can interactively change the date and browse other months and years. The calendar is drawn on a per-month basis and can be drawn with or without a grid.

A PtCalendar widget.

New resources:

Pt_ARG_CALENDAR_COLOR1

The color used to display the current month's days. See PgColor_t in the Photon Library Reference.

Pt_ARG_CALENDAR_COLOR2

The color used to display the next and previous month's days. See PgColor_t in the Photon Library Reference.

Pt_ARG_CALENDAR_COLOR3

The color used for the year and month name. See PgColor_t in the Photon Library Reference.

Pt_ARG_CALENDAR_COLOR4

The color used for any highlighted days in the calendar (see Pt_ARG_CALENDAR_HIGHLIGHT).

Pt_ARG_CALENDAR_COLOR5

The color used for the names of the days of the week (see Pt_ARG_CALENDAR_WDAY_NAMES). See PgColor_t in the Photon Library Reference.

Pt_ARG_CALENDAR_DATE

The current date shown on the calendar.

---

You might find it easier to use Pt_ARG_CALENDAR_TIME_T instead of Pt_ARG_CALENDAR_DATE. They both specify the date, but Pt_ARG_CALENDAR_DATE uses a custom data structure. You can't set either of these resources in PhAB.

---

This date is stored in a PtCalendarDate_t structure that contains:

• year — the current year starting from 0000.
• month — the current month [0-11]; 0 is January.
• day — the current day of the month [0-30].

Pt_ARG_CALENDAR_FLAGS

Calendar-specific flags. This can be a combination of:

Pt_CALENDAR_YEAR_BTNS

Show the next/previous year buttons.

Pt_CALENDAR_MONTH_BTNS

Show the next/previous month buttons.

Pt_CALENDAR_SHOW_PREV

Show the last few days of the previous month.

Pt_CALENDAR_SHOW_NEXT

Show the first few days of the following month.

Pt_CALENDAR_SHOW_GRID

Show the calendar in a grid format with lines separating the days.

Pt_ARG_CALENDAR_FONT1

The font used for the current month's days.

Pt_ARG_CALENDAR_FONT2

The font used for the next and previous month's days.

Pt_ARG_CALENDAR_FONT3

The font used for the year and month name.

Pt_ARG_CALENDAR_FONT4

The font used for any highlighted days in the calendar (see Pt_ARG_CALENDAR_HIGHLIGHT).

Pt_ARG_CALENDAR_FONT5

The font used for the names of the days of the week (see Pt_ARG_CALENDAR_WDAY_NAMES).

Pt_ARG_CALENDAR_HIGHLIGHT

A set of up to 32 bits that specify the days of the current month to highlight. For example, 0x1 means that day 1 is highlighted and 0x3 means that days 1 and 2 are highlighted.

The highlighted days are displayed using the values of Pt_ARG_CALENDAR_COLOR4 and Pt_ARG_CALENDAR_FONT4.

---

You can't edit Pt_ARG_CALENDAR_HIGHLIGHT in PhAB.

---

Pt_ARG_CALENDAR_MONTH_BTN_COLOR

The color used for the buttons for moving to the next and previous months. See PgColor_t in the Photon Library Reference.

Pt_ARG_CALENDAR_MONTH_NAMES

An array of names to be used for the months of the year. By default these values are:

The array should contain 12 elements. If you set more, the extras are discarded. If you set fewer, the above elements are used for the missing ones.

---

You can't edit Pt_ARG_CALENDAR_MONTH_NAMES in PhAB.

---

Pt_ARG_CALENDAR_SEL_COLOR

The color of the currently selected day of the month. See PgColor_t in the Photon Library Reference.

Pt_ARG_CALENDAR_TIME_T

The current date shown on the calendar. This date is stored in a time_t structure.

---

You can't edit Pt_ARG_CALENDAR_TIME_T in PhAB.

---

Pt_ARG_CALENDAR_WDAY_NAMES

An array of names to be used for the days of the week. By default these values are:

The array should contain 7 elements. If you set more, the extras are discarded. If you set fewer, the above elements are used for the missing ones.

---

You can't edit Pt_ARG_CALENDAR_WDAY_NAMES in PhAB.

---

Pt_ARG_CALENDAR_YEAR_BTN_COLOR

The color used for the buttons for moving to next and previous years. See PgColor_t in the Photon Library Reference.

Pt_CB_CALENDAR_SELECT

A list of PtCallback_t structures that define the callbacks invoked when a date is selected. Each callback is passed a PtCallbackInfo_t structure that contains at least the following members:

reason

Pt_CB_CALENDAR_SELECT

reason_subtype

0 (not used).

event

A pointer to a PhEvent_t structure that describes the event that caused the callback to be invoked.

cbdata

A pointer to a PtCalendarSelectCallback_t structure.

The PtCalendarSelectCallback_t structure contains at least:

int type

The type of selection made:

• Pt_CALENDAR_DATE_SELECTED
• Pt_CALENDAR_WDAY_SELECTED
• Pt_CALENDAR_MONTH_SELECTED
• Pt_CALENDAR_YEAR_SELECTED

PtCalendarDate_t date

The selected date. This structure contains at least:

• signed char day — values in the range 0 through 30.
• signed char month — values in the range 0 through 11.
• signed short year — values in the range -32767 through +32767.

time_t time

The selected date, represented as a time_t.

These callbacks should return Pt_CONTINUE.

Inherited resources:

If the widget modifies an inherited resource, the “Default override” column indicates the new value. This modification affects any subclasses of the widget.