/*
 *  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 WebKitDOMKeyboardEvent_h
#define WebKitDOMKeyboardEvent_h

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

G_BEGIN_DECLS

#define WEBKIT_DOM_TYPE_KEYBOARD_EVENT            (webkit_dom_keyboard_event_get_type())
#define WEBKIT_DOM_KEYBOARD_EVENT(obj)            (G_TYPE_CHECK_INSTANCE_CAST((obj), WEBKIT_DOM_TYPE_KEYBOARD_EVENT, WebKitDOMKeyboardEvent))
#define WEBKIT_DOM_KEYBOARD_EVENT_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST((klass),  WEBKIT_DOM_TYPE_KEYBOARD_EVENT, WebKitDOMKeyboardEventClass)
#define WEBKIT_DOM_IS_KEYBOARD_EVENT(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj), WEBKIT_DOM_TYPE_KEYBOARD_EVENT))
#define WEBKIT_DOM_IS_KEYBOARD_EVENT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),  WEBKIT_DOM_TYPE_KEYBOARD_EVENT))
#define WEBKIT_DOM_KEYBOARD_EVENT_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj),  WEBKIT_DOM_TYPE_KEYBOARD_EVENT, WebKitDOMKeyboardEventClass))

/**
 * WEBKIT_DOM_KEYBOARD_EVENT_KEY_LOCATION_STANDARD:
 */
#define WEBKIT_DOM_KEYBOARD_EVENT_KEY_LOCATION_STANDARD 0x00

/**
 * WEBKIT_DOM_KEYBOARD_EVENT_KEY_LOCATION_LEFT:
 */
#define WEBKIT_DOM_KEYBOARD_EVENT_KEY_LOCATION_LEFT 0x01

/**
 * WEBKIT_DOM_KEYBOARD_EVENT_KEY_LOCATION_RIGHT:
 */
#define WEBKIT_DOM_KEYBOARD_EVENT_KEY_LOCATION_RIGHT 0x02

/**
 * WEBKIT_DOM_KEYBOARD_EVENT_KEY_LOCATION_NUMPAD:
 */
#define WEBKIT_DOM_KEYBOARD_EVENT_KEY_LOCATION_NUMPAD 0x03

struct _WebKitDOMKeyboardEvent {
    WebKitDOMUIEvent parent_instance;
};

struct _WebKitDOMKeyboardEventClass {
    WebKitDOMUIEventClass parent_class;
};

WEBKIT_API GType
webkit_dom_keyboard_event_get_type(void);

/**
 * webkit_dom_keyboard_event_get_modifier_state:
 * @self: A #WebKitDOMKeyboardEvent
 * @keyIdentifierArg: A #gchar
 *
 * Returns: A #gboolean
**/
WEBKIT_API gboolean
webkit_dom_keyboard_event_get_modifier_state(WebKitDOMKeyboardEvent* self, const gchar* keyIdentifierArg);

/**
 * webkit_dom_keyboard_event_init_keyboard_event:
 * @self: A #WebKitDOMKeyboardEvent
 * @type: A #gchar
 * @canBubble: A #gboolean
 * @cancelable: A #gboolean
 * @view: A #WebKitDOMDOMWindow
 * @keyIdentifier: A #gchar
 * @location: A #gulong
 * @ctrlKey: A #gboolean
 * @altKey: A #gboolean
 * @shiftKey: A #gboolean
 * @metaKey: A #gboolean
 * @altGraphKey: A #gboolean
 *
**/
WEBKIT_API void
webkit_dom_keyboard_event_init_keyboard_event(WebKitDOMKeyboardEvent* self, const gchar* type, gboolean canBubble, gboolean cancelable, WebKitDOMDOMWindow* view, const gchar* keyIdentifier, gulong location, gboolean ctrlKey, gboolean altKey, gboolean shiftKey, gboolean metaKey, gboolean altGraphKey);

/**
 * webkit_dom_keyboard_event_get_key_identifier:
 * @self: A #WebKitDOMKeyboardEvent
 *
 * Returns: A #gchar
**/
WEBKIT_API gchar*
webkit_dom_keyboard_event_get_key_identifier(WebKitDOMKeyboardEvent* self);

/**
 * webkit_dom_keyboard_event_get_key_location:
 * @self: A #WebKitDOMKeyboardEvent
 *
 * Returns: A #gulong
**/
WEBKIT_API gulong
webkit_dom_keyboard_event_get_key_location(WebKitDOMKeyboardEvent* self);

/**
 * webkit_dom_keyboard_event_get_ctrl_key:
 * @self: A #WebKitDOMKeyboardEvent
 *
 * Returns: A #gboolean
**/
WEBKIT_API gboolean
webkit_dom_keyboard_event_get_ctrl_key(WebKitDOMKeyboardEvent* self);

/**
 * webkit_dom_keyboard_event_get_shift_key:
 * @self: A #WebKitDOMKeyboardEvent
 *
 * Returns: A #gboolean
**/
WEBKIT_API gboolean
webkit_dom_keyboard_event_get_shift_key(WebKitDOMKeyboardEvent* self);

/**
 * webkit_dom_keyboard_event_get_alt_key:
 * @self: A #WebKitDOMKeyboardEvent
 *
 * Returns: A #gboolean
**/
WEBKIT_API gboolean
webkit_dom_keyboard_event_get_alt_key(WebKitDOMKeyboardEvent* self);

/**
 * webkit_dom_keyboard_event_get_meta_key:
 * @self: A #WebKitDOMKeyboardEvent
 *
 * Returns: A #gboolean
**/
WEBKIT_API gboolean
webkit_dom_keyboard_event_get_meta_key(WebKitDOMKeyboardEvent* self);

/**
 * webkit_dom_keyboard_event_get_alt_graph_key:
 * @self: A #WebKitDOMKeyboardEvent
 *
 * Returns: A #gboolean
**/
WEBKIT_API gboolean
webkit_dom_keyboard_event_get_alt_graph_key(WebKitDOMKeyboardEvent* self);

G_END_DECLS

#endif /* WebKitDOMKeyboardEvent_h */