PebbleOS
Loading...
Searching...
No Matches
Macros | Enumerations | Functions
Timeline Peek events

Selects the event shown by Timeline Peek. More...

Macros

#define TIMELINE_PEEK_DEFAULT_SHOW_BEFORE_TIME_S   (10 * PBL_SEC_PER_MIN)
 Default time before an event starts at which Timeline Peek shows it; configurable.
 
#define TIMELINE_PEEK_HIDE_AFTER_TIME_S   (10 * PBL_SEC_PER_MIN)
 Time after an event starts at which Timeline Peek hides it, unless it is persistent; not user configurable.
 

Enumerations

enum  TimelinePeekTimeType {
  TimelinePeekTimeType_None = 0 , TimelinePeekTimeType_SomeTimeNext , TimelinePeekTimeType_ShowWillStart , TimelinePeekTimeType_ShowStarted ,
  TimelinePeekTimeType_WillEnd
}
 Relation between now and the event of a Timeline Peek event. More...
 

Functions

const TimelineEventImpl * timeline_peek_get_event_service (void)
 Get the timeline event service callbacks of Timeline Peek.
 
void timeline_peek_set_show_before_time (unsigned int before_time_s)
 Set how long before an event starts Timeline Peek shows it, and refresh.
 

Detailed Description

Selects the event shown by Timeline Peek.

Posts a PEBBLE_TIMELINE_PEEK_EVENT with the next or current event and its TimelinePeekTimeType whenever that changes.

Macro Definition Documentation

◆ TIMELINE_PEEK_DEFAULT_SHOW_BEFORE_TIME_S

#define TIMELINE_PEEK_DEFAULT_SHOW_BEFORE_TIME_S   (10 * PBL_SEC_PER_MIN)

Default time before an event starts at which Timeline Peek shows it; configurable.

◆ TIMELINE_PEEK_HIDE_AFTER_TIME_S

#define TIMELINE_PEEK_HIDE_AFTER_TIME_S   (10 * PBL_SEC_PER_MIN)

Time after an event starts at which Timeline Peek hides it, unless it is persistent; not user configurable.

Enumeration Type Documentation

◆ TimelinePeekTimeType

Relation between now and the event of a Timeline Peek event.

Enumerator
TimelinePeekTimeType_None 

No event.

TimelinePeekTimeType_SomeTimeNext 

The event is next but not imminent: more than the show-before time away.

TimelinePeekTimeType_ShowWillStart 

The event starts within the show-before time and should be shown.

TimelinePeekTimeType_ShowStarted 

The event started less than TIMELINE_PEEK_HIDE_AFTER_TIME_S ago, or is persistent, and should be shown.

TimelinePeekTimeType_WillEnd 

The event is ongoing and started at least TIMELINE_PEEK_HIDE_AFTER_TIME_S ago.

Function Documentation

◆ timeline_peek_get_event_service()

const TimelineEventImpl * timeline_peek_get_event_service ( void  )

Get the timeline event service callbacks of Timeline Peek.

Returns
Callbacks.

◆ timeline_peek_set_show_before_time()

void timeline_peek_set_show_before_time ( unsigned int  before_time_s)

Set how long before an event starts Timeline Peek shows it, and refresh.

Parameters
before_time_sTime in seconds.