style: add LatentStyles on/off property getters

Steve Canny · Steve Canny · commit 45dd568b7afd · 2015-02-08T00:01:47.000-08:00
diff --git a/docx/oxml/styles.py b/docx/oxml/styles.py
@@ -39,7 +39,21 @@ class CT_LatentStyles(BaseOxmlElement):
     lsdException = ZeroOrMore('w:lsdException', successors=())
 
     count = OptionalAttribute('w:count', ST_DecimalNumber)
+    defLockedState = OptionalAttribute('w:defLockedState', ST_OnOff)
+    defQFormat = OptionalAttribute('w:defQFormat', ST_OnOff)
+    defSemiHidden = OptionalAttribute('w:defSemiHidden', ST_OnOff)
     defUIPriority = OptionalAttribute('w:defUIPriority', ST_DecimalNumber)
+    defUnhideWhenUsed = OptionalAttribute('w:defUnhideWhenUsed', ST_OnOff)
+
+    def bool_prop(self, attr_name):
+        """
+        Return the boolean value of the attribute having *attr_name*, or
+        |False| if not present.
+        """
+        value = getattr(self, attr_name)
+        if value is None:
+            return False
+        return value
 
     def get_by_name(self, name):
         """
diff --git a/docx/styles/latent.py b/docx/styles/latent.py
@@ -44,6 +44,42 @@ def default_priority(self):
         """
         return self._element.defUIPriority
 
+    @property
+    def default_to_hidden(self):
+        """
+        Boolean specifying whether the default behavior for latent styles is
+        to be hidden. A hidden style does not appear in the recommended list
+        or in the style gallery.
+        """
+        return self._element.bool_prop('defSemiHidden')
+
+    @property
+    def default_to_locked(self):
+        """
+        Boolean specifying whether the default behavior for latent styles is
+        to be 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.bool_prop('defLockedState')
+
+    @property
+    def default_to_quick_style(self):
+        """
+        Boolean specifying whether the default behavior for latent styles is
+        to appear in the style gallery when not hidden.
+        """
+        return self._element.bool_prop('defQFormat')
+
+    @property
+    def default_to_unhide_when_used(self):
+        """
+        Boolean specifying whether the default behavior for latent styles is
+        to be unhidden when first applied to content.
+        """
+        return self._element.bool_prop('defUnhideWhenUsed')
+
     @property
     def load_count(self):
         """
diff --git a/features/sty-latent-props.feature b/features/sty-latent-props.feature
@@ -4,7 +4,6 @@ Feature: Get and set latent style properties
   I need a set of read/write latent style properties
 
 
-  @wip
   Scenario Outline: Get default latent style properties
     Given a latent styles object with known defaults
      Then latent_styles.<prop-name> is <value>
diff --git a/tests/styles/test_latent.py b/tests/styles/test_latent.py
@@ -47,8 +47,32 @@ def it_knows_its_load_count(self, count_get_fixture):
         latent_styles, expected_value = count_get_fixture
         assert latent_styles.load_count == expected_value
 
+    def it_knows_its_boolean_properties(self, bool_prop_get_fixture):
+        latent_styles, prop_name, expected_value = bool_prop_get_fixture
+        actual_value = getattr(latent_styles, prop_name)
+        assert actual_value == expected_value
+
     # fixture --------------------------------------------------------
 
+    @pytest.fixture(params=[
+        ('w:latentStyles', 'default_to_hidden',           False),
+        ('w:latentStyles', 'default_to_locked',           False),
+        ('w:latentStyles', 'default_to_quick_style',      False),
+        ('w:latentStyles', 'default_to_unhide_when_used', False),
+        ('w:latentStyles{w:defSemiHidden=1}',
+         'default_to_hidden',           True),
+        ('w:latentStyles{w:defLockedState=0}',
+         'default_to_locked',           False),
+        ('w:latentStyles{w:defQFormat=on}',
+         'default_to_quick_style',      True),
+        ('w:latentStyles{w:defUnhideWhenUsed=false}',
+         'default_to_unhide_when_used', False),
+    ])
+    def bool_prop_get_fixture(self, request):
+        latentStyles_cxml, prop_name, expected_value = request.param
+        latent_styles = LatentStyles(element(latentStyles_cxml))
+        return latent_styles, prop_name, expected_value
+
     @pytest.fixture(params=[
         ('w:latentStyles',             None),
         ('w:latentStyles{w:count=42}', 42),
