aboutsummaryrefslogtreecommitdiffstats
path: root/calendar/layout.h
blob: 734b720b8b7405f4330a754e98360c801d397089 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
/* Event layout engine for Gnomecal
 *
 * Copyright (C) 1998 The Free Software Foundation
 *
 * Authors: Miguel de Icaza <miguel@nuclecu.unam.mx>
 *          Federico Mena <federico@nuclecu.unam.mx>
 */

#ifndef LAYOUT_H
#define LAYOUT_H

#include <glib.h>
#include <time.h>


/* Functions of this type must translate the list item into two time_t values for the start and end
 * of an event.
 */
typedef void (* LayoutQueryTimeFunc) (GList *event, time_t *start, time_t *end);


/* This is the main layout function for overlapping events.  You pass in a list of (presumably)
 * events and a function that should take a list element and return the start and end times for the
 * event corresponding to that list element.
 *
 * It returns the number of slots ("columns") that you need to take into account when actually
 * painting the events, the array of the first slot index that each event occupies, and the array of
 * number of slots that each event occupies.  You have to free both arrays.
 *
 * You will get somewhat better-looking results if the list of events is sorted by using the start
 * time as the primary sort key and the end time as the secondary sort key -- so that "longer"
 * events go first in the list.
 */
void layout_events (GList *events, LayoutQueryTimeFunc func, int *num_slots, int **allocations, int **slots);


#endif