grim/gplate
Clone
Summary
Browse
Changes
Graph
changelogged the glib requirement
default
tip
2013-09-21, Gary Kramlich
169f55edb6a4
changelogged the glib requirement
/*
* GPlate - GObject based templating library
* Copyright (C) 2007-2012 Gary Kramlich <grim@reaperworld.com>
*
* This library 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 3 of the License, or
* (at your option) any later version.
*
* This library 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 this library. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef GPLATE_ITERATOR_H
#define GPLATE_ITERATOR_H
#include
<glib.h>
#include
<glib-object.h>
#define GPLATE_TYPE_ITERATOR (gplate_iterator_get_type())
/**
* SECTION:gplate-iterator
* @short_description: An iterator for GPlateCollection contents.
*
* GPlateIterator is an interface for iterating a GPlateCollection.
*/
#define GPLATE_ITERATOR(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), GPLATE_TYPE_ITERATOR, GPlateIterator))
#define GPLATE_IS_ITERATOR(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), GPLATE_TYPE_ITERATOR))
#define GPLATE_ITERATOR_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE((obj), GPLATE_TYPE_ITERATOR, GPlateIteratorIface))
/**
* GPlateIterator:
*
* GPlateIterator is an opaque data structure and should not be used
* directly.
*/
typedef
struct
_GPlateIterator
GPlateIterator
;
typedef
struct
_GPlateIteratorIface
GPlateIteratorIface
;
#include
<gplate/gplate-variable.h>
/**
* GPlateIteratorIface:
* @gparent: The parent interface (#GTypeInterface) structure.
* @has_next: Determines whether the iterator will return a value on
* the next call to next().
* @next: Returns the next item in the iterator.
*
* The interface for GPlateIterator.
*/
struct
_GPlateIteratorIface
{
GTypeInterface
gparent
;
gboolean
(
*
has_next
)(
const
GPlateIterator
*
iter
);
GPlateVariable
*
(
*
next
)(
GPlateIterator
*
iter
);
/*< private >*/
void
(
*
_gplate_reserved1
)(
void
);
void
(
*
_gplate_reserved2
)(
void
);
void
(
*
_gplate_reserved3
)(
void
);
void
(
*
_gplate_reserved4
)(
void
);
};
G_BEGIN_DECLS
GType
gplate_iterator_get_type
(
void
);
gboolean
gplate_iterator_has_next
(
const
GPlateIterator
*
iter
);
GPlateVariable
*
gplate_iterator_next
(
GPlateIterator
*
iter
);
G_END_DECLS
#endif
/* GPLATE_ITERATOR_H */