Documentation

This commit is contained in:
Tim Bentley 2009-07-10 18:19:13 +01:00
parent 8079eaf982
commit ecd587319b
35 changed files with 4408 additions and 0 deletions

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

View File

@ -0,0 +1,44 @@
.. _core-index:
:mod:`core` Module
==================
.. automodule:: openlp.core
:members:
:mod:`lib` Module
-----------------
.. automodule:: openlp.core.lib
:members:
:mod:`baselistwithdnd` Submodule
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: openlp.core.lib.baselistwithdnd
:members:
:mod:`event` Submodule
^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: openlp.core.lib.event
:members:
:mod:`eventmanager` Submodule
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: openlp.core.lib.eventmanager
:members:
:mod:`eventreceiver` Submodule
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: openlp.core.lib.eventreceiver
:members:
:mod:`theme` Submodule
----------------------
.. automodule:: openlp.core.theme
:members:

View File

@ -0,0 +1,25 @@
.. OpenLP documentation master file, created by
sphinx-quickstart on Fri Jul 10 17:20:40 2009.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to OpenLP's documentation!
==================================
Contents:
.. toctree::
:maxdepth: 2
openlp
core/index
migration/index
plugins/index
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

View File

@ -0,0 +1,32 @@
.. _migration-index:
:mod:`migration` Module
=======================
.. automodule:: openlp.migration
:members:
:mod:`display` Submodule
------------------------
.. automodule:: openlp.migration.display
:members:
:mod:`migratebibles` Submodule
------------------------------
.. automodule:: openlp.migration.migratebibles
:members:
:mod:`migratefiles` Submodule
-----------------------------
.. automodule:: openlp.migration.migratefiles
:members:
:mod:`migratesongs` Submodule
-----------------------------
.. automodule:: openlp.migration.migratesongs
:members:

View File

@ -0,0 +1,7 @@
.. _openlp:
:mod:`openlp` Module
====================
.. automodule:: openlp
:members:

View File

@ -0,0 +1,44 @@
.. _plugins-index:
:mod:`plugins` Module
=====================
.. automodule:: openlp.plugins
:members:
:mod:`songs` Plugin
-------------------
.. automodule:: openlp.plugins.songs
:members:
:mod:`bibles` Plugin
--------------------
.. automodule:: openlp.plugins.bibles
:members:
:mod:`presentations` Plugin
---------------------------
.. automodule:: openlp.plugins.presentations
:members:
:mod:`media` Plugin
-------------------
.. automodule:: openlp.plugins.media
:members:
:mod:`images` Plugin
--------------------
.. automodule:: openlp.plugins.images
:members:
:mod:`custom` Plugin
--------------------
.. automodule:: openlp.plugins.custom
:members:

Binary file not shown.

After

Width:  |  Height:  |  Size: 202 B

View File

@ -0,0 +1,657 @@
/**
* Sphinx Doc Design
*/
body {
font-family: sans-serif;
font-size: 100%;
background-color: #11303d;
color: #000;
margin: 0;
padding: 0;
}
/* :::: LAYOUT :::: */
div.document {
background-color: #1c4e63;
}
div.documentwrapper {
float: left;
width: 100%;
}
div.bodywrapper {
margin: 0 0 0 230px;
}
div.body {
background-color: white;
padding: 0 20px 30px 20px;
}
div.sphinxsidebarwrapper {
padding: 10px 5px 0 10px;
}
div.sphinxsidebar {
float: left;
width: 230px;
margin-left: -100%;
font-size: 90%;
}
div.clearer {
clear: both;
}
div.footer {
color: #fff;
width: 100%;
padding: 9px 0 9px 0;
text-align: center;
font-size: 75%;
}
div.footer a {
color: #fff;
text-decoration: underline;
}
div.related {
background-color: #133f52;
color: #fff;
width: 100%;
line-height: 30px;
font-size: 90%;
}
div.related h3 {
display: none;
}
div.related ul {
margin: 0;
padding: 0 0 0 10px;
list-style: none;
}
div.related li {
display: inline;
}
div.related li.right {
float: right;
margin-right: 5px;
}
div.related a {
color: white;
}
/* ::: TOC :::: */
div.sphinxsidebar h3 {
font-family: 'Trebuchet MS', sans-serif;
color: white;
font-size: 1.4em;
font-weight: normal;
margin: 0;
padding: 0;
}
div.sphinxsidebar h3 a {
color: white;
}
div.sphinxsidebar h4 {
font-family: 'Trebuchet MS', sans-serif;
color: white;
font-size: 1.3em;
font-weight: normal;
margin: 5px 0 0 0;
padding: 0;
}
div.sphinxsidebar p {
color: white;
}
div.sphinxsidebar p.topless {
margin: 5px 10px 10px 10px;
}
div.sphinxsidebar ul {
margin: 10px;
padding: 0;
list-style: none;
color: white;
}
div.sphinxsidebar ul ul,
div.sphinxsidebar ul.want-points {
margin-left: 20px;
list-style: square;
}
div.sphinxsidebar ul ul {
margin-top: 0;
margin-bottom: 0;
}
div.sphinxsidebar a {
color: #98dbcc;
}
div.sphinxsidebar form {
margin-top: 10px;
}
div.sphinxsidebar input {
border: 1px solid #98dbcc;
font-family: sans-serif;
font-size: 1em;
}
/* :::: MODULE CLOUD :::: */
div.modulecloud {
margin: -5px 10px 5px 10px;
padding: 10px;
line-height: 160%;
border: 1px solid #cbe7e5;
background-color: #f2fbfd;
}
div.modulecloud a {
padding: 0 5px 0 5px;
}
/* :::: SEARCH :::: */
ul.search {
margin: 10px 0 0 20px;
padding: 0;
}
ul.search li {
padding: 5px 0 5px 20px;
background-image: url(file.png);
background-repeat: no-repeat;
background-position: 0 7px;
}
ul.search li a {
font-weight: bold;
}
ul.search li div.context {
color: #888;
margin: 2px 0 0 30px;
text-align: left;
}
ul.keywordmatches li.goodmatch a {
font-weight: bold;
}
/* :::: COMMON FORM STYLES :::: */
div.actions {
padding: 5px 10px 5px 10px;
border-top: 1px solid #cbe7e5;
border-bottom: 1px solid #cbe7e5;
background-color: #e0f6f4;
}
form dl {
color: #333;
}
form dt {
clear: both;
float: left;
min-width: 110px;
margin-right: 10px;
padding-top: 2px;
}
input#homepage {
display: none;
}
div.error {
margin: 5px 20px 0 0;
padding: 5px;
border: 1px solid #d00;
font-weight: bold;
}
/* :::: INDEX PAGE :::: */
table.contentstable {
width: 90%;
}
table.contentstable p.biglink {
line-height: 150%;
}
a.biglink {
font-size: 1.3em;
}
span.linkdescr {
font-style: italic;
padding-top: 5px;
font-size: 90%;
}
/* :::: INDEX STYLES :::: */
table.indextable td {
text-align: left;
vertical-align: top;
}
table.indextable dl, table.indextable dd {
margin-top: 0;
margin-bottom: 0;
}
table.indextable tr.pcap {
height: 10px;
}
table.indextable tr.cap {
margin-top: 10px;
background-color: #f2f2f2;
}
img.toggler {
margin-right: 3px;
margin-top: 3px;
cursor: pointer;
}
form.pfform {
margin: 10px 0 20px 0;
}
/* :::: GLOBAL STYLES :::: */
.docwarning {
background-color: #ffe4e4;
padding: 10px;
margin: 0 -20px 0 -20px;
border-bottom: 1px solid #f66;
}
p.subhead {
font-weight: bold;
margin-top: 20px;
}
a {
color: #355f7c;
text-decoration: none;
}
a:hover {
text-decoration: underline;
}
div.body h1,
div.body h2,
div.body h3,
div.body h4,
div.body h5,
div.body h6 {
font-family: 'Trebuchet MS', sans-serif;
background-color: #f2f2f2;
font-weight: normal;
color: #20435c;
border-bottom: 1px solid #ccc;
margin: 20px -20px 10px -20px;
padding: 3px 0 3px 10px;
}
div.body h1 { margin-top: 0; font-size: 200%; }
div.body h2 { font-size: 160%; }
div.body h3 { font-size: 140%; }
div.body h4 { font-size: 120%; }
div.body h5 { font-size: 110%; }
div.body h6 { font-size: 100%; }
a.headerlink {
color: #c60f0f;
font-size: 0.8em;
padding: 0 4px 0 4px;
text-decoration: none;
visibility: hidden;
}
h1:hover > a.headerlink,
h2:hover > a.headerlink,
h3:hover > a.headerlink,
h4:hover > a.headerlink,
h5:hover > a.headerlink,
h6:hover > a.headerlink,
dt:hover > a.headerlink {
visibility: visible;
}
a.headerlink:hover {
background-color: #c60f0f;
color: white;
}
div.body p, div.body dd, div.body li {
text-align: justify;
line-height: 130%;
}
div.body p.caption {
text-align: inherit;
}
div.body td {
text-align: left;
}
ul.fakelist {
list-style: none;
margin: 10px 0 10px 20px;
padding: 0;
}
.field-list ul {
padding-left: 1em;
}
.first {
margin-top: 0 !important;
}
/* "Footnotes" heading */
p.rubric {
margin-top: 30px;
font-weight: bold;
}
/* Sidebars */
div.sidebar {
margin: 0 0 0.5em 1em;
border: 1px solid #ddb;
padding: 7px 7px 0 7px;
background-color: #ffe;
width: 40%;
float: right;
}
p.sidebar-title {
font-weight: bold;
}
/* "Topics" */
div.topic {
background-color: #eee;
border: 1px solid #ccc;
padding: 7px 7px 0 7px;
margin: 10px 0 10px 0;
}
p.topic-title {
font-size: 1.1em;
font-weight: bold;
margin-top: 10px;
}
/* Admonitions */
div.admonition {
margin-top: 10px;
margin-bottom: 10px;
padding: 7px;
}
div.admonition dt {
font-weight: bold;
}
div.admonition dl {
margin-bottom: 0;
}
div.admonition p.admonition-title + p {
display: inline;
}
div.seealso {
background-color: #ffc;
border: 1px solid #ff6;
}
div.warning {
background-color: #ffe4e4;
border: 1px solid #f66;
}
div.note {
background-color: #eee;
border: 1px solid #ccc;
}
p.admonition-title {
margin: 0px 10px 5px 0px;
font-weight: bold;
display: inline;
}
p.admonition-title:after {
content: ":";
}
div.body p.centered {
text-align: center;
margin-top: 25px;
}
table.docutils {
border: 0;
}
table.docutils td, table.docutils th {
padding: 1px 8px 1px 0;
border-top: 0;
border-left: 0;
border-right: 0;
border-bottom: 1px solid #aaa;
}
table.field-list td, table.field-list th {
border: 0 !important;
}
table.footnote td, table.footnote th {
border: 0 !important;
}
.field-list ul {
margin: 0;
padding-left: 1em;
}
.field-list p {
margin: 0;
}
dl {
margin-bottom: 15px;
clear: both;
}
dd p {
margin-top: 0px;
}
dd ul, dd table {
margin-bottom: 10px;
}
dd {
margin-top: 3px;
margin-bottom: 10px;
margin-left: 30px;
}
.refcount {
color: #060;
}
dt:target,
.highlight {
background-color: #fbe54e;
}
dl.glossary dt {
font-weight: bold;
font-size: 1.1em;
}
th {
text-align: left;
padding-right: 5px;
}
pre {
padding: 5px;
background-color: #efc;
color: #333;
border: 1px solid #ac9;
border-left: none;
border-right: none;
overflow: auto;
}
td.linenos pre {
padding: 5px 0px;
border: 0;
background-color: transparent;
color: #aaa;
}
table.highlighttable {
margin-left: 0.5em;
}
table.highlighttable td {
padding: 0 0.5em 0 0.5em;
}
tt {
background-color: #ecf0f3;
padding: 0 1px 0 1px;
font-size: 0.95em;
}
tt.descname {
background-color: transparent;
font-weight: bold;
font-size: 1.2em;
}
tt.descclassname {
background-color: transparent;
}
tt.xref, a tt {
background-color: transparent;
font-weight: bold;
}
.footnote:target { background-color: #ffa }
h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt {
background-color: transparent;
}
.optional {
font-size: 1.3em;
}
.versionmodified {
font-style: italic;
}
form.comment {
margin: 0;
padding: 10px 30px 10px 30px;
background-color: #eee;
}
form.comment h3 {
background-color: #326591;
color: white;
margin: -10px -30px 10px -30px;
padding: 5px;
font-size: 1.4em;
}
form.comment input,
form.comment textarea {
border: 1px solid #ccc;
padding: 2px;
font-family: sans-serif;
font-size: 100%;
}
form.comment input[type="text"] {
width: 240px;
}
form.comment textarea {
width: 100%;
height: 200px;
margin-bottom: 10px;
}
.system-message {
background-color: #fda;
padding: 5px;
border: 3px solid red;
}
img.math {
vertical-align: middle;
}
div.math p {
text-align: center;
}
span.eqno {
float: right;
}
img.logo {
border: 0;
}
/* :::: PRINT :::: */
@media print {
div.document,
div.documentwrapper,
div.bodywrapper {
margin: 0;
width : 100%;
}
div.sphinxsidebar,
div.related,
div.footer,
div#comments div.new-comment-box,
#top-link {
display: none;
}
}

View File

@ -0,0 +1,232 @@
/// XXX: make it cross browser
/**
* make the code below compatible with browsers without
* an installed firebug like debugger
*/
if (!window.console || !console.firebug) {
var names = ["log", "debug", "info", "warn", "error", "assert", "dir", "dirxml",
"group", "groupEnd", "time", "timeEnd", "count", "trace", "profile", "profileEnd"];
window.console = {};
for (var i = 0; i < names.length; ++i)
window.console[names[i]] = function() {}
}
/**
* small helper function to urldecode strings
*/
jQuery.urldecode = function(x) {
return decodeURIComponent(x).replace(/\+/g, ' ');
}
/**
* small helper function to urlencode strings
*/
jQuery.urlencode = encodeURIComponent;
/**
* This function returns the parsed url parameters of the
* current request. Multiple values per key are supported,
* it will always return arrays of strings for the value parts.
*/
jQuery.getQueryParameters = function(s) {
if (typeof s == 'undefined')
s = document.location.search;
var parts = s.substr(s.indexOf('?') + 1).split('&');
var result = {};
for (var i = 0; i < parts.length; i++) {
var tmp = parts[i].split('=', 2);
var key = jQuery.urldecode(tmp[0]);
var value = jQuery.urldecode(tmp[1]);
if (key in result)
result[key].push(value);
else
result[key] = [value];
}
return result;
}
/**
* small function to check if an array contains
* a given item.
*/
jQuery.contains = function(arr, item) {
for (var i = 0; i < arr.length; i++) {
if (arr[i] == item)
return true;
}
return false;
}
/**
* highlight a given string on a jquery object by wrapping it in
* span elements with the given class name.
*/
jQuery.fn.highlightText = function(text, className) {
function highlight(node) {
if (node.nodeType == 3) {
var val = node.nodeValue;
var pos = val.toLowerCase().indexOf(text);
if (pos >= 0 && !jQuery.className.has(node.parentNode, className)) {
var span = document.createElement("span");
span.className = className;
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
document.createTextNode(val.substr(pos + text.length)),
node.nextSibling));
node.nodeValue = val.substr(0, pos);
}
}
else if (!jQuery(node).is("button, select, textarea")) {
jQuery.each(node.childNodes, function() {
highlight(this)
});
}
}
return this.each(function() {
highlight(this);
});
}
/**
* Small JavaScript module for the documentation.
*/
var Documentation = {
init : function() {
this.fixFirefoxAnchorBug();
this.highlightSearchWords();
this.initModIndex();
},
/**
* i18n support
*/
TRANSLATIONS : {},
PLURAL_EXPR : function(n) { return n == 1 ? 0 : 1; },
LOCALE : 'unknown',
// gettext and ngettext don't access this so that the functions
// can savely bound to a different name (_ = Documentation.gettext)
gettext : function(string) {
var translated = Documentation.TRANSLATIONS[string];
if (typeof translated == 'undefined')
return string;
return (typeof translated == 'string') ? translated : translated[0];
},
ngettext : function(singular, plural, n) {
var translated = Documentation.TRANSLATIONS[singular];
if (typeof translated == 'undefined')
return (n == 1) ? singular : plural;
return translated[Documentation.PLURALEXPR(n)];
},
addTranslations : function(catalog) {
for (var key in catalog.messages)
this.TRANSLATIONS[key] = catalog.messages[key];
this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')');
this.LOCALE = catalog.locale;
},
/**
* add context elements like header anchor links
*/
addContextElements : function() {
$('div[@id] > :header:first').each(function() {
$('<a class="headerlink">\u00B6</a>').
attr('href', '#' + this.id).
attr('title', _('Permalink to this headline')).
appendTo(this);
});
$('dt[@id]').each(function() {
$('<a class="headerlink">\u00B6</a>').
attr('href', '#' + this.id).
attr('title', _('Permalink to this definition')).
appendTo(this);
});
},
/**
* workaround a firefox stupidity
*/
fixFirefoxAnchorBug : function() {
if (document.location.hash && $.browser.mozilla)
window.setTimeout(function() {
document.location.href += '';
}, 10);
},
/**
* highlight the search words provided in the url in the text
*/
highlightSearchWords : function() {
var params = $.getQueryParameters();
var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : [];
if (terms.length) {
var body = $('div.body');
window.setTimeout(function() {
$.each(terms, function() {
body.highlightText(this.toLowerCase(), 'highlight');
});
}, 10);
$('<li class="highlight-link"><a href="javascript:Documentation.' +
'hideSearchWords()">' + _('Hide Search Matches') + '</a></li>')
.appendTo($('.sidebar .this-page-menu'));
}
},
/**
* init the modindex toggle buttons
*/
initModIndex : function() {
var togglers = $('img.toggler').click(function() {
var src = $(this).attr('src');
var idnum = $(this).attr('id').substr(7);
console.log($('tr.cg-' + idnum).toggle());
if (src.substr(-9) == 'minus.png')
$(this).attr('src', src.substr(0, src.length-9) + 'plus.png');
else
$(this).attr('src', src.substr(0, src.length-8) + 'minus.png');
}).css('display', '');
if (DOCUMENTATION_OPTIONS.COLLAPSE_MODINDEX) {
togglers.click();
}
},
/**
* helper function to hide the search marks again
*/
hideSearchWords : function() {
$('.sidebar .this-page-menu li.highlight-link').fadeOut(300);
$('span.highlight').removeClass('highlight');
},
/**
* make the url absolute
*/
makeURL : function(relativeURL) {
return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL;
},
/**
* get the current relative url
*/
getCurrentURL : function() {
var path = document.location.pathname;
var parts = path.split(/\//);
$.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() {
if (this == '..')
parts.pop();
});
var url = parts.join('/');
return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
}
};
// quick alias for translations
_ = Documentation.gettext;
$(document).ready(function() {
Documentation.init();
});

Binary file not shown.

After

Width:  |  Height:  |  Size: 392 B

File diff suppressed because one or more lines are too long

Binary file not shown.

After

Width:  |  Height:  |  Size: 199 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 218 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 199 B

View File

@ -0,0 +1,61 @@
.hll { background-color: #ffffcc }
.c { color: #408090; font-style: italic } /* Comment */
.err { border: 1px solid #FF0000 } /* Error */
.k { color: #007020; font-weight: bold } /* Keyword */
.o { color: #666666 } /* Operator */
.cm { color: #408090; font-style: italic } /* Comment.Multiline */
.cp { color: #007020 } /* Comment.Preproc */
.c1 { color: #408090; font-style: italic } /* Comment.Single */
.cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
.gd { color: #A00000 } /* Generic.Deleted */
.ge { font-style: italic } /* Generic.Emph */
.gr { color: #FF0000 } /* Generic.Error */
.gh { color: #000080; font-weight: bold } /* Generic.Heading */
.gi { color: #00A000 } /* Generic.Inserted */
.go { color: #303030 } /* Generic.Output */
.gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
.gs { font-weight: bold } /* Generic.Strong */
.gu { color: #800080; font-weight: bold } /* Generic.Subheading */
.gt { color: #0040D0 } /* Generic.Traceback */
.kc { color: #007020; font-weight: bold } /* Keyword.Constant */
.kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
.kn { color: #007020; font-weight: bold } /* Keyword.Namespace */
.kp { color: #007020 } /* Keyword.Pseudo */
.kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
.kt { color: #902000 } /* Keyword.Type */
.m { color: #208050 } /* Literal.Number */
.s { color: #4070a0 } /* Literal.String */
.na { color: #4070a0 } /* Name.Attribute */
.nb { color: #007020 } /* Name.Builtin */
.nc { color: #0e84b5; font-weight: bold } /* Name.Class */
.no { color: #60add5 } /* Name.Constant */
.nd { color: #555555; font-weight: bold } /* Name.Decorator */
.ni { color: #d55537; font-weight: bold } /* Name.Entity */
.ne { color: #007020 } /* Name.Exception */
.nf { color: #06287e } /* Name.Function */
.nl { color: #002070; font-weight: bold } /* Name.Label */
.nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */
.nt { color: #062873; font-weight: bold } /* Name.Tag */
.nv { color: #bb60d5 } /* Name.Variable */
.ow { color: #007020; font-weight: bold } /* Operator.Word */
.w { color: #bbbbbb } /* Text.Whitespace */
.mf { color: #208050 } /* Literal.Number.Float */
.mh { color: #208050 } /* Literal.Number.Hex */
.mi { color: #208050 } /* Literal.Number.Integer */
.mo { color: #208050 } /* Literal.Number.Oct */
.sb { color: #4070a0 } /* Literal.String.Backtick */
.sc { color: #4070a0 } /* Literal.String.Char */
.sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */
.s2 { color: #4070a0 } /* Literal.String.Double */
.se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */
.sh { color: #4070a0 } /* Literal.String.Heredoc */
.si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */
.sx { color: #c65d09 } /* Literal.String.Other */
.sr { color: #235388 } /* Literal.String.Regex */
.s1 { color: #4070a0 } /* Literal.String.Single */
.ss { color: #517918 } /* Literal.String.Symbol */
.bp { color: #007020 } /* Name.Builtin.Pseudo */
.vc { color: #bb60d5 } /* Name.Variable.Class */
.vg { color: #bb60d5 } /* Name.Variable.Global */
.vi { color: #bb60d5 } /* Name.Variable.Instance */
.il { color: #208050 } /* Literal.Number.Integer.Long */

View File

@ -0,0 +1,16 @@
/**
* Sphinx Doc Design -- Right Side Bar Overrides
*/
div.sphinxsidebar {
float: right;
}
div.bodywrapper {
margin: 0 230px 0 0;
}
div.inlinecomments {
right: 250px;
}

View File

@ -0,0 +1,467 @@
/**
* helper function to return a node containing the
* search summary for a given text. keywords is a list
* of stemmed words, hlwords is the list of normal, unstemmed
* words. the first one is used to find the occurance, the
* latter for highlighting it.
*/
jQuery.makeSearchSummary = function(text, keywords, hlwords) {
var textLower = text.toLowerCase();
var start = 0;
$.each(keywords, function() {
var i = textLower.indexOf(this.toLowerCase());
if (i > -1)
start = i;
});
start = Math.max(start - 120, 0);
var excerpt = ((start > 0) ? '...' : '') +
$.trim(text.substr(start, 240)) +
((start + 240 - text.length) ? '...' : '');
var rv = $('<div class="context"></div>').text(excerpt);
$.each(hlwords, function() {
rv = rv.highlightText(this, 'highlight');
});
return rv;
}
/**
* Porter Stemmer
*/
var PorterStemmer = function() {
var step2list = {
ational: 'ate',
tional: 'tion',
enci: 'ence',
anci: 'ance',
izer: 'ize',
bli: 'ble',
alli: 'al',
entli: 'ent',
eli: 'e',
ousli: 'ous',
ization: 'ize',
ation: 'ate',
ator: 'ate',
alism: 'al',
iveness: 'ive',
fulness: 'ful',
ousness: 'ous',
aliti: 'al',
iviti: 'ive',
biliti: 'ble',
logi: 'log'
};
var step3list = {
icate: 'ic',
ative: '',
alize: 'al',
iciti: 'ic',
ical: 'ic',
ful: '',
ness: ''
};
var c = "[^aeiou]"; // consonant
var v = "[aeiouy]"; // vowel
var C = c + "[^aeiouy]*"; // consonant sequence
var V = v + "[aeiou]*"; // vowel sequence
var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0
var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1
var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1
var s_v = "^(" + C + ")?" + v; // vowel in stem
this.stemWord = function (w) {
var stem;
var suffix;
var firstch;
var origword = w;
if (w.length < 3)
return w;
var re;
var re2;
var re3;
var re4;
firstch = w.substr(0,1);
if (firstch == "y")
w = firstch.toUpperCase() + w.substr(1);
// Step 1a
re = /^(.+?)(ss|i)es$/;
re2 = /^(.+?)([^s])s$/;
if (re.test(w))
w = w.replace(re,"$1$2");
else if (re2.test(w))
w = w.replace(re2,"$1$2");
// Step 1b
re = /^(.+?)eed$/;
re2 = /^(.+?)(ed|ing)$/;
if (re.test(w)) {
var fp = re.exec(w);
re = new RegExp(mgr0);
if (re.test(fp[1])) {
re = /.$/;
w = w.replace(re,"");
}
}
else if (re2.test(w)) {
var fp = re2.exec(w);
stem = fp[1];
re2 = new RegExp(s_v);
if (re2.test(stem)) {
w = stem;
re2 = /(at|bl|iz)$/;
re3 = new RegExp("([^aeiouylsz])\\1$");
re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
if (re2.test(w))
w = w + "e";
else if (re3.test(w)) {
re = /.$/;
w = w.replace(re,"");
}
else if (re4.test(w))
w = w + "e";
}
}
// Step 1c
re = /^(.+?)y$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
re = new RegExp(s_v);
if (re.test(stem))
w = stem + "i";
}
// Step 2
re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
suffix = fp[2];
re = new RegExp(mgr0);
if (re.test(stem))
w = stem + step2list[suffix];
}
// Step 3
re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
suffix = fp[2];
re = new RegExp(mgr0);
if (re.test(stem))
w = stem + step3list[suffix];
}
// Step 4
re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
re2 = /^(.+?)(s|t)(ion)$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
re = new RegExp(mgr1);
if (re.test(stem))
w = stem;
}
else if (re2.test(w)) {
var fp = re2.exec(w);
stem = fp[1] + fp[2];
re2 = new RegExp(mgr1);
if (re2.test(stem))
w = stem;
}
// Step 5
re = /^(.+?)e$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
re = new RegExp(mgr1);
re2 = new RegExp(meq1);
re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
w = stem;
}
re = /ll$/;
re2 = new RegExp(mgr1);
if (re.test(w) && re2.test(w)) {
re = /.$/;
w = w.replace(re,"");
}
// and turn initial Y back to y
if (firstch == "y")
w = firstch.toLowerCase() + w.substr(1);
return w;
}
}
/**
* Search Module
*/
var Search = {
_index : null,
_queued_query : null,
_pulse_status : -1,
init : function() {
var params = $.getQueryParameters();
if (params.q) {
var query = params.q[0];
$('input[@name="q"]')[0].value = query;
this.performSearch(query);
}
},
/**
* Sets the index
*/
setIndex : function(index) {
var q;
this._index = index;
if ((q = this._queued_query) !== null) {
this._queued_query = null;
Search.query(q);
}
},
hasIndex : function() {
return this._index !== null;
},
deferQuery : function(query) {
this._queued_query = query;
},
stopPulse : function() {
this._pulse_status = 0;
},
startPulse : function() {
if (this._pulse_status >= 0)
return;
function pulse() {
Search._pulse_status = (Search._pulse_status + 1) % 4;
var dotString = '';
for (var i = 0; i < Search._pulse_status; i++)
dotString += '.';
Search.dots.text(dotString);
if (Search._pulse_status > -1)
window.setTimeout(pulse, 500);
};
pulse();
},
/**
* perform a search for something
*/
performSearch : function(query) {
// create the required interface elements
this.out = $('#search-results');
this.title = $('<h2>' + _('Searching') + '</h2>').appendTo(this.out);
this.dots = $('<span></span>').appendTo(this.title);
this.status = $('<p style="display: none"></p>').appendTo(this.out);
this.output = $('<ul class="search"/>').appendTo(this.out);
$('#search-progress').text(_('Preparing search...'));
this.startPulse();
// index already loaded, the browser was quick!
if (this.hasIndex())
this.query(query);
else
this.setQuery(query);
},
query : function(query) {
// stem the searchterms and add them to the
// correct list
var stemmer = new PorterStemmer();
var searchterms = [];
var excluded = [];
var hlterms = [];
var tmp = query.split(/\s+/);
var object = (tmp.length == 1) ? tmp[0].toLowerCase() : null;
for (var i = 0; i < tmp.length; i++) {
// stem the word
var word = stemmer.stemWord(tmp[i]).toLowerCase();
// select the correct list
if (word[0] == '-') {
var toAppend = excluded;
word = word.substr(1);
}
else {
var toAppend = searchterms;
hlterms.push(tmp[i].toLowerCase());
}
// only add if not already in the list
if (!$.contains(toAppend, word))
toAppend.push(word);
};
var highlightstring = '?highlight=' + $.urlencode(hlterms.join(" "));
console.debug('SEARCH: searching for:');
console.info('required: ', searchterms);
console.info('excluded: ', excluded);
// prepare search
var filenames = this._index.filenames;
var titles = this._index.titles;
var terms = this._index.terms;
var descrefs = this._index.descrefs;
var modules = this._index.modules;
var desctypes = this._index.desctypes;
var fileMap = {};
var files = null;
var objectResults = [];
var regularResults = [];
$('#search-progress').empty();
// lookup as object
if (object != null) {
for (var module in modules) {
if (module.indexOf(object) > -1) {
fn = modules[module];
descr = _('module, in ') + titles[fn];
objectResults.push([filenames[fn], module, '#module-'+module, descr]);
}
}
for (var prefix in descrefs) {
for (var name in descrefs[prefix]) {
if (name.toLowerCase().indexOf(object) > -1) {
match = descrefs[prefix][name];
fullname = (prefix ? prefix + '.' : '') + name;
descr = desctypes[match[1]] + _(', in ') + titles[match[0]];
objectResults.push([filenames[match[0]], fullname, '#'+fullname, descr]);
}
}
}
}
// sort results descending
objectResults.sort(function(a, b) {
return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0);
});
// perform the search on the required terms
for (var i = 0; i < searchterms.length; i++) {
var word = searchterms[i];
// no match but word was a required one
if ((files = terms[word]) == null)
break;
if (files.length == undefined) {
files = [files];
}
// create the mapping
for (var j = 0; j < files.length; j++) {
var file = files[j];
if (file in fileMap)
fileMap[file].push(word);
else
fileMap[file] = [word];
}
}
// now check if the files don't contain excluded terms
for (var file in fileMap) {
var valid = true;
// check if all requirements are matched
if (fileMap[file].length != searchterms.length)
continue;
// ensure that none of the excluded terms is in the
// search result.
for (var i = 0; i < excluded.length; i++) {
if (terms[excluded[i]] == file ||
$.contains(terms[excluded[i]] || [], file)) {
valid = false;
break;
}
}
// if we have still a valid result we can add it
// to the result list
if (valid)
regularResults.push([filenames[file], titles[file], '', null]);
}
// delete unused variables in order to not waste
// memory until list is retrieved completely
delete filenames, titles, terms;
// now sort the regular results descending by title
regularResults.sort(function(a, b) {
var left = a[1].toLowerCase();
var right = b[1].toLowerCase();
return (left > right) ? -1 : ((left < right) ? 1 : 0);
});
// combine both
var results = regularResults.concat(objectResults);
// print the results
var resultCount = results.length;
function displayNextItem() {
// results left, load the summary and display it
if (results.length) {
var item = results.pop();
var listItem = $('<li style="display:none"></li>');
listItem.append($('<a/>').attr(
'href',
item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX +
highlightstring + item[2]).html(item[1]));
if (item[3]) {
listItem.append($('<span> (' + item[3] + ')</span>'));
Search.output.append(listItem);
listItem.slideDown(5, function() {
displayNextItem();
});
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
$.get('_sources/' + item[0] + '.txt', function(data) {
listItem.append($.makeSearchSummary(data, searchterms, hlterms));
Search.output.append(listItem);
listItem.slideDown(5, function() {
displayNextItem();
});
});
} else {
// no source available, just display title
Search.output.append(listItem);
listItem.slideDown(5, function() {
displayNextItem();
});
}
}
// search finished, update title and status message
else {
Search.stopPulse();
Search.title.text(_('Search Results'));
if (!resultCount)
Search.status.text(_('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.'));
else
Search.status.text(_('Search finished, found %s page(s) matching the search query.').replace('%s', resultCount));
Search.status.fadeIn(500);
}
}
displayNextItem();
}
}
$(document).ready(function() {
Search.init();
});

View File

@ -0,0 +1,557 @@
/**
* Alternate Sphinx design
* Originally created by Armin Ronacher for Werkzeug, adapted by Georg Brandl.
*/
body {
font-family: 'Lucida Grande', 'Lucida Sans Unicode', 'Geneva', 'Verdana', sans-serif;
font-size: 14px;
letter-spacing: -0.01em;
line-height: 150%;
text-align: center;
/*background-color: #AFC1C4; */
background-color: #BFD1D4;
color: black;
padding: 0;
border: 1px solid #aaa;
margin: 0px 80px 0px 80px;
min-width: 740px;
}
a {
color: #CA7900;
text-decoration: none;
}
a:hover {
color: #2491CF;
}
pre {
font-family: 'Consolas', 'Deja Vu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
font-size: 0.95em;
letter-spacing: 0.015em;
padding: 0.5em;
border: 1px solid #ccc;
background-color: #f8f8f8;
}
td.linenos pre {
padding: 0.5em 0;
border: 0;
background-color: transparent;
color: #aaa;
}
table.highlighttable {
margin-left: 0.5em;
}
table.highlighttable td {
padding: 0 0.5em 0 0.5em;
}
cite, code, tt {
font-family: 'Consolas', 'Deja Vu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
font-size: 0.95em;
letter-spacing: 0.01em;
}
hr {
border: 1px solid #abc;
margin: 2em;
}
tt {
background-color: #f2f2f2;
border-bottom: 1px solid #ddd;
color: #333;
}
tt.descname {
background-color: transparent;
font-weight: bold;
font-size: 1.2em;
border: 0;
}
tt.descclassname {
background-color: transparent;
border: 0;
}
tt.xref {
background-color: transparent;
font-weight: bold;
border: 0;
}
a tt {
background-color: transparent;
font-weight: bold;
border: 0;
color: #CA7900;
}
a tt:hover {
color: #2491CF;
}
.field-list ul {
margin: 0;
padding-left: 1em;
}
.field-list p {
margin: 0;
}
dl {
margin-bottom: 15px;
}
dd p {
margin-top: 0px;
}
dd ul, dd table {
margin-bottom: 10px;
}
dd {
margin-top: 3px;
margin-bottom: 10px;
margin-left: 30px;
}
.refcount {
color: #060;
}
dt:target,
.highlight {
background-color: #fbe54e;
}
dl.glossary dt {
font-weight: bold;
font-size: 1.1em;
}
pre {
line-height: 120%;
}
pre a {
color: inherit;
text-decoration: underline;
}
.first {
margin-top: 0 !important;
}
div.document {
background-color: white;
text-align: left;
background-image: url(contents.png);
background-repeat: repeat-x;
}
/*
div.documentwrapper {
width: 100%;
}
*/
div.clearer {
clear: both;
}
div.related h3 {
display: none;
}
div.related ul {
background-image: url(navigation.png);
height: 2em;
list-style: none;
border-top: 1px solid #ddd;
border-bottom: 1px solid #ddd;
margin: 0;
padding-left: 10px;
}
div.related ul li {
margin: 0;
padding: 0;
height: 2em;
float: left;
}
div.related ul li.right {
float: right;
margin-right: 5px;
}
div.related ul li a {
margin: 0;
padding: 0 5px 0 5px;
line-height: 1.75em;
color: #EE9816;
}
div.related ul li a:hover {
color: #3CA8E7;
}
div.body {
margin: 0;
padding: 0.5em 20px 20px 20px;
}
div.bodywrapper {
margin: 0 240px 0 0;
border-right: 1px solid #ccc;
}
div.body a {
text-decoration: underline;
}
div.sphinxsidebar {
margin: 0;
padding: 0.5em 15px 15px 0;
width: 210px;
float: right;
text-align: left;
/* margin-left: -100%; */
}
div.sphinxsidebar h4, div.sphinxsidebar h3 {
margin: 1em 0 0.5em 0;
font-size: 0.9em;
padding: 0.1em 0 0.1em 0.5em;
color: white;
border: 1px solid #86989B;
background-color: #AFC1C4;
}
div.sphinxsidebar h3 a {
color: white;
}
div.sphinxsidebar ul {
padding-left: 1.5em;
margin-top: 7px;
list-style: none;
padding: 0;
line-height: 130%;
}
div.sphinxsidebar ul ul {
list-style: square;
margin-left: 20px;
}
p {
margin: 0.8em 0 0.5em 0;
}
p.rubric {
font-weight: bold;
}
div.sidebar {
margin: 0 0 0.5em 1em;
border: 1px solid #ddb;
padding: 7px 7px 0 7px;
background-color: #ffe;
width: 40%;
float: right;
}
div.quotebar {
background-color: #f8f8f8;
max-width: 250px;
float: right;
padding: 2px 7px;
border: 1px solid #ccc;
}
p.sidebar-title {
font-weight: bold;
}
div.topic {
background-color: #f8f8f8;
border: 1px solid #ccc;
padding: 7px 7px 0 7px;
margin: 10px 0 10px 0;
}
p.topic-title {
font-size: 1.1em;
font-weight: bold;
}
h1 {
margin: 0;
padding: 0.7em 0 0.3em 0;
font-size: 1.5em;
color: #11557C;
}
h2 {
margin: 1.3em 0 0.2em 0;
font-size: 1.35em;
padding: 0;
}
h3 {
margin: 1em 0 -0.3em 0;
font-size: 1.2em;
}
div.body h1 a, div.body h2 a, div.body h3 a, div.body h4 a, div.body h5 a, div.body h6 a {
color: black!important;
}
h1 a.anchor, h2 a.anchor, h3 a.anchor, h4 a.anchor, h5 a.anchor, h6 a.anchor {
display: none;
margin: 0 0 0 0.3em;
padding: 0 0.2em 0 0.2em;
color: #aaa!important;
}
h1:hover a.anchor, h2:hover a.anchor, h3:hover a.anchor, h4:hover a.anchor,
h5:hover a.anchor, h6:hover a.anchor {
display: inline;
}
h1 a.anchor:hover, h2 a.anchor:hover, h3 a.anchor:hover, h4 a.anchor:hover,
h5 a.anchor:hover, h6 a.anchor:hover {
color: #777;
background-color: #eee;
}
table {
border-collapse: collapse;
margin: 0 -0.5em 0 -0.5em;
}
table td, table th {
padding: 0.2em 0.5em 0.2em 0.5em;
}
div.footer {
background-color: #E3EFF1;
color: #86989B;
padding: 3px 8px 3px 0;
clear: both;
font-size: 0.8em;
text-align: right;
}
div.footer a {
color: #86989B;
text-decoration: underline;
}
div.pagination {
margin-top: 2em;
padding-top: 0.5em;
border-top: 1px solid black;
text-align: center;
}
div.sphinxsidebar ul.toc {
margin: 1em 0 1em 0;
padding: 0 0 0 0.5em;
list-style: none;
}
div.sphinxsidebar ul.toc li {
margin: 0.5em 0 0.5em 0;
font-size: 0.9em;
line-height: 130%;
}
div.sphinxsidebar ul.toc li p {
margin: 0;
padding: 0;
}
div.sphinxsidebar ul.toc ul {
margin: 0.2em 0 0.2em 0;
padding: 0 0 0 1.8em;
}
div.sphinxsidebar ul.toc ul li {
padding: 0;
}
div.admonition, div.warning {
font-size: 0.9em;
margin: 1em 0 0 0;
border: 1px solid #86989B;
background-color: #f7f7f7;
}
div.admonition p, div.warning p {
margin: 0.5em 1em 0.5em 1em;
padding: 0;
}
div.admonition pre, div.warning pre {
margin: 0.4em 1em 0.4em 1em;
}
div.admonition p.admonition-title,
div.warning p.admonition-title {
margin: 0;
padding: 0.1em 0 0.1em 0.5em;
color: white;
border-bottom: 1px solid #86989B;
font-weight: bold;
background-color: #AFC1C4;
}
div.warning {
border: 1px solid #940000;
}
div.warning p.admonition-title {
background-color: #CF0000;
border-bottom-color: #940000;
}
div.admonition ul, div.admonition ol,
div.warning ul, div.warning ol {
margin: 0.1em 0.5em 0.5em 3em;
padding: 0;
}
div.versioninfo {
margin: 1em 0 0 0;
border: 1px solid #ccc;
background-color: #DDEAF0;
padding: 8px;
line-height: 1.3em;
font-size: 0.9em;
}
a.headerlink {
color: #c60f0f!important;
font-size: 1em;
margin-left: 6px;
padding: 0 4px 0 4px;
text-decoration: none!important;
visibility: hidden;
}
h1:hover > a.headerlink,
h2:hover > a.headerlink,
h3:hover > a.headerlink,
h4:hover > a.headerlink,
h5:hover > a.headerlink,
h6:hover > a.headerlink,
dt:hover > a.headerlink {
visibility: visible;
}
a.headerlink:hover {
background-color: #ccc;
color: white!important;
}
table.indextable td {
text-align: left;
vertical-align: top;
}
table.indextable dl, table.indextable dd {
margin-top: 0;
margin-bottom: 0;
}
table.indextable tr.pcap {
height: 10px;
}
table.indextable tr.cap {
margin-top: 10px;
background-color: #f2f2f2;
}
img.toggler {
margin-right: 3px;
margin-top: 3px;
cursor: pointer;
}
form.pfform {
margin: 10px 0 20px 0;
}
table.contentstable {
width: 90%;
}
table.contentstable p.biglink {
line-height: 150%;
}
a.biglink {
font-size: 1.3em;
}
span.linkdescr {
font-style: italic;
padding-top: 5px;
font-size: 90%;
}
ul.search {
margin: 10px 0 0 20px;
padding: 0;
}
ul.search li {
padding: 5px 0 5px 20px;
background-image: url(file.png);
background-repeat: no-repeat;
background-position: 0 7px;
}
ul.search li a {
font-weight: bold;
}
ul.search li div.context {
color: #888;
margin: 2px 0 0 30px;
text-align: left;
}
ul.keywordmatches li.goodmatch a {
font-weight: bold;
}
img.math {
vertical-align: center;
}
div.math {
text-align: center;
}
span.eqno {
float: right;
}
img.logo {
border: 0;
}

View File

@ -0,0 +1,19 @@
/**
* Sphinx Doc Design -- Sticky sidebar Overrides
*/
div.sphinxsidebar {
top: 30px;
left: 0px;
position: fixed;
margin: 0;
float: none;
}
div.related {
position: fixed;
}
div.documentwrapper {
margin-top: 30px;
}

View File

@ -0,0 +1,700 @@
/**
* Sphinx Doc Design -- traditional python.org style
*/
body {
color: #000;
margin: 0;
padding: 0;
}
/* :::: LAYOUT :::: */
div.documentwrapper {
float: left;
width: 100%;
}
div.bodywrapper {
margin: 0 230px 0 0;
}
div.body {
background-color: white;
padding: 0 20px 30px 20px;
}
div.sphinxsidebarwrapper {
border: 1px solid #99ccff;
padding: 10px;
margin: 10px 15px 10px 0;
}
div.sphinxsidebar {
float: right;
margin-left: -100%;
width: 230px;
}
div.clearer {
clear: both;
}
div.footer {
clear: both;
width: 100%;
background-color: #99ccff;
padding: 9px 0 9px 0;
text-align: center;
}
div.related {
background-color: #99ccff;
color: #333;
width: 100%;
height: 30px;
line-height: 30px;
border-bottom: 5px solid white;
}
div.related h3 {
display: none;
}
div.related ul {
margin: 0;
padding: 0 0 0 10px;
list-style: none;
}
div.related li {
display: inline;
font-weight: bold;
}
div.related li.right {
float: right;
margin-right: 5px;
}
/* ::: SIDEBAR :::: */
div.sphinxsidebar h3 {
margin: 0;
}
div.sphinxsidebar h4 {
margin: 5px 0 0 0;
}
div.sphinxsidebar p.topless {
margin: 5px 10px 10px 10px;
}
div.sphinxsidebar ul {
margin: 10px;
margin-left: 15px;
padding: 0;
}
div.sphinxsidebar ul ul {
margin-top: 0;
margin-bottom: 0;
}
div.sphinxsidebar form {
margin-top: 10px;
}
/* :::: SEARCH :::: */
ul.search {
margin: 10px 0 0 20px;
padding: 0;
}
ul.search li {
padding: 5px 0 5px 20px;
background-image: url(file.png);
background-repeat: no-repeat;
background-position: 0 7px;
}
ul.search li a {
font-weight: bold;
}
ul.search li div.context {
color: #888;
margin: 2px 0 0 30px;
text-align: left;
}
ul.keywordmatches li.goodmatch a {
font-weight: bold;
}
/* :::: COMMON FORM STYLES :::: */
div.actions {
border-top: 1px solid #aaa;
background-color: #ddd;
margin: 10px 0 0 -20px;
padding: 5px 0 5px 20px;
}
form dl {
color: #333;
}
form dt {
clear: both;
float: left;
min-width: 110px;
margin-right: 10px;
padding-top: 2px;
}
input#homepage {
display: none;
}
div.error {
margin: 5px 20px 0 0;
padding: 5px;
border: 1px solid #d00;
/*border: 2px solid #05171e;
background-color: #092835;
color: white;*/
font-weight: bold;
}
/* :::: INLINE COMMENTS :::: */
div.inlinecommentswrapper {
float: right;
max-width: 40%;
}
div.commentmarker {
float: right;
background-image: url(style/comment.png);
background-repeat: no-repeat;
width: 25px;
height: 25px;
text-align: center;
padding-top: 3px;
}
div.nocommentmarker {
float: right;
background-image: url(style/nocomment.png);
background-repeat: no-repeat;
width: 25px;
height: 25px;
}
div.inlinecomments {
margin-left: 10px;
margin-bottom: 5px;
background-color: #eee;
border: 1px solid #ccc;
padding: 5px;
}
div.inlinecomment {
border-top: 1px solid #ccc;
padding-top: 5px;
margin-top: 5px;
}
.inlinecomments p {
margin: 5px 0 5px 0;
}
.inlinecomments .head {
font-weight: bold;
}
.inlinecomments .meta {
font-style: italic;
}
/* :::: COMMENTS :::: */
div#comments h3 {
border-top: 1px solid #aaa;
padding: 5px 20px 5px 20px;
margin: 20px -20px 20px -20px;
background-color: #ddd;
}
/*
div#comments {
background-color: #ccc;
margin: 40px -20px -30px -20px;
padding: 0 0 1px 0;
}
div#comments h4 {
margin: 30px 0 20px 0;
background-color: #aaa;
border-bottom: 1px solid #09232e;
color: #333;
}
div#comments form {
display: block;
margin: 0 0 0 20px;
}
div#comments textarea {
width: 98%;
height: 160px;
}
div#comments div.help {
margin: 20px 20px 10px 0;
background-color: #ccc;
color: #333;
}
div#comments div.help p {
margin: 0;
padding: 0 0 10px 0;
}
div#comments input, div#comments textarea {
font-family: 'Bitstream Vera Sans', 'Arial', sans-serif;
font-size: 13px;
color: black;
background-color: #aaa;
border: 1px solid #092835;
}
div#comments input[type="reset"],
div#comments input[type="submit"] {
cursor: pointer;
font-weight: bold;
padding: 2px;
margin: 5px 5px 5px 0;
background-color: #666;
color: white;
}
div#comments div.comment {
margin: 10px 10px 10px 20px;
padding: 10px;
border: 1px solid #0f3646;
background-color: #aaa;
color: #333;
}
div#comments div.comment p {
margin: 5px 0 5px 0;
}
div#comments div.comment p.meta {
font-style: italic;
color: #444;
text-align: right;
margin: -5px 0 -5px 0;
}
div#comments div.comment h4 {
margin: -10px -10px 5px -10px;
padding: 3px;
font-size: 15px;
background-color: #888;
color: white;
border: 0;
}
div#comments div.comment pre,
div#comments div.comment tt {
background-color: #ddd;
color: #111;
border: none;
}
div#comments div.comment a {
color: #fff;
text-decoration: underline;
}
div#comments div.comment blockquote {
margin: 10px;
padding: 10px;
border-left: 1px solid #0f3646;
/*border: 1px solid #0f3646;
background-color: #071c25;*/
}
div#comments em.important {
color: #d00;
font-weight: bold;
font-style: normal;
}*/
/* :::: SUGGEST CHANGES :::: */
div#suggest-changes-box input, div#suggest-changes-box textarea {
border: 1px solid #ccc;
background-color: white;
color: black;
}
div#suggest-changes-box textarea {
width: 99%;
height: 400px;
}
/* :::: PREVIEW :::: */
div.preview {
background-image: url(style/preview.png);
padding: 0 20px 20px 20px;
margin-bottom: 30px;
}
/* :::: INDEX PAGE :::: */
table.contentstable {
width: 90%;
}
table.contentstable p.biglink {
line-height: 150%;
}
a.biglink {
font-size: 1.5em;
}
span.linkdescr {
font-style: italic;
padding-top: 5px;
}
/* :::: GENINDEX STYLES :::: */
table.indextable td {
text-align: left;
vertical-align: top;
}
table.indextable dl, table.indextable dd {
margin-top: 0;
margin-bottom: 0;
}
table.indextable tr.pcap {
height: 10px;
}
table.indextable tr.cap {
margin-top: 10px;
background-color: #f2f2f2;
}
img.toggler {
margin-right: 3px;
margin-top: 3px;
cursor: pointer;
}
/* :::: GLOBAL STYLES :::: */
p.subhead {
font-weight: bold;
margin-top: 20px;
}
a:link:active { color: #ff0000; }
a:link:hover { background-color: #bbeeff; }
a:visited:hover { background-color: #bbeeff; }
a:visited { color: #551a8b; }
a:link { color: #0000bb; }
div.body h1,
div.body h2,
div.body h3,
div.body h4,
div.body h5,
div.body h6 {
font-family: avantgarde, sans-serif;
font-weight: bold;
}
div.body h1 { font-size: 180%; }
div.body h2 { font-size: 150%; }
div.body h3 { font-size: 120%; }
div.body h4 { font-size: 120%; }
a.headerlink,
a.headerlink,
a.headerlink,
a.headerlink,
a.headerlink,
a.headerlink {
color: #c60f0f;
font-size: 0.8em;
padding: 0 4px 0 4px;
text-decoration: none;
visibility: hidden;
}
*:hover > a.headerlink,
*:hover > a.headerlink,
*:hover > a.headerlink,
*:hover > a.headerlink,
*:hover > a.headerlink,
*:hover > a.headerlink {
visibility: visible;
}
a.headerlink:hover,
a.headerlink:hover,
a.headerlink:hover,
a.headerlink:hover,
a.headerlink:hover,
a.headerlink:hover {
background-color: #c60f0f;
color: white;
}
div.body p, div.body dd, div.body li {
text-align: justify;
}
div.body td {
text-align: left;
}
ul.fakelist {
list-style: none;
margin: 10px 0 10px 20px;
padding: 0;
}
/* "Footnotes" heading */
p.rubric {
margin-top: 30px;
font-weight: bold;
}
/* "Topics" */
div.topic {
background-color: #eee;
border: 1px solid #ccc;
padding: 0 7px 0 7px;
margin: 10px 0 10px 0;
}
p.topic-title {
font-size: 1.1em;
font-weight: bold;
margin-top: 10px;
}
/* Admonitions */
div.admonition {
margin-top: 10px;
margin-bottom: 10px;
padding: 7px;
}
div.admonition dt {
font-weight: bold;
}
div.admonition dd {
margin-bottom: 10px;
}
div.admonition dl {
margin-bottom: 0;
}
div.admonition p {
display: inline;
}
div.seealso {
background-color: #ffc;
border: 1px solid #ff6;
}
div.warning {
background-color: #ffe4e4;
border: 1px solid #f66;
}
div.note {
background-color: #eee;
border: 1px solid #ccc;
}
p.admonition-title {
margin: 0px 10px 5px 0px;
font-weight: bold;
display: inline;
}
p.admonition-title:after {
content: ":";
}
div.body p.centered {
text-align: center;
margin-top: 25px;
}
table.docutils {
border: 0;
}
table.docutils td, table.docutils th {
padding: 0 8px 2px 0;
border-top: 0;
border-left: 0;
border-right: 0;
border-bottom: 1px solid #aaa;
}
table.field-list td, table.field-list th {
border: 0 !important;
}
table.footnote td, table.footnote th {
border: 0 !important;
}
dl {
margin-bottom: 15px;
clear: both;
}
dd p {
margin-top: 0px;
}
dd ul, dd table {
margin-bottom: 10px;
}
dd {
margin-top: 3px;
margin-bottom: 10px;
margin-left: 30px;
}
dl.glossary dt {
font-weight: bold;
font-size: 1.1em;
}
.refcount {
color: #060;
}
th {
text-align: left;
padding-right: 5px;
}
pre {
font-family: monospace;
padding: 5px;
color: #00008b;
border-left: none;
border-right: none;
}
tt {
font-family: monospace;
background-color: #ecf0f3;
padding: 0 1px 0 1px;
}
tt.descname {
background-color: transparent;
font-weight: bold;
font-size: 1.2em;
}
tt.descclassname {
background-color: transparent;
}
tt.xref, a tt {
background-color: transparent;
font-weight: bold;
}
.footnote:target { background-color: #ffa }
h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt {
background-color: transparent;
}
.optional {
font-size: 1.3em;
}
.versionmodified {
font-style: italic;
}
form.comment {
margin: 0;
padding: 10px 30px 10px 30px;
background-color: #eee;
}
form.comment h3 {
background-color: #326591;
color: white;
margin: -10px -30px 10px -30px;
padding: 5px;
font-size: 1.4em;
}
form.comment input,
form.comment textarea {
border: 1px solid #ccc;
padding: 2px;
font-family: sans-serif;
font-size: 13px;
}
form.comment input[type="text"] {
width: 240px;
}
form.comment textarea {
width: 100%;
height: 200px;
margin-bottom: 10px;
}
/* :::: PRINT :::: */
@media print {
div.documentwrapper {
width: 100%;
}
div.body {
margin: 0;
}
div.sphinxsidebar,
div.related,
div.footer,
div#comments div.new-comment-box,
#top-link {
display: none;
}
}

View File

@ -0,0 +1,374 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>core Module &mdash; OpenLP v1.9.0 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.9.0',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="top" title="OpenLP v1.9.0 documentation" href="../index.html" />
<link rel="next" title="migration Module" href="../migration/index.html" />
<link rel="prev" title="openlp Module" href="../openlp.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../modindex.html" title="Global Module Index"
accesskey="M">modules</a> |</li>
<li class="right" >
<a href="../migration/index.html" title="migration Module"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="../openlp.html" title="openlp Module"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">OpenLP v1.9.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-openlp.core">
<span id="core-index"></span><h1><tt class="xref docutils literal"><span class="pre">core</span></tt> Module<a class="headerlink" href="#module-openlp.core" title="Permalink to this headline"></a></h1>
<p>OpenLP - Open Source Lyrics Projection
Copyright (c) 2008 Raoul Snyman
Portions copyright (c) 2008-2009 Martin Thompson, Tim Bentley</p>
<p>This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation; version 2 of the License.</p>
<p>This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place, Suite 330, Boston, MA 02111-1307 USA</p>
<div class="section" id="module-openlp.core.lib">
<h2><tt class="xref docutils literal"><span class="pre">lib</span></tt> Module<a class="headerlink" href="#module-openlp.core.lib" title="Permalink to this headline"></a></h2>
<p>OpenLP - Open Source Lyrics Projection
Copyright (c) 2008 Raoul Snyman
Portions copyright (c) 2008-2009 Martin Thompson, Tim Bentley,</p>
<p>This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation; version 2 of the License.</p>
<p>This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place, Suite 330, Boston, MA 02111-1307 USA</p>
<dl class="function">
<dt id="openlp.core.lib.contextMenuAction">
<!--[openlp.core.lib.contextMenuAction]--><tt class="descname">contextMenuAction</tt><big>(</big><em>base</em>, <em>icon</em>, <em>text</em>, <em>slot</em><big>)</big><a class="headerlink" href="#openlp.core.lib.contextMenuAction" title="Permalink to this definition"></a></dt>
<dd>Utility method to help build context menus for plugins</dd></dl>
<dl class="class">
<dt id="openlp.core.lib.ServiceItem">
<!--[openlp.core.lib.ServiceItem]-->class <tt class="descname">ServiceItem</tt><big>(</big><em>hostplugin=None</em><big>)</big><a class="headerlink" href="#openlp.core.lib.ServiceItem" title="Permalink to this definition"></a></dt>
<dd><p>The service item is a base class for the plugins to use to interact with
the service manager, the slide controller, and the projection screen
compositor.</p>
<dl class="method">
<dt id="openlp.core.lib.ServiceItem.addIcon">
<!--[openlp.core.lib.ServiceItem.addIcon]--><tt class="descname">addIcon</tt><big>(</big><em>icon</em><big>)</big><a class="headerlink" href="#openlp.core.lib.ServiceItem.addIcon" title="Permalink to this definition"></a></dt>
<dd><p>Add an icon to the service item. This is used when displaying the
service item in the service manager.</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">icon</span></tt></dt>
<dd>An instance of QIcon or a string to an icon in the resource or on
disk.</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="openlp.core.lib.ServiceItem.add_from_command">
<!--[openlp.core.lib.ServiceItem.add_from_command]--><tt class="descname">add_from_command</tt><big>(</big><em>frame_title</em>, <em>command</em><big>)</big><a class="headerlink" href="#openlp.core.lib.ServiceItem.add_from_command" title="Permalink to this definition"></a></dt>
<dd><p>Add a slide from a command.</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">frame_title</span></tt></dt>
<dd>The title of the slide in the service item.</dd>
<dt><tt class="docutils literal"><span class="pre">command</span></tt></dt>
<dd>The command of/for the slide.</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="openlp.core.lib.ServiceItem.add_from_image">
<!--[openlp.core.lib.ServiceItem.add_from_image]--><tt class="descname">add_from_image</tt><big>(</big><em>path</em>, <em>frame_title</em>, <em>image</em><big>)</big><a class="headerlink" href="#openlp.core.lib.ServiceItem.add_from_image" title="Permalink to this definition"></a></dt>
<dd><p>Add an image slide to the service item.</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">path</span></tt></dt>
<dd>The directory in which the image file is located.</dd>
<dt><tt class="docutils literal"><span class="pre">frame_title</span></tt></dt>
<dd>A title for the slide in the service item.</dd>
<dt><tt class="docutils literal"><span class="pre">image</span></tt></dt>
<dd>The actual image file name.</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="openlp.core.lib.ServiceItem.add_from_text">
<!--[openlp.core.lib.ServiceItem.add_from_text]--><tt class="descname">add_from_text</tt><big>(</big><em>frame_title</em>, <em>raw_slide</em><big>)</big><a class="headerlink" href="#openlp.core.lib.ServiceItem.add_from_text" title="Permalink to this definition"></a></dt>
<dd><p>Add a text slide to the service item.</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">frame_title</span></tt></dt>
<dd>The title of the slide in the service item.</dd>
<dt><tt class="docutils literal"><span class="pre">raw_slide</span></tt></dt>
<dd>The raw text of the slide.</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="openlp.core.lib.ServiceItem.get_oos_repr">
<!--[openlp.core.lib.ServiceItem.get_oos_repr]--><tt class="descname">get_oos_repr</tt><big>(</big><big>)</big><a class="headerlink" href="#openlp.core.lib.ServiceItem.get_oos_repr" title="Permalink to this definition"></a></dt>
<dd>This method returns some text which can be saved into the OOS
file to represent this item.</dd></dl>
<dl class="method">
<dt id="openlp.core.lib.ServiceItem.render">
<!--[openlp.core.lib.ServiceItem.render]--><tt class="descname">render</tt><big>(</big><big>)</big><a class="headerlink" href="#openlp.core.lib.ServiceItem.render" title="Permalink to this definition"></a></dt>
<dd>The render method is what renders the frames for the screen.</dd></dl>
<dl class="method">
<dt id="openlp.core.lib.ServiceItem.set_from_oos">
<!--[openlp.core.lib.ServiceItem.set_from_oos]--><tt class="descname">set_from_oos</tt><big>(</big><em>serviceitem</em>, <em>path=None</em><big>)</big><a class="headerlink" href="#openlp.core.lib.ServiceItem.set_from_oos" title="Permalink to this definition"></a></dt>
<dd><p>This method takes a service item from a saved service file (passed
from the ServiceManager) and extracts the data actually required.</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">serviceitem</span></tt></dt>
<dd>The item to extract data from.</dd>
<dt><tt class="docutils literal"><span class="pre">path</span></tt></dt>
<dd>Defaults to <em>None</em>. Any path data, usually for images.</dd>
</dl>
</dd></dl>
</dd></dl>
<div class="section" id="module-openlp.core.lib.baselistwithdnd">
<h3><tt class="xref docutils literal"><span class="pre">baselistwithdnd</span></tt> Submodule<a class="headerlink" href="#module-openlp.core.lib.baselistwithdnd" title="Permalink to this headline"></a></h3>
<p>OpenLP - Open Source Lyrics Projection
Copyright (c) 2008-2009 Raoul Snyman
Portions copyright (c) 2008-2009 Martin Thompson, Tim Bentley</p>
<p>This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation; version 2 of the License.</p>
<p>This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place, Suite 330, Boston, MA 02111-1307 USA</p>
<dl class="class">
<dt id="openlp.core.lib.baselistwithdnd.BaseListWithDnD">
<!--[openlp.core.lib.baselistwithdnd.BaseListWithDnD]-->class <tt class="descname">BaseListWithDnD</tt><big>(</big><em>parent=None</em><big>)</big><a class="headerlink" href="#openlp.core.lib.baselistwithdnd.BaseListWithDnD" title="Permalink to this definition"></a></dt>
<dd><p>Please put a short description of what this class does in here.</p>
<dl class="method">
<dt id="openlp.core.lib.baselistwithdnd.BaseListWithDnD.mouseMoveEvent">
<!--[openlp.core.lib.baselistwithdnd.BaseListWithDnD.mouseMoveEvent]--><tt class="descname">mouseMoveEvent</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#openlp.core.lib.baselistwithdnd.BaseListWithDnD.mouseMoveEvent" title="Permalink to this definition"></a></dt>
<dd>Drag and drop event does not care what data is selected
as the recipient will use events to request the data move
just tell it what plugin to call</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-openlp.core.lib.event">
<h3><tt class="xref docutils literal"><span class="pre">event</span></tt> Submodule<a class="headerlink" href="#module-openlp.core.lib.event" title="Permalink to this headline"></a></h3>
<p>OpenLP - Open Source Lyrics Projection</p>
<p>Copyright (c) 2008 Raoul Snyman</p>
<p>Portions copyright (c) 2008-2009 Martin Thompson, Tim Bentley, Scott Guerreri,
Carsten Tingaard, Jonathan Corwin</p>
<p>This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation; version 2 of the License.</p>
<p>This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place, Suite 330, Boston, MA 02111-1307 USA</p>
<dl class="class">
<dt id="openlp.core.lib.event.Event">
<!--[openlp.core.lib.event.Event]-->class <tt class="descname">Event</tt><big>(</big><em>event_type=0</em>, <em>payload=None</em><big>)</big><a class="headerlink" href="#openlp.core.lib.event.Event" title="Permalink to this definition"></a></dt>
<dd>Provides an Event class to encapsulate events within openlp.org.</dd></dl>
<dl class="class">
<dt id="openlp.core.lib.event.EventType">
<!--[openlp.core.lib.event.EventType]-->class <tt class="descname">EventType</tt><a class="headerlink" href="#openlp.core.lib.event.EventType" title="Permalink to this definition"></a></dt>
<dd>Types of events are stored in this class.</dd></dl>
</div>
<div class="section" id="module-openlp.core.lib.eventmanager">
<h3><tt class="xref docutils literal"><span class="pre">eventmanager</span></tt> Submodule<a class="headerlink" href="#module-openlp.core.lib.eventmanager" title="Permalink to this headline"></a></h3>
<p>OpenLP - Open Source Lyrics Projection</p>
<p>Copyright (c) 2008 Raoul Snyman</p>
<p>Portions copyright (c) 2008-2009 Martin Thompson, Tim Bentley, Scott Guerreri,
Carsten Tingaard, Jonathan Corwin</p>
<p>This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation; version 2 of the License.</p>
<p>This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place, Suite 330, Boston, MA 02111-1307 USA</p>
<dl class="class">
<dt id="openlp.core.lib.eventmanager.EventManager">
<!--[openlp.core.lib.eventmanager.EventManager]-->class <tt class="descname">EventManager</tt><a class="headerlink" href="#openlp.core.lib.eventmanager.EventManager" title="Permalink to this definition"></a></dt>
<dd>A mechanism to send events to all registered endpoints
the endpoints are registered and listen with a handle_event method
the endpoint will decide whether to do somthing with the event or ignore it</dd></dl>
</div>
<div class="section" id="module-openlp.core.lib.eventreceiver">
<h3><tt class="xref docutils literal"><span class="pre">eventreceiver</span></tt> Submodule<a class="headerlink" href="#module-openlp.core.lib.eventreceiver" title="Permalink to this headline"></a></h3>
<p>OpenLP - Open Source Lyrics Projection</p>
<p>Copyright (c) 2008 Raoul Snyman</p>
<p>Portions copyright (c) 2008-2009 Martin Thompson, Tim Bentley,</p>
<p>This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation; version 2 of the License.</p>
<p>This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place, Suite 330, Boston, MA 02111-1307 USA</p>
<dl class="class">
<dt id="openlp.core.lib.eventreceiver.EventReceiver">
<!--[openlp.core.lib.eventreceiver.EventReceiver]-->class <tt class="descname">EventReceiver</tt><a class="headerlink" href="#openlp.core.lib.eventreceiver.EventReceiver" title="Permalink to this definition"></a></dt>
<dd>Class to allow events to be passed from different parts of the system.
This is a private class and should not be used directly but via the Receiver class</dd></dl>
<dl class="class">
<dt id="openlp.core.lib.eventreceiver.Receiver">
<!--[openlp.core.lib.eventreceiver.Receiver]-->class <tt class="descname">Receiver</tt><a class="headerlink" href="#openlp.core.lib.eventreceiver.Receiver" title="Permalink to this definition"></a></dt>
<dd><p>Class to allow events to be passed from different parts of the system.
This is a static wrapper around the EventReceiver class.
As there is only one instance of it in the systems the QT signal/slot architecture
can send messages across the system</p>
<dl class="docutils">
<dt>Send message</dt>
<dd>Receiver().send_message(u&#8217;messageid&#8217;,data)</dd>
<dt>Receive Message</dt>
<dd>QtCore.QObject.connect(Receiver().get_receiver(),QtCore.SIGNAL(u&#8217;openlprepaint&#8217;),&lt;&lt;ACTION&gt;&gt;)</dd>
</dl>
<dl class="attribute">
<dt id="openlp.core.lib.eventreceiver.Receiver.get_receiver">
<!--[openlp.core.lib.eventreceiver.Receiver.get_receiver]--><tt class="descname">get_receiver</tt><a class="headerlink" href="#openlp.core.lib.eventreceiver.Receiver.get_receiver" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="openlp.core.lib.eventreceiver.Receiver.receive">
<!--[openlp.core.lib.eventreceiver.Receiver.receive]--><tt class="descname">receive</tt><a class="headerlink" href="#openlp.core.lib.eventreceiver.Receiver.receive" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="openlp.core.lib.eventreceiver.Receiver.send_message">
<!--[openlp.core.lib.eventreceiver.Receiver.send_message]--><tt class="descname">send_message</tt><a class="headerlink" href="#openlp.core.lib.eventreceiver.Receiver.send_message" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
</div>
<div class="section" id="module-openlp.core.theme">
<h2><tt class="xref docutils literal"><span class="pre">theme</span></tt> Submodule<a class="headerlink" href="#module-openlp.core.theme" title="Permalink to this headline"></a></h2>
<p>OpenLP - Open Source Lyrics Projection
Copyright (c) 2008 Raoul Snyman
Portions copyright (c) 2008 Martin Thompson, Tim Bentley</p>
<p>This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation; version 2 of the License.</p>
<p>This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place, Suite 330, Boston, MA 02111-1307 USA</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference external" href=""><tt class="docutils literal"><span class="pre">core</span></tt> Module</a><ul>
<li><a class="reference external" href="#module-openlp.core.lib"><tt class="docutils literal"><span class="pre">lib</span></tt> Module</a><ul>
<li><a class="reference external" href="#module-openlp.core.lib.baselistwithdnd"><tt class="docutils literal"><span class="pre">baselistwithdnd</span></tt> Submodule</a></li>
<li><a class="reference external" href="#module-openlp.core.lib.event"><tt class="docutils literal"><span class="pre">event</span></tt> Submodule</a></li>
<li><a class="reference external" href="#module-openlp.core.lib.eventmanager"><tt class="docutils literal"><span class="pre">eventmanager</span></tt> Submodule</a></li>
<li><a class="reference external" href="#module-openlp.core.lib.eventreceiver"><tt class="docutils literal"><span class="pre">eventreceiver</span></tt> Submodule</a></li>
</ul>
</li>
<li><a class="reference external" href="#module-openlp.core.theme"><tt class="docutils literal"><span class="pre">theme</span></tt> Submodule</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="../openlp.html" title="previous chapter"><tt class="docutils literal"><span class="pre">openlp</span></tt> Module</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="../migration/index.html" title="next chapter"><tt class="docutils literal"><span class="pre">migration</span></tt> Module</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/core/index.txt">Show Source</a></li>
</ul>
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" size="18" /> <input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../modindex.html" title="Global Module Index"
accesskey="M">modules</a> |</li>
<li class="right" >
<a href="../migration/index.html" title="migration Module"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="../openlp.html" title="openlp Module"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">OpenLP v1.9.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2009, Raoul Snyman.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.5.1.
</div>
</body>
</html>

View File

@ -0,0 +1,197 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Index &mdash; OpenLP v1.9.0 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.9.0',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="index" title="Index" href="" />
<link rel="search" title="Search" href="search.html" />
<link rel="top" title="OpenLP v1.9.0 documentation" href="index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="modindex.html" title="Global Module Index"
accesskey="M">modules</a> |</li>
<li><a href="index.html">OpenLP v1.9.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1 id="index">Index</h1>
<a href="#A"><strong>A</strong></a> | <a href="#B"><strong>B</strong></a> | <a href="#C"><strong>C</strong></a> | <a href="#E"><strong>E</strong></a> | <a href="#G"><strong>G</strong></a> | <a href="#M"><strong>M</strong></a> | <a href="#O"><strong>O</strong></a> | <a href="#P"><strong>P</strong></a> | <a href="#R"><strong>R</strong></a> | <a href="#S"><strong>S</strong></a> | <a href="#T"><strong>T</strong></a>
<hr />
<h2 id="A">A</h2>
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
<dl>
<dt><a href="core/index.html#openlp.core.lib.ServiceItem.add_from_command">add_from_command() (ServiceItem method)</a></dt>
<dt><a href="core/index.html#openlp.core.lib.ServiceItem.add_from_image">add_from_image() (ServiceItem method)</a></dt>
<dt><a href="core/index.html#openlp.core.lib.ServiceItem.add_from_text">add_from_text() (ServiceItem method)</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="core/index.html#openlp.core.lib.ServiceItem.addIcon">addIcon() (ServiceItem method)</a></dt>
</dl></td></tr></table>
<h2 id="B">B</h2>
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
<dl>
<dt><a href="core/index.html#openlp.core.lib.baselistwithdnd.BaseListWithDnD">BaseListWithDnD (class in openlp.core.lib.baselistwithdnd)</a></dt>
<dt><a href="migration/index.html#openlp.migration.migratesongs.BaseModel">BaseModel (class in openlp.migration.migratesongs)</a></dt></dl></td><td width="33%" valign="top"><dl>
</dl></td></tr></table>
<h2 id="C">C</h2>
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
<dl>
<dt><a href="core/index.html#openlp.core.lib.contextMenuAction">contextMenuAction() (in module openlp.core.lib)</a></dt></dl></td><td width="33%" valign="top"><dl>
</dl></td></tr></table>
<h2 id="E">E</h2>
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
<dl>
<dt><a href="core/index.html#openlp.core.lib.event.Event">Event (class in openlp.core.lib.event)</a></dt>
<dt><a href="core/index.html#openlp.core.lib.eventmanager.EventManager">EventManager (class in openlp.core.lib.eventmanager)</a></dt>
<dt><a href="core/index.html#openlp.core.lib.eventreceiver.EventReceiver">EventReceiver (class in openlp.core.lib.eventreceiver)</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="core/index.html#openlp.core.lib.event.EventType">EventType (class in openlp.core.lib.event)</a></dt>
</dl></td></tr></table>
<h2 id="G">G</h2>
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
<dl>
<dt><a href="core/index.html#openlp.core.lib.ServiceItem.get_oos_repr">get_oos_repr() (ServiceItem method)</a></dt>
<dt><a href="core/index.html#openlp.core.lib.eventreceiver.Receiver.get_receiver">get_receiver (Receiver attribute)</a></dt></dl></td><td width="33%" valign="top"><dl>
</dl></td></tr></table>
<h2 id="M">M</h2>
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
<dl>
<dt><a href="core/index.html#openlp.core.lib.baselistwithdnd.BaseListWithDnD.mouseMoveEvent">mouseMoveEvent() (BaseListWithDnD method)</a></dt></dl></td><td width="33%" valign="top"><dl>
</dl></td></tr></table>
<h2 id="O">O</h2>
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
<dl>
<dt><a href="openlp.html#module-openlp">openlp (module)</a></dt>
<dt><a href="core/index.html#module-openlp.core">openlp.core (module)</a></dt>
<dt><a href="core/index.html#module-openlp.core.lib">openlp.core.lib (module)</a></dt>
<dt><a href="core/index.html#module-openlp.core.lib.baselistwithdnd">openlp.core.lib.baselistwithdnd (module)</a></dt>
<dt><a href="core/index.html#module-openlp.core.lib.event">openlp.core.lib.event (module)</a></dt>
<dt><a href="core/index.html#module-openlp.core.lib.eventmanager">openlp.core.lib.eventmanager (module)</a></dt>
<dt><a href="core/index.html#module-openlp.core.lib.eventreceiver">openlp.core.lib.eventreceiver (module)</a></dt>
<dt><a href="core/index.html#module-openlp.core.theme">openlp.core.theme (module)</a></dt>
<dt><a href="migration/index.html#module-openlp.migration">openlp.migration (module)</a></dt>
<dt><a href="migration/index.html#module-openlp.migration.display">openlp.migration.display (module)</a></dt>
<dt><a href="migration/index.html#module-openlp.migration.migratebibles">openlp.migration.migratebibles (module)</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="migration/index.html#module-openlp.migration.migratefiles">openlp.migration.migratefiles (module)</a></dt>
<dt><a href="migration/index.html#module-openlp.migration.migratesongs">openlp.migration.migratesongs (module)</a></dt>
<dt><a href="plugins/index.html#module-openlp.plugins">openlp.plugins (module)</a></dt>
<dt><a href="plugins/index.html#module-openlp.plugins.bibles">openlp.plugins.bibles (module)</a></dt>
<dt><a href="plugins/index.html#module-openlp.plugins.custom">openlp.plugins.custom (module)</a></dt>
<dt><a href="plugins/index.html#module-openlp.plugins.images">openlp.plugins.images (module)</a></dt>
<dt><a href="plugins/index.html#module-openlp.plugins.media">openlp.plugins.media (module)</a></dt>
<dt><a href="plugins/index.html#module-openlp.plugins.presentations">openlp.plugins.presentations (module)</a></dt>
<dt><a href="plugins/index.html#module-openlp.plugins.songs">openlp.plugins.songs (module)</a></dt>
</dl></td></tr></table>
<h2 id="P">P</h2>
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
<dl>
<dt><a href="migration/index.html#openlp.migration.migratesongs.BaseModel.populate">populate (BaseModel attribute)</a></dt></dl></td><td width="33%" valign="top"><dl>
</dl></td></tr></table>
<h2 id="R">R</h2>
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
<dl>
<dt><a href="core/index.html#openlp.core.lib.eventreceiver.Receiver.receive">receive (Receiver attribute)</a></dt>
<dt><a href="core/index.html#openlp.core.lib.eventreceiver.Receiver">Receiver (class in openlp.core.lib.eventreceiver)</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="core/index.html#openlp.core.lib.ServiceItem.render">render() (ServiceItem method)</a></dt>
</dl></td></tr></table>
<h2 id="S">S</h2>
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
<dl>
<dt><a href="core/index.html#openlp.core.lib.eventreceiver.Receiver.send_message">send_message (Receiver attribute)</a></dt>
<dt><a href="core/index.html#openlp.core.lib.ServiceItem">ServiceItem (class in openlp.core.lib)</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="core/index.html#openlp.core.lib.ServiceItem.set_from_oos">set_from_oos() (ServiceItem method)</a></dt>
</dl></td></tr></table>
<h2 id="T">T</h2>
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
<dl>
<dt><a href="migration/index.html#openlp.migration.migratesongs.TAuthor">TAuthor (class in openlp.migration.migratesongs)</a></dt>
<dt><a href="migration/index.html#openlp.migration.migratesongs.TSong">TSong (class in openlp.migration.migratesongs)</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="migration/index.html#openlp.migration.migratesongs.TSongAuthor">TSongAuthor (class in openlp.migration.migratesongs)</a></dt>
</dl></td></tr></table>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" /> <input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="modindex.html" title="Global Module Index"
accesskey="M">modules</a> |</li>
<li><a href="index.html">OpenLP v1.9.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2009, Raoul Snyman.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.5.1.
</div>
</body>
</html>

View File

@ -0,0 +1,140 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Welcome to OpenLP&#8217;s documentation! &mdash; OpenLP v1.9.0 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.9.0',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="top" title="OpenLP v1.9.0 documentation" href="" />
<link rel="next" title="openlp Module" href="openlp.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="modindex.html" title="Global Module Index"
accesskey="M">modules</a> |</li>
<li class="right" >
<a href="openlp.html" title="openlp Module"
accesskey="N">next</a> |</li>
<li><a href="">OpenLP v1.9.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="welcome-to-openlp-s-documentation">
<h1>Welcome to OpenLP&#8217;s documentation!<a class="headerlink" href="#welcome-to-openlp-s-documentation" title="Permalink to this headline"></a></h1>
<p>Contents:</p>
<ul>
<li class="toctree-l1"><a class="reference external" href="openlp.html"><tt class="docutils literal"><span class="pre">openlp</span></tt> Module</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference external" href="core/index.html"><tt class="docutils literal"><span class="pre">core</span></tt> Module</a><ul>
<li class="toctree-l2"><a class="reference external" href="core/index.html#module-openlp.core.lib"><tt class="docutils literal"><span class="pre">lib</span></tt> Module</a></li>
<li class="toctree-l2"><a class="reference external" href="core/index.html#module-openlp.core.theme"><tt class="docutils literal"><span class="pre">theme</span></tt> Submodule</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference external" href="migration/index.html"><tt class="docutils literal"><span class="pre">migration</span></tt> Module</a><ul>
<li class="toctree-l2"><a class="reference external" href="migration/index.html#module-openlp.migration.display"><tt class="docutils literal"><span class="pre">display</span></tt> Submodule</a></li>
<li class="toctree-l2"><a class="reference external" href="migration/index.html#module-openlp.migration.migratebibles"><tt class="docutils literal"><span class="pre">migratebibles</span></tt> Submodule</a></li>
<li class="toctree-l2"><a class="reference external" href="migration/index.html#module-openlp.migration.migratefiles"><tt class="docutils literal"><span class="pre">migratefiles</span></tt> Submodule</a></li>
<li class="toctree-l2"><a class="reference external" href="migration/index.html#module-openlp.migration.migratesongs"><tt class="docutils literal"><span class="pre">migratesongs</span></tt> Submodule</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference external" href="plugins/index.html"><tt class="docutils literal"><span class="pre">plugins</span></tt> Module</a><ul>
<li class="toctree-l2"><a class="reference external" href="plugins/index.html#module-openlp.plugins.songs"><tt class="docutils literal"><span class="pre">songs</span></tt> Plugin</a></li>
<li class="toctree-l2"><a class="reference external" href="plugins/index.html#module-openlp.plugins.bibles"><tt class="docutils literal"><span class="pre">bibles</span></tt> Plugin</a></li>
<li class="toctree-l2"><a class="reference external" href="plugins/index.html#module-openlp.plugins.presentations"><tt class="docutils literal"><span class="pre">presentations</span></tt> Plugin</a></li>
<li class="toctree-l2"><a class="reference external" href="plugins/index.html#module-openlp.plugins.media"><tt class="docutils literal"><span class="pre">media</span></tt> Plugin</a></li>
<li class="toctree-l2"><a class="reference external" href="plugins/index.html#module-openlp.plugins.images"><tt class="docutils literal"><span class="pre">images</span></tt> Plugin</a></li>
<li class="toctree-l2"><a class="reference external" href="plugins/index.html#module-openlp.plugins.custom"><tt class="docutils literal"><span class="pre">custom</span></tt> Plugin</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h1>
<ul class="simple">
<li><a class="reference external" href="genindex.html"><em>Index</em></a></li>
<li><a class="reference external" href="modindex.html"><em>Module Index</em></a></li>
<li><a class="reference external" href="search.html"><em>Search Page</em></a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="">Table Of Contents</a></h3>
<ul>
<li><a class="reference external" href="">Welcome to OpenLP&#8217;s documentation!</a><ul>
</ul>
</li>
<li><a class="reference external" href="#indices-and-tables">Indices and tables</a></li>
</ul>
<h4>Next topic</h4>
<p class="topless"><a href="openlp.html" title="next chapter"><tt class="docutils literal docutils literal"><span class="pre">openlp</span></tt> Module</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.txt">Show Source</a></li>
</ul>
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" /> <input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="modindex.html" title="Global Module Index"
accesskey="M">modules</a> |</li>
<li class="right" >
<a href="openlp.html" title="openlp Module"
accesskey="N">next</a> |</li>
<li><a href="">OpenLP v1.9.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2009, Raoul Snyman.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.5.1.
</div>
</body>
</html>

View File

@ -0,0 +1,211 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>migration Module &mdash; OpenLP v1.9.0 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.9.0',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="top" title="OpenLP v1.9.0 documentation" href="../index.html" />
<link rel="next" title="plugins Module" href="../plugins/index.html" />
<link rel="prev" title="core Module" href="../core/index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../modindex.html" title="Global Module Index"
accesskey="M">modules</a> |</li>
<li class="right" >
<a href="../plugins/index.html" title="plugins Module"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="../core/index.html" title="core Module"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">OpenLP v1.9.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-openlp.migration">
<span id="migration-index"></span><h1><tt class="xref docutils literal"><span class="pre">migration</span></tt> Module<a class="headerlink" href="#module-openlp.migration" title="Permalink to this headline"></a></h1>
<p>OpenLP - Open Source Lyrics Projection
Copyright (c) 2008 Raoul Snyman
Portions copyright (c) 2008 Martin Thompson, Tim Bentley</p>
<p>This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation; version 2 of the License.</p>
<p>This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place, Suite 330, Boston, MA 02111-1307 USA</p>
<div class="section" id="module-openlp.migration.display">
<h2><tt class="xref docutils literal"><span class="pre">display</span></tt> Submodule<a class="headerlink" href="#module-openlp.migration.display" title="Permalink to this headline"></a></h2>
<p>OpenLP - Open Source Lyrics Projection
Copyright (c) 2008 Raoul Snyman
Portions copyright (c) 2008 Martin Thompson, Tim Bentley</p>
<p>This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation; version 2 of the License.</p>
<p>This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place, Suite 330, Boston, MA 02111-1307 USA</p>
</div>
<div class="section" id="module-openlp.migration.migratebibles">
<h2><tt class="xref docutils literal"><span class="pre">migratebibles</span></tt> Submodule<a class="headerlink" href="#module-openlp.migration.migratebibles" title="Permalink to this headline"></a></h2>
<p>OpenLP - Open Source Lyrics Projection
Copyright (c) 2008 Raoul Snyman
Portions copyright (c) 2008 Martin Thompson, Tim Bentley</p>
<p>This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation; version 2 of the License.</p>
<p>This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place, Suite 330, Boston, MA 02111-1307 USA</p>
</div>
<div class="section" id="module-openlp.migration.migratefiles">
<h2><tt class="xref docutils literal"><span class="pre">migratefiles</span></tt> Submodule<a class="headerlink" href="#module-openlp.migration.migratefiles" title="Permalink to this headline"></a></h2>
<p>OpenLP - Open Source Lyrics Projection
Copyright (c) 2008 Raoul Snyman
Portions copyright (c) 2008 Martin Thompson, Tim Bentley</p>
<p>This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation; version 2 of the License.</p>
<p>This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place, Suite 330, Boston, MA 02111-1307 USA</p>
</div>
<div class="section" id="module-openlp.migration.migratesongs">
<h2><tt class="xref docutils literal"><span class="pre">migratesongs</span></tt> Submodule<a class="headerlink" href="#module-openlp.migration.migratesongs" title="Permalink to this headline"></a></h2>
<p>OpenLP - Open Source Lyrics Projection
Copyright (c) 2008 Raoul Snyman
Portions copyright (c) 2008 Martin Thompson, Tim Bentley</p>
<p>This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation; version 2 of the License.</p>
<p>This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place, Suite 330, Boston, MA 02111-1307 USA</p>
<dl class="class">
<dt id="openlp.migration.migratesongs.BaseModel">
<!--[openlp.migration.migratesongs.BaseModel]-->class <tt class="descname">BaseModel</tt><a class="headerlink" href="#openlp.migration.migratesongs.BaseModel" title="Permalink to this definition"></a></dt>
<dd><p>BaseModel provides a base object with a set of generic functions</p>
<dl class="attribute">
<dt id="openlp.migration.migratesongs.BaseModel.populate">
<!--[openlp.migration.migratesongs.BaseModel.populate]--><tt class="descname">populate</tt><a class="headerlink" href="#openlp.migration.migratesongs.BaseModel.populate" title="Permalink to this definition"></a></dt>
<dd>Creates an instance of a class and populates it, returning the instance</dd></dl>
</dd></dl>
<dl class="class">
<dt id="openlp.migration.migratesongs.TAuthor">
<!--[openlp.migration.migratesongs.TAuthor]-->class <tt class="descname">TAuthor</tt><a class="headerlink" href="#openlp.migration.migratesongs.TAuthor" title="Permalink to this definition"></a></dt>
<dd>Author model</dd></dl>
<dl class="class">
<dt id="openlp.migration.migratesongs.TSong">
<!--[openlp.migration.migratesongs.TSong]-->class <tt class="descname">TSong</tt><a class="headerlink" href="#openlp.migration.migratesongs.TSong" title="Permalink to this definition"></a></dt>
<dd>Author model</dd></dl>
<dl class="class">
<dt id="openlp.migration.migratesongs.TSongAuthor">
<!--[openlp.migration.migratesongs.TSongAuthor]-->class <tt class="descname">TSongAuthor</tt><a class="headerlink" href="#openlp.migration.migratesongs.TSongAuthor" title="Permalink to this definition"></a></dt>
<dd>Author model</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference external" href=""><tt class="docutils literal"><span class="pre">migration</span></tt> Module</a><ul>
<li><a class="reference external" href="#module-openlp.migration.display"><tt class="docutils literal"><span class="pre">display</span></tt> Submodule</a></li>
<li><a class="reference external" href="#module-openlp.migration.migratebibles"><tt class="docutils literal"><span class="pre">migratebibles</span></tt> Submodule</a></li>
<li><a class="reference external" href="#module-openlp.migration.migratefiles"><tt class="docutils literal"><span class="pre">migratefiles</span></tt> Submodule</a></li>
<li><a class="reference external" href="#module-openlp.migration.migratesongs"><tt class="docutils literal"><span class="pre">migratesongs</span></tt> Submodule</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="../core/index.html" title="previous chapter"><tt class="docutils literal docutils literal"><span class="pre">core</span></tt> Module</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="../plugins/index.html" title="next chapter"><tt class="docutils literal"><span class="pre">plugins</span></tt> Module</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/migration/index.txt">Show Source</a></li>
</ul>
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" size="18" /> <input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../modindex.html" title="Global Module Index"
accesskey="M">modules</a> |</li>
<li class="right" >
<a href="../plugins/index.html" title="plugins Module"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="../core/index.html" title="core Module"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">OpenLP v1.9.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2009, Raoul Snyman.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.5.1.
</div>
</body>
</html>

View File

@ -0,0 +1,170 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Global Module Index &mdash; OpenLP v1.9.0 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.9.0',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="top" title="OpenLP v1.9.0 documentation" href="index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="" title="Global Module Index"
accesskey="M">modules</a> |</li>
<li><a href="index.html">OpenLP v1.9.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1 id="global-module-index">Global Module Index</h1>
<a href="#cap-O"><strong>O</strong></a>
<hr/>
<table width="100%" class="indextable" cellspacing="0" cellpadding="2"><tr class="pcap"><td></td><td>&nbsp;</td><td></td></tr>
<tr class="cap"><td></td><td><a name="cap-O"><strong>O</strong></a></td><td></td></tr><tr>
<td><img src="_static/minus.png" id="toggle-1"
class="toggler" style="display: none" alt="-" /></td>
<td>
<a href="openlp.html#module-openlp"><tt class="xref">openlp</tt></a></td><td>
<em></em></td></tr><tr class="cg-1">
<td></td>
<td>&nbsp;&nbsp;&nbsp;
<a href="core/index.html#module-openlp.core"><tt class="xref">openlp.core</tt></a></td><td>
<em></em></td></tr><tr class="cg-1">
<td></td>
<td>&nbsp;&nbsp;&nbsp;
<a href="core/index.html#module-openlp.core.lib"><tt class="xref">openlp.core.lib</tt></a></td><td>
<em></em></td></tr><tr class="cg-1">
<td></td>
<td>&nbsp;&nbsp;&nbsp;
<a href="core/index.html#module-openlp.core.lib.baselistwithdnd"><tt class="xref">openlp.core.lib.baselistwithdnd</tt></a></td><td>
<em></em></td></tr><tr class="cg-1">
<td></td>
<td>&nbsp;&nbsp;&nbsp;
<a href="core/index.html#module-openlp.core.lib.event"><tt class="xref">openlp.core.lib.event</tt></a></td><td>
<em></em></td></tr><tr class="cg-1">
<td></td>
<td>&nbsp;&nbsp;&nbsp;
<a href="core/index.html#module-openlp.core.lib.eventmanager"><tt class="xref">openlp.core.lib.eventmanager</tt></a></td><td>
<em></em></td></tr><tr class="cg-1">
<td></td>
<td>&nbsp;&nbsp;&nbsp;
<a href="core/index.html#module-openlp.core.lib.eventreceiver"><tt class="xref">openlp.core.lib.eventreceiver</tt></a></td><td>
<em></em></td></tr><tr class="cg-1">
<td></td>
<td>&nbsp;&nbsp;&nbsp;
<a href="core/index.html#module-openlp.core.theme"><tt class="xref">openlp.core.theme</tt></a></td><td>
<em></em></td></tr><tr class="cg-1">
<td></td>
<td>&nbsp;&nbsp;&nbsp;
<a href="migration/index.html#module-openlp.migration"><tt class="xref">openlp.migration</tt></a></td><td>
<em></em></td></tr><tr class="cg-1">
<td></td>
<td>&nbsp;&nbsp;&nbsp;
<a href="migration/index.html#module-openlp.migration.display"><tt class="xref">openlp.migration.display</tt></a></td><td>
<em></em></td></tr><tr class="cg-1">
<td></td>
<td>&nbsp;&nbsp;&nbsp;
<a href="migration/index.html#module-openlp.migration.migratebibles"><tt class="xref">openlp.migration.migratebibles</tt></a></td><td>
<em></em></td></tr><tr class="cg-1">
<td></td>
<td>&nbsp;&nbsp;&nbsp;
<a href="migration/index.html#module-openlp.migration.migratefiles"><tt class="xref">openlp.migration.migratefiles</tt></a></td><td>
<em></em></td></tr><tr class="cg-1">
<td></td>
<td>&nbsp;&nbsp;&nbsp;
<a href="migration/index.html#module-openlp.migration.migratesongs"><tt class="xref">openlp.migration.migratesongs</tt></a></td><td>
<em></em></td></tr><tr class="cg-1">
<td></td>
<td>&nbsp;&nbsp;&nbsp;
<a href="plugins/index.html#module-openlp.plugins"><tt class="xref">openlp.plugins</tt></a></td><td>
<em></em></td></tr><tr class="cg-1">
<td></td>
<td>&nbsp;&nbsp;&nbsp;
<a href="plugins/index.html#module-openlp.plugins.bibles"><tt class="xref">openlp.plugins.bibles</tt></a></td><td>
<em></em></td></tr><tr class="cg-1">
<td></td>
<td>&nbsp;&nbsp;&nbsp;
<a href="plugins/index.html#module-openlp.plugins.custom"><tt class="xref">openlp.plugins.custom</tt></a></td><td>
<em></em></td></tr><tr class="cg-1">
<td></td>
<td>&nbsp;&nbsp;&nbsp;
<a href="plugins/index.html#module-openlp.plugins.images"><tt class="xref">openlp.plugins.images</tt></a></td><td>
<em></em></td></tr><tr class="cg-1">
<td></td>
<td>&nbsp;&nbsp;&nbsp;
<a href="plugins/index.html#module-openlp.plugins.media"><tt class="xref">openlp.plugins.media</tt></a></td><td>
<em></em></td></tr><tr class="cg-1">
<td></td>
<td>&nbsp;&nbsp;&nbsp;
<a href="plugins/index.html#module-openlp.plugins.presentations"><tt class="xref">openlp.plugins.presentations</tt></a></td><td>
<em></em></td></tr><tr class="cg-1">
<td></td>
<td>&nbsp;&nbsp;&nbsp;
<a href="plugins/index.html#module-openlp.plugins.songs"><tt class="xref">openlp.plugins.songs</tt></a></td><td>
<em></em></td></tr>
</table>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" /> <input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="" title="Global Module Index"
accesskey="M">modules</a> |</li>
<li><a href="index.html">OpenLP v1.9.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2009, Raoul Snyman.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.5.1.
</div>
</body>
</html>

View File

@ -0,0 +1,47 @@
# Sphinx inventory version 1
# Project: OpenLP
# Version: 2.0
openlp.core.lib.eventreceiver mod core/index.html
openlp.migration.display mod migration/index.html
openlp.core.lib mod core/index.html
openlp.migration.migratefiles mod migration/index.html
openlp.core.lib.eventmanager mod core/index.html
openlp.migration.migratebibles mod migration/index.html
openlp.migration mod migration/index.html
openlp.plugins.images mod plugins/index.html
openlp.plugins.songs mod plugins/index.html
openlp.core mod core/index.html
openlp.migration.migratesongs mod migration/index.html
openlp.plugins mod plugins/index.html
openlp.plugins.presentations mod plugins/index.html
openlp.plugins.media mod plugins/index.html
openlp.plugins.bibles mod plugins/index.html
openlp.core.lib.baselistwithdnd mod core/index.html
openlp.core.lib.event mod core/index.html
openlp.plugins.custom mod plugins/index.html
openlp mod openlp.html
openlp.core.theme mod core/index.html
openlp.core.lib.ServiceItem.get_oos_repr method core/index.html
openlp.core.lib.ServiceItem.render method core/index.html
openlp.core.lib.eventreceiver.Receiver class core/index.html
openlp.core.lib.eventreceiver.Receiver.get_receiver attribute core/index.html
openlp.core.lib.baselistwithdnd.BaseListWithDnD class core/index.html
openlp.core.lib.event.Event class core/index.html
openlp.migration.migratesongs.BaseModel class migration/index.html
openlp.core.lib.eventreceiver.Receiver.send_message attribute core/index.html
openlp.core.lib.eventmanager.EventManager class core/index.html
openlp.migration.migratesongs.BaseModel.populate attribute migration/index.html
openlp.core.lib.eventreceiver.Receiver.receive attribute core/index.html
openlp.migration.migratesongs.TSongAuthor class migration/index.html
openlp.core.lib.ServiceItem.add_from_image method core/index.html
openlp.core.lib.eventreceiver.EventReceiver class core/index.html
openlp.core.lib.ServiceItem.addIcon method core/index.html
openlp.migration.migratesongs.TSong class migration/index.html
openlp.core.lib.ServiceItem.add_from_command method core/index.html
openlp.core.lib.baselistwithdnd.BaseListWithDnD.mouseMoveEvent method core/index.html
openlp.core.lib.event.EventType class core/index.html
openlp.core.lib.ServiceItem.add_from_text method core/index.html
openlp.migration.migratesongs.TAuthor class migration/index.html
openlp.core.lib.ServiceItem.set_from_oos method core/index.html
openlp.core.lib.ServiceItem class core/index.html
openlp.core.lib.contextMenuAction function core/index.html

View File

@ -0,0 +1,114 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>openlp Module &mdash; OpenLP v1.9.0 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.9.0',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="top" title="OpenLP v1.9.0 documentation" href="index.html" />
<link rel="next" title="core Module" href="core/index.html" />
<link rel="prev" title="Welcome to OpenLP&#8217;s documentation!" href="index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="modindex.html" title="Global Module Index"
accesskey="M">modules</a> |</li>
<li class="right" >
<a href="core/index.html" title="core Module"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="Welcome to OpenLP&#8217;s documentation!"
accesskey="P">previous</a> |</li>
<li><a href="index.html">OpenLP v1.9.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-openlp">
<span id="openlp"></span><h1><tt class="xref docutils literal"><span class="pre">openlp</span></tt> Module<a class="headerlink" href="#module-openlp" title="Permalink to this headline"></a></h1>
<p>OpenLP - Open Source Lyrics Projection
Copyright (c) 2008 Raoul Snyman
Portions copyright (c) 2008-2009 Martin Thompson, Tim Bentley</p>
<p>This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation; version 2 of the License.</p>
<p>This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place, Suite 330, Boston, MA 02111-1307 USA</p>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="index.html" title="previous chapter">Welcome to OpenLP&#8217;s documentation!</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="core/index.html" title="next chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">core</span></tt> Module</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/openlp.txt">Show Source</a></li>
</ul>
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" /> <input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="modindex.html" title="Global Module Index"
accesskey="M">modules</a> |</li>
<li class="right" >
<a href="core/index.html" title="core Module"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="Welcome to OpenLP&#8217;s documentation!"
accesskey="P">previous</a> |</li>
<li><a href="index.html">OpenLP v1.9.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2009, Raoul Snyman.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.5.1.
</div>
</body>
</html>

View File

@ -0,0 +1,172 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>plugins Module &mdash; OpenLP v1.9.0 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.9.0',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="top" title="OpenLP v1.9.0 documentation" href="../index.html" />
<link rel="prev" title="migration Module" href="../migration/index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../modindex.html" title="Global Module Index"
accesskey="M">modules</a> |</li>
<li class="right" >
<a href="../migration/index.html" title="migration Module"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">OpenLP v1.9.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-openlp.plugins">
<span id="plugins-index"></span><h1><tt class="xref docutils literal"><span class="pre">plugins</span></tt> Module<a class="headerlink" href="#module-openlp.plugins" title="Permalink to this headline"></a></h1>
<div class="section" id="module-openlp.plugins.songs">
<h2><tt class="xref docutils literal"><span class="pre">songs</span></tt> Plugin<a class="headerlink" href="#module-openlp.plugins.songs" title="Permalink to this headline"></a></h2>
<p>OpenLP - Open Source Lyrics Projection
Copyright (c) 2008 Raoul Snyman
Portions copyright (c) 2008 Martin Thompson, Tim Bentley, Carsten Tinggaard</p>
<p>This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation; version 2 of the License.</p>
<p>This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place, Suite 330, Boston, MA 02111-1307 USA</p>
</div>
<div class="section" id="module-openlp.plugins.bibles">
<h2><tt class="xref docutils literal"><span class="pre">bibles</span></tt> Plugin<a class="headerlink" href="#module-openlp.plugins.bibles" title="Permalink to this headline"></a></h2>
<p>OpenLP - Open Source Lyrics Projection
Copyright (c) 2008 Raoul Snyman
Portions copyright (c) 2008 Martin Thompson, Tim Bentley</p>
<p>This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation; version 2 of the License.</p>
<p>This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place, Suite 330, Boston, MA 02111-1307 USA</p>
</div>
<div class="section" id="module-openlp.plugins.presentations">
<h2><tt class="xref docutils literal"><span class="pre">presentations</span></tt> Plugin<a class="headerlink" href="#module-openlp.plugins.presentations" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="module-openlp.plugins.media">
<h2><tt class="xref docutils literal"><span class="pre">media</span></tt> Plugin<a class="headerlink" href="#module-openlp.plugins.media" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="module-openlp.plugins.images">
<h2><tt class="xref docutils literal"><span class="pre">images</span></tt> Plugin<a class="headerlink" href="#module-openlp.plugins.images" title="Permalink to this headline"></a></h2>
<p>OpenLP - Open Source Lyrics Projection
Copyright (c) 2008 - 2009 Raoul Snyman
Portions copyright (c) 2008 - 2009 Martin Thompson, Tim Bentley,</p>
<p>This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation; version 2 of the License.</p>
<p>This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place, Suite 330, Boston, MA 02111-1307 USA</p>
</div>
<div class="section" id="module-openlp.plugins.custom">
<h2><tt class="xref docutils literal"><span class="pre">custom</span></tt> Plugin<a class="headerlink" href="#module-openlp.plugins.custom" title="Permalink to this headline"></a></h2>
<p>OpenLP - Open Source Lyrics Projection
Copyright (c) 2008 Raoul Snyman
Portions copyright (c) 2008-2009 Martin Thompson, Tim Bentley, Carsten Tinggaard</p>
<p>This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation; version 2 of the License.</p>
<p>This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place, Suite 330, Boston, MA 02111-1307 USA</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference external" href=""><tt class="docutils literal"><span class="pre">plugins</span></tt> Module</a><ul>
<li><a class="reference external" href="#module-openlp.plugins.songs"><tt class="docutils literal"><span class="pre">songs</span></tt> Plugin</a></li>
<li><a class="reference external" href="#module-openlp.plugins.bibles"><tt class="docutils literal"><span class="pre">bibles</span></tt> Plugin</a></li>
<li><a class="reference external" href="#module-openlp.plugins.presentations"><tt class="docutils literal"><span class="pre">presentations</span></tt> Plugin</a></li>
<li><a class="reference external" href="#module-openlp.plugins.media"><tt class="docutils literal"><span class="pre">media</span></tt> Plugin</a></li>
<li><a class="reference external" href="#module-openlp.plugins.images"><tt class="docutils literal"><span class="pre">images</span></tt> Plugin</a></li>
<li><a class="reference external" href="#module-openlp.plugins.custom"><tt class="docutils literal"><span class="pre">custom</span></tt> Plugin</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="../migration/index.html" title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">migration</span></tt> Module</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/plugins/index.txt">Show Source</a></li>
</ul>
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" size="18" /> <input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../modindex.html" title="Global Module Index"
accesskey="M">modules</a> |</li>
<li class="right" >
<a href="../migration/index.html" title="migration Module"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">OpenLP v1.9.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2009, Raoul Snyman.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.5.1.
</div>
</body>
</html>

View File

@ -0,0 +1,89 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Search &mdash; OpenLP v1.9.0 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.9.0',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/searchtools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="" />
<link rel="top" title="OpenLP v1.9.0 documentation" href="index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="modindex.html" title="Global Module Index"
accesskey="M">modules</a> |</li>
<li><a href="index.html">OpenLP v1.9.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1 id="search-documentation">Search</h1>
<p>
From here you can search these documents. Enter your search
words into the box below and click "search". Note that the search
function will automatically search for all of the words. Pages
containing fewer words won't appear in the result list.
</p>
<form action="" method="get">
<input type="text" name="q" value="" />
<input type="submit" value="search" />
<span id="search-progress" style="padding-left: 10px"></span>
</form>
<div id="search-results">
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="modindex.html" title="Global Module Index"
accesskey="M">modules</a> |</li>
<li><a href="index.html">OpenLP v1.9.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2009, Raoul Snyman.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.5.1.
</div>
<script type="text/javascript" src="searchindex.js"></script>
</body>
</html>

View File

@ -0,0 +1 @@
Search.setIndex({desctypes:{"0":"method","1":"class","2":"attribute","3":"function"},terms:{recipi:4,all:4,help:4,just:4,migrateb:[0,1],text:4,move:4,lyric:[1,2,3,4],messageid:4,mousemoveev:4,openlp:[0,1,2,3,4],disk:4,slot:4,decid:4,locat:4,guerreri:4,copyright:[1,2,3,4],menu:4,frame_titl:4,send:4,should:[0,1,2,3,4],whether:4,theme:[0,4],program:[1,2,3,4],snyman:[1,2,3,4],under:[1,2,3,4],thompson:[1,2,3,4],save:4,hope:[1,2,3,4],build:4,merchant:[1,2,3,4],tsongauthor:1,sourc:[1,2,3,4],"return":[1,4],around:4,song:[0,2],none:4,util:4,add_from_command:4,mechan:4,command:4,span:[1,2,3,4],requir:4,eventtyp:4,term:[1,2,3,4],document:0,name:4,somth:4,docutil:[1,2,3,4],signal:4,drop:4,method:4,item:4,slide:4,have:[1,2,3,4],serviceitem:4,scott:4,architectur:4,manag:4,pleas:4,servicemanag:4,impli:[1,2,3,4],set:1,frame:4,some:4,direct:0,across:4,redistribut:[1,2,3,4],"static":4,connect:4,bentlei:[1,2,3,4],pass:4,extract:4,event:4,contextmenuact:4,hostplugin:4,even:[1,2,3,4],index:0,what:4,publish:[1,2,3,4],your:0,content:0,"public":[1,2,3,4],version:[1,2,3,4],adapt:0,jonathan:4,tingaard:4,eventreceiv:4,migratesong:[0,1],core:[0,4],privat:4,bibl:[0,2],parent:4,event_typ:4,migrat:[0,1],screen:4,martin:[1,2,3,4],onli:4,free:[1,2,3,4],like:0,base:[1,4],here:4,put:4,compositor:4,along:[1,2,3,4],templ:[1,2,3,4],modifi:[1,2,3,4],popul:1,raoul:[1,2,3,4],search:0,actual:4,fit:[1,2,3,4],plugin:[0,2,4],baselistwithdnd:4,drag:4,carsten:[2,4],instanc:[1,4],place:[1,2,3,4],descript:4,context:4,basemodel:1,gener:[1,2,3,4],fri:0,softwar:[1,2,3,4],via:4,directli:4,modul:[0,1,2,3,4],within:4,foundat:[1,2,3,4],submodul:[0,1,4],system:4,warranti:[1,2,3,4],model:1,messag:4,path:4,qobject:4,open:[1,2,3,4],payload:4,select:4,quickstart:0,differ:4,from:4,usa:[1,2,3,4],interact:4,regist:4,add:4,least:0,custom:[0,2],addicon:4,call:4,handle_ev:4,suit:[1,2,3,4],master:0,set_from_oo:4,type:4,tell:4,store:4,more:[1,2,3,4],"function":1,wrapper:4,imag:[0,2,4],copi:[1,2,3,4],jul:0,provid:[1,4],part:4,particular:[1,2,3,4],present:[0,2],send_messag:4,endpoint:4,gnu:[1,2,3,4],"default":4,qtcore:4,servic:4,displai:[0,1,4],project:[1,2,3,4],can:[0,1,2,3,4],add_from_imag:4,purpos:[1,2,3,4],root:0,get_oos_repr:4,care:4,control:4,listen:4,encapsul:4,creat:[0,1],boston:[1,2,3,4],toctre:0,ani:[1,2,3,4],indic:0,repres:4,raw:4,add_from_text:4,file:[0,4],tabl:0,tauthor:1,string:4,pre:[1,2,3,4],lib:[0,4],author:1,receiv:[1,2,3,4],titl:4,when:4,detail:[1,2,3,4],write:[1,2,3,4],tim:[1,2,3,4],raw_slid:4,take:4,which:4,icon:4,you:[0,1,2,3,4],inc:[1,2,3,4],corwin:4,complet:0,tinggaard:2,resourc:4,distribut:[1,2,3,4],see:[1,2,3,4],liter:[1,2,3,4],openlprepaint:4,org:4,licens:[1,2,3,4],get_receiv:4,action:4,render:4,thi:[0,1,2,3,4],contain:0,data:4,"class":[1,2,3,4],welcom:0,"short":4,sphinx:0,qicon:4,directori:4,eventmanag:4,page:0,request:4,object:1,doe:4,portion:[1,2,3,4],without:[1,2,3,4],ignor:4,allow:4,media:[0,2],tsong:1,migratefil:[0,1],usual:4},titles:["Welcome to OpenLP&#8217;s documentation!","<tt class=\"docutils literal docutils literal\"><span class=\"pre\">migration</span></tt> Module","<tt class=\"docutils literal docutils literal\"><span class=\"pre\">plugins</span></tt> Module","<tt class=\"docutils literal docutils literal docutils literal\"><span class=\"pre\">openlp</span></tt> Module","<tt class=\"docutils literal\"><span class=\"pre\">core</span></tt> Module"],modules:{"openlp.core.lib.eventreceiver":4,"openlp.migration.display":1,"openlp.core.lib":4,"openlp.migration.migratefiles":1,"openlp.core.lib.eventmanager":4,"openlp.migration.migratebibles":1,"openlp.migration":1,"openlp.plugins.images":2,"openlp.plugins.songs":2,"openlp.core":4,"openlp.migration.migratesongs":1,"openlp.core.theme":4,"openlp.plugins":2,"openlp.plugins.media":2,"openlp.plugins.bibles":2,"openlp.core.lib.baselistwithdnd":4,"openlp.core.lib.event":4,"openlp.plugins.custom":2,openlp:3,"openlp.plugins.presentations":2},descrefs:{"openlp.core.lib.eventreceiver":{EventReceiver:[4,1],Receiver:[4,1]},"openlp.core.lib":{contextMenuAction:[4,3],ServiceItem:[4,1]},"openlp.core.lib.eventmanager":{EventManager:[4,1]},"openlp.core.lib.ServiceItem":{set_from_oos:[4,0],render:[4,0],addIcon:[4,0],add_from_command:[4,0],add_from_text:[4,0],add_from_image:[4,0],get_oos_repr:[4,0]},"openlp.core.lib.eventreceiver.Receiver":{get_receiver:[4,2],receive:[4,2],send_message:[4,2]},"openlp.migration.migratesongs":{TSongAuthor:[1,1],TSong:[1,1],TAuthor:[1,1],BaseModel:[1,1]},"openlp.core.lib.baselistwithdnd.BaseListWithDnD":{mouseMoveEvent:[4,0]},"openlp.core.lib.baselistwithdnd":{BaseListWithDnD:[4,1]},"openlp.core.lib.event":{EventType:[4,1],Event:[4,1]},"openlp.migration.migratesongs.BaseModel":{populate:[1,2]}},filenames:["index","migration/index","plugins/index","openlp","core/index"]})