Module bpcalendar

Calendar user interface and data for bitpim.

This module has a bp prefix so it doesn't clash with the system calendar module

Version 3:

The format for the calendar is standardised. It is a dict with the following fields: (Note: hour fields are in 24 hour format) 'string id': CalendarEntry object.

CalendarEntry properties: description - 'string description' location - 'string location' desc_loc - combination of description & location in the form of 'description[location]' priority - None=no priority, int from 1-10, 1=highest priority alarm - how many minutes beforehand to set the alarm (use 0 for on-time, None or -1 for no alarm) allday - True for an allday event, False otherwise start - (year, month, day, hour, minute) as integers end - (year, month, day, hour, minute) as integers serials - list of dicts of serials. repeat - None, or RepeatEntry object id - string id of this object. Created the same way as bpserials IDs for phonebook entries. notes - string notes categories - [ { 'category': string category }, ... ] ringtone - string ringtone assignment wallpaper - string wallpaper assignment. vibrate - True if the alarm is set to vibrate, False otherwise voice - ID of voice alarm

CalendarEntry methods: get() - return a copy of the internal dict get_db_dict()- return a copy of a database.basedataobject dict. set(dict) - set the internal dict with the supplied dict set_db_dict(dict) - set internal data with the database.basedataobject dict is_active(y, m, d) - True if this event is active on (y,m,d) suppress_repeat_entry(y,m,d) - exclude (y,m,d) from this repeat event.

RepeatEntry properties: repeat_type - one of daily, weekly, monthly, or yearly. interval - for daily: repeat every nth day. For weekly, for every nth week. interval2 - for monhtly: repeat every nth month. dow - bitmap of which day of week are being repeated. weekstart - the start of the work week ('MO', 'TU', 'WE', 'TH', 'FR', 'SA', 'SU') suppressed - list of (y,m,d) being excluded from this series.

-------------------------------------------------------------------------------- Version 2:

The format for the calendar is standardised. It is a dict with the following fields:

(Note: hour fields are in 24 hour format)

• (year, month, day, hour, minute) as integers

• (year, month, day, hour, minute) as integers # if you want no end, set to the same value as start, or to the year 4000

• one of None, "daily", "monfri", "weekly", "monthly", "yearly"

• "String description"

• Set to integer 1

• Set to an integer number of minutes (default 0)

• how many minutes beforehand to set the alarm (use 0 for on-time, None for no alarm)

• default 0, it will become which days of the week weekly events happen on (eg every monday and friday)

• index number of the ringtone for the alarm (use 0 for none - will become a string)

• integer that should be the same as the dictionary key for this entry

• (optional) A list of (year,month,day) tuples that repeats are suppressed