ECalendarItem: Evolution Utilities Reference Manual

## ECalendarItem ECalendarItem |

## Functions

#define | E_CALENDAR_ITEM_MARK_ITALIC
void | e_calendar_item_get_first_month ()
void | e_calendar_item_set_first_month ()
gint | e_calendar_item_get_max_days_sel ()
void | e_calendar_item_set_max_days_sel ()
gint | e_calendar_item_get_days_start_week_sel ()
void | e_calendar_item_set_days_start_week_sel ()
gboolean | e_calendar_item_get_display_popup ()
void | e_calendar_item_set_display_popup ()
gboolean | e_calendar_item_get_date_range ()
gboolean | e_calendar_item_get_selection ()
void | e_calendar_item_set_selection ()
void | e_calendar_item_clear_marks ()
void | e_calendar_item_mark_day ()
void | e_calendar_item_mark_days ()
void | (*ECalendarItemStyleCallback) ()
void | e_calendar_item_set_style_callback ()
void | e_calendar_item_set_get_time_callback ()
void | e_calendar_item_normalize_date ()
gint | e_calendar_item_get_week_number ()

## Properties

gint | column-width | Read
gint | days-to-start-week-selection | Read / Write
gboolean | display-popup | Read / Write
PangoFontDescription * | font-desc | Read / Write
gboolean | keep-wdays-on-weeknum-click | Read / Write
gint | maximum-columns | Read / Write
gint | maximum-days-selected | Read / Write
gint | maximum-rows | Read / Write
gint | minimum-columns | Read / Write
gint | minimum-rows | Read / Write
gint | month | Read / Write
gboolean | move-selection-when-moving | Read / Write
gboolean | preserve-day-when-moving | Read / Write
gint | row-height | Read
gboolean | show-week-numbers | Read / Write
PangoFontDescription * | week-number-font-desc | Read / Write
EDateWeekday | week-start-day | Read / Write
gdouble | x1 | Read / Write
gdouble | x2 | Read / Write
gdouble | y1 | Read / Write
gdouble | y2 | Read / Write
gint | year | Read / Write

## Signals

void | date-range-changed | Run First
void | date-range-moved | Run First
void | selection-changed | Run First
void | selection-preview-changed | Run Last

## Types and Values

#define | E_CALENDAR_ITEM_YPAD_ABOVE_MONTH_NAME
#define | E_CALENDAR_ITEM_YPAD_BELOW_MONTH_NAME
#define | E_CALENDAR_ROWS_PER_MONTH
#define | E_CALENDAR_COLS_PER_MONTH
#define | E_CALENDAR_ITEM_MARK_BOLD
#define | E_CALENDAR_ITEM_MIN_CELL_XPAD
#define | E_CALENDAR_ITEM_MIN_CELL_YPAD
#define | E_CALENDAR_ITEM_YPAD_ABOVE_DAY_LETTERS
#define | E_CALENDAR_ITEM_YPAD_BELOW_DAY_LETTERS
#define | E_CALENDAR_ITEM_YPAD_ABOVE_CELLS
#define | E_CALENDAR_ITEM_YPAD_BELOW_CELLS
#define | E_CALENDAR_ITEM_XPAD_BEFORE_MONTH_NAME_WITH_BUTTON
#define | E_CALENDAR_ITEM_XPAD_BEFORE_MONTH_NAME
#define | E_CALENDAR_ITEM_XPAD_AFTER_MONTH_NAME
#define | E_CALENDAR_ITEM_XPAD_AFTER_MONTH_NAME_WITH_BUTTON
#define | E_CALENDAR_ITEM_XPAD_BEFORE_WEEK_NUMBERS
#define | E_CALENDAR_ITEM_XPAD_AFTER_WEEK_NUMBERS
#define | E_CALENDAR_ITEM_XPAD_BEFORE_CELLS
#define | E_CALENDAR_ITEM_XPAD_AFTER_CELLS
enum | ECalendarItemColors
struct | ECalendarItem

## Object Hierarchy

        GObject
        ╰── GInitiallyUnowned
            ╰── GnomeCanvasItem
                ╰── ECalendarItem

## Implemented Interfaces

ECalendarItem implements EExtensible.

## Description

## Functions

### E_CALENDAR_ITEM_MARK_ITALIC

    #define E_CALENDAR_ITEM_MARK_ITALIC     (1 << 1)

### e_calendar_item_get_first_month ()

    void
    e_calendar_item_get_first_month (ECalendarItem *calitem,
                                     gint *year,
                                     gint *month);

### e_calendar_item_set_first_month ()

    void
    e_calendar_item_set_first_month (ECalendarItem *calitem,
                                     gint year,
                                     gint month);

### e_calendar_item_get_max_days_sel ()

    gint
    e_calendar_item_get_max_days_sel (ECalendarItem *calitem);

### e_calendar_item_set_max_days_sel ()

    void
    e_calendar_item_set_max_days_sel (ECalendarItem *calitem,
                                      gint days);

### e_calendar_item_get_days_start_week_sel ()

    gint
    e_calendar_item_get_days_start_week_sel
                                   (ECalendarItem *calitem);

### e_calendar_item_set_days_start_week_sel ()

    void
    e_calendar_item_set_days_start_week_sel
                                   (ECalendarItem *calitem,
                                    gint days);

### e_calendar_item_get_display_popup ()

    gboolean
    e_calendar_item_get_display_popup (ECalendarItem *calitem);

### e_calendar_item_set_display_popup ()

    void
    e_calendar_item_set_display_popup (ECalendarItem *calitem,
                                       gboolean display);

### e_calendar_item_get_date_range ()

    gboolean
    e_calendar_item_get_date_range (ECalendarItem *calitem,
                                    gint *start_year,
                                    gint *start_month,
                                    gint *start_day,
                                    gint *end_year,
                                    gint *end_month,
                                    gint *end_day);

### e_calendar_item_get_selection ()

    gboolean
    e_calendar_item_get_selection (ECalendarItem *calitem,
                                   GDate *start_date,
                                   GDate *end_date);

### e_calendar_item_set_selection ()

    void
    e_calendar_item_set_selection (ECalendarItem *calitem,
                                   const GDate *start_date,
                                   const GDate *end_date);

### e_calendar_item_clear_marks ()

    void
    e_calendar_item_clear_marks (ECalendarItem *calitem);

### e_calendar_item_mark_day ()

    void
    e_calendar_item_mark_day (ECalendarItem *calitem,
                              gint year,
                              gint month,
                              gint day,
                              guint8 day_style,
                              gboolean add_day_style);

### e_calendar_item_mark_days ()

    void
    e_calendar_item_mark_days (ECalendarItem *calitem,
                               gint start_year,
                               gint start_month,
                               gint start_day,
                               gint end_year,
                               gint end_month,
                               gint end_day,
                               guint8 day_style,
                               gboolean add_day_style);

### ECalendarItemStyleCallback ()

    void
    (*ECalendarItemStyleCallback) (ECalendarItem *calitem,
                                   gint year,
                                   gint month,
                                   gint day,
                                   gint day_style,
                                   gboolean today,
                                   gboolean prev_or_next_month,
                                   gboolean selected,
                                   gboolean has_focus,
                                   gboolean drop_target,
                                   GdkColor **bg_color,
                                   GdkColor **fg_color,
                                   GdkColor **box_color,
                                   gboolean *bold,
                                   gboolean *italic,
                                   gpointer data);

### e_calendar_item_set_style_callback ()

    void
    e_calendar_item_set_style_callback (ECalendarItem *calitem,
                                        ECalendarItemStyleCallback cb,
                                        gpointer data,
                                        GDestroyNotify destroy);

### e_calendar_item_set_get_time_callback ()

    void
    e_calendar_item_set_get_time_callback (ECalendarItem *calitem,
                                           ECalendarItemGetTimeCallback cb,
                                           gpointer data,
                                           GDestroyNotify destroy);

### e_calendar_item_normalize_date ()

    void
    e_calendar_item_normalize_date (ECalendarItem *calitem,
                                    gint *year,
                                    gint *month);

### e_calendar_item_get_week_number ()

    gint
    e_calendar_item_get_week_number (ECalendarItem *calitem,
                                     gint day,
                                     gint month,
                                     gint year);

## Types and Values

### E_CALENDAR_ITEM_YPAD_ABOVE_MONTH_NAME

    #define E_CALENDAR_ITEM_YPAD_ABOVE_MONTH_NAME 1

### E_CALENDAR_ITEM_YPAD_BELOW_MONTH_NAME

    #define E_CALENDAR_ITEM_YPAD_BELOW_MONTH_NAME 1

### E_CALENDAR_ROWS_PER_MONTH

    #define E_CALENDAR_ROWS_PER_MONTH 6

### E_CALENDAR_COLS_PER_MONTH

    #define E_CALENDAR_COLS_PER_MONTH 7

### E_CALENDAR_ITEM_MARK_BOLD

    #define E_CALENDAR_ITEM_MARK_BOLD (1 << 0)

### E_CALENDAR_ITEM_MIN_CELL_XPAD

    #define E_CALENDAR_ITEM_MIN_CELL_XPAD 4

### E_CALENDAR_ITEM_MIN_CELL_YPAD

    #define E_CALENDAR_ITEM_MIN_CELL_YPAD 0

### E_CALENDAR_ITEM_YPAD_ABOVE_DAY_LETTERS

    #define E_CALENDAR_ITEM_YPAD_ABOVE_DAY_LETTERS		1

### E_CALENDAR_ITEM_YPAD_BELOW_DAY_LETTERS

    #define E_CALENDAR_ITEM_YPAD_BELOW_DAY_LETTERS		0

### E_CALENDAR_ITEM_YPAD_ABOVE_CELLS

    #define E_CALENDAR_ITEM_YPAD_ABOVE_CELLS		1

### E_CALENDAR_ITEM_YPAD_BELOW_CELLS

    #define E_CALENDAR_ITEM_YPAD_BELOW_CELLS		2

### E_CALENDAR_ITEM_XPAD_BEFORE_MONTH_NAME_WITH_BUTTON

    #define E_CALENDAR_ITEM_XPAD_BEFORE_MONTH_NAME_WITH_BUTTON 10

### E_CALENDAR_ITEM_XPAD_BEFORE_MONTH_NAME

    #define E_CALENDAR_ITEM_XPAD_BEFORE_MONTH_NAME			3

### E_CALENDAR_ITEM_XPAD_AFTER_MONTH_NAME

    #define E_CALENDAR_ITEM_XPAD_AFTER_MONTH_NAME			3

### E_CALENDAR_ITEM_XPAD_AFTER_MONTH_NAME_WITH_BUTTON

    #define E_CALENDAR_ITEM_XPAD_AFTER_MONTH_NAME_WITH_BUTTON 10

### E_CALENDAR_ITEM_XPAD_BEFORE_WEEK_NUMBERS

    #define E_CALENDAR_ITEM_XPAD_BEFORE_WEEK_NUMBERS 4

### E_CALENDAR_ITEM_XPAD_AFTER_WEEK_NUMBERS

    #define E_CALENDAR_ITEM_XPAD_AFTER_WEEK_NUMBERS		2

### E_CALENDAR_ITEM_XPAD_BEFORE_CELLS

    #define E_CALENDAR_ITEM_XPAD_BEFORE_CELLS		1

### E_CALENDAR_ITEM_XPAD_AFTER_CELLS

    #define E_CALENDAR_ITEM_XPAD_AFTER_CELLS		4

### enum ECalendarItemColors

#### Members

E_CALENDAR_ITEM_COLOR_TODAY_BOX |  |
E_CALENDAR_ITEM_COLOR_SELECTION_FG |  |
E_CALENDAR_ITEM_COLOR_SELECTION_BG_FOCUSED |  |
E_CALENDAR_ITEM_COLOR_SELECTION_BG |  |
E_CALENDAR_ITEM_COLOR_PREV_OR_NEXT_MONTH_FG |  |
E_CALENDAR_ITEM_COLOR_LAST |  |

### struct ECalendarItem

    struct ECalendarItem;

## Property Details

### The `“column-width”` property

      “column-width”             gint

Flags: Read

Default value: 0

### The `“days-to-start-week-selection”` property

      “days-to-start-week-selection” gint

Flags: Read / Write

Default value: 0

### The `“display-popup”` property

      “display-popup”            gboolean

Flags: Read / Write

Default value: TRUE

### The `“font-desc”` property

      “font-desc”                PangoFontDescription *

Flags: Read / Write

### The `“keep-wdays-on-weeknum-click”` property

      “keep-wdays-on-weeknum-click” gboolean

Flags: Read / Write

Default value: FALSE

### The `“maximum-columns”` property

      “maximum-columns”          gint

Flags: Read / Write

Default value: 0

### The `“maximum-days-selected”` property

      “maximum-days-selected”    gint

Flags: Read / Write

Default value: 0

### The `“maximum-rows”` property

      “maximum-rows”             gint

Flags: Read / Write

Default value: 0

### The `“minimum-columns”` property

      “minimum-columns”          gint

Flags: Read / Write

Default value: 0

### The `“minimum-rows”` property

      “minimum-rows”             gint

Flags: Read / Write

Default value: 0

### The `“month”` property

      “month”                    gint

Flags: Read / Write

Default value: 0

### The `“move-selection-when-moving”` property

      “move-selection-when-moving” gboolean

Flags: Read / Write

Default value: TRUE

### The `“preserve-day-when-moving”` property

      “preserve-day-when-moving” gboolean

Flags: Read / Write

Default value: TRUE

### The `“row-height”` property

      “row-height”               gint

Flags: Read

Default value: 0

### The `“show-week-numbers”` property

      “show-week-numbers”        gboolean

Flags: Read / Write

Default value: TRUE

### The `“week-number-font-desc”` property

      “week-number-font-desc”    PangoFontDescription *

Flags: Read / Write

### The `“week-start-day”` property

      “week-start-day”           EDateWeekday

Flags: Read / Write

Default value: E_DATE_MONDAY

### The `“x1”` property

      “x1”                       gdouble

Flags: Read / Write

Default value: 0

### The `“x2”` property

      “x2”                       gdouble

Flags: Read / Write

Default value: 0

### The `“y1”` property

      “y1”                       gdouble

Flags: Read / Write

Default value: 0

### The `“y2”` property

      “y2”                       gdouble

Flags: Read / Write

Default value: 0

### The `“year”` property

      “year”                     gint

Flags: Read / Write

Default value: 0

## Signal Details

### The `“date-range-changed”` signal

    void
    user_function (ECalendarItem *ecalendaritem,
                   gpointer       user_data)

Flags: Run First

### The `“date-range-moved”` signal

    void
    user_function (ECalendarItem *ecalendaritem,
                   gpointer       user_data)

Flags: Run First

### The `“selection-changed”` signal

    void
    user_function (ECalendarItem *ecalendaritem,
                   gpointer       user_data)

Flags: Run First

### The `“selection-preview-changed”` signal

    void
    user_function (ECalendarItem *ecalendaritem,
                   gpointer       user_data)

Flags: Run Last