shp: add InlineShape.width, height setters

Steve Canny · Steve Canny · commit d4908711ab8f · 2013-12-30T21:39:00.000-08:00
diff --git a/docs/dev/analysis/features/shapes-inline-size.rst b/docs/dev/analysis/features/shapes-inline-size.rst
@@ -9,30 +9,9 @@ Overview
 The position of an inline shape is completely determined by the text it is
 inline with, however its dimensions can be specified. For some shape types,
 both the contained shape and the shape container specify a width and height.
-
-
-Unit tests
-----------
-
-DescribeInlineShape
-
-* it_knows_its_display_dimensions
-* it_can_change_its_display_dimensions
-
-
-Code sketches
--------------
-
-::
-
-    @property
-    def InlineShape.width(self):
-       assert isinstance(self._inline.extent.cx, _BaseLength)
-       return self._inline.extent.cx
-
-    @width.setter
-    def width(self, emu):
-       self._inline.extent = emu
+In the case of a picture, the dimensions of the inline shape (container)
+determine the display size while the dimension of the pic element determine the
+"original size" of the image.
 
 
 Candidate protocol -- inline shape access
diff --git a/docx/oxml/shape.py b/docx/oxml/shape.py
@@ -194,12 +194,22 @@ def cx(self):
         cx = int(cx_str)
         return Emu(cx)
 
+    @cx.setter
+    def cx(self, cx):
+        cx_str = str(cx)
+        self.set('cx', cx_str)
+
     @property
     def cy(self):
         cy_str = self.get('cy')
         cy = int(cy_str)
         return Emu(cy)
 
+    @cy.setter
+    def cy(self, cy):
+        cy_str = str(cy)
+        self.set('cy', cy_str)
+
     @classmethod
     def new(cls, nsptagname_str, cx, cy):
         elm = OxmlElement(nsptagname_str)
diff --git a/docx/shape.py b/docx/shape.py
@@ -37,6 +37,12 @@ def height(self):
         """
         return self._inline.extent.cy
 
+    @height.setter
+    def height(self, cy):
+        assert isinstance(cy, int)
+        assert 0 < cy
+        self._inline.extent.cy = cy
+
     @classmethod
     def new_picture(cls, r, image_part, rId, shape_id):
         """
@@ -78,3 +84,9 @@ def width(self):
         Return the display width of this inline shape as an |Emu| instance.
         """
         return self._inline.extent.cx
+
+    @width.setter
+    def width(self, cx):
+        assert isinstance(cx, int)
+        assert 0 < cx
+        self._inline.extent.cx = cx
diff --git a/features/shp-inline-shape-size.feature b/features/shp-inline-shape-size.feature
@@ -7,7 +7,6 @@ Feature: Query and change dimensions of inline shape
     Given an inline shape of known dimensions
      Then the dimensions of the inline shape match the known values
 
-  @wip
   Scenario: Change inline shape dimensions
     Given an inline shape of known dimensions
      When I change the dimensions of the inline shape
diff --git a/tests/test_shape.py b/tests/test_shape.py
@@ -47,18 +47,32 @@ def it_knows_its_display_dimensions(self, dimensions_get_fixture):
         assert isinstance(height, _BaseLength)
         assert height == cy
 
+    def it_can_change_its_display_dimensions(self, dimensions_set_fixture):
+        inline_shape, cx, cy, expected_xml = dimensions_set_fixture
+        inline_shape.width = cx
+        inline_shape.height = cy
+        assert inline_shape._inline.xml == expected_xml
+
     # fixtures -------------------------------------------------------
 
     @pytest.fixture
     def dimensions_get_fixture(self):
         cx, cy = 333, 666
-        inline = (
-            an_inline().with_nsdecls().with_child(
-                an_extent().with_cx(cx).with_cy(cy))
-        ).element
+        inline = self._inline_bldr_with_dimensions(cx, cy).element
         inline_shape = InlineShape(inline)
         return inline_shape, cx, cy
 
+    @pytest.fixture
+    def dimensions_set_fixture(self):
+        # inline_shape -----------------
+        cx, cy = 333, 666
+        inline = self._inline_bldr_with_dimensions(cx, cy).element
+        inline_shape = InlineShape(inline)
+        # expected_xml -----------------
+        cx, cy = cx + 111, cy + 222
+        expected_xml = self._inline_bldr_with_dimensions(cx, cy).xml()
+        return inline_shape, cx, cy, expected_xml
+
     @pytest.fixture
     def image_params(self):
         filename = 'foobar.garf'
@@ -127,6 +141,12 @@ def shape_type_fixture(self, request):
 
         return InlineShape(inline), shape_type
 
+    def _inline_bldr_with_dimensions(self, cx, cy):
+        return (
+            an_inline().with_nsdecls().with_child(
+                an_extent().with_cx(cx).with_cy(cy))
+        )
+
     def _inline_with_picture(self, embed=False, link=False):
         picture_ns = nsmap['pic']
 
