style: add BaseStyle.quick_format getter

Steve Canny · Steve Canny · commit 7dafb7044ec0 · 2015-02-08T00:01:46.000-08:00
diff --git a/docx/oxml/__init__.py b/docx/oxml/__init__.py
@@ -116,6 +116,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:name',           CT_String)
+register_element_cls('w:qFormat',        CT_OnOff)
 register_element_cls('w:semiHidden',     CT_OnOff)
 register_element_cls('w:style',          CT_Style)
 register_element_cls('w:styles',         CT_Styles)
diff --git a/docx/oxml/styles.py b/docx/oxml/styles.py
@@ -46,6 +46,7 @@ class CT_Style(BaseOxmlElement):
     uiPriority = ZeroOrOne('w:uiPriority', successors=_tag_seq[8:])
     semiHidden = ZeroOrOne('w:semiHidden', successors=_tag_seq[9:])
     unhideWhenUsed = ZeroOrOne('w:unhideWhenUsed', successors=_tag_seq[10:])
+    qFormat = ZeroOrOne('w:qFormat', successors=_tag_seq[11:])
     pPr = ZeroOrOne('w:pPr', successors=_tag_seq[17:])
     rPr = ZeroOrOne('w:rPr', successors=_tag_seq[18:])
     del _tag_seq
@@ -110,6 +111,16 @@ def name_val(self, value):
             name = self._add_name()
             name.val = value
 
+    @property
+    def qFormat_val(self):
+        """
+        Value of `w:qFormat/@w:val` or |False| if not present.
+        """
+        qFormat = self.qFormat
+        if qFormat is None:
+            return False
+        return qFormat.val
+
     @property
     def semiHidden_val(self):
         """
diff --git a/docx/styles/style.py b/docx/styles/style.py
@@ -101,6 +101,14 @@ def priority(self):
     def priority(self, value):
         self._element.uiPriority_val = value
 
+    @property
+    def quick_style(self):
+        """
+        |True| if this style should be displayed in the style gallery when
+        :attr:`.hidden` is |False|. Read/write Boolean.
+        """
+        return self._element.qFormat_val
+
     @property
     def style_id(self):
         """
diff --git a/features/sty-style-props.feature b/features/sty-style-props.feature
@@ -81,7 +81,6 @@ Feature: Get and set style properties
       | 42         | None      | None  |
 
 
-  @wip
   Scenario Outline: Get quick-style value
     Given a style having quick-style set <setting>
      Then style.quick_style is <value>
diff --git a/tests/styles/test_style.py b/tests/styles/test_style.py
@@ -150,6 +150,10 @@ def it_can_change_its_unhide_when_used_value(self, unhide_set_fixture):
         style.unhide_when_used = value
         assert style._element.xml == expected_xml
 
+    def it_knows_its_quick_style_setting(self, quick_get_fixture):
+        style, expected_value = quick_get_fixture
+        assert style.quick_style == expected_value
+
     def it_can_delete_itself_from_the_document(self, delete_fixture):
         style, styles, expected_xml = delete_fixture
         style.delete()
@@ -265,6 +269,17 @@ def priority_set_fixture(self, request):
         expected_xml = xml(expected_cxml)
         return style, value, expected_xml
 
+    @pytest.fixture(params=[
+        ('w:style',                     False),
+        ('w:style/w:qFormat',           True),
+        ('w:style/w:qFormat{w:val=0}',  False),
+        ('w:style/w:qFormat{w:val=on}', True),
+    ])
+    def quick_get_fixture(self, request):
+        style_cxml, expected_value = request.param
+        style = BaseStyle(element(style_cxml))
+        return style, expected_value
+
     @pytest.fixture(params=[
         ('w:style',                   WD_STYLE_TYPE.PARAGRAPH),
         ('w:style{w:type=paragraph}', WD_STYLE_TYPE.PARAGRAPH),
