~ubuntu-branches/debian/squeeze/sword/squeeze

« back to all changes in this revision

Viewing changes to include/swoptfilter.h

  • Committer: Bazaar Package Importer
  • Author(s): Jonathan Marsden, Jonathan Marsden, Dmitrijs Ledkovs, Closed Bugs
  • Date: 2009-05-30 11:55:55 UTC
  • mfrom: (1.3.1 upstream) (6.1.1 experimental)
  • Revision ID: james.westby@ubuntu.com-20090530115555-r427zsn3amivdpfu
Tags: 1.6.0+dfsg-1
[ Jonathan Marsden ]
* New upstream release. (Closes: #507960) (LP: #320558)
* debian/patches/02_libver.diff:
  - Bump SONAME to 8 -- SWORD 1.6 is not backward compatible with 1.5.11.
* debian/patches/series:
  - Remove 10_diatheke.diff -- included in upstream source.
* debian/patches/:
  - Remove several old unused .diff files.
  - Add 11_regex_only_when_needed.diff to conditionally include regex lib.
  - Add 12_fix_compiler_warnings.diff to remove all compiler warnings.
  - Add 13_fix_osis2mod_compression_default.diff from upstream svn.
  - Add 14_closing_section_not_chapter.diff from upstream svn.
* debian/libsword7.*: 
  - Rename to libsword8.*
  - Change libsword7 to libsword8 within files.
* debian/rules: 
  - SONAME bump to 8.
  - Set library version check to >= 1.6
* debian/control:
  - Change libsword7 to libsword8.
  - Add libsword7 to Conflicts.
  - Fix case of sword to SWORD in package descriptions.
  - Bump Standards-Version to 3.8.1 (no changes needed).
  - Fix section for libsword-dbg to avoid lintian warning.
* debian/rules:
  - Add DFSG get-orig-source target.
* debian/copyright:
  - Fix various mistakes in initial attempt to document copyrights.

[ Dmitrijs Ledkovs ]
* debian/rules: Added utils.mk to use missing-files target and call it on
  each build.
* debian/libsword-dev.install: Added libsword.la, previously missing.
* debian/libsword7.install: Added missing libicu translit files.
* debian/control:
  - Updated all uses of SWORD version to 1.6
  - Added libsword-dbg package
* debian/watch: Fixed a small mistake which was resulting in extra "."
  in final version name.
* debian/rules: simplified manpage processing.
* debian/libsword8.lintian-overrides: added override for module
  installation directory.
* debian/copyright: Updated with information about everyfile.
  Closes: #513448 LP: #322638
* debian/diatheke.examples: moved examples here from the diatheke.install
* debian/rules:
  - enabled shell script based testsuite
  - added commented out cppunit testsuite
* debian/patches/40_missing_includes.diff: 
  - added several missing stdio.h includes to prevent FTBFS of testsuite.

[ Closed Bugs ]
* FTBFS on intrepid (LP: #305172)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/***************************************************************************
 
2
 *
 
3
 * $Id: swoptfilter.h 1864 2005-11-20 06:06:40Z scribe $
 
4
 *
 
5
 * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
 
6
 *      CrossWire Bible Society
 
7
 *      P. O. Box 2528
 
8
 *      Tempe, AZ  85280-2528
 
9
 *
 
10
 * This program is free software; you can redistribute it and/or modify it
 
11
 * under the terms of the GNU General Public License as published by the
 
12
 * Free Software Foundation version 2.
 
13
 *
 
14
 * This program is distributed in the hope that it will be useful, but
 
15
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 
16
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 
17
 * General Public License for more details.
 
18
 *
 
19
 */
 
20
 
 
21
#ifndef SWOPTFILTER_H
 
22
#define SWOPTFILTER_H
 
23
 
 
24
#include <swfilter.h>
 
25
#include <swbuf.h>
 
26
#include <list>
 
27
 
 
28
SWORD_NAMESPACE_START
 
29
 
 
30
/**
 
31
* The type definitoin for option types
 
32
*/
 
33
typedef std::list < SWBuf > StringList;
 
34
 
 
35
 
 
36
  /** Base class for all option filters.
 
37
  */
 
38
class SWDLLEXPORT SWOptionFilter : public SWFilter {
 
39
protected:
 
40
        SWBuf optionValue;
 
41
        const char *optName;
 
42
        const char *optTip;
 
43
        const StringList *optValues;
 
44
        bool option;
 
45
public:
 
46
 
 
47
        SWOptionFilter();
 
48
        SWOptionFilter(const char *oName, const char *oTip, const StringList *oValues);
 
49
        virtual ~SWOptionFilter();
 
50
 
 
51
 
 
52
        /** gets the name of the option of this filter
 
53
         * @return option name
 
54
         */
 
55
        virtual const char *getOptionName() { return optName; }
 
56
 
 
57
        /** gets a short explanation of the option of this filter;
 
58
         * it could be presented to the user in frontend programs
 
59
         * @return option tip/explanation
 
60
         */
 
61
        virtual const char *getOptionTip() { return optTip; }
 
62
 
 
63
        /** returns a list of the possible option values
 
64
         * 
 
65
         * @return list of option values
 
66
         */
 
67
        virtual StringList getOptionValues() { return *optValues; }
 
68
 
 
69
        /** @return The value of the current option.
 
70
        */
 
71
        virtual const char *getOptionValue();
 
72
 
 
73
        /** sets the value of the option of this filter,
 
74
         * e.g maybe a strong's filter mioght be set to "on" / "off" -
 
75
         * that would mean to show or not to show the strongs in the text,
 
76
         * see also getOptionValues()
 
77
         * @param ival the new option value
 
78
         */
 
79
        virtual void setOptionValue(const char *ival);
 
80
 
 
81
};
 
82
 
 
83
SWORD_NAMESPACE_END
 
84
#endif