Updates to documentation.

This commit is contained in:
Raoul Snyman 2010-12-10 07:09:03 +02:00
parent 360ef84d6e
commit c2b8228729
5 changed files with 55 additions and 41 deletions

View File

@ -1,8 +1,10 @@
.. _core-theme: .. _core-theme:
:mod:`theme` Module Theme Function Library
=================== ======================
.. automodule:: openlp.core.theme .. automodule:: openlp.core.theme
:members: :members:
.. autoclass:: openlp.core.theme.theme.Theme
:members:

View File

@ -18,7 +18,7 @@ Forms
.. automodule:: openlp.plugins.bibles.forms .. automodule:: openlp.plugins.bibles.forms
:members: :members:
.. autoclass:: openlp.plugins.bibles.forms.importwizardform.ImportWizardForm .. autoclass:: openlp.plugins.bibles.forms.bibleimportform.BibleImportForm
:members: :members:
Helper Classes & Functions Helper Classes & Functions

View File

@ -149,15 +149,15 @@ Or, as root::
root@linux: # nividia-settings root@linux: # nividia-settings
If you do not want to write the changes to your ``xorg.conf`` file simply run 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, the nVidia Settings program (:command:`nvidia-settings`) from your desktop's
usually in an administration or system menu, or from the terminal as a normal menu, usually in an administration or system menu, or from the terminal as a
user run:: normal user run::
user@linux:~ $ nvidia-settings user@linux:~ $ nvidia-settings
Once you have opened nVidia Settings, click on Once you have opened nVidia Settings, click on :guilabel:`X Server Display
:guilabel:`X Server Display Configuration`. Then select the monitor you are Configuration`. Then select the monitor you are wanting to use as your second
wanting to use as your second monitor and click :guilabel:`Configure`. monitor and click :guilabel:`Configure`.
.. image:: pics/nvlinux1.png .. image:: pics/nvlinux1.png

View File

@ -68,38 +68,45 @@ class Theme(object):
Theme name Theme name
``BackgroundMode`` ``BackgroundMode``
The behaviour of the background. Valid modes are: The behaviour of the background. Valid modes are:
- 0 - Transparent
- 1 - Opaque * ``0`` - Transparent
* ``1`` - Opaque
``BackgroundType`` ``BackgroundType``
The content of the background. Valid types are: The content of the background. Valid types are:
- 0 - solid color
- 1 - gradient color * ``0`` - solid color
- 2 - image * ``1`` - gradient color
* ``2`` - image
``BackgroundParameter1`` ``BackgroundParameter1``
Extra information about the background. The contents of this attribute Extra information about the background. The contents of this attribute
depend on the BackgroundType: depend on the BackgroundType:
- image: image filename
- gradient: start color * ``image`` - image filename
- solid: color * ``gradient`` - start color
* ``solid`` - color
``BackgroundParameter2`` ``BackgroundParameter2``
Extra information about the background. The contents of this attribute Extra information about the background. The contents of this attribute
depend on the BackgroundType: depend on the BackgroundType:
- image: border color
- gradient: end color * ``image`` - border color
- solid: N/A * ``gradient`` - end color
* ``solid`` - N/A
``BackgroundParameter3`` ``BackgroundParameter3``
Extra information about the background. The contents of this attribute Extra information about the background. The contents of this attribute
depend on the BackgroundType: depend on the BackgroundType:
- image: N/A
- gradient: The direction of the gradient. Valid entries are: * ``image`` - N/A
- 0 -> vertical * ``gradient`` - The direction of the gradient. Valid entries are:
- 1 -> horizontal
- solid: N/A * ``0`` - vertical
* ``1`` - horizontal
* ``solid`` - N/A
``FontName`` ``FontName``
Name of the font to use for the main font. Name of the font to use for the main font.
@ -115,36 +122,41 @@ class Theme(object):
``Shadow`` ``Shadow``
The shadow type to apply to the main font. The shadow type to apply to the main font.
- 0 - no shadow
- non-zero - use shadow * ``0`` - no shadow
* non-zero - use shadow
``ShadowColor`` ``ShadowColor``
Color for the shadow Color for the shadow
``Outline`` ``Outline``
The outline to apply to the main font The outline to apply to the main font
- 0 - no outline
- non-zero - use outline * ``0`` - no outline
* non-zero - use outline
``OutlineColor`` ``OutlineColor``
Color for the outline (or None if Outline is 0) Color for the outline (or None if Outline is 0)
``HorizontalAlign`` ``HorizontalAlign``
The horizontal alignment to apply to text. Valid alignments are: The horizontal alignment to apply to text. Valid alignments are:
- 0 - left align
- 1 - right align * ``0`` - left align
- 2 - centre align * ``1`` - right align
* ``2`` - centre align
``VerticalAlign`` ``VerticalAlign``
The vertical alignment to apply to the text. Valid alignments are: The vertical alignment to apply to the text. Valid alignments are:
- 0 - top align
- 1 - bottom align * ``0`` - top align
- 2 - centre align * ``1`` - bottom align
* ``2`` - centre align
``WrapStyle`` ``WrapStyle``
The wrap style to apply to the text. Valid styles are: The wrap style to apply to the text. Valid styles are:
- 0 - normal
- 1 - lyrics * ``0`` - normal
* ``1`` - lyrics
""" """
def __init__(self, xml): def __init__(self, xml):
""" """

View File

@ -24,7 +24,7 @@
# Temple Place, Suite 330, Boston, MA 02111-1307 USA # # Temple Place, Suite 330, Boston, MA 02111-1307 USA #
############################################################################### ###############################################################################
""" """
The :mod:`utils` module provides the utility libraries for OpenLP The :mod:`openlp.core.utils` module provides the utility libraries for OpenLP.
""" """
import logging import logging