style: add BaseStyle.unhide_when_used getter

Steve Canny · Steve Canny · commit 8ea3891a850f · 2015-02-08T00:01:46.000-08:00
diff --git a/docx/oxml/__init__.py b/docx/oxml/__init__.py
@@ -120,6 +120,7 @@ def OxmlElement(nsptag_str, attrs=None, nsdecls=None):
 register_element_cls('w:style',          CT_Style)
 register_element_cls('w:styles',         CT_Styles)
 register_element_cls('w:uiPriority',     CT_DecimalNumber)
+register_element_cls('w:unhideWhenUsed', CT_OnOff)
 
 from .table import (
     CT_Row, CT_Tbl, CT_TblGrid, CT_TblGridCol, CT_TblLayoutType, CT_TblPr,
diff --git a/docx/oxml/styles.py b/docx/oxml/styles.py
@@ -45,6 +45,7 @@ class CT_Style(BaseOxmlElement):
     basedOn = ZeroOrOne('w:basedOn', successors=_tag_seq[3:])
     uiPriority = ZeroOrOne('w:uiPriority', successors=_tag_seq[8:])
     semiHidden = ZeroOrOne('w:semiHidden', successors=_tag_seq[9:])
+    unhideWhenUsed = ZeroOrOne('w:unhideWhenUsed', successors=_tag_seq[10:])
     pPr = ZeroOrOne('w:pPr', successors=_tag_seq[17:])
     rPr = ZeroOrOne('w:rPr', successors=_tag_seq[18:])
     del _tag_seq
@@ -143,6 +144,16 @@ def uiPriority_val(self, value):
             uiPriority = self._add_uiPriority()
             uiPriority.val = value
 
+    @property
+    def unhideWhenUsed_val(self):
+        """
+        Value of `w:unhideWhenUsed/@w:val` or |False| if not present.
+        """
+        unhideWhenUsed = self.unhideWhenUsed
+        if unhideWhenUsed is None:
+            return False
+        return unhideWhenUsed.val
+
 
 class CT_Styles(BaseOxmlElement):
     """
diff --git a/docx/styles/style.py b/docx/styles/style.py
@@ -125,6 +125,16 @@ def type(self):
             return WD_STYLE_TYPE.PARAGRAPH
         return type
 
+    @property
+    def unhide_when_used(self):
+        """
+        |True| if an application should make this style visible the next time
+        it is applied to content. False otherwise. Note that |docx| does not
+        automatically unhide a style having |True| for this attribute when it
+        is applied to content.
+        """
+        return self._element.unhideWhenUsed_val
+
     @staticmethod
     def _translate_special_case_names(name):
         """
diff --git a/features/sty-style-props.feature b/features/sty-style-props.feature
@@ -97,7 +97,6 @@ Feature: Get and set style properties
      Then style.type is the known type
 
 
-  @wip
   Scenario Outline: Get unhide-when-used value
     Given a style having unhide-when-used set <setting>
      Then style.unhide_when_used is <value>
diff --git a/tests/styles/test_style.py b/tests/styles/test_style.py
@@ -141,6 +141,10 @@ def it_can_change_its_sort_order(self, priority_set_fixture):
         style.priority = value
         assert style._element.xml == expected_xml
 
+    def it_knows_whether_its_unhide_when_used(self, unhide_get_fixture):
+        style, expected_value = unhide_get_fixture
+        assert style.unhide_when_used == expected_value
+
     def it_can_delete_itself_from_the_document(self, delete_fixture):
         style, styles, expected_xml = delete_fixture
         style.delete()
@@ -267,6 +271,17 @@ def type_get_fixture(self, request):
         style = BaseStyle(element(style_cxml))
         return style, expected_value
 
+    @pytest.fixture(params=[
+        ('w:style',                           False),
+        ('w:style/w:unhideWhenUsed',          True),
+        ('w:style/w:unhideWhenUsed{w:val=0}', False),
+        ('w:style/w:unhideWhenUsed{w:val=1}', True),
+    ])
+    def unhide_get_fixture(self, request):
+        style_cxml, expected_value = request.param
+        style = BaseStyle(element(style_cxml))
+        return style, expected_value
+
 
 class Describe_CharacterStyle(object):
 
