aboutsummaryrefslogtreecommitdiff
path: root/libbible.h
diff options
context:
space:
mode:
authorYour Name <you@example.com>2020-11-21 14:33:33 -0500
committerYour Name <you@example.com>2020-11-21 14:33:33 -0500
commit51734065a38cf6db48fe9fb4b16461ce424cad90 (patch)
tree9abea3db7c02d7eb957256062f8a71d6a7672e35 /libbible.h
parentdcfac3432f981191da68f14f21f5010fc4da51c0 (diff)
downloadlibbible-51734065a38cf6db48fe9fb4b16461ce424cad90.tar.gz
libbible-51734065a38cf6db48fe9fb4b16461ce424cad90.tar.bz2
libbible-51734065a38cf6db48fe9fb4b16461ce424cad90.zip
Updated API to be more explicit with references
Diffstat (limited to 'libbible.h')
-rw-r--r--libbible.h20
1 files changed, 13 insertions, 7 deletions
diff --git a/libbible.h b/libbible.h
index 85ea9eb..c1058e7 100644
--- a/libbible.h
+++ b/libbible.h
@@ -3,7 +3,7 @@
#include <map>
namespace libbible {
-
+
struct text {
int chapter;
int verse;
@@ -17,7 +17,6 @@ namespace libbible {
std::string modName;
std::string book;
std::string bookShort;
- std::string reference;
int chapterStart;
int verseStart;
int chapterEnd;
@@ -35,13 +34,20 @@ namespace libbible {
std::vector<struct passage> getPassages(std::string modName, std::string book);
/*
+ * @param modName the module to use for determining the passage
+ * @param reference a human-readable reference, e.g., "gen 1:26-27"
+ * @return the passage matching the reference
+ */
+ passage getPassage(std::string modName, std::string reference);
+
+ /*
* @return Text for a passage
*/
std::vector<struct text> getText(struct passage pass);
/**************************
- * Methods dealing with mods
- ***************************/
+ * Methods dealing with mods
+ ***************************/
class Status {
public:
@@ -82,9 +88,9 @@ namespace libbible {
void uninstallMod(std::string modname);
/******************************
- * Methods dealing with settings
- *******************************/
-
+ * Methods dealing with settings
+ *******************************/
+
/*
* From already established code, valid and useful values are:
* int fontsize: the last used size of the font