Source code

Download source archive ↓

src/openpyxl/worksheet/ole.py

1# Copyright (c) 2010-2024 openpyxl
2
3from openpyxl.descriptors.serialisable import Serialisable
4from openpyxl.descriptors import (
5    Typed,
6    Integer,
7    String,
8    Set,
9    Bool,
10    Sequence,
11)
12
13from openpyxl.drawing.spreadsheet_drawing import AnchorMarker
14from openpyxl.xml.constants import SHEET_DRAWING_NS
15
16
17class ObjectAnchor(Serialisable):
18
19    tagname = "anchor"
20
21    _from = Typed(expected_type=AnchorMarker, namespace=SHEET_DRAWING_NS)
22    to = Typed(expected_type=AnchorMarker, namespace=SHEET_DRAWING_NS)
23    moveWithCells = Bool(allow_none=True)
24    sizeWithCells = Bool(allow_none=True)
25    z_order = Integer(allow_none=True, hyphenated=True)
26
27
28    def __init__(self,
29                 _from=None,
30                 to=None,
31                 moveWithCells=False,
32                 sizeWithCells=False,
33                 z_order=None,
34                ):
35        self._from = _from
36        self.to = to
37        self.moveWithCells = moveWithCells
38        self.sizeWithCells = sizeWithCells
39        self.z_order = z_order
40
41
42class ObjectPr(Serialisable):
43
44    tagname = "objectPr"
45
46    anchor = Typed(expected_type=ObjectAnchor, )
47    locked = Bool(allow_none=True)
48    defaultSize = Bool(allow_none=True)
49    _print = Bool(allow_none=True)
50    disabled = Bool(allow_none=True)
51    uiObject = Bool(allow_none=True)
52    autoFill = Bool(allow_none=True)
53    autoLine = Bool(allow_none=True)
54    autoPict = Bool(allow_none=True)
55    macro = String()
56    altText = String(allow_none=True)
57    dde = Bool(allow_none=True)
58
59    __elements__ = ('anchor',)
60
61    def __init__(self,
62                 anchor=None,
63                 locked=True,
64                 defaultSize=True,
65                 _print=True,
66                 disabled=False,
67                 uiObject=False,
68                 autoFill=True,
69                 autoLine=True,
70                 autoPict=True,
71                 macro=None,
72                 altText=None,
73                 dde=False,
74                ):
75        self.anchor = anchor
76        self.locked = locked
77        self.defaultSize = defaultSize
78        self._print = _print
79        self.disabled = disabled
80        self.uiObject = uiObject
81        self.autoFill = autoFill
82        self.autoLine = autoLine
83        self.autoPict = autoPict
84        self.macro = macro
85        self.altText = altText
86        self.dde = dde
87
88
89class OleObject(Serialisable):
90
91    tagname = "oleObject"
92
93    objectPr = Typed(expected_type=ObjectPr, allow_none=True)
94    progId = String(allow_none=True)
95    dvAspect = Set(values=(['DVASPECT_CONTENT', 'DVASPECT_ICON']))
96    link = String(allow_none=True)
97    oleUpdate = Set(values=(['OLEUPDATE_ALWAYS', 'OLEUPDATE_ONCALL']))
98    autoLoad = Bool(allow_none=True)
99    shapeId = Integer()
100
101    __elements__ = ('objectPr',)
102
103    def __init__(self,
104                 objectPr=None,
105                 progId=None,
106                 dvAspect='DVASPECT_CONTENT',
107                 link=None,
108                 oleUpdate=None,
109                 autoLoad=False,
110                 shapeId=None,
111                ):
112        self.objectPr = objectPr
113        self.progId = progId
114        self.dvAspect = dvAspect
115        self.link = link
116        self.oleUpdate = oleUpdate
117        self.autoLoad = autoLoad
118        self.shapeId = shapeId
119
120
121class OleObjects(Serialisable):
122
123    tagname = "oleObjects"
124
125    oleObject = Sequence(expected_type=OleObject)
126
127    __elements__ = ('oleObject',)
128
129    def __init__(self,
130                 oleObject=(),
131                ):
132        self.oleObject = oleObject
133