forked from openlp/openlp
Removed an incorrect import.
Added more documentation.
This commit is contained in:
parent
baaa7e0508
commit
009e337158
@ -3,9 +3,13 @@
|
|||||||
:mod:`core` Module
|
:mod:`core` Module
|
||||||
==================
|
==================
|
||||||
|
|
||||||
|
.. automodule:: openlp.core
|
||||||
|
:members:
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
lib
|
lib
|
||||||
theme
|
theme
|
||||||
|
ui
|
||||||
|
utils
|
@ -1,7 +1,7 @@
|
|||||||
.. _core-lib:
|
.. _core-lib:
|
||||||
|
|
||||||
:mod:`lib` Module
|
Object Library
|
||||||
=================
|
==============
|
||||||
|
|
||||||
.. automodule:: openlp.core.lib
|
.. automodule:: openlp.core.lib
|
||||||
:members:
|
:members:
|
||||||
|
27
documentation/api/source/core/ui.rst
Normal file
27
documentation/api/source/core/ui.rst
Normal file
@ -0,0 +1,27 @@
|
|||||||
|
.. _core-ui:
|
||||||
|
|
||||||
|
User Interface
|
||||||
|
==============
|
||||||
|
|
||||||
|
.. automodule:: openlp.core.ui
|
||||||
|
|
||||||
|
Main Windows
|
||||||
|
------------
|
||||||
|
|
||||||
|
.. autoclass:: openlp.core.ui.mainwindow.MainWindow
|
||||||
|
:members:
|
||||||
|
|
||||||
|
.. autoclass:: openlp.core.ui.maindisplay.MainDisplay
|
||||||
|
:members:
|
||||||
|
|
||||||
|
Managers
|
||||||
|
--------
|
||||||
|
|
||||||
|
.. autoclass:: openlp.core.ui.servicemanager.ServiceManager
|
||||||
|
:members:
|
||||||
|
|
||||||
|
.. autoclass:: openlp.core.ui.mediadockmanager.MediaDockManager
|
||||||
|
:members:
|
||||||
|
|
||||||
|
.. autoclass:: openlp.core.ui.thememanager.ThemeManager
|
||||||
|
:members:
|
7
documentation/api/source/core/utils.rst
Normal file
7
documentation/api/source/core/utils.rst
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
.. _core-utils:
|
||||||
|
|
||||||
|
Utilities
|
||||||
|
=========
|
||||||
|
|
||||||
|
.. automodule:: openlp.core.utils
|
||||||
|
:members:
|
@ -15,7 +15,6 @@ Contents:
|
|||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
openlp
|
|
||||||
core/index
|
core/index
|
||||||
plugins/index
|
plugins/index
|
||||||
|
|
||||||
|
34
documentation/api/source/plugins/custom.rst
Normal file
34
documentation/api/source/plugins/custom.rst
Normal file
@ -0,0 +1,34 @@
|
|||||||
|
.. _plugins-custom:
|
||||||
|
|
||||||
|
Custom Slides Plugin
|
||||||
|
====================
|
||||||
|
|
||||||
|
.. automodule:: openlp.plugins.custom
|
||||||
|
:members:
|
||||||
|
|
||||||
|
Plugin Class
|
||||||
|
------------
|
||||||
|
|
||||||
|
.. autoclass:: openlp.plugins.custom.customplugin.CustomPlugin
|
||||||
|
:members:
|
||||||
|
|
||||||
|
Forms
|
||||||
|
-----
|
||||||
|
|
||||||
|
.. automodule:: openlp.plugins.custom.forms
|
||||||
|
:members:
|
||||||
|
|
||||||
|
.. autoclass:: openlp.plugins.custom.forms.editcustomform.EditCustomForm
|
||||||
|
:members:
|
||||||
|
|
||||||
|
.. autoclass:: openlp.plugins.custom.forms.editcustomslideform.EditCustomSlideForm
|
||||||
|
:members:
|
||||||
|
|
||||||
|
Helper Classes & Functions
|
||||||
|
--------------------------
|
||||||
|
|
||||||
|
.. automodule:: openlp.plugins.custom.lib
|
||||||
|
:members:
|
||||||
|
|
||||||
|
.. automodule:: openlp.plugins.custom.lib.mediaitem
|
||||||
|
:members:
|
@ -1,7 +1,7 @@
|
|||||||
.. _plugins-index:
|
.. _plugins-index:
|
||||||
|
|
||||||
:mod:`plugins` Module
|
Plugins
|
||||||
=====================
|
=======
|
||||||
|
|
||||||
.. automodule:: openlp.plugins
|
.. automodule:: openlp.plugins
|
||||||
:members:
|
:members:
|
||||||
@ -14,15 +14,6 @@
|
|||||||
presentations
|
presentations
|
||||||
media
|
media
|
||||||
images
|
images
|
||||||
|
custom
|
||||||
:mod:`custom` Plugin
|
remotes
|
||||||
--------------------
|
songusage
|
||||||
|
|
||||||
.. automodule:: openlp.plugins.custom
|
|
||||||
:members:
|
|
||||||
|
|
||||||
:mod:`songusage` Plugin
|
|
||||||
-----------------------
|
|
||||||
|
|
||||||
.. automodule:: openlp.plugins.songusage
|
|
||||||
:members:
|
|
||||||
|
19
documentation/api/source/plugins/remotes.rst
Normal file
19
documentation/api/source/plugins/remotes.rst
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
.. _plugins-remotes:
|
||||||
|
|
||||||
|
Remotes Plugin
|
||||||
|
==============
|
||||||
|
|
||||||
|
.. automodule:: openlp.plugins.remotes
|
||||||
|
:members:
|
||||||
|
|
||||||
|
Plugin Class
|
||||||
|
------------
|
||||||
|
|
||||||
|
.. autoclass:: openlp.plugins.remotes.remoteplugin.RemotesPlugin
|
||||||
|
:members:
|
||||||
|
|
||||||
|
Helper Classes & Functions
|
||||||
|
--------------------------
|
||||||
|
|
||||||
|
.. automodule:: openlp.plugins.remotes.lib
|
||||||
|
:members:
|
25
documentation/api/source/plugins/songusage.rst
Normal file
25
documentation/api/source/plugins/songusage.rst
Normal file
@ -0,0 +1,25 @@
|
|||||||
|
.. _plugins-songusage:
|
||||||
|
|
||||||
|
Song Usage Plugin
|
||||||
|
=================
|
||||||
|
|
||||||
|
.. automodule:: openlp.plugins.songusage
|
||||||
|
:members:
|
||||||
|
|
||||||
|
Plugin Class
|
||||||
|
------------
|
||||||
|
|
||||||
|
.. autoclass:: openlp.plugins.songusage.songusageplugin.SongUsagePlugin
|
||||||
|
:members:
|
||||||
|
|
||||||
|
Forms
|
||||||
|
-----
|
||||||
|
|
||||||
|
.. automodule:: openlp.plugins.songusage.forms
|
||||||
|
:members:
|
||||||
|
|
||||||
|
Helper Classes & Functions
|
||||||
|
--------------------------
|
||||||
|
|
||||||
|
.. automodule:: openlp.plugins.songusage.lib
|
||||||
|
:members:
|
@ -39,7 +39,6 @@ class HideMode(object):
|
|||||||
|
|
||||||
from filerenameform import FileRenameForm
|
from filerenameform import FileRenameForm
|
||||||
from maindisplay import MainDisplay
|
from maindisplay import MainDisplay
|
||||||
from slidecontroller import HideMode
|
|
||||||
from servicenoteform import ServiceNoteForm
|
from servicenoteform import ServiceNoteForm
|
||||||
from serviceitemeditform import ServiceItemEditForm
|
from serviceitemeditform import ServiceItemEditForm
|
||||||
from screen import ScreenList
|
from screen import ScreenList
|
||||||
|
@ -90,6 +90,9 @@ class DisplayWidget(QtGui.QGraphicsView):
|
|||||||
event.ignore()
|
event.ignore()
|
||||||
|
|
||||||
class MainDisplay(DisplayWidget):
|
class MainDisplay(DisplayWidget):
|
||||||
|
"""
|
||||||
|
This is the display screen.
|
||||||
|
"""
|
||||||
|
|
||||||
def __init__(self, parent, screens, live):
|
def __init__(self, parent, screens, live):
|
||||||
DisplayWidget.__init__(self, live, parent=None)
|
DisplayWidget.__init__(self, live, parent=None)
|
||||||
|
Loading…
Reference in New Issue
Block a user