/ 
Sword-0.102800
River stage zero No dependents
/ Sword::Module

NAME

Sword::Module - Sword modules (Bibles, commentaries, dictionaries, etc.)

VERSION

version 0.102800

SYNOPSIS

use Sword;

my $library = Sword::Manager->new;

my $module = $library->get_module('KJV');
$module->set_key('jn3.16');
print "John 3:16 says (KJV): ", $module->render_text, "\n";

$module->increment(2);
print "John 3:18 says (KJV): ", $module->render_text, "\n";

$module->decrement;
print "John 3:17 says (KJV): ", $module->render_text, "\n";

DESCRIPTION

This Perl module provides access to the SWModule class from the Sword Engine API.

This documetnation should cover everything that you can do with it. If something is wrong or missing, please report a bug.

METHODS

name

my $name = $module->name;
$module->name($new_name);

This is the getter/setter for the short name of the module.

description

my $description = $module->description;
$module->description($new_description);

This is the getter/setter for the long description of the module.

type

my $type = $module->type;
$module->type($new_type);

This is the getter/setter for the type of the module. This is the name of the category this module belongs to, like "Biblical Texts" or "Lexicons / Dictionaries".

set_key

$module->set_key($key);

This selects a key pointing into the text. The kind of key value used depends on the module. For example, in a Bible or commentary, this may be a scripture reference or an abbreviation of one like "John 3:16" or "Ps 23" or "rm8.28". In a dictionary, this may be a word or word number.

increment

decrement

$module->increment;
$module->increment($steps);
$module->decrement;
$module->decrement($steps);

Use increment to moves the key one or more steps forward of the current. Use decrement to move the key backward. If $steps is omitted, the increment/decrement defaults to 1.

top

bottom

$module->top
$module->bottom

These set the module key to the beginning or end position, respectively.

These are analogous to:

module->setPosition(TOP);
module->setPosition(BOTTOM);

in the C++ API.

strip_text

my $str = $module->strip_text;

Show the unfiltered plain text for the current key/position in the module.

render_text

my $str = $module->render_text;

Returns the the text for the key that has been selected.

SEE ALSO

Sword::Manager

AUTHOR

Andrew Sterling Hanenkamp <hanenkamp@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2010 by Qubling Software LLC.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.