<spanid="core-index"></span><h1><ttclass="xref docutils literal"><spanclass="pre">core</span></tt> Module<aclass="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>
<divclass="section"id="module-openlp.core.lib">
<h2><ttclass="xref docutils literal"><spanclass="pre">lib</span></tt> Module<aclass="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>
<dlclass="function">
<dtid="openlp.core.lib.contextMenuAction">
<!--[openlp.core.lib.contextMenuAction]--><ttclass="descname">contextMenuAction</tt><big>(</big><em>base</em>, <em>icon</em>, <em>text</em>, <em>slot</em><big>)</big><aclass="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>
<dlclass="class">
<dtid="openlp.core.lib.ServiceItem">
<!--[openlp.core.lib.ServiceItem]-->class <ttclass="descname">ServiceItem</tt><big>(</big><em>hostplugin=None</em><big>)</big><aclass="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>
<dlclass="method">
<dtid="openlp.core.lib.ServiceItem.addIcon">
<!--[openlp.core.lib.ServiceItem.addIcon]--><ttclass="descname">addIcon</tt><big>(</big><em>icon</em><big>)</big><aclass="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
<!--[openlp.core.lib.ServiceItem.add_from_command]--><ttclass="descname">add_from_command</tt><big>(</big><em>frame_title</em>, <em>command</em><big>)</big><aclass="headerlink"href="#openlp.core.lib.ServiceItem.add_from_command"title="Permalink to this definition">¶</a></dt>
<!--[openlp.core.lib.ServiceItem.add_from_image]--><ttclass="descname">add_from_image</tt><big>(</big><em>path</em>, <em>frame_title</em>, <em>image</em><big>)</big><aclass="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>
<!--[openlp.core.lib.ServiceItem.add_from_text]--><ttclass="descname">add_from_text</tt><big>(</big><em>frame_title</em>, <em>raw_slide</em><big>)</big><aclass="headerlink"href="#openlp.core.lib.ServiceItem.add_from_text"title="Permalink to this definition">¶</a></dt>
<!--[openlp.core.lib.ServiceItem.get_oos_repr]--><ttclass="descname">get_oos_repr</tt><big>(</big><big>)</big><aclass="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>
<dlclass="method">
<dtid="openlp.core.lib.ServiceItem.render">
<!--[openlp.core.lib.ServiceItem.render]--><ttclass="descname">render</tt><big>(</big><big>)</big><aclass="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>
<dlclass="method">
<dtid="openlp.core.lib.ServiceItem.set_from_oos">
<!--[openlp.core.lib.ServiceItem.set_from_oos]--><ttclass="descname">set_from_oos</tt><big>(</big><em>serviceitem</em>, <em>path=None</em><big>)</big><aclass="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>
<h3><ttclass="xref docutils literal"><spanclass="pre">baselistwithdnd</span></tt> Submodule<aclass="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
<!--[openlp.core.lib.baselistwithdnd.BaseListWithDnD]-->class <ttclass="descname">BaseListWithDnD</tt><big>(</big><em>parent=None</em><big>)</big><aclass="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>
<!--[openlp.core.lib.baselistwithdnd.BaseListWithDnD.mouseMoveEvent]--><ttclass="descname">mouseMoveEvent</tt><big>(</big><em>event</em><big>)</big><aclass="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
<h3><ttclass="xref docutils literal"><spanclass="pre">event</span></tt> Submodule<aclass="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>
<dlclass="class">
<dtid="openlp.core.lib.event.Event">
<!--[openlp.core.lib.event.Event]-->class <ttclass="descname">Event</tt><big>(</big><em>event_type=0</em>, <em>payload=None</em><big>)</big><aclass="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>
<dlclass="class">
<dtid="openlp.core.lib.event.EventType">
<!--[openlp.core.lib.event.EventType]-->class <ttclass="descname">EventType</tt><aclass="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>
<h3><ttclass="xref docutils literal"><spanclass="pre">eventmanager</span></tt> Submodule<aclass="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
<!--[openlp.core.lib.eventmanager.EventManager]-->class <ttclass="descname">EventManager</tt><aclass="headerlink"href="#openlp.core.lib.eventmanager.EventManager"title="Permalink to this definition">¶</a></dt>
<!--[openlp.core.lib.eventmanager.EventManager.post_event]--><ttclass="descname">post_event</tt><big>(</big><em>event</em><big>)</big><aclass="headerlink"href="#openlp.core.lib.eventmanager.EventManager.post_event"title="Permalink to this definition">¶</a></dt>
<dd><p>Called by any part of the system which wants send events to the plugins</p>
<!--[openlp.core.lib.eventmanager.EventManager.register]--><ttclass="descname">register</tt><big>(</big><em>plugin</em><big>)</big><aclass="headerlink"href="#openlp.core.lib.eventmanager.EventManager.register"title="Permalink to this definition">¶</a></dt>
<dd>Called by plugings who wish to receive event notifications</dd></dl>
<h3><ttclass="xref docutils literal"><spanclass="pre">eventreceiver</span></tt> Submodule<aclass="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
<!--[openlp.core.lib.eventreceiver.EventReceiver]-->class <ttclass="descname">EventReceiver</tt><aclass="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>
<dlclass="class">
<dtid="openlp.core.lib.eventreceiver.Receiver">
<!--[openlp.core.lib.eventreceiver.Receiver]-->class <ttclass="descname">Receiver</tt><aclass="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
<!--[openlp.core.lib.eventreceiver.Receiver.get_receiver]--><ttclass="descname">get_receiver</tt><aclass="headerlink"href="#openlp.core.lib.eventreceiver.Receiver.get_receiver"title="Permalink to this definition">¶</a></dt>
<!--[openlp.core.lib.eventreceiver.Receiver.receive]--><ttclass="descname">receive</tt><aclass="headerlink"href="#openlp.core.lib.eventreceiver.Receiver.receive"title="Permalink to this definition">¶</a></dt>
<!--[openlp.core.lib.eventreceiver.Receiver.send_message]--><ttclass="descname">send_message</tt><aclass="headerlink"href="#openlp.core.lib.eventreceiver.Receiver.send_message"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</div>
</div>
<divclass="section"id="module-openlp.core.theme">
<h2><ttclass="xref docutils literal"><spanclass="pre">theme</span></tt> Submodule<aclass="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>
<divclass="sphinxsidebar">
<divclass="sphinxsidebarwrapper">
<h3><ahref="../index.html">Table Of Contents</a></h3>
