ole: add _OleObjectElementCreator._icon_height

Author: scanny

pptx/oxml/shapes/graphfrm.py

@@ -193,7 +193,7 @@ def new_graphicFrame(cls, id_, name, x, y, cx, cy):
 
     @classmethod
     def new_ole_object_graphicFrame(
-        cls, id_, name, ole_object_rId, progId, icon_rId, x, y, cx, cy, imgW
+        cls, id_, name, ole_object_rId, progId, icon_rId, x, y, cx, cy, imgW, imgH
     ):
         """Return newly-created `<p:graphicFrame>` for embedded OLE-object.
 

pptx/shapes/shapetree.py

@@ -1088,6 +1088,7 @@ def _graphicFrame(self):
             self._cx,
             self._cy,
             self._icon_width,
+            self._icon_height,
         )
 
     @lazyproperty
@@ -1120,6 +1121,21 @@ def _cy(self):
             else Emu(609600)
         )
 
+    @lazyproperty
+    def _icon_height(self):
+        """Vertical size of enclosed EMF icon within the OLE graphic-frame.
+
+        This must be specified when a custom icon is used, to avoid stretching of the
+        image and possible undesired resizing by PowerPoint when the OLE shape is
+        double-clicked to open it.
+
+        The correct size can be determined by creating an example PPTX using PowerPoint
+        and then inspecting the XML of the OLE graphics-frame (p:oleObj.imgH).
+        """
+        return (
+            self._icon_height_arg if self._icon_height_arg is not None else Emu(609600)
+        )
+
     @lazyproperty
     def _icon_image_file(self):
         """Reference to image file containing icon to show in lieu of this object.

tests/shapes/test_shapetree.py

@@ -2246,6 +2246,16 @@ def it_determines_the_shape_height_to_help(self, cy_arg, prog_id, expected_value
         )
         assert element_creator._cy == expected_value
 
+    @pytest.mark.parametrize(
+        "icon_height_arg, expected_value",
+        ((Emu(666666), Emu(666666)), (None, Emu(609600)),),
+    )
+    def it_determines_the_icon_height_to_help(self, icon_height_arg, expected_value):
+        element_creator = _OleObjectElementCreator(
+            None, None, None, None, None, None, None, None, None, None, icon_height_arg
+        )
+        assert element_creator._icon_height == expected_value
+
     @pytest.mark.parametrize(
         "icon_file_arg, prog_id, expected_value",
         (