~ubuntu-branches/ubuntu/oneiric/libee/oneiric

« back to all changes in this revision

Viewing changes to include/libee/tag.h

  • Committer: Bazaar Package Importer
  • Author(s): Pierre Chifflier
  • Date: 2010-12-11 12:37:09 UTC
  • Revision ID: james.westby@ubuntu.com-20101211123709-i8v7mpdtzhgjoqn5
Tags: upstream-0.1.0
ImportĀ upstreamĀ versionĀ 0.1.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/**
 
2
 * @file tag.h
 
3
 * @brief The CEE tag object.
 
4
 * @class ee_tag tag.h
 
5
 *
 
6
 *//*
 
7
 *
 
8
 * Libee - An Event Expression Library inspired by CEE
 
9
 * Copyright 2010 by Rainer Gerhards and Adiscon GmbH.
 
10
 *
 
11
 * This file is part of libee.
 
12
 *
 
13
 * This library is free software; you can redistribute it and/or
 
14
 * modify it under the terms of the GNU Lesser General Public
 
15
 * License as published by the Free Software Foundation; either
 
16
 * version 2.1 of the License, or (at your option) any later version.
 
17
 *
 
18
 * This library is distributed in the hope that it will be useful,
 
19
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 
20
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 
21
 * Lesser General Public License for more details.
 
22
 *
 
23
 * You should have received a copy of the GNU Lesser General Public
 
24
 * License along with this library; if not, write to the Free Software
 
25
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 
26
 *
 
27
 * A copy of the LGPL v2.1 can be found in the file "COPYING" in this distribution.
 
28
 */
 
29
#ifndef LIBEE_TAG_H_INCLUDED
 
30
#define LIBEE_TAG_H_INCLUDED
 
31
 
 
32
/**
 
33
 * The tag class.
 
34
 * @extends ee_obj
 
35
 */
 
36
struct ee_tag {
 
37
        struct ee_obj o;        /*<< the base object */
 
38
        /*struct ee_namelist *altNames;*/
 
39
        struct ee_tagSet *tagset;
 
40
        /* TODO?: add Tag Relation Element -- but first wait how CEE evolves */
 
41
};
 
42
 
 
43
/**
 
44
 * Constructor for the ee_tag object.
 
45
 *
 
46
 * @memberof ee_tag
 
47
 * @public
 
48
 *
 
49
 * @param[in] ctx associated library context
 
50
 *
 
51
 * @return new library context or NULL if an error occured
 
52
 */
 
53
struct ee_tag* ee_newTag(ee_ctx ctx);
 
54
 
 
55
/**
 
56
 * Destructor for the ee_tag object.
 
57
 *
 
58
 * @memberof ee_tag
 
59
 * @public
 
60
 *
 
61
 * @param tag The tag to be discarded.
 
62
 */
 
63
void ee_deleteTag(struct ee_tag *tag);
 
64
 
 
65
 
 
66
#endif /* #ifndef LIBEE_TAG_H_INCLUDED */