Package Gnumed :: Package timelinelib :: Package canvas :: Package data :: Module event :: Class Event |
[frames] | no frames]

# Class Event

source code

           object --+
                    |
        base.ItemBase --+
                        |
           object --+   |
                    |   |
    item.TimelineItem --+
                        |
                       Event

Instance Methods
__init__(self, db=None, id_=None, immutable_value=ImmutableEvent()) x.__init__(...) initializes x; see help(type(x)) for signature | source code
duplicate(self, target_db=None) | source code
save(self) | source code
reload(self) | source code
delete(self) | source code
__eq__(self, other) | source code
__ne__(self, other) | source code
__lt__(self, other) | source code
__gt__(self, other) | source code
__le__(self, other) | source code
__ge__(self, other) | source code
__repr__(self) repr(x) | source code
set_end_time(self, time) | source code
get_text(self) | source code
set_text(self, text) | source code
get_category(self) | source code
get_category_name(self) | source code
set_category(self, category) | source code
get_container(self) | source code
set_container(self, container) | source code
get_fuzzy(self) | source code
set_fuzzy(self, fuzzy) | source code
get_locked(self) | source code
set_locked(self, locked) | source code
get_ends_today(self) | source code
set_ends_today(self, ends_today) | source code
get_description(self) | source code
set_description(self, description) | source code
get_icon(self) | source code
set_icon(self, icon) | source code
get_hyperlink(self) | source code
set_hyperlink(self, hyperlink) | source code
get_alert(self) | source code
set_alert(self, alert) | source code
get_progress(self) | source code
set_progress(self, progress) | source code
get_sort_order(self) | source code
set_sort_order(self, sort_order) | source code
get_default_color(self) | source code
set_default_color(self, color) | source code
get_done_color(self) | source code
get_progress_color(self) | source code
update(self, start_time, end_time, text, category=None, fuzzy=None, locked=None, ends_today=None) Change the event data. | source code
get_data(self, event_id) Return data with the given id or None if no data with that id exists. | source code
set_data(self, event_id, data) Set data with the given id. | source code
get_whole_data(self) | source code
set_whole_data(self, data) | source code
has_data(self) Return True if the event has associated data, or False if not. | source code
has_balloon_data(self) Return True if the event has associated data to be displayed in a balloon. | source code
get_label(self, time_type) Returns a unicode label describing the event. | source code
is_container(self) | source code
is_subevent(self) | source code
is_milestone(self) | source code
get_exportable_fields(self) | source code
set_milestone(self, value) | source code
get_milestone(self) | source code
Inherited from `base.ItemBase`: `db`, `ensure_id`, `get_id`, `has_id`, `id`, `set_id` Inherited from `item.TimelineItem`: `distance_to`, `end_to_end`, `get_end_time`, `get_start_time`, `get_time_period`, `inside_period`, `is_period`, `mean_time`, `move_delta`, `overlaps`, `set_time_period`, `start_to_end`, `start_to_start`, `time_span`, `update_period`, `update_period_o` Inherited from `object`: `__delattr__`, `__format__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__setattr__`, `__sizeof__`, `__str__`, `__subclasshook__`

Class Variables
| text = `property(get_text, set_text)`
| category = `property(get_category, set_category)`
| container = `property(get_container, set_container)`
| fuzzy = `property(get_fuzzy, set_fuzzy)`
| locked = `property(get_locked, set_locked)`
| ends_today = `property(get_ends_today, set_ends_today)`
| description = `property(get_description, set_description)`
| icon = `property(get_icon, set_icon)`
| hyperlink = `property(get_hyperlink, set_hyperlink)`
| alert = `property(get_alert, set_alert)`
| progress = `property(get_progress, set_progress)`
| sort_order = `property(get_sort_order, set_sort_order)`
| default_color = `property(get_default_color, set_default_color)`
| data = `property(get_whole_data, set_whole_data)`
Inherited from `item.TimelineItem`: `time_period`

Properties
Inherited from `object`: `__class__`

Method Details

### __init__(self, db=None, id_=None, immutable_value=ImmutableEvent()) (Constructor) | source code
x.__init__(...) initializes x; see help(type(x)) for signature Overrides: object.__init__ (inherited documentation)

### duplicate(self, target_db=None) | source code
Overrides: base.ItemBase.duplicate

### __repr__(self) (Representation operator) | source code
repr(x) Overrides: object.__repr__ (inherited documentation)

### get_data(self, event_id) | source code
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(self, event_id, data) | source code
    Set data with the given id.

    Here is how ids map to data:

        description - string
        icon - wx.Bitmap