swift::SKeymap Class Reference

The readline keymap wrapper. Attention: It is not thread safe! Supports: key binding, key unbinding. More...

#include <SReadline.h>

List of all members.

Public Member Functions

 SKeymap (bool PrintableBound=false)
 Creates a new keymap.
 SKeymap (Keymap Pattern)
 Creates a new keymap which is a copy of Pattern.
 ~SKeymap ()
 Frees the allocated keymap.
void Bind (int Key, KeyCallback Callback)
 Binds the given key to a function.
void Unbind (int Key)
 Unbinds the given key.
 SKeymap (const SKeymap &rhs)
 Copy constructor.
SKeymapoperator= (const SKeymap &rhs)
 operator=

Friends

class SReadline


Detailed Description

The readline keymap wrapper. Attention: It is not thread safe! Supports: key binding, key unbinding.

Definition at line 264 of file SReadline.h.


Constructor & Destructor Documentation

swift::SKeymap::SKeymap bool  PrintableBound = false  )  [inline, explicit]
 

Creates a new keymap.

Parameters:
PrintableBound if true - the printable characters are bound if false - the keymap is empty

Definition at line 274 of file SReadline.h.

swift::SKeymap::SKeymap Keymap  Pattern  )  [inline, explicit]
 

Creates a new keymap which is a copy of Pattern.

Parameters:
Pattern A keymap to be copied

Definition at line 298 of file SReadline.h.

swift::SKeymap::SKeymap const SKeymap rhs  )  [inline]
 

Copy constructor.

Parameters:
rhs Right hand side object of SKeymap

Definition at line 351 of file SReadline.h.

References keymap.


Member Function Documentation

void swift::SKeymap::Bind int  Key,
KeyCallback  Callback
[inline]
 

Binds the given key to a function.

Parameters:
Key A key to be bound
Callback A function to be called when the Key is pressed

Definition at line 323 of file SReadline.h.

SKeymap& swift::SKeymap::operator= const SKeymap rhs  )  [inline]
 

operator=

Parameters:
rhs Right hand side object of SKeymap

Definition at line 363 of file SReadline.h.

References keymap.

void swift::SKeymap::Unbind int  Key  )  [inline]
 

Unbinds the given key.

Parameters:
Key A key to be unbound

Definition at line 338 of file SReadline.h.


The documentation for this class was generated from the following file:
Generated on Mon May 8 21:58:24 2006 for SReadline - C++ Wrapper Around readline Library by  doxygen 1.4.5