swift::SKeymap Class Reference

The readline keymap wrapper. More...

#include <opentrep/ui/cmdline/SReadline.hpp>

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.
SKeymap &	operator= (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 307 of file SReadline.hpp.

Constructor & Destructor Documentation

SKeymap() [1/3]

swift::SKeymap::SKeymap ( bool PrintableBound = false )

inlineexplicit

Creates a new keymap.

Parameters

PrintableBound

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

Definition at line 319 of file SReadline.hpp.

Referenced by operator=(), and SKeymap().

SKeymap() [2/3]

swift::SKeymap::SKeymap ( Keymap Pattern )

inlineexplicit

Creates a new keymap which is a copy of Pattern.

Parameters

Pattern

A keymap to be copied.

Definition at line 342 of file SReadline.hpp.

~SKeymap()

swift::SKeymap::~SKeymap ( )

inline

Frees the allocated keymap.

Definition at line 354 of file SReadline.hpp.

SKeymap() [3/3]

swift::SKeymap::SKeymap ( const SKeymap & rhs )

inline

Copy constructor.

Parameters

rhs	Right hand side object of SKeymap

Definition at line 395 of file SReadline.hpp.

References SKeymap().

Member Function Documentation

Bind()

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 366 of file SReadline.hpp.

Unbind()

void swift::SKeymap::Unbind ( int Key )

inline

Unbinds the given key.

Parameters

Key	A key to be unbound

Definition at line 381 of file SReadline.hpp.

operator=()

SKeymap & swift::SKeymap::operator= ( const SKeymap & rhs )

inline

operator=

Parameters

rhs	Right hand side object of SKeymap

Definition at line 407 of file SReadline.hpp.

References SKeymap().

Friends And Related Symbol Documentation

SReadline

friend class SReadline

friend

Definition at line 415 of file SReadline.hpp.

References SReadline.

Referenced by SReadline.

---

The documentation for this class was generated from the following file:

• opentrep/ui/cmdline/SReadline.hpp