diff --git a/documentation/api/source/core/index.rst b/documentation/api/source/core/index.rst index 38a98ab97..8555e1ebe 100644 --- a/documentation/api/source/core/index.rst +++ b/documentation/api/source/core/index.rst @@ -3,9 +3,13 @@ :mod:`core` Module ================== +.. automodule:: openlp.core + :members: + .. toctree:: :maxdepth: 2 lib theme - + ui + utils \ No newline at end of file diff --git a/documentation/api/source/core/lib.rst b/documentation/api/source/core/lib.rst index 5fc66200d..6ca952d7d 100644 --- a/documentation/api/source/core/lib.rst +++ b/documentation/api/source/core/lib.rst @@ -1,7 +1,7 @@ .. _core-lib: -:mod:`lib` Module -================= +Object Library +============== .. automodule:: openlp.core.lib :members: diff --git a/documentation/api/source/core/ui.rst b/documentation/api/source/core/ui.rst new file mode 100644 index 000000000..63db7478e --- /dev/null +++ b/documentation/api/source/core/ui.rst @@ -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: diff --git a/documentation/api/source/core/utils.rst b/documentation/api/source/core/utils.rst new file mode 100644 index 000000000..d0c6a672b --- /dev/null +++ b/documentation/api/source/core/utils.rst @@ -0,0 +1,7 @@ +.. _core-utils: + +Utilities +========= + +.. automodule:: openlp.core.utils + :members: diff --git a/documentation/api/source/index.rst b/documentation/api/source/index.rst index cd64b13a1..e1aeebbab 100644 --- a/documentation/api/source/index.rst +++ b/documentation/api/source/index.rst @@ -15,7 +15,6 @@ Contents: .. toctree:: :maxdepth: 2 - openlp core/index plugins/index diff --git a/documentation/api/source/plugins/alerts.rst b/documentation/api/source/plugins/alerts.rst new file mode 100644 index 000000000..e7cf33d63 --- /dev/null +++ b/documentation/api/source/plugins/alerts.rst @@ -0,0 +1,31 @@ +.. _plugins-alerts: + +Alerts Plugin +============= + +.. automodule:: openlp.plugins.alerts + :members: + +Plugin Class +------------ + +.. autoclass:: openlp.plugins.alerts.alertsplugin.AlertsPlugin + :members: + +Forms +----- + +.. automodule:: openlp.plugins.alerts.forms + :members: + +.. autoclass:: openlp.plugins.alerts.forms.alertform.AlertForm + :members: + +Helper Classes & Functions +-------------------------- + +.. automodule:: openlp.plugins.alerts.lib + :members: + +.. automodule:: openlp.plugins.alerts.lib.db + :members: diff --git a/documentation/api/source/plugins/custom.rst b/documentation/api/source/plugins/custom.rst new file mode 100644 index 000000000..f50b86d41 --- /dev/null +++ b/documentation/api/source/plugins/custom.rst @@ -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: diff --git a/documentation/api/source/plugins/index.rst b/documentation/api/source/plugins/index.rst index 6c5b139d5..78126ff9e 100644 --- a/documentation/api/source/plugins/index.rst +++ b/documentation/api/source/plugins/index.rst @@ -1,7 +1,7 @@ .. _plugins-index: -:mod:`plugins` Module -===================== +Plugins +======= .. automodule:: openlp.plugins :members: @@ -14,15 +14,7 @@ presentations media images - -:mod:`custom` Plugin --------------------- - -.. automodule:: openlp.plugins.custom - :members: - -:mod:`songusage` Plugin ------------------------ - -.. automodule:: openlp.plugins.songusage - :members: + custom + remotes + songusage + alerts diff --git a/documentation/api/source/plugins/remotes.rst b/documentation/api/source/plugins/remotes.rst new file mode 100644 index 000000000..0bcd37119 --- /dev/null +++ b/documentation/api/source/plugins/remotes.rst @@ -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: diff --git a/documentation/api/source/plugins/songusage.rst b/documentation/api/source/plugins/songusage.rst new file mode 100644 index 000000000..e4804ea34 --- /dev/null +++ b/documentation/api/source/plugins/songusage.rst @@ -0,0 +1,34 @@ +.. _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: + +.. autoclass:: openlp.plugins.songusage.forms.songusagedeleteform.SongUsageDeleteForm + :members: + +.. autoclass:: openlp.plugins.songusage.forms.songusagedetailform.SongUsageDetailForm + :members: + +Helper Classes & Functions +-------------------------- + +.. automodule:: openlp.plugins.songusage.lib + :members: + +.. automodule:: openlp.plugins.songusage.lib.db + :members: diff --git a/documentation/manual/source/dualmonitors.rst b/documentation/manual/source/dualmonitors.rst index c8fd5faf1..7e5fdc19b 100644 --- a/documentation/manual/source/dualmonitors.rst +++ b/documentation/manual/source/dualmonitors.rst @@ -3,7 +3,7 @@ Dual Monitor Setup ================== The first step in getting OpenLP working on your system is to setup your -computer properly for dual monitors. This is not very difficult, but the steps +computer properly for dual monitors. This is not very difficult, but the steps do vary depending on operating system. Most modern computers do have the ability for dual monitors. To be certain @@ -19,11 +19,13 @@ monitors will have two of, or a combination of the two connectors below. .. image:: pics/dvi.png A laptop computer setup only varies slightly, generally you will need only one -of outputs pictured above since your laptops screen serves as one of the -monitors. Sometimes with older laptops a key stroke generally involving the FN -key and another key is required to enable the second monitor on laptops. +of outputs pictured above since your laptops screen serves as one of the +monitors. Sometimes with older laptops a key stroke generally involving the +:kbd:`Fn` key and another key is required to enable the second monitor on +laptops. -Some computers also incorporate the use of S-Video or HDMI connections. +Some computers also incorporate the use of :abbr:`S-Video (Separate Video)` or +:abbr:`HDMI (High-Definition Multimedia Interface)` connections. A typical OpenLP set up consist of your normal single monitor setup, with your projector setup as the second monitor. With the option of extending your @@ -39,49 +41,47 @@ next. Windows 7 ^^^^^^^^^ -Windows 7 has using a projector in mind. Simply connect your projector and -press the **Windows key and tap P**. +Windows 7 has using a projector in mind. Simply connect your projector and +press :kbd:`Windows+P`. -The more traditional way is also fairly straight forward. Go to the control -panel and click on display. This will open up the Display options. You can -also bypass this step by right click on a blank area on your desktop and -selecting **resolution**. +The more traditional way is also fairly straight forward. Go to +:guilabel:`Control Panel` and click on :guilabel:`Display`. This will open up +the :guilabel:`Display` dialog. You can also bypass this step by right click on +a blank area on your desktop and selecting :guilabel:`Resolution`. .. image:: pics/winsevendisplay.png -Then click on the Screen Resolution from the left pane. +Then click on the :guilabel:`Adjust resolution` link in the left pane. Enable +your projector and make sure that the selected value for :guilabel:`Multiple +displays` is :guilabel:`Extend these displays`. .. image:: pics/winsevenresolution.png -Then enable your projector and ensure your desktop is extended. - Windows Vista ^^^^^^^^^^^^^ -From the control panel click on personalize, or right click a blank place on -the desktop and click personalization. +From :guilabel:`Control Panel` click on :guilabel:`Personalize`, or right click +a blank place on the desktop and click :guilabel:`Personalization`. .. image:: pics/vistapersonalize.png -From the **Personalization** window click on Display Settings. +From the :guilabel:`Personalization` window click on :guilabel:`Display +Settings`. Then enable the montior that represents your projector and make sure +you have checked :guilabel:`Extend the desktop onto this monitor`. .. image:: pics/vistadisplaysettings.png -Then enable the montior that represents your projector an make sure your -you have checked Extend the desktop. - Windows XP ^^^^^^^^^^ -From the control panel select Display, or right click on a blank area of the -desktop and select properties. From the properties window click on the settings -tab. +From :guilabel:`Control Panel` select :guilabel:`Display`, or right click on a +blank area of the desktop and select :guilabel:`Properties`. From the +:guilabel:`Display Properties` window click on the :guilabel:`Settings` tab. +Then click on the monitor that represents your projector and make sure you have +checked :guilabel:`Extend my Windows desktop onto this monitor`. .. image:: pics/xpdisplaysettings.png -Then enable the monitor that represents your projector an make sure your -you have checked Extend the desktop. - Linux ----- @@ -91,22 +91,22 @@ assumes that you have properly set up any proprietary drivers if needed. You should seek out your distributions documentation if this general guide does not work. -GNOME +GNOME ^^^^^ This guide is for users of the GNOME desktop who do not use proprietary drivers. -From most distros go to System --> Preferences --> Display Settings (Monitors) +From most distros go to :menuselection:`System --> Preferences --> Display +Settings (Monitors)`. Set up your projector with the correct resolution and make +sure that :guilabel:`Same image on all monitors` is **unchecked**. .. image:: pics/gnome.png -Setup your projector with the correct resolution and make sure you do **not** -have mirrored desktop enabled (same image on all monitors). - KDE ^^^ This guide is for users of the KDE desktop who do not use proprietary drivers. -From most distros click the Kick Off menu and navigate to **system settings** +From most distros click the Kick Off menu and navigate to +:guilabel:`System Settings` .. image:: pics/kdesystemsettings.png @@ -118,66 +118,63 @@ From here you will need to set up your projector with the appropriate resolution, and position. OpenLP works best projecting to the monitor on the right. -Linux Systems Using nVida Drivers -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Linux Systems Using nVidia Drivers +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This guide is for users of the proprietary Nvidia driver on Linux Distributions. +This guide is for users of the proprietary nVidia driver on Linux Distributions. It is assumed that you have properly setup your drivers according to your -distribution's documentation, and you have a working xorg.conf file in place. +distribution's documentation, and you have a working ``xorg.conf`` file in place. If you wish to make the changes permanent in setting up your system for dual -monitors it will be necessary to modify your xorg.conf file. It is always a good -idea to make a backup of any critical file before making changes:: +monitors it will be necessary to modify your ``xorg.conf`` file. It is always a +good idea to make a backup of any critical file before making changes:: - user@linux:~ $ sudo cp /etc/X11/xorg.conf /etc/X11/xorg.conf.old + user@linux:~ $ sudo cp /etc/X11/xorg.conf /etc/X11/xorg.conf.old -or for those using systems that use the root user instead of sudo, change to +Or for those using systems that use the root user instead of sudo, change to root and enter:: - - root@linux: # cp /etc/X11/xorg.conf /etc/X11/xorg.conf.old -The exact location of the xorg.conf file can vary so check your distribution's -documentation. + root@linux: # cp /etc/X11/xorg.conf /etc/X11/xorg.conf.old -If you want to make your changes permanent run nVidia settings from the terminal:: +The exact location of the ``xorg.conf`` file can vary so check your +distribution's documentation. - user@linux:~ $ sudo nvidia-settings +If you want to make your changes permanent run nVidia settings from the +terminal:: -or:: + user@linux:~ $ sudo nvidia-settings - root@linux: # nividia-settings +Or, as root:: -If you do not want to write the changes to your xorg.conf file simply run the -nVidia Settings program from your desktops menu, usually in an administration -or system menu, or from the terminal as a normal user run:: + root@linux: # nividia-settings - user@linux:~ $ nvidia-settings +If you do not want to write the changes to your ``xorg.conf`` file simply run +the nVidia Settings program (``nvidia-settings``) from your desktop's menu, +usually in an administration or system menu, or from the terminal as a normal +user run:: -Once you have opened nVidia Settings, click on **X Server Display Confiuration** -Then select the monitor you are wanting to use as your second monitor and click -configure. + user@linux:~ $ nvidia-settings + +Once you have opened nVidia Settings, click on +:guilabel:`X Server Display Configuration`. Then select the monitor you are +wanting to use as your second monitor and click :guilabel:`Configure`. .. image:: pics/nvlinux1.png -After clicking configure, select twinview. Then click ok. +After clicking :guilabel:`Configure`, select :guilabel:`TwinView`. Then click +:guilabel:`OK`. .. image:: pics/twinview.png -Then click **apply** and if you are happy with the way things look click to keep -your new settings. Don't worry if all goes wrong the settings will return back -to the previous settings in 15 seconds without any action. nVidia Settings -should take care of selecting your optimum resolution etc, but that can be -changed as needed. When you are happy with everything click on **Save to X Configuration File** +Then click :guilabel:`Apply` and if you are happy with the way things look click +:guilabel:`Keep` to keep your new settings. Don't worry if all goes wrong the +settings will return back to the previous settings in 15 seconds without any +action. nVidia Settings should take care of selecting your optimum resolution +etc, but that can be changed as needed. When you are happy with everything click +on :guilabel:`Save to X Configuration File`. .. image:: pics/xorgwrite.png -Then click **Save** and you should be set. You may want to restart X or your -machine just to make sure all the settings carry over the next time you log in. - - - - - - - - +Then click :guilabel:`Save` and you should be set. You may want to restart X or +your machine just to make sure all the settings carry over the next time you log +in. diff --git a/documentation/manual/source/pics/xpdisplaysettings.png b/documentation/manual/source/pics/xpdisplaysettings.png index e1ec66c6f..eb7a8921c 100644 Binary files a/documentation/manual/source/pics/xpdisplaysettings.png and b/documentation/manual/source/pics/xpdisplaysettings.png differ diff --git a/openlp/core/ui/__init__.py b/openlp/core/ui/__init__.py index 80d677386..fa704752e 100644 --- a/openlp/core/ui/__init__.py +++ b/openlp/core/ui/__init__.py @@ -39,7 +39,6 @@ class HideMode(object): from filerenameform import FileRenameForm from maindisplay import MainDisplay -from slidecontroller import HideMode from servicenoteform import ServiceNoteForm from serviceitemeditform import ServiceItemEditForm from screen import ScreenList diff --git a/openlp/core/ui/maindisplay.py b/openlp/core/ui/maindisplay.py index d8dabd315..6592f9e03 100644 --- a/openlp/core/ui/maindisplay.py +++ b/openlp/core/ui/maindisplay.py @@ -90,6 +90,9 @@ class DisplayWidget(QtGui.QGraphicsView): event.ignore() class MainDisplay(DisplayWidget): + """ + This is the display screen. + """ def __init__(self, parent, screens, live): DisplayWidget.__init__(self, live, parent=None)