Source/WebKit/WebProcess/InjectedBundle/API/gtk/DOM/WebKitDOMNodeIterator.h

/*
 *  This file is part of the WebKit open source project.
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Library General Public
 *  License as published by the Free Software Foundation; either
 *  version 2 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
 *  Library General Public License for more details.
 *
 *  You should have received a copy of the GNU Library General Public License
 *  along with this library; see the file COPYING.LIB.  If not, write to
 *  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 *  Boston, MA 02110-1301, USA.
 */

#if !defined(__WEBKITDOM_H_INSIDE__) && !defined(BUILDING_WEBKIT)
#error "Only <webkitdom/webkitdom.h> can be included directly."
#endif

#ifndef WebKitDOMNodeIterator_h
#define WebKitDOMNodeIterator_h

#include <glib-object.h>
#include <webkitdom/WebKitDOMObject.h>
#include <webkitdom/webkitdomdefines.h>

G_BEGIN_DECLS

#define WEBKIT_DOM_TYPE_NODE_ITERATOR            (webkit_dom_node_iterator_get_type())
#define WEBKIT_DOM_NODE_ITERATOR(obj)            (G_TYPE_CHECK_INSTANCE_CAST((obj), WEBKIT_DOM_TYPE_NODE_ITERATOR, WebKitDOMNodeIterator))
#define WEBKIT_DOM_NODE_ITERATOR_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST((klass),  WEBKIT_DOM_TYPE_NODE_ITERATOR, WebKitDOMNodeIteratorClass)
#define WEBKIT_DOM_IS_NODE_ITERATOR(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj), WEBKIT_DOM_TYPE_NODE_ITERATOR))
#define WEBKIT_DOM_IS_NODE_ITERATOR_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),  WEBKIT_DOM_TYPE_NODE_ITERATOR))
#define WEBKIT_DOM_NODE_ITERATOR_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj),  WEBKIT_DOM_TYPE_NODE_ITERATOR, WebKitDOMNodeIteratorClass))

struct _WebKitDOMNodeIterator {
    WebKitDOMObject parent_instance;
};

struct _WebKitDOMNodeIteratorClass {
    WebKitDOMObjectClass parent_class;
};

WEBKIT_DEPRECATED GType
webkit_dom_node_iterator_get_type(void);

/**
 * webkit_dom_node_iterator_next_node:
 * @self: A #WebKitDOMNodeIterator
 * @error: #GError
 *
 * Returns: (transfer none): A #WebKitDOMNode
 *
 * Deprecated: 2.22: Use JavaScriptCore API instead
**/
WEBKIT_DEPRECATED WebKitDOMNode*
webkit_dom_node_iterator_next_node(WebKitDOMNodeIterator* self, GError** error);

/**
 * webkit_dom_node_iterator_previous_node:
 * @self: A #WebKitDOMNodeIterator
 * @error: #GError
 *
 * Returns: (transfer none): A #WebKitDOMNode
 *
 * Deprecated: 2.22: Use JavaScriptCore API instead
**/
WEBKIT_DEPRECATED WebKitDOMNode*
webkit_dom_node_iterator_previous_node(WebKitDOMNodeIterator* self, GError** error);

/**
 * webkit_dom_node_iterator_detach:
 * @self: A #WebKitDOMNodeIterator
 *
 *
 * Deprecated: 2.22: Use JavaScriptCore API instead
**/
WEBKIT_DEPRECATED void
webkit_dom_node_iterator_detach(WebKitDOMNodeIterator* self);

/**
 * webkit_dom_node_iterator_get_root:
 * @self: A #WebKitDOMNodeIterator
 *
 * Returns: (transfer none): A #WebKitDOMNode
 *
 * Deprecated: 2.22: Use JavaScriptCore API instead
**/
WEBKIT_DEPRECATED WebKitDOMNode*
webkit_dom_node_iterator_get_root(WebKitDOMNodeIterator* self);

/**
 * webkit_dom_node_iterator_get_what_to_show:
 * @self: A #WebKitDOMNodeIterator
 *
 * Returns: A #gulong
 *
 * Deprecated: 2.22: Use JavaScriptCore API instead
**/
WEBKIT_DEPRECATED gulong
webkit_dom_node_iterator_get_what_to_show(WebKitDOMNodeIterator* self);

/**
 * webkit_dom_node_iterator_get_filter:
 * @self: A #WebKitDOMNodeIterator
 *
 * Returns: (transfer full): A #WebKitDOMNodeFilter
 *
 * Deprecated: 2.22: Use JavaScriptCore API instead
**/
WEBKIT_DEPRECATED WebKitDOMNodeFilter*
webkit_dom_node_iterator_get_filter(WebKitDOMNodeIterator* self);

/**
 * webkit_dom_node_iterator_get_reference_node:
 * @self: A #WebKitDOMNodeIterator
 *
 * Returns: (transfer none): A #WebKitDOMNode
 *
 * Deprecated: 2.22: Use JavaScriptCore API instead
**/
WEBKIT_DEPRECATED WebKitDOMNode*
webkit_dom_node_iterator_get_reference_node(WebKitDOMNodeIterator* self);

/**
 * webkit_dom_node_iterator_get_pointer_before_reference_node:
 * @self: A #WebKitDOMNodeIterator
 *
 * Returns: A #gboolean
 *
 * Deprecated: 2.22: Use JavaScriptCore API instead
**/
WEBKIT_DEPRECATED gboolean
webkit_dom_node_iterator_get_pointer_before_reference_node(WebKitDOMNodeIterator* self);

G_END_DECLS

#endif /* WebKitDOMNodeIterator_h */