120 lines
4.7 KiB
C
120 lines
4.7 KiB
C
/*
|
|
* Copyright (C) 2010-2011 Daiki Ueno <ueno@unixuser.org>
|
|
* Copyright (C) 2010-2011 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
|
|
*/
|
|
|
|
#if !defined(__EEK_H_INSIDE__) && !defined(EEK_COMPILATION)
|
|
#error "Only <eek/eek.h> can be included directly."
|
|
#endif
|
|
|
|
#ifndef EEK_KEY_H
|
|
#define EEK_KEY_H 1
|
|
|
|
#include "eek-element.h"
|
|
#include "eek-symbol-matrix.h"
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
#define EEK_TYPE_KEY (eek_key_get_type())
|
|
#define EEK_KEY(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), EEK_TYPE_KEY, EekKey))
|
|
#define EEK_KEY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), EEK_TYPE_KEY, EekKeyClass))
|
|
#define EEK_IS_KEY(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), EEK_TYPE_KEY))
|
|
#define EEK_IS_KEY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), EEK_TYPE_KEY))
|
|
#define EEK_KEY_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), EEK_TYPE_KEY, EekKeyClass))
|
|
|
|
typedef struct _EekKeyClass EekKeyClass;
|
|
typedef struct _EekKeyPrivate EekKeyPrivate;
|
|
|
|
/**
|
|
* EekKey:
|
|
*
|
|
* Contains information about the state of a key.
|
|
* TODO: rewrite as a plain struct
|
|
*
|
|
* The #EekKey structure contains only private data and should only be
|
|
* accessed using the provided API.
|
|
*/
|
|
struct _EekKey
|
|
{
|
|
/*< private >*/
|
|
EekElement parent;
|
|
|
|
EekKeyPrivate *priv;
|
|
};
|
|
|
|
/**
|
|
* EekKeyClass:
|
|
* @pressed: class handler for #EekKey::pressed signal
|
|
* @released: class handler for #EekKey::released signal
|
|
* @locked: class handler for #EekKey::locked signal
|
|
* @unlocked: class handler for #EekKey::unlocked signal
|
|
* @cancelled: class handler for #EekKey::cancelled signal
|
|
* @is_pressed: virtual function for getting whether the key is pressed
|
|
* @is_locked: virtual function for getting whether the key is locked
|
|
*/
|
|
struct _EekKeyClass
|
|
{
|
|
/*< private >*/
|
|
EekElementClass parent_class;
|
|
|
|
/*< public >*/
|
|
/* signals */
|
|
void (* released) (EekKey *key);
|
|
void (* locked) (EekKey *key);
|
|
void (* unlocked) (EekKey *key);
|
|
void (* cancelled) (EekKey *key);
|
|
};
|
|
|
|
GType eek_key_get_type (void) G_GNUC_CONST;
|
|
|
|
void eek_key_set_keycode (EekKey *key,
|
|
guint keycode);
|
|
guint eek_key_get_keycode (EekKey *key);
|
|
void eek_key_set_symbol_matrix (EekKey *key,
|
|
EekSymbolMatrix *matrix);
|
|
EekSymbolMatrix *eek_key_get_symbol_matrix (EekKey *key);
|
|
EekSymbol *eek_key_get_symbol (EekKey *key);
|
|
EekSymbol *eek_key_get_symbol_with_fallback
|
|
(EekKey *key,
|
|
gint fallback_group,
|
|
gint fallback_level);
|
|
EekSymbol *eek_key_get_symbol_at_index (EekKey *key,
|
|
gint group,
|
|
gint level,
|
|
gint fallback_group,
|
|
gint fallback_level);
|
|
|
|
void eek_key_set_index (EekKey *key,
|
|
gint column,
|
|
gint row);
|
|
void eek_key_get_index (EekKey *key,
|
|
gint *column,
|
|
gint *row);
|
|
|
|
void eek_key_set_oref (EekKey *key,
|
|
guint oref);
|
|
guint eek_key_get_oref (EekKey *key);
|
|
|
|
gboolean eek_key_is_pressed (EekKey *key);
|
|
gboolean eek_key_is_locked (EekKey *key);
|
|
void eek_key_set_pressed (EekKey *key,
|
|
gboolean value);
|
|
|
|
G_END_DECLS
|
|
#endif /* EEK_KEY_H */
|