You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
353 lines
10 KiB
Python
353 lines
10 KiB
Python
# encoding: utf-8
|
|
|
|
"""
|
|
Enumerations related to text in WordprocessingML files
|
|
"""
|
|
|
|
from __future__ import absolute_import, print_function, unicode_literals
|
|
|
|
from .base import alias, EnumMember, XmlEnumeration, XmlMappedEnumMember
|
|
|
|
|
|
@alias('WD_ALIGN_PARAGRAPH')
|
|
class WD_PARAGRAPH_ALIGNMENT(XmlEnumeration):
|
|
"""
|
|
alias: **WD_ALIGN_PARAGRAPH**
|
|
|
|
Specifies paragraph justification type.
|
|
|
|
Example::
|
|
|
|
from docx.enum.text import WD_ALIGN_PARAGRAPH
|
|
|
|
paragraph = document.add_paragraph()
|
|
paragraph.alignment = WD_ALIGN_PARAGRAPH.CENTER
|
|
"""
|
|
|
|
__ms_name__ = 'WdParagraphAlignment'
|
|
|
|
__url__ = 'http://msdn.microsoft.com/en-us/library/office/ff835817.aspx'
|
|
|
|
__members__ = (
|
|
XmlMappedEnumMember(
|
|
'LEFT', 0, 'left', 'Left-aligned'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'CENTER', 1, 'center', 'Center-aligned.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'RIGHT', 2, 'right', 'Right-aligned.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'JUSTIFY', 3, 'both', 'Fully justified.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'DISTRIBUTE', 4, 'distribute', 'Paragraph characters are distrib'
|
|
'uted to fill the entire width of the paragraph.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'JUSTIFY_MED', 5, 'mediumKashida', 'Justified with a medium char'
|
|
'acter compression ratio.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'JUSTIFY_HI', 7, 'highKashida', 'Justified with a high character'
|
|
' compression ratio.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'JUSTIFY_LOW', 8, 'lowKashida', 'Justified with a low character '
|
|
'compression ratio.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'THAI_JUSTIFY', 9, 'thaiDistribute', 'Justified according to Tha'
|
|
'i formatting layout.'
|
|
),
|
|
)
|
|
|
|
|
|
class WD_BREAK_TYPE(object):
|
|
"""
|
|
Corresponds to WdBreakType enumeration
|
|
http://msdn.microsoft.com/en-us/library/office/ff195905.aspx
|
|
"""
|
|
COLUMN = 8
|
|
LINE = 6
|
|
LINE_CLEAR_LEFT = 9
|
|
LINE_CLEAR_RIGHT = 10
|
|
LINE_CLEAR_ALL = 11 # added for consistency, not in MS version
|
|
PAGE = 7
|
|
SECTION_CONTINUOUS = 3
|
|
SECTION_EVEN_PAGE = 4
|
|
SECTION_NEXT_PAGE = 2
|
|
SECTION_ODD_PAGE = 5
|
|
TEXT_WRAPPING = 11
|
|
|
|
|
|
WD_BREAK = WD_BREAK_TYPE
|
|
|
|
|
|
@alias('WD_COLOR')
|
|
class WD_COLOR_INDEX(XmlEnumeration):
|
|
"""
|
|
Specifies a standard preset color to apply. Used for font highlighting and
|
|
perhaps other applications.
|
|
"""
|
|
|
|
__ms_name__ = 'WdColorIndex'
|
|
|
|
__url__ = 'https://msdn.microsoft.com/EN-US/library/office/ff195343.aspx'
|
|
|
|
__members__ = (
|
|
XmlMappedEnumMember(
|
|
None, None, None, 'Color is inherited from the style hierarchy.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'AUTO', 0, 'default', 'Automatic color. Default; usually black.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'BLACK', 1, 'black', 'Black color.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'BLUE', 2, 'blue', 'Blue color'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'BRIGHT_GREEN', 4, 'green', 'Bright green color.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'DARK_BLUE', 9, 'darkBlue', 'Dark blue color.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'DARK_RED', 13, 'darkRed', 'Dark red color.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'DARK_YELLOW', 14, 'darkYellow', 'Dark yellow color.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'GRAY_25', 16, 'lightGray', '25% shade of gray color.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'GRAY_50', 15, 'darkGray', '50% shade of gray color.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'GREEN', 11, 'darkGreen', 'Green color.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'PINK', 5, 'magenta', 'Pink color.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'RED', 6, 'red', 'Red color.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'TEAL', 10, 'darkCyan', 'Teal color.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'TURQUOISE', 3, 'cyan', 'Turquoise color.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'VIOLET', 12, 'darkMagenta', 'Violet color.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'WHITE', 8, 'white', 'White color.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'YELLOW', 7, 'yellow', 'Yellow color.'
|
|
),
|
|
)
|
|
|
|
|
|
class WD_LINE_SPACING(XmlEnumeration):
|
|
"""
|
|
Specifies a line spacing format to be applied to a paragraph.
|
|
|
|
Example::
|
|
|
|
from docx.enum.text import WD_LINE_SPACING
|
|
|
|
paragraph = document.add_paragraph()
|
|
paragraph.line_spacing_rule = WD_LINE_SPACING.EXACTLY
|
|
"""
|
|
|
|
__ms_name__ = 'WdLineSpacing'
|
|
|
|
__url__ = 'http://msdn.microsoft.com/en-us/library/office/ff844910.aspx'
|
|
|
|
__members__ = (
|
|
EnumMember(
|
|
'ONE_POINT_FIVE', 1, 'Space-and-a-half line spacing.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'AT_LEAST', 3, 'atLeast', 'Line spacing is always at least the s'
|
|
'pecified amount. The amount is specified separately.'
|
|
),
|
|
EnumMember(
|
|
'DOUBLE', 2, 'Double spaced.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'EXACTLY', 4, 'exact', 'Line spacing is exactly the specified am'
|
|
'ount. The amount is specified separately.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'MULTIPLE', 5, 'auto', 'Line spacing is specified as a multiple '
|
|
'of line heights. Changing the font size will change the line sp'
|
|
'acing proportionately.'
|
|
),
|
|
EnumMember(
|
|
'SINGLE', 0, 'Single spaced (default).'
|
|
),
|
|
)
|
|
|
|
|
|
class WD_TAB_ALIGNMENT(XmlEnumeration):
|
|
"""
|
|
Specifies the tab stop alignment to apply.
|
|
"""
|
|
|
|
__ms_name__ = 'WdTabAlignment'
|
|
|
|
__url__ = 'https://msdn.microsoft.com/EN-US/library/office/ff195609.aspx'
|
|
|
|
__members__ = (
|
|
XmlMappedEnumMember(
|
|
'LEFT', 0, 'left', 'Left-aligned.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'CENTER', 1, 'center', 'Center-aligned.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'RIGHT', 2, 'right', 'Right-aligned.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'DECIMAL', 3, 'decimal', 'Decimal-aligned.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'BAR', 4, 'bar', 'Bar-aligned.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'LIST', 6, 'list', 'List-aligned. (deprecated)'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'CLEAR', 101, 'clear', 'Clear an inherited tab stop.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'END', 102, 'end', 'Right-aligned. (deprecated)'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'NUM', 103, 'num', 'Left-aligned. (deprecated)'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'START', 104, 'start', 'Left-aligned. (deprecated)'
|
|
),
|
|
)
|
|
|
|
|
|
class WD_TAB_LEADER(XmlEnumeration):
|
|
"""
|
|
Specifies the character to use as the leader with formatted tabs.
|
|
"""
|
|
|
|
__ms_name__ = 'WdTabLeader'
|
|
|
|
__url__ = 'https://msdn.microsoft.com/en-us/library/office/ff845050.aspx'
|
|
|
|
__members__ = (
|
|
XmlMappedEnumMember(
|
|
'SPACES', 0, 'none', 'Spaces. Default.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'DOTS', 1, 'dot', 'Dots.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'DASHES', 2, 'hyphen', 'Dashes.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'LINES', 3, 'underscore', 'Double lines.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'HEAVY', 4, 'heavy', 'A heavy line.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'MIDDLE_DOT', 5, 'middleDot', 'A vertically-centered dot.'
|
|
),
|
|
)
|
|
|
|
|
|
class WD_UNDERLINE(XmlEnumeration):
|
|
"""
|
|
Specifies the style of underline applied to a run of characters.
|
|
"""
|
|
|
|
__ms_name__ = 'WdUnderline'
|
|
|
|
__url__ = 'http://msdn.microsoft.com/en-us/library/office/ff822388.aspx'
|
|
|
|
__members__ = (
|
|
XmlMappedEnumMember(
|
|
None, None, None, 'Inherit underline setting from containing par'
|
|
'agraph.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'NONE', 0, 'none', 'No underline. This setting overrides any inh'
|
|
'erited underline value, so can be used to remove underline from'
|
|
' a run that inherits underlining from its containing paragraph.'
|
|
' Note this is not the same as assigning |None| to Run.underline'
|
|
'. |None| is a valid assignment value, but causes the run to inh'
|
|
'erit its underline value. Assigning ``WD_UNDERLINE.NONE`` cause'
|
|
's underlining to be unconditionally turned off.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'SINGLE', 1, 'single', 'A single line. Note that this setting is'
|
|
'write-only in the sense that |True| (rather than ``WD_UNDERLINE'
|
|
'.SINGLE``) is returned for a run having this setting.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'WORDS', 2, 'words', 'Underline individual words only.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'DOUBLE', 3, 'double', 'A double line.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'DOTTED', 4, 'dotted', 'Dots.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'THICK', 6, 'thick', 'A single thick line.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'DASH', 7, 'dash', 'Dashes.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'DOT_DASH', 9, 'dotDash', 'Alternating dots and dashes.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'DOT_DOT_DASH', 10, 'dotDotDash', 'An alternating dot-dot-dash p'
|
|
'attern.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'WAVY', 11, 'wave', 'A single wavy line.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'DOTTED_HEAVY', 20, 'dottedHeavy', 'Heavy dots.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'DASH_HEAVY', 23, 'dashedHeavy', 'Heavy dashes.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'DOT_DASH_HEAVY', 25, 'dashDotHeavy', 'Alternating heavy dots an'
|
|
'd heavy dashes.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'DOT_DOT_DASH_HEAVY', 26, 'dashDotDotHeavy', 'An alternating hea'
|
|
'vy dot-dot-dash pattern.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'WAVY_HEAVY', 27, 'wavyHeavy', 'A heavy wavy line.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'DASH_LONG', 39, 'dashLong', 'Long dashes.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'WAVY_DOUBLE', 43, 'wavyDouble', 'A double wavy line.'
|
|
),
|
|
XmlMappedEnumMember(
|
|
'DASH_LONG_HEAVY', 55, 'dashLongHeavy', 'Long heavy dashes.'
|
|
),
|
|
)
|