swld(3)

swld3

The basis for all types of lexicon and dictionary modules (hence the 'ld').

Usage

#include <swld.h>

Inherits SWModule.

Inherited by RawLD, and RawLD4.

Public Methods

SWLD (const char *imodname=0, const char *imoddesc=0, SWDisplay *idisp=0, bool unicode=false)
Initializes data for instance of SWLD. virtual ~SWLD ()
virtual SWKey* CreateKey ()
Allocates a key of specific type for module. virtual const char* KeyText (const char *ikeytext)
Sets/gets module KeyText, getting from saved text if key is persistent.

Protected Attributes

char* entkeytxt

Detailed description

the basis for all types of Lexicon and Dictionary modules (hence the 'LD').

Definition at line 34 of file swld.h.

Constructor & destructor documentation

SWLD::SWLD (const char * imodname = 0, const char * imoddesc = 0, SWDisplay * idisp = 0, bool unicode = false)

Initializes data for instance of SWLD.

Parameters:

imodname

Internal name for module

imoddesc

Name to display to user for module

idisp

Display object to use for displaying

Member function documentation

SWKey * SWLD::CreateKey () [inline, virtual]

Allocates a key of specific type for module.

Returns: pointer to allocated key

Reimplemented from SWModule.

Definition at line 47 of file swld.h.

const char * SWLD::KeyText (const char * ikeytext) [virtual]

Sets/gets module KeyText, getting from saved text if key is persistent.

Parameters:

ikeytext

value which to set keytext; [0] - only get

Returns: pointer to keytext

Reimplemented from SWModule.

Author

Generated automatically by Doxygen for The Sword Project from the source code.

From libsword-dev 1.5.3-3woody2 in Debian 3.0 (Woody). Parsed by carta from the page's man source.