tab_stops: Add paragraph_format.tab_stops object

DKWoods · DKWoods · commit 851bfc134dca · 2016-04-06T10:00:21.000-05:00
diff --git a/docx/oxml/__init__.py b/docx/oxml/__init__.py
@@ -181,7 +181,7 @@ def OxmlElement(nsptag_str, attrs=None, nsdecls=None):
 from .text.paragraph import CT_P
 register_element_cls('w:p', CT_P)
 
-from .text.parfmt import CT_Ind, CT_Jc, CT_PPr, CT_Spacing
+from .text.parfmt import CT_Ind, CT_Jc, CT_PPr, CT_Spacing, CT_TabStops
 register_element_cls('w:ind',             CT_Ind)
 register_element_cls('w:jc',              CT_Jc)
 register_element_cls('w:keepLines',       CT_OnOff)
@@ -190,6 +190,7 @@ def OxmlElement(nsptag_str, attrs=None, nsdecls=None):
 register_element_cls('w:pPr',             CT_PPr)
 register_element_cls('w:pStyle',          CT_String)
 register_element_cls('w:spacing',         CT_Spacing)
+register_element_cls('w:tabs',            CT_TabStops)
 register_element_cls('w:widowControl',    CT_OnOff)
 
 from .text.run import CT_Br, CT_R, CT_Text
diff --git a/docx/oxml/text/parfmt.py b/docx/oxml/text/parfmt.py
@@ -8,7 +8,7 @@
 from ...shared import Length
 from ..simpletypes import ST_SignedTwipsMeasure, ST_TwipsMeasure
 from ..xmlchemy import (
-    BaseOxmlElement, OptionalAttribute, RequiredAttribute, ZeroOrOne
+    BaseOxmlElement, OptionalAttribute, RequiredAttribute, ZeroOrOne, OneOrMore
 )
 
 
@@ -50,6 +50,7 @@ class CT_PPr(BaseOxmlElement):
     pageBreakBefore = ZeroOrOne('w:pageBreakBefore', successors=_tag_seq[4:])
     widowControl = ZeroOrOne('w:widowControl', successors=_tag_seq[6:])
     numPr = ZeroOrOne('w:numPr', successors=_tag_seq[7:])
+    tabs = ZeroOrOne('w:tabs', successors=_tag_seq[11:])
     spacing = ZeroOrOne('w:spacing', successors=_tag_seq[22:])
     ind = ZeroOrOne('w:ind', successors=_tag_seq[23:])
     jc = ZeroOrOne('w:jc', successors=_tag_seq[27:])
@@ -311,3 +312,10 @@ class CT_Spacing(BaseOxmlElement):
     before = OptionalAttribute('w:before', ST_TwipsMeasure)
     line = OptionalAttribute('w:line', ST_SignedTwipsMeasure)
     lineRule = OptionalAttribute('w:lineRule', WD_LINE_SPACING)
+
+
+class CT_TabStops(BaseOxmlElement):
+    """
+    ``<w:tabs>`` element, specifying the sorted list of tab stops.
+    """
+    tab = OneOrMore('w:tab', successors=())
diff --git a/docx/text/parfmt.py b/docx/text/parfmt.py
@@ -8,6 +8,7 @@
     absolute_import, division, print_function, unicode_literals
 )
 
+from .tabstops import TabStops
 from ..enum.text import WD_LINE_SPACING
 from ..shared import ElementProxy, Emu, Length, Pt, Twips
 
@@ -243,6 +244,14 @@ def space_before(self):
     def space_before(self, value):
         self._element.get_or_add_pPr().spacing_before = value
 
+    @property
+    def tab_stops(self):
+        """
+        The |TabStops| object providing access to the tab_stop
+        properties for this paragraph, such as position, alignment, and leader.
+        """
+        return TabStops(self._element)
+
     @property
     def widow_control(self):
         """
diff --git a/features/steps/tabs.py b/features/steps/tabs.py
diff --git a/features/tab-access-tabs.feature b/features/tab-access-tabs.feature
diff --git a/tests/text/test_parfmt.py b/tests/text/test_parfmt.py
@@ -12,6 +12,7 @@
 from docx.enum.text import WD_ALIGN_PARAGRAPH, WD_LINE_SPACING
 from docx.shared import Pt
 from docx.text.parfmt import ParagraphFormat
+from docx.text.tabstops import TabStops
 
 import pytest
 
@@ -20,6 +21,10 @@
 
 class DescribeParagraphFormat(object):
 
+    def it_provides_access_to_its_tab_stops(self, tab_stops_get_fixture):
+        tab_stops = tab_stops_get_fixture
+        assert isinstance(tab_stops, TabStops)
+
     def it_knows_its_alignment_value(self, alignment_get_fixture):
         paragraph_format, expected_value = alignment_get_fixture
         assert paragraph_format.alignment == expected_value
@@ -104,6 +109,16 @@ def it_can_change_its_on_off_props(self, on_off_set_fixture):
 
     # fixtures -------------------------------------------------------
 
+    @pytest.fixture(params=[
+        ('w:p'),
+        ('w:p/w:pPr/w:tabs/w:tab{w:pos=2880}'),
+    ])
+    def tab_stops_get_fixture(self, request):
+        p_cxml = request.param
+        paragraph_format = ParagraphFormat(element(p_cxml))
+        tab_stops = paragraph_format.tab_stops
+        return tab_stops
+
     @pytest.fixture(params=[
         ('w:p',                          None),
         ('w:p/w:pPr',                    None),
