module timelinelib.canvas.data.event

timelinelib.canvas.data.event.DEFAULT_COLOR = (200, 200, 200)

timelinelib.canvas.data.event.EXPORTABLE_FIELDS = ('Text', 'Description', 'Labels', 'Start', 'End', 'Category', 'Fuzzy Start', 'Fuzzy End', 'Locked', 'Ends Today', 'Hyperlink', 'Progress', 'Progress Color', 'Done Color', 'Alert', 'Is Container', 'Is Subevent')

class timelinelib.canvas.data.event.Event

Bases: timelinelib.canvas.data.base.ItemBase, timelinelib.canvas.data.item.TimelineItem

An Event is the basic data type for representing information on the timeline. It must specify where on the timeline it should be placed (when that event happened). This can be either a specific point in time or a period.

Derived classes:

• Milestone.

• Container.

• Subevent.

__init__(db=None, id_=None, immutable_value=ImmutableEvent({ 'text': None, 'time_period': None, 'category_id': None, 'category_ids': ImmutableDict({ }), 'fuzzy': False, 'fuzzy_start': False, 'fuzzy_end': False, 'locked': False, 'ends_today': False, 'description': None, 'labels': None, 'icon': None, 'hyperlink': None, 'alert': None, 'progress': None, 'default_color': None, 'container_id': None, 'sort_order': None, }))

Initialize self. See help(type(self)) for accurate signature.

property horizontal_mouse_position_factor

This factor describes the relation between the lengt of an event and the length from the start of the event up to the cursor position in the event. For point events this factor is None. The factor is used for calculation of the status-bar label that describes the time duration up to the cursor position.

duplicate(target_db=None)

save()

reload()

delete()

__eq__(other)

Return self==value.

__ne__(other)

Return self!=value.

__lt__(other)

Return self<value.

__gt__(other)

Return self>value.

__le__(other)

Return self<=value.

__ge__(other)

Return self>=value.

__repr__()

Return repr(self).

set_end_time(time)

get_text()

set_text(text)

property text

get_category()

get_category_name()

set_category(category)

property category

get_categories()

set_categories(categories)

get_container()

set_container(container)

property container

get_fuzzy()

set_fuzzy(fuzzy)

property fuzzy

get_fuzzy_start()

set_fuzzy_start(fuzzy_start)

property fuzzy_start

get_fuzzy_end()

set_fuzzy_end(fuzzy_end)

property fuzzy_end

get_locked()

set_locked(locked)

property locked

get_ends_today()

set_ends_today(ends_today)

property ends_today

get_description()

set_description(description)

property description

get_labels()

set_labels(value)

property labels

get_icon()

set_icon(icon)

property icon

has_edge_icons()

get_hyperlink()

set_hyperlink(hyperlink)

property hyperlink

get_alert()

set_alert(alert)

property alert

get_progress()

set_progress(progress)

property progress

get_sort_order()

set_sort_order(sort_order)

property sort_order

get_default_color()

set_default_color(color)

property default_color

get_color()

get_border_color()

get_done_color()

get_progress_color()

update(start_time, end_time, text, category=None, fuzzy=None, locked=None, ends_today=None, fuzzy_start=None, fuzzy_end=None)

Change the event data.

get_data(event_id, default=None)

Return data with the given id or None if no data with that id exists.

See set_data for information how ids map to data.

set_data(event_id, data)

Set data with the given id.

Here is how ids map to data:

description - string icon - wx.Bitmap

get_whole_data()

set_whole_data(data)

property data

has_data()

Return True if the event has associated data, or False if not.

has_balloon_data()

Return True if the event has associated data to be displayed in a balloon.

get_label(time_type)

Returns a unicode label describing the event.

is_container()

is_subevent()

is_milestone()

get_exportable_fields()

set_milestone(value)

get_milestone()

timelinelib.canvas.data.event.DATA_FIELDS = ['description', 'labels', 'icon', 'hyperlink', 'alert', 'progress', 'default_color']