Blame gdata/atom/gdata-category.h

Packit 4b6dd7
/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */
Packit 4b6dd7
/*
Packit 4b6dd7
 * GData Client
Packit 4b6dd7
 * Copyright (C) Philip Withnall 2009 <philip@tecnocode.co.uk>
Packit 4b6dd7
 *
Packit 4b6dd7
 * GData Client is free software; you can redistribute it and/or
Packit 4b6dd7
 * modify it under the terms of the GNU Lesser General Public
Packit 4b6dd7
 * License as published by the Free Software Foundation; either
Packit 4b6dd7
 * version 2.1 of the License, or (at your option) any later version.
Packit 4b6dd7
 *
Packit 4b6dd7
 * GData Client is distributed in the hope that it will be useful,
Packit 4b6dd7
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit 4b6dd7
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Packit 4b6dd7
 * Lesser General Public License for more details.
Packit 4b6dd7
 *
Packit 4b6dd7
 * You should have received a copy of the GNU Lesser General Public
Packit 4b6dd7
 * License along with GData Client.  If not, see <http://www.gnu.org/licenses/>.
Packit 4b6dd7
 */
Packit 4b6dd7
Packit 4b6dd7
#ifndef GDATA_CATEGORY_H
Packit 4b6dd7
#define GDATA_CATEGORY_H
Packit 4b6dd7
Packit 4b6dd7
#include <glib.h>
Packit 4b6dd7
#include <glib-object.h>
Packit 4b6dd7
Packit 4b6dd7
#include <gdata/gdata-parsable.h>
Packit 4b6dd7
Packit 4b6dd7
G_BEGIN_DECLS
Packit 4b6dd7
Packit 4b6dd7
/**
Packit 4b6dd7
 * GDATA_CATEGORY_SCHEMA_LABELS:
Packit 4b6dd7
 *
Packit 4b6dd7
 * A schema for categories which label the entry they're applied to in some way, such as starring it. The semantics of the various labels
Packit 4b6dd7
 * (such as %GDATA_CATEGORY_SCHEMA_LABELS_STARRED) are service-specific.
Packit 4b6dd7
 *
Packit 4b6dd7
 * Since: 0.11.0
Packit 4b6dd7
 */
Packit 4b6dd7
#define GDATA_CATEGORY_SCHEMA_LABELS "http://schemas.google.com/g/2005/labels"
Packit 4b6dd7
Packit 4b6dd7
/**
Packit 4b6dd7
 * GDATA_CATEGORY_SCHEMA_LABELS_SHARED:
Packit 4b6dd7
 *
Packit 4b6dd7
 * A term for categories of the %GDATA_CATEGORY_SCHEMA_LABELS schema which labels an entry as being “shared”. The semantics of this label are
Packit 4b6dd7
 * service-specific, but are obvious for services such as Google Documents.
Packit 4b6dd7
 *
Packit 4b6dd7
 * Since: 0.17.0
Packit 4b6dd7
 */
Packit 4b6dd7
#define GDATA_CATEGORY_SCHEMA_LABELS_SHARED GDATA_CATEGORY_SCHEMA_LABELS"#shared"
Packit 4b6dd7
Packit 4b6dd7
/**
Packit 4b6dd7
 * GDATA_CATEGORY_SCHEMA_LABELS_STARRED:
Packit 4b6dd7
 *
Packit 4b6dd7
 * A term for categories of the %GDATA_CATEGORY_SCHEMA_LABELS schema which labels an entry as being “starred”. The semantics of this label are
Packit 4b6dd7
 * service-specific, but are obvious for services such as Google Documents.
Packit 4b6dd7
 *
Packit 4b6dd7
 * Since: 0.11.0
Packit 4b6dd7
 */
Packit 4b6dd7
#define GDATA_CATEGORY_SCHEMA_LABELS_STARRED GDATA_CATEGORY_SCHEMA_LABELS"#starred"
Packit 4b6dd7
Packit 4b6dd7
/**
Packit 4b6dd7
 * GDATA_CATEGORY_SCHEMA_LABELS_VIEWED:
Packit 4b6dd7
 *
Packit 4b6dd7
 * A term for categories of the %GDATA_CATEGORY_SCHEMA_LABELS schema which labels an entry as being “viewed”. The semantics of this label are
Packit 4b6dd7
 * service-specific, but are obvious for services such as Google Documents.
Packit 4b6dd7
 *
Packit 4b6dd7
 * Since: 0.17.0
Packit 4b6dd7
 */
Packit 4b6dd7
#define GDATA_CATEGORY_SCHEMA_LABELS_VIEWED GDATA_CATEGORY_SCHEMA_LABELS"#viewed"
Packit 4b6dd7
Packit 4b6dd7
#define GDATA_TYPE_CATEGORY		(gdata_category_get_type ())
Packit 4b6dd7
#define GDATA_CATEGORY(o)		(G_TYPE_CHECK_INSTANCE_CAST ((o), GDATA_TYPE_CATEGORY, GDataCategory))
Packit 4b6dd7
#define GDATA_CATEGORY_CLASS(k)		(G_TYPE_CHECK_CLASS_CAST((k), GDATA_TYPE_CATEGORY, GDataCategoryClass))
Packit 4b6dd7
#define GDATA_IS_CATEGORY(o)		(G_TYPE_CHECK_INSTANCE_TYPE ((o), GDATA_TYPE_CATEGORY))
Packit 4b6dd7
#define GDATA_IS_CATEGORY_CLASS(k)	(G_TYPE_CHECK_CLASS_TYPE ((k), GDATA_TYPE_CATEGORY))
Packit 4b6dd7
#define GDATA_CATEGORY_GET_CLASS(o)	(G_TYPE_INSTANCE_GET_CLASS ((o), GDATA_TYPE_CATEGORY, GDataCategoryClass))
Packit 4b6dd7
Packit 4b6dd7
typedef struct _GDataCategoryPrivate	GDataCategoryPrivate;
Packit 4b6dd7
Packit 4b6dd7
/**
Packit 4b6dd7
 * GDataCategory:
Packit 4b6dd7
 *
Packit 4b6dd7
 * All the fields in the #GDataCategory structure are private and should never be accessed directly.
Packit 4b6dd7
 */
Packit 4b6dd7
typedef struct {
Packit 4b6dd7
	GDataParsable parent;
Packit 4b6dd7
	GDataCategoryPrivate *priv;
Packit 4b6dd7
} GDataCategory;
Packit 4b6dd7
Packit 4b6dd7
/**
Packit 4b6dd7
 * GDataCategoryClass:
Packit 4b6dd7
 *
Packit 4b6dd7
 * All the fields in the #GDataCategoryClass structure are private and should never be accessed directly.
Packit 4b6dd7
 *
Packit 4b6dd7
 * Since: 0.4.0
Packit 4b6dd7
 */
Packit 4b6dd7
typedef struct {
Packit 4b6dd7
	/*< private >*/
Packit 4b6dd7
	GDataParsableClass parent;
Packit 4b6dd7
Packit 4b6dd7
	/*< private >*/
Packit 4b6dd7
	/* Padding for future expansion */
Packit 4b6dd7
	void (*_g_reserved0) (void);
Packit 4b6dd7
	void (*_g_reserved1) (void);
Packit 4b6dd7
} GDataCategoryClass;
Packit 4b6dd7
Packit 4b6dd7
GType gdata_category_get_type (void) G_GNUC_CONST;
Packit 4b6dd7
Packit 4b6dd7
GDataCategory *gdata_category_new (const gchar *term, const gchar *scheme, const gchar *label) G_GNUC_WARN_UNUSED_RESULT G_GNUC_MALLOC;
Packit 4b6dd7
Packit 4b6dd7
const gchar *gdata_category_get_term (GDataCategory *self) G_GNUC_PURE;
Packit 4b6dd7
void gdata_category_set_term (GDataCategory *self, const gchar *term);
Packit 4b6dd7
Packit 4b6dd7
const gchar *gdata_category_get_scheme (GDataCategory *self) G_GNUC_PURE;
Packit 4b6dd7
void gdata_category_set_scheme (GDataCategory *self, const gchar *scheme);
Packit 4b6dd7
Packit 4b6dd7
const gchar *gdata_category_get_label (GDataCategory *self) G_GNUC_PURE;
Packit 4b6dd7
void gdata_category_set_label (GDataCategory *self, const gchar *label);
Packit 4b6dd7
Packit 4b6dd7
G_END_DECLS
Packit 4b6dd7
Packit 4b6dd7
#endif /* !GDATA_CATEGORY_H */