path: root/calendar/gui/e-meeting-time-sel.h

/*
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) version 3.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with the program; if not, see <http://www.gnu.org/licenses/>
 *
 *
 * Authors:
 *      Damon Chaplin <damon@gtk.org>
 *
 * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
 *
 */

#ifndef E_MEETING_TIME_SELECTOR_H
#define E_MEETING_TIME_SELECTOR_H

#include <gtk/gtk.h>
#include <libgnomecanvas/libgnomecanvas.h>

#include <e-util/e-util.h>

#include "e-meeting-store.h"
#include "e-meeting-list-view.h"

/*
 * EMeetingTimeSelector displays a list of attendees for a meeting and a
 * graphical summary of the times which they are free and busy, allowing the
 * user to select an appropriate time for a meeting.
 */

/* Standard GObject macros */
#define E_TYPE_MEETING_TIME_SELECTOR \
    (e_meeting_time_selector_get_type ())
#define E_MEETING_TIME_SELECTOR(obj) \
    (G_TYPE_CHECK_INSTANCE_CAST \
    ((obj), E_TYPE_MEETING_TIME_SELECTOR, EMeetingTimeSelector))
#define E_MEETING_TIME_SELECTOR_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_CAST \
    ((cls), E_TYPE_MEETING_TIME_SELECTOR, EMeetingTimeSelectorClass))
#define E_IS_MEETING_TIME_SELECTOR(obj) \
    (G_TYPE_CHECK_INSTANCE_TYPE \
    ((obj), E_TYPE_MEETING_TIME_SELECTOR))
#define E_IS_MEETING_TIME_SELECTOR_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_TYPE \
    ((cls), E_TYPE_MEETING_TIME_SELECTOR))
#define E_MEETING_TIME_SELECTOR_GET_CLASS(obj) \
    (G_TYPE_INSTANCE_GET_CLASS \
    ((obj), E_TYPE_MEETING_TIME_SELECTOR))

/* Define this to include the debugging functions. */
#undef E_MEETING_TIME_SELECTOR_DEBUG

/* This is the width of the icon column in the attendees list. */
#define E_MEETING_TIME_SELECTOR_ICON_COLUMN_WIDTH   24

#define E_MEETING_TIME_SELECTOR_TEXT_Y_PAD      3
#define E_MEETING_TIME_SELECTOR_TEXT_X_PAD      2

G_BEGIN_DECLS

/* This is used to specify the format used when displaying the dates.
 * The abbreviated format is like 'Sun 12/9/99'.
 * The short format is like '12/9/99'.
 * The actual format used is determined in e_meeting_time_selector_style_set (),
 * once we know the font being used.
 */
typedef enum
{
    E_MEETING_TIME_SELECTOR_DATE_ABBREVIATED_DAY,
    E_MEETING_TIME_SELECTOR_DATE_SHORT
} EMeetingTimeSelectorDateFormat;

/* This is used to specify a position regarding the vertical bars around the
 * current meeting time, so we know which one is being dragged. */
typedef enum
{
    E_MEETING_TIME_SELECTOR_POS_NONE,
    E_MEETING_TIME_SELECTOR_POS_START,
    E_MEETING_TIME_SELECTOR_POS_END
} EMeetingTimeSelectorPosition;

/* This is used to specify the autopick option, which determines how we choose
 * the previous/next appropriate meeting time. */
typedef enum
{
    E_MEETING_TIME_SELECTOR_ALL_PEOPLE_AND_RESOURCES,
    E_MEETING_TIME_SELECTOR_ALL_PEOPLE_AND_ONE_RESOURCE,
    E_MEETING_TIME_SELECTOR_REQUIRED_PEOPLE,
    E_MEETING_TIME_SELECTOR_REQUIRED_PEOPLE_AND_ONE_RESOURCE
} EMeetingTimeSelectorAutopickOption;

/* An array of hour strings for 24 hour time, "0:00" .. "23:00". */
extern const gchar *EMeetingTimeSelectorHours[24];
/* An array of hour strings for 12 hour time, "12:00am" .. "11:00pm". */
extern const gchar *EMeetingTimeSelectorHours12[24];

typedef struct _EMeetingTimeSelector EMeetingTimeSelector;
typedef struct _EMeetingTimeSelectorClass EMeetingTimeSelectorClass;
typedef struct _EMeetingTimeSelectorPrivate EMeetingTimeSelectorPrivate;

struct _EMeetingTimeSelector {
    /* We subclass a GtkTable which makes it easy to add extra widgets
     * if neccesary. */
    GtkTable table;

    EMeetingTimeSelectorPrivate *priv;

    /*
     * User Interface stuff - widgets, colors etc.
     */

    /* This contains our keyboard accelerators, which need to be added to
     * the toplevel window. */
    GtkAccelGroup *accel_group;

    /* The vbox in the top-left corner, containing the 'All Attendees'
     * title bar packed at the end. Extra widgets can be added here
     * with PACK_START if necessary. */
    GtkWidget *attendees_vbox;
    GtkWidget *attendees_vbox_spacer;

    /* The etable and model */
    EMeetingStore *model;
    EMeetingListView *list_view;

    /* The canvas displaying the dates, times, and the summary
     * 'All Attendees' free/busy display. */
    GtkWidget *display_top;
    GnomeCanvasItem *item_top;

    /* The canvas containing the free/busy displays of individual
     * attendees. This is separate from display_top since it also scrolls
     * vertically. */
    GtkWidget *display_main;
    GnomeCanvasItem *item_main;

    /* The 'Add attendees from addressbook' button */
    GtkWidget *add_attendees_button;

    /* This is the 'Options' button & menu. */
    GtkWidget *options_button;
    GtkWidget *options_menu;

    /* This is the 'Autopick' button, menu & radio menu items. */
    GtkWidget *autopick_down_button;
    GtkWidget *autopick_button;
    GtkWidget *autopick_up_button;
    GtkWidget *autopick_menu;
    GtkWidget *autopick_all_item;
    GtkWidget *autopick_all_people_one_resource_item;
    GtkWidget *autopick_required_people_item;
    GtkWidget *autopick_required_people_one_resource_item;

    /* The horizontal scrollbar which scrolls display_top & display_main.*/
    GtkWidget *hscrollbar;

    /* The vertical scrollbar which scrolls attendees & display_main. */
    GtkWidget *vscrollbar;

    /* The 2 EDateEdit widgets for the meeting start & end times. */
    GtkWidget *start_date_edit;
    GtkWidget *end_date_edit;

    /* Colors. */
    GdkColor bg_color;
    GdkColor all_attendees_bg_color;
    GdkColor meeting_time_bg_color;
    GdkColor attendee_list_bg_color;
    GdkColor grid_color;
    GdkColor grid_shadow_color;
    GdkColor grid_unused_color;
    GdkColor busy_colors[E_MEETING_FREE_BUSY_LAST];

        /* The pattern used for attendees with no data. */
        cairo_pattern_t *no_info_pattern;

    /* Width of the hours strings (e.g. "1:00") in the current font. */
    gint hour_widths[24];

    /* Whether we are using the full, abbreviated or short date format. */
    EMeetingTimeSelectorDateFormat date_format;

    /*
     * Option Settings.
     */

    /* True if we are selecting all day events */
    gboolean all_day;

    /* If this is TRUE we only show hours between day_start_hour and
     * day_end_hour, defaults to TRUE (9am-6pm). */
    gboolean working_hours_only;
    gint day_start_hour;
    gint day_start_minute;
    gint day_end_hour;
    gint day_end_minute;

    /* If TRUE, view is compressed, with one cell for every 3 hours rather
     * than every hour. Defaults to FALSE. */
    gboolean zoomed_out;

    /*
     * Internal Data.
     */

    /* These are the first & last dates shown in the current scroll area.
     * We show E_MEETING_TIME_SELECTOR_DAYS_SHOWN days at a time. */
    GDate first_date_shown;
    GDate last_date_shown;

    /* This is the current selection of the meeting time. */
    EMeetingTime meeting_start_time;
    EMeetingTime meeting_end_time;

    /* These are the x pixel coordinates in the entire scroll region of
     * the start and end times. Set to meeting_positions_valid to FALSE to
     * invalidate. They will then be recomputed when needed. Always access
     * with e_meeting_time_selector_get_meeting_time_positions (). */
    gint meeting_positions_valid;
    gint meeting_positions_in_scroll_area;
    gint meeting_start_x;
    gint meeting_end_x;

    /* These are the width and height of the cells, including the grid
     * lines which are displayed on the right and top or bottom of cells.*/
    gint row_height;
    gint col_width;

    /* This is the width of a day in the display, which depends on
     * col_width, working_hours_only and zoomed_out. */
    gint day_width;

    /* These are the first and last hour of each day we display, depending
     * on working_hours_only and zoomed_out. */
    gint first_hour_shown;
    gint last_hour_shown;

    /* The id of the source function for auto-scroll timeouts. */
    guint auto_scroll_timeout_id;

    /* This specifies if we are dragging one of the vertical bars around
     * the meeting time. */
    EMeetingTimeSelectorPosition dragging_position;

    /* The last x coordinate of the mouse, relative to either the left or
     * right edge of the canvas. Used in the auto_scroll_timeout function
     * to determine which way to scroll and how fast. */
    gint last_drag_x;

    /* This is used to determine the delay between scrolls. */
    gint scroll_count;

    /* The notification function id for Free/Busy refreshes */
    gboolean fb_refresh_not;

    GdkCursorType last_cursor_set;

    guint style_change_idle_id;
};

struct _EMeetingTimeSelectorClass {
    GtkTableClass parent_class;

    void (* changed) (EMeetingTimeSelector *mts);
};

/*
 * PUBLIC INTERFACE - note that this interface will probably change, when I
 * know where the data is coming from. This is mainly just for testing for now.
 */

GType       e_meeting_time_selector_get_type (void);
GtkWidget * e_meeting_time_selector_new (EMeetingStore *ems);
void        e_meeting_time_selector_construct
                        (EMeetingTimeSelector *mts,
                         EMeetingStore *ems);
gboolean    e_meeting_time_selector_get_use_24_hour_format
                        (EMeetingTimeSelector *mts);
void        e_meeting_time_selector_set_use_24_hour_format
                        (EMeetingTimeSelector *mts,
                         gboolean use_24_hour_format);

/* This returns the currently selected meeting time.
 * Note that months are 1-12 and days are 1-31. The start time is guaranteed to
 * be before or equal to the end time. You may want to check if they are equal
 * if that if it is a problem. */
void        e_meeting_time_selector_get_meeting_time
                        (EMeetingTimeSelector *mts,
                         gint *start_year,
                         gint *start_month,
                         gint *start_day,
                         gint *start_hour,
                         gint *start_minute,
                         gint *end_year,
                         gint *end_month,
                         gint *end_day,
                         gint *end_hour,
                         gint *end_minute);

/* This sets the meeting time, returning TRUE if it is valid. */
gboolean    e_meeting_time_selector_set_meeting_time
                        (EMeetingTimeSelector *mts,
                         gint start_year,
                         gint start_month,
                         gint start_day,
                         gint start_hour,
                         gint start_minute,
                         gint end_year,
                         gint end_month,
                         gint end_day,
                         gint end_hour,
                         gint end_minute);

void        e_meeting_time_selector_set_all_day
                        (EMeetingTimeSelector *mts,
                         gboolean all_day);
void        e_meeting_time_selector_set_working_hours_only
                        (EMeetingTimeSelector *mts,
                         gboolean working_hours_only);
void        e_meeting_time_selector_set_working_hours
                        (EMeetingTimeSelector *mts,
                         gint day_start_hour,
                         gint day_start_minute,
                         gint day_end_hour,
                         gint day_end_minute);

void        e_meeting_time_selector_set_zoomed_out
                        (EMeetingTimeSelector *mts,
                         gboolean zoomed_out);

EMeetingTimeSelectorAutopickOption
        e_meeting_time_selector_get_autopick_option
                        (EMeetingTimeSelector *mts);
void        e_meeting_time_selector_set_autopick_option
                        (EMeetingTimeSelector *mts,
                         EMeetingTimeSelectorAutopickOption autopick_option);

void        e_meeting_time_selector_attendee_set_send_meeting_to
                        (EMeetingTimeSelector *mts,
                         gint row,
                         gboolean send_meeting_to);

void        e_meeting_time_selector_set_read_only
                        (EMeetingTimeSelector *mts,
                         gboolean read_only);

/* Clears all busy times for the given attendee. */
void        e_meeting_time_selector_attendee_clear_busy_periods
                        (EMeetingTimeSelector *mts,
                         gint row);
/* Adds one busy time for the given attendee. */
gboolean    e_meeting_time_selector_attendee_add_busy_period
                        (EMeetingTimeSelector *mts,
                         gint row,
                         gint start_year,
                         gint start_month,
                         gint start_day,
                         gint start_hour,
                         gint start_minute,
                         gint end_year,
                         gint end_month,
                         gint end_day,
                         gint end_hour,
                         gint end_minute,
                         EMeetingFreeBusyType busy_type);

/*
 * INTERNAL ROUTINES - functions to communicate with the canvas items within
 *             the EMeetingTimeSelector.
 */

/* This returns the x pixel coordinates of the meeting start and end times,
 * in the entire canvas scroll area. If it returns FALSE, then the meeting
 * time isn't in the current scroll area (which shouldn't really happen). */
gboolean    e_meeting_time_selector_get_meeting_time_positions
                        (EMeetingTimeSelector *mts,
                         gint *start_x,
                         gint *end_x);

void        e_meeting_time_selector_drag_meeting_time
                        (EMeetingTimeSelector *mts,
                         gint x);

void        e_meeting_time_selector_remove_timeout
                        (EMeetingTimeSelector *mts);

void        e_meeting_time_selector_fix_time_overflows
                        (EMeetingTime *mtstime);

void        e_meeting_time_selector_calculate_day_and_position
                        (EMeetingTimeSelector *mts,
                         gint x,
                         GDate *date,
                         gint *day_position);
void        e_meeting_time_selector_convert_day_position_to_hours_and_mins
                        (EMeetingTimeSelector *mts,
                         gint day_position,
                         guint8 *hours,
                         guint8 *minutes);
void        e_meeting_time_selector_calculate_time
                        (EMeetingTimeSelector *mts,
                         gint x,
                         EMeetingTime *time);
gint        e_meeting_time_selector_calculate_time_position
                        (EMeetingTimeSelector *mts,
                         EMeetingTime *mtstime);
void        e_meeting_time_selector_refresh_free_busy
                        (EMeetingTimeSelector *mts,
                         gint row,
                         gboolean all);

/* Debugging function to dump information on all attendees. */
#ifdef E_MEETING_TIME_SELECTOR_DEBUG
void        e_meeting_time_selector_dump    (EMeetingTimeSelector *mts);
gchar *     e_meeting_time_selector_dump_time
                        (EMeetingTime *mtstime);
gchar *     e_meeting_time_selector_dump_date
                        (GDate *date);
#endif /* E_MEETING_TIME_SELECTOR_DEBUG */

G_END_DECLS

#endif /* E_MEETING_TIME_SELECTOR_H */