style: add _LatentStyle on/off prop getters

Steve Canny · Steve Canny · commit ec1964391f6d · 2015-02-08T00:01:48.000-08:00
diff --git a/docx/oxml/styles.py b/docx/oxml/styles.py
@@ -78,8 +78,19 @@ class CT_LsdException(BaseOxmlElement):
     ``<w:lsdException>`` element, defining override visibility behaviors for
     a named latent style.
     """
+    locked = OptionalAttribute('w:locked', ST_OnOff)
     name = RequiredAttribute('w:name', ST_String)
+    qFormat = OptionalAttribute('w:qFormat', ST_OnOff)
+    semiHidden = OptionalAttribute('w:semiHidden', ST_OnOff)
     uiPriority = OptionalAttribute('w:uiPriority', ST_DecimalNumber)
+    unhideWhenUsed = OptionalAttribute('w:unhideWhenUsed', ST_OnOff)
+
+    def on_off_prop(self, attr_name):
+        """
+        Return the boolean value of the attribute having *attr_name*, or
+        |None| if not present.
+        """
+        return getattr(self, attr_name)
 
 
 class CT_Style(BaseOxmlElement):
diff --git a/docx/styles/latent.py b/docx/styles/latent.py
@@ -126,6 +126,26 @@ class _LatentStyle(ElementProxy):
 
     __slots__ = ()
 
+    @property
+    def hidden(self):
+        """
+        Tri-state value specifying whether this latent style should appear in
+        the recommended list. |None| indicates the effective value is
+        inherited from the parent ``<w:latentStyles>`` element.
+        """
+        return self._element.on_off_prop('semiHidden')
+
+    @property
+    def locked(self):
+        """
+        Tri-state value specifying whether this latent styles 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.on_off_prop('locked')
+
     @property
     def name(self):
         """
@@ -143,3 +163,24 @@ def priority(self):
     @priority.setter
     def priority(self, value):
         self._element.uiPriority = value
+
+    @property
+    def quick_style(self):
+        """
+        Tri-state value specifying whether this latent style should appear in
+        the Word styles gallery when not hidden. |None| indicates the
+        effective value should be inherited from the default values in its
+        parent |LatentStyles| object.
+        """
+        return self._element.on_off_prop('qFormat')
+
+    @property
+    def unhide_when_used(self):
+        """
+        Tri-state value specifying whether this style should have its
+        :attr:`hidden` attribute set |False| the next time the style is
+        applied to content. |None| indicates the effective value should be
+        inherited from the default specified by its parent |LatentStyles|
+        object.
+        """
+        return self._element.on_off_prop('unhideWhenUsed')
diff --git a/features/sty-latent-props.feature b/features/sty-latent-props.feature
@@ -60,7 +60,6 @@ Feature: Get and set latent style properties
       | 42         | None      | None  |
 
 
-  @wip
   Scenario Outline: Get on/off latent style properties
     Given a latent style having <prop-name> set <setting>
      Then latent_style.<prop-name> is <value>
diff --git a/tests/styles/test_latent.py b/tests/styles/test_latent.py
@@ -30,6 +30,11 @@ def it_can_change_its_priority(self, priority_set_fixture):
         latent_style.priority = new_value
         assert latent_style._element.xml == expected_xml
 
+    def it_knows_its_on_off_properties(self, on_off_get_fixture):
+        latent_style, prop_name, expected_value = on_off_get_fixture
+        actual_value = getattr(latent_style, prop_name)
+        assert actual_value == expected_value
+
     # fixtures -------------------------------------------------------
 
     @pytest.fixture(params=[
@@ -40,6 +45,25 @@ def name_get_fixture(self, request):
         latent_style = _LatentStyle(element(lsdException_cxml))
         return latent_style, expected_value
 
+    @pytest.fixture(params=[
+        ('w:lsdException',                     'hidden',           None),
+        ('w:lsdException',                     'locked',           None),
+        ('w:lsdException',                     'quick_style',      None),
+        ('w:lsdException',                     'unhide_when_used', None),
+        ('w:lsdException{w:semiHidden=1}',     'hidden',           True),
+        ('w:lsdException{w:locked=1}',         'locked',           True),
+        ('w:lsdException{w:qFormat=1}',        'quick_style',      True),
+        ('w:lsdException{w:unhideWhenUsed=1}', 'unhide_when_used', True),
+        ('w:lsdException{w:semiHidden=0}',     'hidden',           False),
+        ('w:lsdException{w:locked=0}',         'locked',           False),
+        ('w:lsdException{w:qFormat=0}',        'quick_style',      False),
+        ('w:lsdException{w:unhideWhenUsed=0}', 'unhide_when_used', False),
+    ])
+    def on_off_get_fixture(self, request):
+        lsdException_cxml, prop_name, expected_value = request.param
+        latent_style = _LatentStyle(element(lsdException_cxml))
+        return latent_style, prop_name, expected_value
+
     @pytest.fixture(params=[
         ('w:lsdException',                  None),
         ('w:lsdException{w:uiPriority=42}', 42),
