python-pptx2 2.13.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (175) hide show
  1. pptx2/__init__.py +152 -0
  2. pptx2/_color.py +75 -0
  3. pptx2/_slide_importer.py +597 -0
  4. pptx2/_svg.py +155 -0
  5. pptx2/_template_applier.py +292 -0
  6. pptx2/_textstyle.py +187 -0
  7. pptx2/accessibility.py +365 -0
  8. pptx2/action.py +270 -0
  9. pptx2/animation.py +2237 -0
  10. pptx2/api.py +49 -0
  11. pptx2/audit.py +258 -0
  12. pptx2/chart/__init__.py +0 -0
  13. pptx2/chart/analytics.py +381 -0
  14. pptx2/chart/axis.py +543 -0
  15. pptx2/chart/category.py +200 -0
  16. pptx2/chart/chart.py +670 -0
  17. pptx2/chart/data.py +864 -0
  18. pptx2/chart/datalabel.py +406 -0
  19. pptx2/chart/legend.py +86 -0
  20. pptx2/chart/marker.py +70 -0
  21. pptx2/chart/palettes.py +129 -0
  22. pptx2/chart/plot.py +462 -0
  23. pptx2/chart/point.py +101 -0
  24. pptx2/chart/quick_layouts.py +325 -0
  25. pptx2/chart/series.py +334 -0
  26. pptx2/chart/xlsx.py +272 -0
  27. pptx2/chart/xmlwriter.py +1845 -0
  28. pptx2/compose/__init__.py +28 -0
  29. pptx2/compose/from_spec.py +1094 -0
  30. pptx2/design/__init__.py +8 -0
  31. pptx2/design/components.py +607 -0
  32. pptx2/design/figures.py +389 -0
  33. pptx2/design/layout.py +370 -0
  34. pptx2/design/recipes.py +1967 -0
  35. pptx2/design/style.py +209 -0
  36. pptx2/design/tokens.py +915 -0
  37. pptx2/diagrams.py +754 -0
  38. pptx2/dml/__init__.py +0 -0
  39. pptx2/dml/chtfmt.py +40 -0
  40. pptx2/dml/color.py +496 -0
  41. pptx2/dml/effect.py +909 -0
  42. pptx2/dml/fill.py +691 -0
  43. pptx2/dml/line.py +287 -0
  44. pptx2/dml/picture.py +212 -0
  45. pptx2/dml/three_d.py +381 -0
  46. pptx2/enum/__init__.py +0 -0
  47. pptx2/enum/action.py +71 -0
  48. pptx2/enum/animation.py +31 -0
  49. pptx2/enum/base.py +218 -0
  50. pptx2/enum/chart.py +574 -0
  51. pptx2/enum/dml.py +740 -0
  52. pptx2/enum/lang.py +685 -0
  53. pptx2/enum/presentation.py +133 -0
  54. pptx2/enum/shapes.py +1029 -0
  55. pptx2/enum/text.py +230 -0
  56. pptx2/exc.py +42 -0
  57. pptx2/formats.py +139 -0
  58. pptx2/geometry.py +420 -0
  59. pptx2/inherit.py +109 -0
  60. pptx2/lint.py +2256 -0
  61. pptx2/math.py +177 -0
  62. pptx2/media.py +197 -0
  63. pptx2/opc/__init__.py +0 -0
  64. pptx2/opc/constants.py +332 -0
  65. pptx2/opc/oxml.py +188 -0
  66. pptx2/opc/package.py +762 -0
  67. pptx2/opc/packuri.py +109 -0
  68. pptx2/opc/serialized.py +296 -0
  69. pptx2/opc/shared.py +20 -0
  70. pptx2/opc/spec.py +45 -0
  71. pptx2/oxml/__init__.py +555 -0
  72. pptx2/oxml/action.py +53 -0
  73. pptx2/oxml/chart/__init__.py +0 -0
  74. pptx2/oxml/chart/axis.py +337 -0
  75. pptx2/oxml/chart/chart.py +481 -0
  76. pptx2/oxml/chart/datalabel.py +253 -0
  77. pptx2/oxml/chart/legend.py +72 -0
  78. pptx2/oxml/chart/marker.py +61 -0
  79. pptx2/oxml/chart/plot.py +365 -0
  80. pptx2/oxml/chart/series.py +425 -0
  81. pptx2/oxml/chart/shared.py +220 -0
  82. pptx2/oxml/coreprops.py +288 -0
  83. pptx2/oxml/dml/__init__.py +0 -0
  84. pptx2/oxml/dml/color.py +135 -0
  85. pptx2/oxml/dml/effect.py +213 -0
  86. pptx2/oxml/dml/fill.py +316 -0
  87. pptx2/oxml/dml/line.py +12 -0
  88. pptx2/oxml/dml/three_d.py +110 -0
  89. pptx2/oxml/ns.py +135 -0
  90. pptx2/oxml/presentation.py +313 -0
  91. pptx2/oxml/shapes/__init__.py +19 -0
  92. pptx2/oxml/shapes/autoshape.py +467 -0
  93. pptx2/oxml/shapes/connector.py +107 -0
  94. pptx2/oxml/shapes/graphfrm.py +347 -0
  95. pptx2/oxml/shapes/groupshape.py +329 -0
  96. pptx2/oxml/shapes/picture.py +270 -0
  97. pptx2/oxml/shapes/shared.py +577 -0
  98. pptx2/oxml/simpletypes.py +1027 -0
  99. pptx2/oxml/slide.py +563 -0
  100. pptx2/oxml/table.py +650 -0
  101. pptx2/oxml/text.py +815 -0
  102. pptx2/oxml/theme.py +36 -0
  103. pptx2/oxml/xmlchemy.py +717 -0
  104. pptx2/package.py +222 -0
  105. pptx2/parts/__init__.py +0 -0
  106. pptx2/parts/chart.py +95 -0
  107. pptx2/parts/coreprops.py +167 -0
  108. pptx2/parts/diagram.py +37 -0
  109. pptx2/parts/embeddedpackage.py +93 -0
  110. pptx2/parts/image.py +275 -0
  111. pptx2/parts/media.py +37 -0
  112. pptx2/parts/presentation.py +136 -0
  113. pptx2/parts/slide.py +371 -0
  114. pptx2/presentation.py +408 -0
  115. pptx2/py.typed +0 -0
  116. pptx2/render.py +586 -0
  117. pptx2/section.py +272 -0
  118. pptx2/shapes/__init__.py +26 -0
  119. pptx2/shapes/autoshape.py +442 -0
  120. pptx2/shapes/base.py +1078 -0
  121. pptx2/shapes/connector.py +297 -0
  122. pptx2/shapes/freeform.py +337 -0
  123. pptx2/shapes/graphfrm.py +316 -0
  124. pptx2/shapes/group.py +264 -0
  125. pptx2/shapes/picture.py +422 -0
  126. pptx2/shapes/placeholder.py +468 -0
  127. pptx2/shapes/shapetree.py +2027 -0
  128. pptx2/shared.py +82 -0
  129. pptx2/skill/SKILL.md +450 -0
  130. pptx2/skill/__init__.py +78 -0
  131. pptx2/skill/__main__.py +64 -0
  132. pptx2/skill/references/animations.md +189 -0
  133. pptx2/skill/references/basics.md +421 -0
  134. pptx2/skill/references/charts.md +254 -0
  135. pptx2/skill/references/compose.md +234 -0
  136. pptx2/skill/references/design.md +366 -0
  137. pptx2/skill/references/effects.md +249 -0
  138. pptx2/skill/references/end-to-end-deck.md +231 -0
  139. pptx2/skill/references/geometry-and-arrows.md +334 -0
  140. pptx2/skill/references/lint.md +275 -0
  141. pptx2/skill/references/math.md +86 -0
  142. pptx2/skill/references/picture-effects.md +129 -0
  143. pptx2/skill/references/render.md +151 -0
  144. pptx2/skill/references/smart-art.md +75 -0
  145. pptx2/skill/references/space-aware-authoring.md +249 -0
  146. pptx2/skill/references/tables.md +244 -0
  147. pptx2/skill/references/theme.md +127 -0
  148. pptx2/skill/references/three-d.md +109 -0
  149. pptx2/skill/references/transitions.md +100 -0
  150. pptx2/slide.py +1244 -0
  151. pptx2/smart_art.py +220 -0
  152. pptx2/spec.py +633 -0
  153. pptx2/table.py +1181 -0
  154. pptx2/table_styles.py +184 -0
  155. pptx2/templates/default.pptx +0 -0
  156. pptx2/templates/docx-icon.emf +0 -0
  157. pptx2/templates/generic-icon.emf +0 -0
  158. pptx2/templates/notes.xml +23 -0
  159. pptx2/templates/notesMaster.xml +352 -0
  160. pptx2/templates/pptx-icon.emf +0 -0
  161. pptx2/templates/theme.xml +321 -0
  162. pptx2/templates/xlsx-icon.emf +0 -0
  163. pptx2/text/__init__.py +0 -0
  164. pptx2/text/fonts.py +482 -0
  165. pptx2/text/layout.py +374 -0
  166. pptx2/text/text.py +1272 -0
  167. pptx2/theme.py +721 -0
  168. pptx2/types.py +36 -0
  169. pptx2/util.py +263 -0
  170. python_pptx2-2.13.0.dist-info/METADATA +351 -0
  171. python_pptx2-2.13.0.dist-info/RECORD +175 -0
  172. python_pptx2-2.13.0.dist-info/WHEEL +5 -0
  173. python_pptx2-2.13.0.dist-info/entry_points.txt +3 -0
  174. python_pptx2-2.13.0.dist-info/licenses/LICENSE +22 -0
  175. python_pptx2-2.13.0.dist-info/top_level.txt +1 -0
pptx2/enum/shapes.py ADDED
@@ -0,0 +1,1029 @@
1
+ """Enumerations used by shapes and related objects."""
2
+
3
+ from __future__ import annotations
4
+
5
+ import enum
6
+
7
+ from pptx2.enum.base import BaseEnum, BaseXmlEnum
8
+
9
+
10
+ class MSO_AUTO_SHAPE_TYPE(BaseXmlEnum):
11
+ """Specifies a type of AutoShape, e.g. DOWN_ARROW.
12
+
13
+ Alias: ``MSO_SHAPE``
14
+
15
+ Example::
16
+
17
+ from pptx2.enum.shapes import MSO_SHAPE
18
+ from pptx2.util import Inches
19
+
20
+ left = top = width = height = Inches(1.0)
21
+ slide.shapes.add_shape(
22
+ MSO_SHAPE.ROUNDED_RECTANGLE, left, top, width, height
23
+ )
24
+
25
+ MS API Name: `MsoAutoShapeType`
26
+
27
+ https://learn.microsoft.com/en-us/office/vba/api/Office.MsoAutoShapeType
28
+ """
29
+
30
+ ACTION_BUTTON_BACK_OR_PREVIOUS = (
31
+ 129,
32
+ "actionButtonBackPrevious",
33
+ "Back or Previous button. Supports mouse-click and mouse-over actions",
34
+ )
35
+ """Back or Previous button. Supports mouse-click and mouse-over actions"""
36
+
37
+ ACTION_BUTTON_BEGINNING = (
38
+ 131,
39
+ "actionButtonBeginning",
40
+ "Beginning button. Supports mouse-click and mouse-over actions",
41
+ )
42
+ """Beginning button. Supports mouse-click and mouse-over actions"""
43
+
44
+ ACTION_BUTTON_CUSTOM = (
45
+ 125,
46
+ "actionButtonBlank",
47
+ "Button with no default picture or text. Supports mouse-click and mouse-over actions",
48
+ )
49
+ """Button with no default picture or text. Supports mouse-click and mouse-over actions"""
50
+
51
+ ACTION_BUTTON_DOCUMENT = (
52
+ 134,
53
+ "actionButtonDocument",
54
+ "Document button. Supports mouse-click and mouse-over actions",
55
+ )
56
+ """Document button. Supports mouse-click and mouse-over actions"""
57
+
58
+ ACTION_BUTTON_END = (
59
+ 132,
60
+ "actionButtonEnd",
61
+ "End button. Supports mouse-click and mouse-over actions",
62
+ )
63
+ """End button. Supports mouse-click and mouse-over actions"""
64
+
65
+ ACTION_BUTTON_FORWARD_OR_NEXT = (
66
+ 130,
67
+ "actionButtonForwardNext",
68
+ "Forward or Next button. Supports mouse-click and mouse-over actions",
69
+ )
70
+ """Forward or Next button. Supports mouse-click and mouse-over actions"""
71
+
72
+ ACTION_BUTTON_HELP = (
73
+ 127,
74
+ "actionButtonHelp",
75
+ "Help button. Supports mouse-click and mouse-over actions",
76
+ )
77
+ """Help button. Supports mouse-click and mouse-over actions"""
78
+
79
+ ACTION_BUTTON_HOME = (
80
+ 126,
81
+ "actionButtonHome",
82
+ "Home button. Supports mouse-click and mouse-over actions",
83
+ )
84
+ """Home button. Supports mouse-click and mouse-over actions"""
85
+
86
+ ACTION_BUTTON_INFORMATION = (
87
+ 128,
88
+ "actionButtonInformation",
89
+ "Information button. Supports mouse-click and mouse-over actions",
90
+ )
91
+ """Information button. Supports mouse-click and mouse-over actions"""
92
+
93
+ ACTION_BUTTON_MOVIE = (
94
+ 136,
95
+ "actionButtonMovie",
96
+ "Movie button. Supports mouse-click and mouse-over actions",
97
+ )
98
+ """Movie button. Supports mouse-click and mouse-over actions"""
99
+
100
+ ACTION_BUTTON_RETURN = (
101
+ 133,
102
+ "actionButtonReturn",
103
+ "Return button. Supports mouse-click and mouse-over actions",
104
+ )
105
+ """Return button. Supports mouse-click and mouse-over actions"""
106
+
107
+ ACTION_BUTTON_SOUND = (
108
+ 135,
109
+ "actionButtonSound",
110
+ "Sound button. Supports mouse-click and mouse-over actions",
111
+ )
112
+ """Sound button. Supports mouse-click and mouse-over actions"""
113
+
114
+ ARC = (25, "arc", "Arc")
115
+ """Arc"""
116
+
117
+ BALLOON = (137, "wedgeRoundRectCallout", "Rounded Rectangular Callout")
118
+ """Rounded Rectangular Callout"""
119
+
120
+ BENT_ARROW = (41, "bentArrow", "Block arrow that follows a curved 90-degree angle")
121
+ """Block arrow that follows a curved 90-degree angle"""
122
+
123
+ BENT_UP_ARROW = (
124
+ 44,
125
+ "bentUpArrow",
126
+ "Block arrow that follows a sharp 90-degree angle. Points up by default",
127
+ )
128
+ """Block arrow that follows a sharp 90-degree angle. Points up by default"""
129
+
130
+ BEVEL = (15, "bevel", "Bevel")
131
+ """Bevel"""
132
+
133
+ BLOCK_ARC = (20, "blockArc", "Block arc")
134
+ """Block arc"""
135
+
136
+ CAN = (13, "can", "Can")
137
+ """Can"""
138
+
139
+ CHART_PLUS = (182, "chartPlus", "Chart Plus")
140
+ """Chart Plus"""
141
+
142
+ CHART_STAR = (181, "chartStar", "Chart Star")
143
+ """Chart Star"""
144
+
145
+ CHART_X = (180, "chartX", "Chart X")
146
+ """Chart X"""
147
+
148
+ CHEVRON = (52, "chevron", "Chevron")
149
+ """Chevron"""
150
+
151
+ CHORD = (161, "chord", "Geometric chord shape")
152
+ """Geometric chord shape"""
153
+
154
+ CIRCULAR_ARROW = (60, "circularArrow", "Block arrow that follows a curved 180-degree angle")
155
+ """Block arrow that follows a curved 180-degree angle"""
156
+
157
+ CLOUD = (179, "cloud", "Cloud")
158
+ """Cloud"""
159
+
160
+ CLOUD_CALLOUT = (108, "cloudCallout", "Cloud callout")
161
+ """Cloud callout"""
162
+
163
+ CORNER = (162, "corner", "Corner")
164
+ """Corner"""
165
+
166
+ CORNER_TABS = (169, "cornerTabs", "Corner Tabs")
167
+ """Corner Tabs"""
168
+
169
+ CROSS = (11, "plus", "Cross")
170
+ """Cross"""
171
+
172
+ CUBE = (14, "cube", "Cube")
173
+ """Cube"""
174
+
175
+ CURVED_DOWN_ARROW = (48, "curvedDownArrow", "Block arrow that curves down")
176
+ """Block arrow that curves down"""
177
+
178
+ CURVED_DOWN_RIBBON = (100, "ellipseRibbon", "Ribbon banner that curves down")
179
+ """Ribbon banner that curves down"""
180
+
181
+ CURVED_LEFT_ARROW = (46, "curvedLeftArrow", "Block arrow that curves left")
182
+ """Block arrow that curves left"""
183
+
184
+ CURVED_RIGHT_ARROW = (45, "curvedRightArrow", "Block arrow that curves right")
185
+ """Block arrow that curves right"""
186
+
187
+ CURVED_UP_ARROW = (47, "curvedUpArrow", "Block arrow that curves up")
188
+ """Block arrow that curves up"""
189
+
190
+ CURVED_UP_RIBBON = (99, "ellipseRibbon2", "Ribbon banner that curves up")
191
+ """Ribbon banner that curves up"""
192
+
193
+ DECAGON = (144, "decagon", "Decagon")
194
+ """Decagon"""
195
+
196
+ DIAGONAL_STRIPE = (141, "diagStripe", "Diagonal Stripe")
197
+ """Diagonal Stripe"""
198
+
199
+ DIAMOND = (4, "diamond", "Diamond")
200
+ """Diamond"""
201
+
202
+ DODECAGON = (146, "dodecagon", "Dodecagon")
203
+ """Dodecagon"""
204
+
205
+ DONUT = (18, "donut", "Donut")
206
+ """Donut"""
207
+
208
+ DOUBLE_BRACE = (27, "bracePair", "Double brace")
209
+ """Double brace"""
210
+
211
+ DOUBLE_BRACKET = (26, "bracketPair", "Double bracket")
212
+ """Double bracket"""
213
+
214
+ DOUBLE_WAVE = (104, "doubleWave", "Double wave")
215
+ """Double wave"""
216
+
217
+ DOWN_ARROW = (36, "downArrow", "Block arrow that points down")
218
+ """Block arrow that points down"""
219
+
220
+ DOWN_ARROW_CALLOUT = (56, "downArrowCallout", "Callout with arrow that points down")
221
+ """Callout with arrow that points down"""
222
+
223
+ DOWN_RIBBON = (98, "ribbon", "Ribbon banner with center area below ribbon ends")
224
+ """Ribbon banner with center area below ribbon ends"""
225
+
226
+ EXPLOSION1 = (89, "irregularSeal1", "Explosion")
227
+ """Explosion"""
228
+
229
+ EXPLOSION2 = (90, "irregularSeal2", "Explosion")
230
+ """Explosion"""
231
+
232
+ FLOWCHART_ALTERNATE_PROCESS = (
233
+ 62,
234
+ "flowChartAlternateProcess",
235
+ "Alternate process flowchart symbol",
236
+ )
237
+ """Alternate process flowchart symbol"""
238
+
239
+ FLOWCHART_CARD = (75, "flowChartPunchedCard", "Card flowchart symbol")
240
+ """Card flowchart symbol"""
241
+
242
+ FLOWCHART_COLLATE = (79, "flowChartCollate", "Collate flowchart symbol")
243
+ """Collate flowchart symbol"""
244
+
245
+ FLOWCHART_CONNECTOR = (73, "flowChartConnector", "Connector flowchart symbol")
246
+ """Connector flowchart symbol"""
247
+
248
+ FLOWCHART_DATA = (64, "flowChartInputOutput", "Data flowchart symbol")
249
+ """Data flowchart symbol"""
250
+
251
+ FLOWCHART_DECISION = (63, "flowChartDecision", "Decision flowchart symbol")
252
+ """Decision flowchart symbol"""
253
+
254
+ FLOWCHART_DELAY = (84, "flowChartDelay", "Delay flowchart symbol")
255
+ """Delay flowchart symbol"""
256
+
257
+ FLOWCHART_DIRECT_ACCESS_STORAGE = (
258
+ 87,
259
+ "flowChartMagneticDrum",
260
+ "Direct access storage flowchart symbol",
261
+ )
262
+ """Direct access storage flowchart symbol"""
263
+
264
+ FLOWCHART_DISPLAY = (88, "flowChartDisplay", "Display flowchart symbol")
265
+ """Display flowchart symbol"""
266
+
267
+ FLOWCHART_DOCUMENT = (67, "flowChartDocument", "Document flowchart symbol")
268
+ """Document flowchart symbol"""
269
+
270
+ FLOWCHART_EXTRACT = (81, "flowChartExtract", "Extract flowchart symbol")
271
+ """Extract flowchart symbol"""
272
+
273
+ FLOWCHART_INTERNAL_STORAGE = (
274
+ 66,
275
+ "flowChartInternalStorage",
276
+ "Internal storage flowchart symbol",
277
+ )
278
+ """Internal storage flowchart symbol"""
279
+
280
+ FLOWCHART_MAGNETIC_DISK = (86, "flowChartMagneticDisk", "Magnetic disk flowchart symbol")
281
+ """Magnetic disk flowchart symbol"""
282
+
283
+ FLOWCHART_MANUAL_INPUT = (71, "flowChartManualInput", "Manual input flowchart symbol")
284
+ """Manual input flowchart symbol"""
285
+
286
+ FLOWCHART_MANUAL_OPERATION = (
287
+ 72,
288
+ "flowChartManualOperation",
289
+ "Manual operation flowchart symbol",
290
+ )
291
+ """Manual operation flowchart symbol"""
292
+
293
+ FLOWCHART_MERGE = (82, "flowChartMerge", "Merge flowchart symbol")
294
+ """Merge flowchart symbol"""
295
+
296
+ FLOWCHART_MULTIDOCUMENT = (68, "flowChartMultidocument", "Multi-document flowchart symbol")
297
+ """Multi-document flowchart symbol"""
298
+
299
+ FLOWCHART_OFFLINE_STORAGE = (139, "flowChartOfflineStorage", "Offline Storage")
300
+ """Offline Storage"""
301
+
302
+ FLOWCHART_OFFPAGE_CONNECTOR = (
303
+ 74,
304
+ "flowChartOffpageConnector",
305
+ "Off-page connector flowchart symbol",
306
+ )
307
+ """Off-page connector flowchart symbol"""
308
+
309
+ FLOWCHART_OR = (78, "flowChartOr", '"Or" flowchart symbol')
310
+ """\"Or\" flowchart symbol"""
311
+
312
+ FLOWCHART_PREDEFINED_PROCESS = (
313
+ 65,
314
+ "flowChartPredefinedProcess",
315
+ "Predefined process flowchart symbol",
316
+ )
317
+ """Predefined process flowchart symbol"""
318
+
319
+ FLOWCHART_PREPARATION = (70, "flowChartPreparation", "Preparation flowchart symbol")
320
+ """Preparation flowchart symbol"""
321
+
322
+ FLOWCHART_PROCESS = (61, "flowChartProcess", "Process flowchart symbol")
323
+ """Process flowchart symbol"""
324
+
325
+ FLOWCHART_PUNCHED_TAPE = (76, "flowChartPunchedTape", "Punched tape flowchart symbol")
326
+ """Punched tape flowchart symbol"""
327
+
328
+ FLOWCHART_SEQUENTIAL_ACCESS_STORAGE = (
329
+ 85,
330
+ "flowChartMagneticTape",
331
+ "Sequential access storage flowchart symbol",
332
+ )
333
+ """Sequential access storage flowchart symbol"""
334
+
335
+ FLOWCHART_SORT = (80, "flowChartSort", "Sort flowchart symbol")
336
+ """Sort flowchart symbol"""
337
+
338
+ FLOWCHART_STORED_DATA = (83, "flowChartOnlineStorage", "Stored data flowchart symbol")
339
+ """Stored data flowchart symbol"""
340
+
341
+ FLOWCHART_SUMMING_JUNCTION = (
342
+ 77,
343
+ "flowChartSummingJunction",
344
+ "Summing junction flowchart symbol",
345
+ )
346
+ """Summing junction flowchart symbol"""
347
+
348
+ FLOWCHART_TERMINATOR = (69, "flowChartTerminator", "Terminator flowchart symbol")
349
+ """Terminator flowchart symbol"""
350
+
351
+ FOLDED_CORNER = (16, "foldedCorner", "Folded corner")
352
+ """Folded corner"""
353
+
354
+ FRAME = (158, "frame", "Frame")
355
+ """Frame"""
356
+
357
+ FUNNEL = (174, "funnel", "Funnel")
358
+ """Funnel"""
359
+
360
+ GEAR_6 = (172, "gear6", "Gear 6")
361
+ """Gear 6"""
362
+
363
+ GEAR_9 = (173, "gear9", "Gear 9")
364
+ """Gear 9"""
365
+
366
+ HALF_FRAME = (159, "halfFrame", "Half Frame")
367
+ """Half Frame"""
368
+
369
+ HEART = (21, "heart", "Heart")
370
+ """Heart"""
371
+
372
+ HEPTAGON = (145, "heptagon", "Heptagon")
373
+ """Heptagon"""
374
+
375
+ HEXAGON = (10, "hexagon", "Hexagon")
376
+ """Hexagon"""
377
+
378
+ HORIZONTAL_SCROLL = (102, "horizontalScroll", "Horizontal scroll")
379
+ """Horizontal scroll"""
380
+
381
+ ISOSCELES_TRIANGLE = (7, "triangle", "Isosceles triangle")
382
+ """Isosceles triangle"""
383
+
384
+ LEFT_ARROW = (34, "leftArrow", "Block arrow that points left")
385
+ """Block arrow that points left"""
386
+
387
+ LEFT_ARROW_CALLOUT = (54, "leftArrowCallout", "Callout with arrow that points left")
388
+ """Callout with arrow that points left"""
389
+
390
+ LEFT_BRACE = (31, "leftBrace", "Left brace")
391
+ """Left brace"""
392
+
393
+ LEFT_BRACKET = (29, "leftBracket", "Left bracket")
394
+ """Left bracket"""
395
+
396
+ LEFT_CIRCULAR_ARROW = (176, "leftCircularArrow", "Left Circular Arrow")
397
+ """Left Circular Arrow"""
398
+
399
+ LEFT_RIGHT_ARROW = (
400
+ 37,
401
+ "leftRightArrow",
402
+ "Block arrow with arrowheads that point both left and right",
403
+ )
404
+ """Block arrow with arrowheads that point both left and right"""
405
+
406
+ LEFT_RIGHT_ARROW_CALLOUT = (
407
+ 57,
408
+ "leftRightArrowCallout",
409
+ "Callout with arrowheads that point both left and right",
410
+ )
411
+ """Callout with arrowheads that point both left and right"""
412
+
413
+ LEFT_RIGHT_CIRCULAR_ARROW = (177, "leftRightCircularArrow", "Left Right Circular Arrow")
414
+ """Left Right Circular Arrow"""
415
+
416
+ LEFT_RIGHT_RIBBON = (140, "leftRightRibbon", "Left Right Ribbon")
417
+ """Left Right Ribbon"""
418
+
419
+ LEFT_RIGHT_UP_ARROW = (
420
+ 40,
421
+ "leftRightUpArrow",
422
+ "Block arrow with arrowheads that point left, right, and up",
423
+ )
424
+ """Block arrow with arrowheads that point left, right, and up"""
425
+
426
+ LEFT_UP_ARROW = (43, "leftUpArrow", "Block arrow with arrowheads that point left and up")
427
+ """Block arrow with arrowheads that point left and up"""
428
+
429
+ LIGHTNING_BOLT = (22, "lightningBolt", "Lightning bolt")
430
+ """Lightning bolt"""
431
+
432
+ LINE_CALLOUT_1 = (109, "borderCallout1", "Callout with border and horizontal callout line")
433
+ """Callout with border and horizontal callout line"""
434
+
435
+ LINE_CALLOUT_1_ACCENT_BAR = (113, "accentCallout1", "Callout with vertical accent bar")
436
+ """Callout with vertical accent bar"""
437
+
438
+ LINE_CALLOUT_1_BORDER_AND_ACCENT_BAR = (
439
+ 121,
440
+ "accentBorderCallout1",
441
+ "Callout with border and vertical accent bar",
442
+ )
443
+ """Callout with border and vertical accent bar"""
444
+
445
+ LINE_CALLOUT_1_NO_BORDER = (117, "callout1", "Callout with horizontal line")
446
+ """Callout with horizontal line"""
447
+
448
+ LINE_CALLOUT_2 = (110, "borderCallout2", "Callout with diagonal straight line")
449
+ """Callout with diagonal straight line"""
450
+
451
+ LINE_CALLOUT_2_ACCENT_BAR = (
452
+ 114,
453
+ "accentCallout2",
454
+ "Callout with diagonal callout line and accent bar",
455
+ )
456
+ """Callout with diagonal callout line and accent bar"""
457
+
458
+ LINE_CALLOUT_2_BORDER_AND_ACCENT_BAR = (
459
+ 122,
460
+ "accentBorderCallout2",
461
+ "Callout with border, diagonal straight line, and accent bar",
462
+ )
463
+ """Callout with border, diagonal straight line, and accent bar"""
464
+
465
+ LINE_CALLOUT_2_NO_BORDER = (118, "callout2", "Callout with no border and diagonal callout line")
466
+ """Callout with no border and diagonal callout line"""
467
+
468
+ LINE_CALLOUT_3 = (111, "borderCallout3", "Callout with angled line")
469
+ """Callout with angled line"""
470
+
471
+ LINE_CALLOUT_3_ACCENT_BAR = (
472
+ 115,
473
+ "accentCallout3",
474
+ "Callout with angled callout line and accent bar",
475
+ )
476
+ """Callout with angled callout line and accent bar"""
477
+
478
+ LINE_CALLOUT_3_BORDER_AND_ACCENT_BAR = (
479
+ 123,
480
+ "accentBorderCallout3",
481
+ "Callout with border, angled callout line, and accent bar",
482
+ )
483
+ """Callout with border, angled callout line, and accent bar"""
484
+
485
+ LINE_CALLOUT_3_NO_BORDER = (119, "callout3", "Callout with no border and angled callout line")
486
+ """Callout with no border and angled callout line"""
487
+
488
+ LINE_CALLOUT_4 = (
489
+ 112,
490
+ "borderCallout3",
491
+ "Callout with callout line segments forming a U-shape.",
492
+ )
493
+ """Callout with callout line segments forming a U-shape."""
494
+
495
+ LINE_CALLOUT_4_ACCENT_BAR = (
496
+ 116,
497
+ "accentCallout3",
498
+ "Callout with accent bar and callout line segments forming a U-shape.",
499
+ )
500
+ """Callout with accent bar and callout line segments forming a U-shape."""
501
+
502
+ LINE_CALLOUT_4_BORDER_AND_ACCENT_BAR = (
503
+ 124,
504
+ "accentBorderCallout3",
505
+ "Callout with border, accent bar, and callout line segments forming a U-shape.",
506
+ )
507
+ """Callout with border, accent bar, and callout line segments forming a U-shape."""
508
+
509
+ LINE_CALLOUT_4_NO_BORDER = (
510
+ 120,
511
+ "callout3",
512
+ "Callout with no border and callout line segments forming a U-shape.",
513
+ )
514
+ """Callout with no border and callout line segments forming a U-shape."""
515
+
516
+ LINE_INVERSE = (183, "lineInv", "Straight Connector")
517
+ """Straight Connector"""
518
+
519
+ MATH_DIVIDE = (166, "mathDivide", "Division")
520
+ """Division"""
521
+
522
+ MATH_EQUAL = (167, "mathEqual", "Equal")
523
+ """Equal"""
524
+
525
+ MATH_MINUS = (164, "mathMinus", "Minus")
526
+ """Minus"""
527
+
528
+ MATH_MULTIPLY = (165, "mathMultiply", "Multiply")
529
+ """Multiply"""
530
+
531
+ MATH_NOT_EQUAL = (168, "mathNotEqual", "Not Equal")
532
+ """Not Equal"""
533
+
534
+ MATH_PLUS = (163, "mathPlus", "Plus")
535
+ """Plus"""
536
+
537
+ MOON = (24, "moon", "Moon")
538
+ """Moon"""
539
+
540
+ NON_ISOSCELES_TRAPEZOID = (143, "nonIsoscelesTrapezoid", "Non-isosceles Trapezoid")
541
+ """Non-isosceles Trapezoid"""
542
+
543
+ NOTCHED_RIGHT_ARROW = (50, "notchedRightArrow", "Notched block arrow that points right")
544
+ """Notched block arrow that points right"""
545
+
546
+ NO_SYMBOL = (19, "noSmoking", "'No' Symbol")
547
+ """'No' Symbol"""
548
+
549
+ OCTAGON = (6, "octagon", "Octagon")
550
+ """Octagon"""
551
+
552
+ OVAL = (9, "ellipse", "Oval")
553
+ """Oval"""
554
+
555
+ OVAL_CALLOUT = (107, "wedgeEllipseCallout", "Oval-shaped callout")
556
+ """Oval-shaped callout"""
557
+
558
+ PARALLELOGRAM = (2, "parallelogram", "Parallelogram")
559
+ """Parallelogram"""
560
+
561
+ PENTAGON = (51, "homePlate", "Pentagon")
562
+ """Pentagon"""
563
+
564
+ PIE = (142, "pie", "Pie")
565
+ """Pie"""
566
+
567
+ PIE_WEDGE = (175, "pieWedge", "Pie")
568
+ """Pie"""
569
+
570
+ PLAQUE = (28, "plaque", "Plaque")
571
+ """Plaque"""
572
+
573
+ PLAQUE_TABS = (171, "plaqueTabs", "Plaque Tabs")
574
+ """Plaque Tabs"""
575
+
576
+ QUAD_ARROW = (39, "quadArrow", "Block arrows that point up, down, left, and right")
577
+ """Block arrows that point up, down, left, and right"""
578
+
579
+ QUAD_ARROW_CALLOUT = (
580
+ 59,
581
+ "quadArrowCallout",
582
+ "Callout with arrows that point up, down, left, and right",
583
+ )
584
+ """Callout with arrows that point up, down, left, and right"""
585
+
586
+ RECTANGLE = (1, "rect", "Rectangle")
587
+ """Rectangle"""
588
+
589
+ RECTANGULAR_CALLOUT = (105, "wedgeRectCallout", "Rectangular callout")
590
+ """Rectangular callout"""
591
+
592
+ REGULAR_PENTAGON = (12, "pentagon", "Pentagon")
593
+ """Pentagon"""
594
+
595
+ RIGHT_ARROW = (33, "rightArrow", "Block arrow that points right")
596
+ """Block arrow that points right"""
597
+
598
+ RIGHT_ARROW_CALLOUT = (53, "rightArrowCallout", "Callout with arrow that points right")
599
+ """Callout with arrow that points right"""
600
+
601
+ RIGHT_BRACE = (32, "rightBrace", "Right brace")
602
+ """Right brace"""
603
+
604
+ RIGHT_BRACKET = (30, "rightBracket", "Right bracket")
605
+ """Right bracket"""
606
+
607
+ RIGHT_TRIANGLE = (8, "rtTriangle", "Right triangle")
608
+ """Right triangle"""
609
+
610
+ ROUNDED_RECTANGLE = (5, "roundRect", "Rounded rectangle")
611
+ """Rounded rectangle"""
612
+
613
+ ROUNDED_RECTANGULAR_CALLOUT = (106, "wedgeRoundRectCallout", "Rounded rectangle-shaped callout")
614
+ """Rounded rectangle-shaped callout"""
615
+
616
+ ROUND_1_RECTANGLE = (151, "round1Rect", "Round Single Corner Rectangle")
617
+ """Round Single Corner Rectangle"""
618
+
619
+ ROUND_2_DIAG_RECTANGLE = (153, "round2DiagRect", "Round Diagonal Corner Rectangle")
620
+ """Round Diagonal Corner Rectangle"""
621
+
622
+ ROUND_2_SAME_RECTANGLE = (152, "round2SameRect", "Round Same Side Corner Rectangle")
623
+ """Round Same Side Corner Rectangle"""
624
+
625
+ SMILEY_FACE = (17, "smileyFace", "Smiley face")
626
+ """Smiley face"""
627
+
628
+ SNIP_1_RECTANGLE = (155, "snip1Rect", "Snip Single Corner Rectangle")
629
+ """Snip Single Corner Rectangle"""
630
+
631
+ SNIP_2_DIAG_RECTANGLE = (157, "snip2DiagRect", "Snip Diagonal Corner Rectangle")
632
+ """Snip Diagonal Corner Rectangle"""
633
+
634
+ SNIP_2_SAME_RECTANGLE = (156, "snip2SameRect", "Snip Same Side Corner Rectangle")
635
+ """Snip Same Side Corner Rectangle"""
636
+
637
+ SNIP_ROUND_RECTANGLE = (154, "snipRoundRect", "Snip and Round Single Corner Rectangle")
638
+ """Snip and Round Single Corner Rectangle"""
639
+
640
+ SQUARE_TABS = (170, "squareTabs", "Square Tabs")
641
+ """Square Tabs"""
642
+
643
+ STAR_10_POINT = (149, "star10", "10-Point Star")
644
+ """10-Point Star"""
645
+
646
+ STAR_12_POINT = (150, "star12", "12-Point Star")
647
+ """12-Point Star"""
648
+
649
+ STAR_16_POINT = (94, "star16", "16-point star")
650
+ """16-point star"""
651
+
652
+ STAR_24_POINT = (95, "star24", "24-point star")
653
+ """24-point star"""
654
+
655
+ STAR_32_POINT = (96, "star32", "32-point star")
656
+ """32-point star"""
657
+
658
+ STAR_4_POINT = (91, "star4", "4-point star")
659
+ """4-point star"""
660
+
661
+ STAR_5_POINT = (92, "star5", "5-point star")
662
+ """5-point star"""
663
+
664
+ STAR_6_POINT = (147, "star6", "6-Point Star")
665
+ """6-Point Star"""
666
+
667
+ STAR_7_POINT = (148, "star7", "7-Point Star")
668
+ """7-Point Star"""
669
+
670
+ STAR_8_POINT = (93, "star8", "8-point star")
671
+ """8-point star"""
672
+
673
+ STRIPED_RIGHT_ARROW = (
674
+ 49,
675
+ "stripedRightArrow",
676
+ "Block arrow that points right with stripes at the tail",
677
+ )
678
+ """Block arrow that points right with stripes at the tail"""
679
+
680
+ SUN = (23, "sun", "Sun")
681
+ """Sun"""
682
+
683
+ SWOOSH_ARROW = (178, "swooshArrow", "Swoosh Arrow")
684
+ """Swoosh Arrow"""
685
+
686
+ TEAR = (160, "teardrop", "Teardrop")
687
+ """Teardrop"""
688
+
689
+ TRAPEZOID = (3, "trapezoid", "Trapezoid")
690
+ """Trapezoid"""
691
+
692
+ UP_ARROW = (35, "upArrow", "Block arrow that points up")
693
+ """Block arrow that points up"""
694
+
695
+ UP_ARROW_CALLOUT = (55, "upArrowCallout", "Callout with arrow that points up")
696
+ """Callout with arrow that points up"""
697
+
698
+ UP_DOWN_ARROW = (38, "upDownArrow", "Block arrow that points up and down")
699
+ """Block arrow that points up and down"""
700
+
701
+ UP_DOWN_ARROW_CALLOUT = (58, "upDownArrowCallout", "Callout with arrows that point up and down")
702
+ """Callout with arrows that point up and down"""
703
+
704
+ UP_RIBBON = (97, "ribbon2", "Ribbon banner with center area above ribbon ends")
705
+ """Ribbon banner with center area above ribbon ends"""
706
+
707
+ U_TURN_ARROW = (42, "uturnArrow", "Block arrow forming a U shape")
708
+ """Block arrow forming a U shape"""
709
+
710
+ VERTICAL_SCROLL = (101, "verticalScroll", "Vertical scroll")
711
+ """Vertical scroll"""
712
+
713
+ WAVE = (103, "wave", "Wave")
714
+ """Wave"""
715
+
716
+
717
+ MSO_SHAPE = MSO_AUTO_SHAPE_TYPE
718
+
719
+
720
+ class MSO_CONNECTOR_TYPE(BaseXmlEnum):
721
+ """
722
+ Specifies a type of connector.
723
+
724
+ Alias: ``MSO_CONNECTOR``
725
+
726
+ Example::
727
+
728
+ from pptx2.enum.shapes import MSO_CONNECTOR
729
+ from pptx2.util import Cm
730
+
731
+ shapes = prs.slides[0].shapes
732
+ connector = shapes.add_connector(
733
+ MSO_CONNECTOR.STRAIGHT, Cm(2), Cm(2), Cm(10), Cm(10)
734
+ )
735
+ assert connector.left.cm == 2
736
+
737
+ MS API Name: `MsoConnectorType`
738
+
739
+ http://msdn.microsoft.com/en-us/library/office/ff860918.aspx
740
+ """
741
+
742
+ CURVE = (3, "curvedConnector3", "Curved connector.")
743
+ """Curved connector."""
744
+
745
+ ELBOW = (2, "bentConnector3", "Elbow connector.")
746
+ """Elbow connector."""
747
+
748
+ STRAIGHT = (1, "line", "Straight line connector.")
749
+ """Straight line connector."""
750
+
751
+ MIXED = (-2, "", "Return value only; indicates a combination of other states.")
752
+ """Return value only; indicates a combination of other states."""
753
+
754
+
755
+ MSO_CONNECTOR = MSO_CONNECTOR_TYPE
756
+
757
+
758
+ class MSO_SHAPE_TYPE(BaseEnum):
759
+ """Specifies the type of a shape, more specifically than the five base types.
760
+
761
+ Alias: ``MSO``
762
+
763
+ Example::
764
+
765
+ from pptx2.enum.shapes import MSO_SHAPE_TYPE
766
+
767
+ assert shape.type == MSO_SHAPE_TYPE.PICTURE
768
+
769
+ MS API Name: `MsoShapeType`
770
+
771
+ http://msdn.microsoft.com/en-us/library/office/ff860759(v=office.15).aspx
772
+ """
773
+
774
+ AUTO_SHAPE = (1, "AutoShape")
775
+ """AutoShape"""
776
+
777
+ CALLOUT = (2, "Callout shape")
778
+ """Callout shape"""
779
+
780
+ CANVAS = (20, "Drawing canvas")
781
+ """Drawing canvas"""
782
+
783
+ CHART = (3, "Chart, e.g. pie chart, bar chart")
784
+ """Chart, e.g. pie chart, bar chart"""
785
+
786
+ COMMENT = (4, "Comment")
787
+ """Comment"""
788
+
789
+ DIAGRAM = (21, "Diagram")
790
+ """Diagram"""
791
+
792
+ EMBEDDED_OLE_OBJECT = (7, "Embedded OLE object")
793
+ """Embedded OLE object"""
794
+
795
+ FORM_CONTROL = (8, "Form control")
796
+ """Form control"""
797
+
798
+ FREEFORM = (5, "Freeform")
799
+ """Freeform"""
800
+
801
+ GROUP = (6, "Group shape")
802
+ """Group shape"""
803
+
804
+ IGX_GRAPHIC = (24, "SmartArt graphic")
805
+ """SmartArt graphic"""
806
+
807
+ INK = (22, "Ink")
808
+ """Ink"""
809
+
810
+ INK_COMMENT = (23, "Ink Comment")
811
+ """Ink Comment"""
812
+
813
+ LINE = (9, "Line")
814
+ """Line"""
815
+
816
+ LINKED_OLE_OBJECT = (10, "Linked OLE object")
817
+ """Linked OLE object"""
818
+
819
+ LINKED_PICTURE = (11, "Linked picture")
820
+ """Linked picture"""
821
+
822
+ MEDIA = (16, "Media")
823
+ """Media"""
824
+
825
+ OLE_CONTROL_OBJECT = (12, "OLE control object")
826
+ """OLE control object"""
827
+
828
+ PICTURE = (13, "Picture")
829
+ """Picture"""
830
+
831
+ PLACEHOLDER = (14, "Placeholder")
832
+ """Placeholder"""
833
+
834
+ SCRIPT_ANCHOR = (18, "Script anchor")
835
+ """Script anchor"""
836
+
837
+ TABLE = (19, "Table")
838
+ """Table"""
839
+
840
+ TEXT_BOX = (17, "Text box")
841
+ """Text box"""
842
+
843
+ TEXT_EFFECT = (15, "Text effect")
844
+ """Text effect"""
845
+
846
+ WEB_VIDEO = (26, "Web video")
847
+ """Web video"""
848
+
849
+ MIXED = (-2, "Multiple shape types (read-only).")
850
+ """Multiple shape types (read-only)."""
851
+
852
+
853
+ MSO = MSO_SHAPE_TYPE
854
+
855
+
856
+ class PP_MEDIA_TYPE(BaseEnum):
857
+ """Indicates the OLE media type.
858
+
859
+ Example::
860
+
861
+ from pptx2.enum.shapes import PP_MEDIA_TYPE
862
+
863
+ movie = slide.shapes[0]
864
+ assert movie.media_type == PP_MEDIA_TYPE.MOVIE
865
+
866
+ MS API Name: `PpMediaType`
867
+
868
+ https://msdn.microsoft.com/en-us/library/office/ff746008.aspx
869
+ """
870
+
871
+ MOVIE = (3, "Video media such as MP4.")
872
+ """Video media such as MP4."""
873
+
874
+ OTHER = (1, "Other media types")
875
+ """Other media types"""
876
+
877
+ SOUND = (1, "Audio media such as MP3.")
878
+ """Audio media such as MP3."""
879
+
880
+ MIXED = (
881
+ -2,
882
+ "Return value only; indicates multiple media types, typically for a collection of shapes."
883
+ " May not be applicable in python-pptx.",
884
+ )
885
+ """Return value only; indicates multiple media types.
886
+
887
+ Typically for a collection of shapes. May not be applicable in python-pptx.
888
+ """
889
+
890
+
891
+ class PP_PLACEHOLDER_TYPE(BaseXmlEnum):
892
+ """Specifies one of the 18 distinct types of placeholder.
893
+
894
+ Alias: ``PP_PLACEHOLDER``
895
+
896
+ Example::
897
+
898
+ from pptx2.enum.shapes import PP_PLACEHOLDER
899
+
900
+ placeholder = slide.placeholders[0]
901
+ assert placeholder.type == PP_PLACEHOLDER.TITLE
902
+
903
+ MS API name: `PpPlaceholderType`
904
+
905
+ http://msdn.microsoft.com/en-us/library/office/ff860759(v=office.15 ").aspx"
906
+ """
907
+
908
+ BITMAP = (9, "clipArt", "Clip art placeholder")
909
+ """Clip art placeholder"""
910
+
911
+ BODY = (2, "body", "Body")
912
+ """Body"""
913
+
914
+ CENTER_TITLE = (3, "ctrTitle", "Center Title")
915
+ """Center Title"""
916
+
917
+ CHART = (8, "chart", "Chart")
918
+ """Chart"""
919
+
920
+ DATE = (16, "dt", "Date")
921
+ """Date"""
922
+
923
+ FOOTER = (15, "ftr", "Footer")
924
+ """Footer"""
925
+
926
+ HEADER = (14, "hdr", "Header")
927
+ """Header"""
928
+
929
+ MEDIA_CLIP = (10, "media", "Media Clip")
930
+ """Media Clip"""
931
+
932
+ OBJECT = (7, "obj", "Object")
933
+ """Object"""
934
+
935
+ ORG_CHART = (11, "dgm", "SmartArt placeholder. Organization chart is a legacy name.")
936
+ """SmartArt placeholder. Organization chart is a legacy name."""
937
+
938
+ PICTURE = (18, "pic", "Picture")
939
+ """Picture"""
940
+
941
+ SLIDE_IMAGE = (101, "sldImg", "Slide Image")
942
+ """Slide Image"""
943
+
944
+ SLIDE_NUMBER = (13, "sldNum", "Slide Number")
945
+ """Slide Number"""
946
+
947
+ SUBTITLE = (4, "subTitle", "Subtitle")
948
+ """Subtitle"""
949
+
950
+ TABLE = (12, "tbl", "Table")
951
+ """Table"""
952
+
953
+ TITLE = (1, "title", "Title")
954
+ """Title"""
955
+
956
+ VERTICAL_BODY = (6, "", "Vertical Body (read-only).")
957
+ """Vertical Body (read-only)."""
958
+
959
+ VERTICAL_OBJECT = (17, "", "Vertical Object (read-only).")
960
+ """Vertical Object (read-only)."""
961
+
962
+ VERTICAL_TITLE = (5, "", "Vertical Title (read-only).")
963
+ """Vertical Title (read-only)."""
964
+
965
+ MIXED = (-2, "", "Return value only; multiple placeholders of differing types.")
966
+ """Return value only; multiple placeholders of differing types."""
967
+
968
+
969
+ PP_PLACEHOLDER = PP_PLACEHOLDER_TYPE
970
+
971
+
972
+ class PROG_ID(enum.Enum):
973
+ """One-off Enum-like object for progId values.
974
+
975
+ Indicates the type of an OLE object in terms of the program used to open it.
976
+
977
+ A member of this enumeration can be used in a `SlideShapes.add_ole_object()` call to
978
+ specify a Microsoft Office file-type (Excel, PowerPoint, or Word), which will
979
+ then not require several of the arguments required to embed other object types.
980
+
981
+ Example::
982
+
983
+ from pptx2.enum.shapes import PROG_ID
984
+ from pptx2.util import Inches
985
+
986
+ embedded_xlsx_shape = slide.shapes.add_ole_object(
987
+ "workbook.xlsx", PROG_ID.XLSX, left=Inches(1), top=Inches(1)
988
+ )
989
+ assert embedded_xlsx_shape.ole_format.prog_id == "Excel.Sheet.12"
990
+ """
991
+
992
+ _progId: str
993
+ _icon_filename: str
994
+ _width: int
995
+ _height: int
996
+
997
+ def __new__(cls, value: str, progId: str, icon_filename: str, width: int, height: int):
998
+ self = object.__new__(cls)
999
+ self._value_ = value
1000
+ self._progId = progId
1001
+ self._icon_filename = icon_filename
1002
+ self._width = width
1003
+ self._height = height
1004
+ return self
1005
+
1006
+ @property
1007
+ def height(self):
1008
+ return self._height
1009
+
1010
+ @property
1011
+ def icon_filename(self):
1012
+ return self._icon_filename
1013
+
1014
+ @property
1015
+ def progId(self):
1016
+ return self._progId
1017
+
1018
+ @property
1019
+ def width(self):
1020
+ return self._width
1021
+
1022
+ DOCX = ("DOCX", "Word.Document.12", "docx-icon.emf", 965200, 609600)
1023
+ """`progId` for an embedded Word 2007+ (.docx) document."""
1024
+
1025
+ PPTX = ("PPTX", "PowerPoint.Show.12", "pptx-icon.emf", 965200, 609600)
1026
+ """`progId` for an embedded PowerPoint 2007+ (.pptx) document."""
1027
+
1028
+ XLSX = ("XLSX", "Excel.Sheet.12", "xlsx-icon.emf", 965200, 609600)
1029
+ """`progId` for an embedded Excel 2007+ (.xlsx) document."""