/* 
 * Copyright (C) 2010 Daiki Ueno <ueno@unixuser.org>
 * Copyright (C) 2010 Red Hat, Inc.
 * 
 * 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 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
 * 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301 USA
 */
#ifndef EEK_KEYBOARD_H
#define EEK_KEYBOARD_H 1

#include <glib-object.h>
#include "eek-container.h"
#include "eek-types.h"
#include "eek-layout.h"

G_BEGIN_DECLS

#define EEK_TYPE_KEYBOARD (eek_keyboard_get_type())
#define EEK_KEYBOARD(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), EEK_TYPE_KEYBOARD, EekKeyboard))
#define EEK_KEYBOARD_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), EEK_TYPE_KEYBOARD, EekKeyboardClass))
#define EEK_IS_KEYBOARD(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), EEK_TYPE_KEYBOARD))
#define EEK_IS_KEYBOARD_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), EEK_TYPE_KEYBOARD))
#define EEK_KEYBOARD_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), EEK_TYPE_KEYBOARD, EekKeyboardClass))

typedef struct _EekKeyboardClass EekKeyboardClass;
typedef struct _EekKeyboardPrivate EekKeyboardPrivate;

struct _EekKeyboard
{
    /*< private >*/
    EekContainer parent;

    EekKeyboardPrivate *priv;
};

/**
 * EekKeyboardClass:
 * @set_keysym_index: virtual function for setting group and level of
 * the entire keyboard
 * @get_keysym_index: virtual function for getting group and level of
 * the entire keyboard
 * @create_section: virtual function for creating a section
 * @find_key_by_keycode: virtual function for finding a key in the
 * keyboard by keycode
 * @keysym_index_changed: class handler for #EekKeyboard::keysym-index-changed signal
 */
struct _EekKeyboardClass
{
    /*< private >*/
    EekContainerClass parent_class;

    /*< public >*/
    void        (* set_keysym_index)     (EekKeyboard *self,
                                          gint         group,
                                          gint         level);
    void        (* get_keysym_index)     (EekKeyboard *self,
                                          gint        *group,
                                          gint        *level);

    EekSection *(* create_section)       (EekKeyboard *self);

    EekKey     *(* find_key_by_keycode)  (EekKeyboard *self,
                                          guint        keycode);

    /* signals */
    void        (* keysym_index_changed) (EekKeyboard *self,
                                          gint         group,
                                          gint         level);

    /*< private >*/
    /* padding */
    gpointer pdummy[23];
};

GType        eek_keyboard_get_type            (void) G_GNUC_CONST;

EekKeyboard *eek_keyboard_new                 (EekLayout   *layout,
                                               gint         initial_width,
                                               gint         initial_height);
void         eek_keyboard_set_keysym_index    (EekKeyboard *keyboard,
                                               gint         group,
                                               gint         level);
void         eek_keyboard_get_keysym_index    (EekKeyboard *keyboard,
                                               gint        *group,
                                               gint        *level);

EekSection  *eek_keyboard_create_section      (EekKeyboard *keyboard);

EekKey      *eek_keyboard_find_key_by_keycode (EekKeyboard *keyboard,
                                               guint        keycode);

G_END_DECLS
#endif  /* EEK_KEYBOARD_H */