style: add BaseStyle.hidden getter

Steve Canny · Steve Canny · commit 167de845f0f8 · 2015-02-08T00:01:45.000-08:00
diff --git a/docx/oxml/__init__.py b/docx/oxml/__init__.py
@@ -114,10 +114,11 @@ def OxmlElement(nsptag_str, attrs=None, nsdecls=None):
 register_element_cls('wp:inline',     CT_Inline)
 
 from .styles import CT_Style, CT_Styles
-register_element_cls('w:basedOn', CT_String)
-register_element_cls('w:name',    CT_String)
-register_element_cls('w:style',   CT_Style)
-register_element_cls('w:styles',  CT_Styles)
+register_element_cls('w:basedOn',        CT_String)
+register_element_cls('w:name',           CT_String)
+register_element_cls('w:semiHidden',     CT_OnOff)
+register_element_cls('w:style',          CT_Style)
+register_element_cls('w:styles',         CT_Styles)
 
 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
@@ -43,6 +43,7 @@ class CT_Style(BaseOxmlElement):
     )
     name = ZeroOrOne('w:name', successors=_tag_seq[1:])
     basedOn = ZeroOrOne('w:basedOn', successors=_tag_seq[3:])
+    semiHidden = ZeroOrOne('w:semiHidden', successors=_tag_seq[9:])
     pPr = ZeroOrOne('w:pPr', successors=_tag_seq[17:])
     rPr = ZeroOrOne('w:rPr', successors=_tag_seq[18:])
     del _tag_seq
@@ -107,6 +108,16 @@ def name_val(self, value):
             name = self._add_name()
             name.val = value
 
+    @property
+    def semiHidden_val(self):
+        """
+        Value of ``<w:semiHidden>`` child or |False| if not present.
+        """
+        semiHidden = self.semiHidden
+        if semiHidden is None:
+            return False
+        return semiHidden.val
+
 
 class CT_Styles(BaseOxmlElement):
     """
diff --git a/docx/styles/style.py b/docx/styles/style.py
@@ -59,6 +59,16 @@ def delete(self):
         self._element.delete()
         self._element = None
 
+    @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
+        shown in the style gallery, this value must be |False| and
+        :attr:`.quick_style` must be |True|.
+        """
+        return self._element.semiHidden_val
+
     @property
     def name(self):
         """
diff --git a/features/sty-style-props.feature b/features/sty-style-props.feature
@@ -26,7 +26,6 @@ Feature: Get and set style properties
       | Base       | None             | None             |
 
 
-  @wip
   Scenario Outline: Get hidden value
     Given a style having hidden set <setting>
      Then style.hidden is <value>
diff --git a/tests/styles/test_style.py b/tests/styles/test_style.py
@@ -123,6 +123,10 @@ def it_knows_whether_its_a_builtin_style(self, builtin_get_fixture):
         style, expected_value = builtin_get_fixture
         assert style.builtin is expected_value
 
+    def it_knows_whether_its_hidden(self, hidden_get_fixture):
+        style, expected_value = hidden_get_fixture
+        assert style.hidden == expected_value
+
     def it_can_delete_itself_from_the_document(self, delete_fixture):
         style, styles, expected_xml = delete_fixture
         style.delete()
@@ -148,6 +152,17 @@ def delete_fixture(self):
         expected_xml = xml('w:styles')
         return style, styles, expected_xml
 
+    @pytest.fixture(params=[
+        ('w:style',                       False),
+        ('w:style/w:semiHidden',          True),
+        ('w:style/w:semiHidden{w:val=0}', False),
+        ('w:style/w:semiHidden{w:val=1}', True),
+    ])
+    def hidden_get_fixture(self, request):
+        style_cxml, expected_value = request.param
+        style = BaseStyle(element(style_cxml))
+        return style, expected_value
+
     @pytest.fixture(params=[
         ('w:style',                   None),
         ('w:style{w:styleId=Foobar}', 'Foobar'),
