common/scim-bridge-key-event.h

Go to the documentation of this file.
00001 /*
00002  * SCIM Bridge
00003  *
00004  * Copyright (c) 2006 Ryo Dairiki <ryo-dairiki@users.sourceforge.net>
00005  *
00006  *
00007  * This library is free software; you can redistribute it and/or
00008  * modify it under the terms of the GNU Lesser General Public
00009  * License as published by the Free Software Foundation; either
00010  * version 2 of the License, or (at your option) any later version.*
00011  * This library is distributed in the hope that it will be useful,
00012  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00013  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
00014  * GNU Lesser General Public License for more details.*
00015  * You should have received a copy of the GNU Lesser General Public
00016  * License along with this program; if not, write to the
00017  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
00018  * Boston, MA  02111-1307  USA
00019  */
00020 
00026 #ifndef SCIM_BRIDGE_KEY_EVENT_H_
00027 #define SCIM_BRIDGE_KEY_EVENT_H_
00028 
00029 #include "scim-bridge.h"
00030 #include "scim-bridge-key-code.h"
00031 
00035 typedef struct _ScimBridgeKeyEvent ScimBridgeKeyEvent;
00036 
00037 #ifdef __cplusplus
00038 extern "C"
00039 {
00040 #endif
00041 
00047     ScimBridgeKeyEvent *scim_bridge_alloc_key_event ();
00048 
00055     void scim_bridge_free_key_event (ScimBridgeKeyEvent *key_event);
00056 
00063     scim_bridge_key_code_t scim_bridge_key_event_get_code (const ScimBridgeKeyEvent *key_event);
00064 
00071     void scim_bridge_key_event_set_code (ScimBridgeKeyEvent *key_event, scim_bridge_key_code_t key_code);
00072 
00079     boolean scim_bridge_key_event_is_pressed (const ScimBridgeKeyEvent *key_event);
00080 
00087     void scim_bridge_key_event_set_pressed (ScimBridgeKeyEvent *key_event, boolean pressed);
00088 
00089 
00095     void scim_bridge_key_event_clear_modifiers (ScimBridgeKeyEvent *key_event);
00096 
00097 
00104     boolean scim_bridge_key_event_is_shift_down (const ScimBridgeKeyEvent *key_event);
00105 
00112     void scim_bridge_key_event_set_shift_down (ScimBridgeKeyEvent *key_event, boolean down);
00113 
00120     boolean scim_bridge_key_event_is_caps_lock_down (const ScimBridgeKeyEvent *key_event);
00121 
00128     void scim_bridge_key_event_set_caps_lock_down (ScimBridgeKeyEvent *key_event, boolean down);
00129 
00136     boolean scim_bridge_key_event_is_control_down (const ScimBridgeKeyEvent *key_event);
00137 
00144     void scim_bridge_key_event_set_control_down (ScimBridgeKeyEvent *key_event, boolean down);
00145 
00152     boolean scim_bridge_key_event_is_alt_down (const ScimBridgeKeyEvent *key_event);
00153 
00160     void scim_bridge_key_event_set_alt_down (ScimBridgeKeyEvent *key_event, boolean down);
00161 
00168     boolean scim_bridge_key_event_is_meta_down (const ScimBridgeKeyEvent *key_event);
00169 
00176     void scim_bridge_key_event_set_meta_down (ScimBridgeKeyEvent *key_event, boolean down);
00177 
00184     boolean scim_bridge_key_event_is_super_down (const ScimBridgeKeyEvent *key_event);
00185 
00192     void scim_bridge_key_event_set_super_down (ScimBridgeKeyEvent *key_event, boolean down);
00193 
00200     boolean scim_bridge_key_event_is_hyper_down (const ScimBridgeKeyEvent *key_event);
00201 
00208     void scim_bridge_key_event_set_hyper_down (ScimBridgeKeyEvent *key_event, boolean down);
00209 
00216     boolean scim_bridge_key_event_is_num_lock_down (const ScimBridgeKeyEvent *key_event);
00217 
00224     void scim_bridge_key_event_set_num_lock_down (ScimBridgeKeyEvent *key_event, boolean down);
00225 
00226 #ifdef __cplusplus
00227 }
00228 #endif
00229 #endif                                            /*SCIM_BRIDGE_KEY_EVENT_H_*/

Generated on Tue Sep 26 21:53:41 2006 for ScimBridge by  doxygen 1.4.6