Reference

swcom(3)

The basis for all commentary modules.

NAME

SWCom - The basis for all commentary modules.

SYNOPSIS

#include <swcom.h>

Inherits SWModule.

Inherited by HREFCom, RawCom, RawFiles, and zCom.

Public Methods

SWCom (const char *imodname=0, const char *imoddesc=0, SWDisplay *idisp=0, bool unicode=false)
Initializes data for instance of SWCom. virtual ~SWCom ()
virtual SWKey* CreateKey ()
Allocates a key of specific type for module.

DETAILED DESCRIPTION

The basis for all commentary modules.

Definition at line 33 of file swcom.h.

CONSTRUCTOR & DESTRUCTOR DOCUMENTATION

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

Initializes data for instance of SWCom.

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 * SWCom::CreateKey () [inline, virtual]

Allocates a key of specific type for module.

Returns: pointer to allocated key

Reimplemented from SWModule.

Definition at line 44 of file swcom.h.

AUTHOR

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