common/scim-bridge-key-event.h

Go to the documentation of this file.

/*
 * SCIM Bridge
 *
 * Copyright (c) 2006 Ryo Dairiki <ryo-dairiki@users.sourceforge.net>
 *
 *
 * 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 and 
 * appearing in the file LICENSE.LGPL included in the package of this file.
 * You can also redistribute it and/or modify it under the terms of 
 * the GNU General Public License as published by the Free Software Foundation and 
 * appearing in the file LICENSE.GPL included in the package of this file.
 *
 * 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.
 */

#ifndef SCIM_BRIDGE_KEY_EVENT_H_
#define SCIM_BRIDGE_KEY_EVENT_H_

#include "scim-bridge.h"
#include "scim-bridge-key-code.h"

typedef unsigned int scim_bridge_key_quirk_t;

#define SCIM_BRIDGE_KEY_NO_QUIRK (0)

#define SCIM_BRIDGE_KEY_ALL_QUIRKS (0xF)

#define SCIM_BRIDGE_KEY_QUIRK_KANA_RO (1 << 1)

typedef struct _ScimBridgeKeyEvent ScimBridgeKeyEvent;

#ifdef __cplusplus
extern "C"
{
#endif

    ScimBridgeKeyEvent *scim_bridge_alloc_key_event ();

    void scim_bridge_free_key_event (ScimBridgeKeyEvent *key_event);

    scim_bridge_key_code_t scim_bridge_key_event_get_code (const ScimBridgeKeyEvent *key_event);

    void scim_bridge_key_event_set_code (ScimBridgeKeyEvent *key_event, scim_bridge_key_code_t key_code);

    boolean scim_bridge_key_event_is_pressed (const ScimBridgeKeyEvent *key_event);

    void scim_bridge_key_event_set_pressed (ScimBridgeKeyEvent *key_event, boolean pressed);


    void scim_bridge_key_event_clear_modifiers (ScimBridgeKeyEvent *key_event);


    boolean scim_bridge_key_event_is_shift_down (const ScimBridgeKeyEvent *key_event);

    void scim_bridge_key_event_set_shift_down (ScimBridgeKeyEvent *key_event, boolean down);

    boolean scim_bridge_key_event_is_caps_lock_down (const ScimBridgeKeyEvent *key_event);

    void scim_bridge_key_event_set_caps_lock_down (ScimBridgeKeyEvent *key_event, boolean down);

    boolean scim_bridge_key_event_is_control_down (const ScimBridgeKeyEvent *key_event);

    void scim_bridge_key_event_set_control_down (ScimBridgeKeyEvent *key_event, boolean down);

    boolean scim_bridge_key_event_is_alt_down (const ScimBridgeKeyEvent *key_event);

    void scim_bridge_key_event_set_alt_down (ScimBridgeKeyEvent *key_event, boolean down);

    boolean scim_bridge_key_event_is_meta_down (const ScimBridgeKeyEvent *key_event);

    void scim_bridge_key_event_set_meta_down (ScimBridgeKeyEvent *key_event, boolean down);

    boolean scim_bridge_key_event_is_super_down (const ScimBridgeKeyEvent *key_event);

    void scim_bridge_key_event_set_super_down (ScimBridgeKeyEvent *key_event, boolean down);

    boolean scim_bridge_key_event_is_hyper_down (const ScimBridgeKeyEvent *key_event);

    void scim_bridge_key_event_set_hyper_down (ScimBridgeKeyEvent *key_event, boolean down);

    boolean scim_bridge_key_event_is_num_lock_down (const ScimBridgeKeyEvent *key_event);

    void scim_bridge_key_event_set_num_lock_down (ScimBridgeKeyEvent *key_event, boolean down);
    
    boolean scim_bridge_key_event_is_quirk_enabled (const ScimBridgeKeyEvent *key_event, scim_bridge_key_quirk_t quirk);

    void scim_bridge_key_event_set_quirk_enabled (ScimBridgeKeyEvent *key_event, scim_bridge_key_quirk_t quirk, boolean enabled);
    
    void scim_bridge_key_event_clear_all_quirks (ScimBridgeKeyEvent *key_event);
    
#ifdef __cplusplus
}
#endif
#endif                                            /*SCIM_BRIDGE_KEY_EVENT_H_*/