GDataCalendarCalendar

## GDataCalendarCalendar GDataCalendarCalendar — GData Calendar calendar object |

## Stability Level

Unstable, unless otherwise indicated

## Synopsis

    #include <gdata/services/calendar/gdata-calendar-calendar.h>

                        GDataCalendarCalendar;
                        GDataCalendarCalendarClass;
    GDataCalendarCalendar * gdata_calendar_calendar_new     (const gchar *id);
    void                gdata_calendar_calendar_get_color   (GDataCalendarCalendar *self,
                                                             GDataColor *color);
    void                gdata_calendar_calendar_set_color   (GDataCalendarCalendar *self,
                                                             GDataColor *color);
    gboolean            gdata_calendar_calendar_is_hidden   (GDataCalendarCalendar *self);
    void                gdata_calendar_calendar_set_is_hidden
                                                            (GDataCalendarCalendar *self,
                                                             gboolean is_hidden);
    gboolean            gdata_calendar_calendar_is_selected (GDataCalendarCalendar *self);
    void                gdata_calendar_calendar_set_is_selected
                                                            (GDataCalendarCalendar *self,
                                                             gboolean is_selected);
    const gchar *       gdata_calendar_calendar_get_timezone
                                                            (GDataCalendarCalendar *self);
    void                gdata_calendar_calendar_set_timezone
                                                            (GDataCalendarCalendar *self,
                                                             const gchar *_timezone);
    void                gdata_calendar_calendar_get_edited  (GDataCalendarCalendar *self,
                                                             GTimeVal *edited);
    guint               gdata_calendar_calendar_get_times_cleaned
                                                            (GDataCalendarCalendar *self);
    const gchar *       gdata_calendar_calendar_get_access_level
                                                            (GDataCalendarCalendar *self);

## Object Hierarchy

      GObject
       +----GDataParsable
             +----GDataEntry
                   +----GDataCalendarCalendar

## Implemented Interfaces

GDataCalendarCalendar implements GDataAccessHandler.

## Properties

      "access-level"             gchar*                : Read
      "color"                    GDataColor*           : Read / Write
      "edited"                   GDataTimeVal*         : Read
      "is-hidden"                gboolean              : Read / Write
      "is-selected"              gboolean              : Read / Write
      "times-cleaned"            guint                 : Read
      "timezone"                 gchar*                : Read / Write

## Description

GDataCalendarCalendar is a subclass of GDataEntry to represent a calendar from Google Calendar.

For more details of Google Calendar's GData API, see the online documentation.

## Details

### GDataCalendarCalendar

    typedef struct _GDataCalendarCalendar GDataCalendarCalendar;

All the fields in the GDataCalendarCalendar structure are private and should never be accessed directly.

### GDataCalendarCalendarClass

    typedef struct {
    } GDataCalendarCalendarClass;

All the fields in the GDataCalendarCalendarClass structure are private and should never be accessed directly.

### gdata_calendar_calendar_new ()

    GDataCalendarCalendar * gdata_calendar_calendar_new     (const gchar *id);

Creates a new GDataCalendarCalendar with the given ID and default properties.

`id` : | the calendar's ID, or `NULL`
Returns : | a new GDataCalendarCalendar; unref with `g_object_unref()`

### gdata_calendar_calendar_get_color ()

    void                gdata_calendar_calendar_get_color   (GDataCalendarCalendar *self,
                                                             GDataColor *color);

Gets the "color" property and puts it in `color`.

`self` : | a GDataCalendarCalendar
`color` : | a GDataColor. [out caller-allocates]

### gdata_calendar_calendar_set_color ()

    void                gdata_calendar_calendar_set_color   (GDataCalendarCalendar *self,
                                                             GDataColor *color);

Sets the "color" property to `color`.

`self` : | a GDataCalendarCalendar
`color` : | a new GDataColor

### gdata_calendar_calendar_is_hidden ()

    gboolean            gdata_calendar_calendar_is_hidden   (GDataCalendarCalendar *self);

Gets the "is-hidden" property.

`self` : | a GDataCalendarCalendar
Returns : | `TRUE` if the calendar is hidden, `FALSE` otherwise

Since 0.2.0

### gdata_calendar_calendar_set_is_hidden ()

    void                gdata_calendar_calendar_set_is_hidden
                                                            (GDataCalendarCalendar *self,
                                                             gboolean is_hidden);

Sets the "is-hidden" property to `is_hidden`.

`self` : | a GDataCalendarCalendar
`is_hidden` : | `TRUE` to hide the calendar, `FALSE` otherwise

Since 0.2.0

### gdata_calendar_calendar_is_selected ()

    gboolean            gdata_calendar_calendar_is_selected (GDataCalendarCalendar *self);

Gets the "is-selected" property.

`self` : | a GDataCalendarCalendar
Returns : | `TRUE` if the calendar is selected, `FALSE` otherwise

Since 0.2.0

### gdata_calendar_calendar_set_is_selected ()

    void                gdata_calendar_calendar_set_is_selected
                                                            (GDataCalendarCalendar *self,
                                                             gboolean is_selected);

Sets the "is-selected" property to `is_selected`.

`self` : | a GDataCalendarCalendar
`is_selected` : | `TRUE` to select the calendar, `FALSE` otherwise

Since 0.2.0

### gdata_calendar_calendar_get_timezone ()

    const gchar *       gdata_calendar_calendar_get_timezone
                                                            (GDataCalendarCalendar *self);

Gets the "timezone" property.

`self` : | a GDataCalendarCalendar
Returns : | the calendar's timezone, or `NULL`

### gdata_calendar_calendar_set_timezone ()

    void                gdata_calendar_calendar_set_timezone
                                                            (GDataCalendarCalendar *self,
                                                             const gchar *_timezone);

Sets the "timezone" property to the new timezone, `_timezone`.

Set `_timezone` to `NULL` to unset the property in the calendar.

`self` : | a GDataCalendarCalendar
`_timezone` : | a new timezone, or `NULL`. [allow-none]

### gdata_calendar_calendar_get_edited ()

    void                gdata_calendar_calendar_get_edited  (GDataCalendarCalendar *self,
                                                             GTimeVal *edited);

Gets the "edited" property and puts it in `edited`. If the property is unset, both fields in the GTimeVal will be set to `0`.

`self` : | a GDataCalendarCalendar
`edited` : | a GTimeVal. [out caller-allocates]

### gdata_calendar_calendar_get_times_cleaned ()

    guint               gdata_calendar_calendar_get_times_cleaned
                                                            (GDataCalendarCalendar *self);

Gets the "times-cleaned" property.

`self` : | a GDataCalendarCalendar
Returns : | the number of times the calendar has been totally emptied

### gdata_calendar_calendar_get_access_level ()

    const gchar *       gdata_calendar_calendar_get_access_level
                                                            (GDataCalendarCalendar *self);

Gets the "access-level" property.

`self` : | a GDataCalendarCalendar
Returns : | the authenticated user's access level to the calendar, or `NULL`

## Property Details

### The `"access-level"` property

      "access-level"             gchar*                : Read

Indicates what level of access the authenticated user has to the calendar.

Default value: NULL

### The `"color"` property

      "color"                    GDataColor*           : Read / Write

The color used to highlight the calendar in the user's browser.

### The `"edited"` property

      "edited"                   GDataTimeVal*         : Read

The last time the calendar was edited. If the calendar has not been edited yet, the content indicates the time it was created.

For more information, see the Atom Publishing Protocol specification.

### The `"is-hidden"` property

      "is-hidden"                gboolean              : Read / Write

Indicates whether the calendar is visible.

Default value: FALSE

Since 0.2.0

### The `"is-selected"` property

      "is-selected"              gboolean              : Read / Write

Indicates whether the calendar is selected.

Default value: FALSE

Since 0.2.0

### The `"times-cleaned"` property

      "times-cleaned"            guint                 : Read

The number of times the calendar has been completely cleared of events.

Default value: 0

### The `"timezone"` property

      "timezone"                 gchar*                : Read / Write

The timezone in which the calendar's times are given.

Default value: NULL