1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
"""Enumerations used by text and related objects."""
from __future__ import annotations
from pptx.enum.base import BaseEnum, BaseXmlEnum
class MSO_AUTO_SIZE(BaseEnum):
"""Determines the type of automatic sizing allowed.
The following names can be used to specify the automatic sizing behavior used to fit a shape's
text within the shape bounding box, for example::
from pptx.enum.text import MSO_AUTO_SIZE
shape.text_frame.auto_size = MSO_AUTO_SIZE.TEXT_TO_FIT_SHAPE
The word-wrap setting of the text frame interacts with the auto-size setting to determine the
specific auto-sizing behavior.
Note that `TextFrame.auto_size` can also be set to |None|, which removes the auto size setting
altogether. This causes the setting to be inherited, either from the layout placeholder, in the
case of a placeholder shape, or from the theme.
MS API Name: `MsoAutoSize`
http://msdn.microsoft.com/en-us/library/office/ff865367(v=office.15).aspx
"""
NONE = (
0,
"No automatic sizing of the shape or text will be done.\n\nText can freely extend beyond"
" the horizontal and vertical edges of the shape bounding box.",
)
"""No automatic sizing of the shape or text will be done.
Text can freely extend beyond the horizontal and vertical edges of the shape bounding box.
"""
SHAPE_TO_FIT_TEXT = (
1,
"The shape height and possibly width are adjusted to fit the text.\n\nNote this setting"
" interacts with the TextFrame.word_wrap property setting. If word wrap is turned on,"
" only the height of the shape will be adjusted; soft line breaks will be used to fit the"
" text horizontally.",
)
"""The shape height and possibly width are adjusted to fit the text.
Note this setting interacts with the TextFrame.word_wrap property setting. If word wrap is
turned on, only the height of the shape will be adjusted; soft line breaks will be used to fit
the text horizontally.
"""
TEXT_TO_FIT_SHAPE = (
2,
"The font size is reduced as necessary to fit the text within the shape.",
)
"""The font size is reduced as necessary to fit the text within the shape."""
MIXED = (-2, "Return value only; indicates a combination of automatic sizing schemes are used.")
"""Return value only; indicates a combination of automatic sizing schemes are used."""
class MSO_TEXT_UNDERLINE_TYPE(BaseXmlEnum):
"""
Indicates the type of underline for text. Used with
:attr:`.Font.underline` to specify the style of text underlining.
Alias: ``MSO_UNDERLINE``
Example::
from pptx.enum.text import MSO_UNDERLINE
run.font.underline = MSO_UNDERLINE.DOUBLE_LINE
MS API Name: `MsoTextUnderlineType`
http://msdn.microsoft.com/en-us/library/aa432699.aspx
"""
NONE = (0, "none", "Specifies no underline.")
"""Specifies no underline."""
DASH_HEAVY_LINE = (8, "dashHeavy", "Specifies a dash underline.")
"""Specifies a dash underline."""
DASH_LINE = (7, "dash", "Specifies a dash line underline.")
"""Specifies a dash line underline."""
DASH_LONG_HEAVY_LINE = (10, "dashLongHeavy", "Specifies a long heavy line underline.")
"""Specifies a long heavy line underline."""
DASH_LONG_LINE = (9, "dashLong", "Specifies a dashed long line underline.")
"""Specifies a dashed long line underline."""
DOT_DASH_HEAVY_LINE = (12, "dotDashHeavy", "Specifies a dot dash heavy line underline.")
"""Specifies a dot dash heavy line underline."""
DOT_DASH_LINE = (11, "dotDash", "Specifies a dot dash line underline.")
"""Specifies a dot dash line underline."""
DOT_DOT_DASH_HEAVY_LINE = (
14,
"dotDotDashHeavy",
"Specifies a dot dot dash heavy line underline.",
)
"""Specifies a dot dot dash heavy line underline."""
DOT_DOT_DASH_LINE = (13, "dotDotDash", "Specifies a dot dot dash line underline.")
"""Specifies a dot dot dash line underline."""
DOTTED_HEAVY_LINE = (6, "dottedHeavy", "Specifies a dotted heavy line underline.")
"""Specifies a dotted heavy line underline."""
DOTTED_LINE = (5, "dotted", "Specifies a dotted line underline.")
"""Specifies a dotted line underline."""
DOUBLE_LINE = (3, "dbl", "Specifies a double line underline.")
"""Specifies a double line underline."""
HEAVY_LINE = (4, "heavy", "Specifies a heavy line underline.")
"""Specifies a heavy line underline."""
SINGLE_LINE = (2, "sng", "Specifies a single line underline.")
"""Specifies a single line underline."""
WAVY_DOUBLE_LINE = (17, "wavyDbl", "Specifies a wavy double line underline.")
"""Specifies a wavy double line underline."""
WAVY_HEAVY_LINE = (16, "wavyHeavy", "Specifies a wavy heavy line underline.")
"""Specifies a wavy heavy line underline."""
WAVY_LINE = (15, "wavy", "Specifies a wavy line underline.")
"""Specifies a wavy line underline."""
WORDS = (1, "words", "Specifies underlining words.")
"""Specifies underlining words."""
MIXED = (-2, "", "Specifies a mix of underline types (read-only).")
"""Specifies a mix of underline types (read-only)."""
MSO_UNDERLINE = MSO_TEXT_UNDERLINE_TYPE
class MSO_VERTICAL_ANCHOR(BaseXmlEnum):
"""Specifies the vertical alignment of text in a text frame.
Used with the `.vertical_anchor` property of the |TextFrame| object. Note that the
`vertical_anchor` property can also have the value None, indicating there is no directly
specified vertical anchor setting and its effective value is inherited from its placeholder if
it has one or from the theme. |None| may also be assigned to remove an explicitly specified
vertical anchor setting.
MS API Name: `MsoVerticalAnchor`
http://msdn.microsoft.com/en-us/library/office/ff865255.aspx
"""
TOP = (1, "t", "Aligns text to top of text frame")
"""Aligns text to top of text frame"""
MIDDLE = (3, "ctr", "Centers text vertically")
"""Centers text vertically"""
BOTTOM = (4, "b", "Aligns text to bottom of text frame")
"""Aligns text to bottom of text frame"""
MIXED = (-2, "", "Return value only; indicates a combination of the other states.")
"""Return value only; indicates a combination of the other states."""
MSO_ANCHOR = MSO_VERTICAL_ANCHOR
class PP_PARAGRAPH_ALIGNMENT(BaseXmlEnum):
"""Specifies the horizontal alignment for one or more paragraphs.
Alias: `PP_ALIGN`
Example::
from pptx.enum.text import PP_ALIGN
shape.paragraphs[0].alignment = PP_ALIGN.CENTER
MS API Name: `PpParagraphAlignment`
http://msdn.microsoft.com/en-us/library/office/ff745375(v=office.15).aspx
"""
CENTER = (2, "ctr", "Center align")
"""Center align"""
DISTRIBUTE = (
5,
"dist",
"Evenly distributes e.g. Japanese characters from left to right within a line",
)
"""Evenly distributes e.g. Japanese characters from left to right within a line"""
JUSTIFY = (
4,
"just",
"Justified, i.e. each line both begins and ends at the margin.\n\nSpacing between words"
" is adjusted such that the line exactly fills the width of the paragraph.",
)
"""Justified, i.e. each line both begins and ends at the margin.
Spacing between words is adjusted such that the line exactly fills the width of the paragraph.
"""
JUSTIFY_LOW = (7, "justLow", "Justify using a small amount of space between words.")
"""Justify using a small amount of space between words."""
LEFT = (1, "l", "Left aligned")
"""Left aligned"""
RIGHT = (3, "r", "Right aligned")
"""Right aligned"""
THAI_DISTRIBUTE = (6, "thaiDist", "Thai distributed")
"""Thai distributed"""
MIXED = (-2, "", "Multiple alignments are present in a set of paragraphs (read-only).")
"""Multiple alignments are present in a set of paragraphs (read-only)."""
PP_ALIGN = PP_PARAGRAPH_ALIGNMENT
|
