core Module

OpenLP - Open Source Lyrics Projection Copyright (c) 2008 Raoul Snyman Portions copyright (c) 2008-2009 Martin Thompson, Tim Bentley

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.

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.

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

lib Module

OpenLP - Open Source Lyrics Projection Copyright (c) 2008 Raoul Snyman Portions copyright (c) 2008-2009 Martin Thompson, Tim Bentley,

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.

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.

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

contextMenuAction(base, icon, text, slot)

Utility method to help build context menus for plugins

class ServiceItem(hostplugin=None)

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.

addIcon(icon)

Add an icon to the service item. This is used when displaying the service item in the service manager.

icon

An instance of QIcon or a string to an icon in the resource or on disk.

add_from_command(frame_title, command)

Add a slide from a command.

frame_title

The title of the slide in the service item.

command

The command of/for the slide.

add_from_image(path, frame_title, image)

Add an image slide to the service item.

path

The directory in which the image file is located.

frame_title

A title for the slide in the service item.

image

The actual image file name.

add_from_text(frame_title, raw_slide)

Add a text slide to the service item.

frame_title

The title of the slide in the service item.

raw_slide

The raw text of the slide.

get_oos_repr()

This method returns some text which can be saved into the OOS file to represent this item.

render()

The render method is what renders the frames for the screen.

set_from_oos(serviceitem, path=None)

This method takes a service item from a saved service file (passed from the ServiceManager) and extracts the data actually required.

serviceitem

The item to extract data from.

path

Defaults to None. Any path data, usually for images.

baselistwithdnd Submodule

OpenLP - Open Source Lyrics Projection Copyright (c) 2008-2009 Raoul Snyman Portions copyright (c) 2008-2009 Martin Thompson, Tim Bentley

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.

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.

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

class BaseListWithDnD(parent=None)

Please put a short description of what this class does in here.

mouseMoveEvent(event)

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

event Submodule

OpenLP - Open Source Lyrics Projection

Copyright (c) 2008 Raoul Snyman

Portions copyright (c) 2008-2009 Martin Thompson, Tim Bentley, Scott Guerreri, Carsten Tingaard, Jonathan Corwin

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.

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.

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

class Event(event_type=0, payload=None)

Provides an Event class to encapsulate events within openlp.org.

class EventType

Types of events are stored in this class.

eventmanager Submodule

OpenLP - Open Source Lyrics Projection

Copyright (c) 2008 Raoul Snyman

Portions copyright (c) 2008-2009 Martin Thompson, Tim Bentley, Scott Guerreri, Carsten Tingaard, Jonathan Corwin

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.

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.

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

class EventManager

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

eventreceiver Submodule

OpenLP - Open Source Lyrics Projection

Copyright (c) 2008 Raoul Snyman

Portions copyright (c) 2008-2009 Martin Thompson, Tim Bentley,

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.

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.

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

class EventReceiver

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

class Receiver

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

Send message

Receiver().send_message(u’messageid’,data)

Receive Message

QtCore.QObject.connect(Receiver().get_receiver(),QtCore.SIGNAL(u’openlprepaint’),<<ACTION>>)

get_receiver

receive

send_message

theme Submodule

OpenLP - Open Source Lyrics Projection Copyright (c) 2008 Raoul Snyman Portions copyright (c) 2008 Martin Thompson, Tim Bentley

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.

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.

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