style: add BaseStyle.locked getter

Steve Canny · Steve Canny · commit e8f3ad352b41 · 2015-02-08T00:01:46.000-08:00
diff --git a/docx/oxml/__init__.py b/docx/oxml/__init__.py
@@ -115,6 +115,7 @@ def OxmlElement(nsptag_str, attrs=None, nsdecls=None):
 
 from .styles import CT_Style, CT_Styles
 register_element_cls('w:basedOn',        CT_String)
+register_element_cls('w:locked',         CT_OnOff)
 register_element_cls('w:name',           CT_String)
 register_element_cls('w:qFormat',        CT_OnOff)
 register_element_cls('w:semiHidden',     CT_OnOff)
diff --git a/docx/oxml/styles.py b/docx/oxml/styles.py
@@ -47,6 +47,7 @@ class CT_Style(BaseOxmlElement):
     semiHidden = ZeroOrOne('w:semiHidden', successors=_tag_seq[9:])
     unhideWhenUsed = ZeroOrOne('w:unhideWhenUsed', successors=_tag_seq[10:])
     qFormat = ZeroOrOne('w:qFormat', successors=_tag_seq[11:])
+    locked = ZeroOrOne('w:locked', successors=_tag_seq[12:])
     pPr = ZeroOrOne('w:pPr', successors=_tag_seq[17:])
     rPr = ZeroOrOne('w:rPr', successors=_tag_seq[18:])
     del _tag_seq
@@ -94,6 +95,16 @@ def delete(self):
         """
         self.getparent().remove(self)
 
+    @property
+    def locked_val(self):
+        """
+        Value of `w:locked/@w:val` or |False| if not present.
+        """
+        locked = self.locked
+        if locked is None:
+            return False
+        return locked.val
+
     @property
     def name_val(self):
         """
diff --git a/docx/styles/style.py b/docx/styles/style.py
@@ -62,8 +62,8 @@ def delete(self):
     @property
     def hidden(self):
         """
-        True if display of this style in the style gallery and list of
-        recommended styles is suppressed. False otherwise. In order to be
+        |True| if display of this style in the style gallery and list of
+        recommended styles is suppressed. |False| otherwise. In order to be
         shown in the style gallery, this value must be |False| and
         :attr:`.quick_style` must be |True|.
         """
@@ -73,6 +73,17 @@ def hidden(self):
     def hidden(self, value):
         self._element.semiHidden_val = value
 
+    @property
+    def locked(self):
+        """
+        Read/write Boolean. |True| if this style is locked. A locked style
+        does not appear in the styles panel or the style gallery and cannot
+        be applied to document content. This behavior is only active when
+        formatting protection is turned on for the document (via the
+        Developer menu).
+        """
+        return self._element.locked_val
+
     @property
     def name(self):
         """
diff --git a/features/sty-style-props.feature b/features/sty-style-props.feature
@@ -48,7 +48,6 @@ Feature: Get and set style properties
       | on         | False     | False |
 
 
-  @wip
   Scenario Outline: Get locked value
     Given a style having locked set <setting>
      Then style.locked is <value>
diff --git a/tests/styles/test_style.py b/tests/styles/test_style.py
@@ -159,6 +159,10 @@ def it_can_change_its_quick_style_setting(self, quick_set_fixture):
         style.quick_style = new_value
         assert style._element.xml == expected_xml
 
+    def it_knows_whether_its_locked(self, locked_get_fixture):
+        style, expected_value = locked_get_fixture
+        assert style.locked == expected_value
+
     def it_can_delete_itself_from_the_document(self, delete_fixture):
         style, styles, expected_xml = delete_fixture
         style.delete()
@@ -230,6 +234,17 @@ def id_set_fixture(self, request):
         expected_xml = xml(expected_style_cxml)
         return style, new_value, expected_xml
 
+    @pytest.fixture(params=[
+        ('w:style',                   False),
+        ('w:style/w:locked',          True),
+        ('w:style/w:locked{w:val=0}', False),
+        ('w:style/w:locked{w:val=1}', True),
+    ])
+    def locked_get_fixture(self, request):
+        style_cxml, expected_value = request.param
+        style = BaseStyle(element(style_cxml))
+        return style, expected_value
+
     @pytest.fixture(params=[
         ('w:style{w:type=table}',                         None),
         ('w:style{w:type=table}/w:name{w:val=Boofar}',    'Boofar'),
