lyx_mirror/src/kbmap.h
Lars Gullik Bjønnes 482c04ecca use more specific smart_ptr headers
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@4183 a592a061-630c-0410-9148-cb99ea01b6c8
2002-05-22 01:16:37 +00:00

100 lines
2.0 KiB
C++
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

// -*- C++ -*-
/**
* \file kbmap.h
* Copyright 1995-2002 the LyX Team
* Read the file COPYING
*
* \author Lars Gullik Bjønnes <larsbj@lyx.org>
* \author John Levon <moz@compsoc.man.ac.uk>
*/
#ifndef KBMAP_H
#define KBMAP_H
#ifdef __GNUG__
#pragma interface
#endif
#include "LString.h"
#include <boost/shared_ptr.hpp>
#include <list>
class kb_sequence;
/// Defines key maps and actions for key sequences
class kb_keymap {
public:
/**
* Bind a key sequence to an action.
* @return 0 on success, or position in string seq where error
* occurs.
*/
string::size_type bind(string const & seq, int action);
/// print all available keysyms
string const print() const;
/**
* Look up a key press in the keymap.
* @param key the keysym
* @param mod the modifiers
* @param seq the current key sequence so far
* @return the action / LFUN_PREFIX / LFUN_UNKNOWN_ACTION
*/
int lookup(unsigned int key,
unsigned int mod, kb_sequence * seq) const;
/// Given an action, find all keybindings.
string const findbinding(int action,
string const & prefix = string()) const;
/**
* Returns a string of the given keysym, with modifiers.
* @param key the key
* @param mod the modifiers
*/
static string const printKeysym(unsigned int key, unsigned int mod);
/// return the ISO value of a keysym
static char getiso(unsigned int i);
private:
///
struct kb_key {
/// Keysym
unsigned int code;
/// Modifier masks
unsigned int mod;
/// Keymap for prefix keys
boost::shared_ptr<kb_keymap> table;
/// Action for !prefix keys
int action;
};
/**
* Define an action for a key sequence.
* @param r internal recursion level
*/
void defkey(kb_sequence * seq, int action, unsigned int r = 0);
/// Returns a string of the given key
string const printKey(kb_key const & key) const;
/// is the table empty ?
bool empty() const {
return table.empty();
}
///
typedef std::list<kb_key> Table;
///
Table table;
};
#endif // KBMAP_H