acpt: add scenarios for feature/tabstops

DKWoods · DKWoods · commit b919cc8308c5 · 2016-03-18T12:39:40.000-05:00
diff --git a/docs/api/enum/WdTabAlignment.rst b/docs/api/enum/WdTabAlignment.rst
@@ -0,0 +1,38 @@
+.. _WdTabAlignment:
+
+``WD_TAB_ALIGNMENT``
+====================
+
+Specifies the alignment of tab stops that can be applied to a paragraph.
+
+----
+
+LEFT
+    Left-aligned.
+
+CENTER
+    Center-aligned.
+
+RIGHT
+    Right-aligned.
+
+DECIMAL
+    Decimal-aligned.
+
+BAR
+    Bar-aligned.
+
+LIST
+    List-aligned. (deprecated)
+
+START
+    Left-aligned.  (deprecated)
+
+END
+    Right-aligned.  (deprecated)
+
+NUM
+    Left-aligned!  (deprecated)
+
+CLEAR
+    Clear an inherited tab stop.
diff --git a/docs/api/enum/WdTabLeader.rst b/docs/api/enum/WdTabLeader.rst
@@ -0,0 +1,27 @@
+.. _WdTabLeader:
+
+``WD_TAB_LEADER``
+=================
+
+Specifies the leading character for tab stops that can be applied to a
+paragraph.
+
+----
+
+SPACES
+    Spaces. Default.
+
+DOTS
+    Dots.
+
+DASHES
+    Dashes.
+
+LINES
+    Double lines.
+
+HEAVY
+    A heavy line.
+
+MIDDLE_DOT
+    A middle dot.
diff --git a/docs/api/enum/index.rst b/docs/api/enum/index.rst
@@ -18,5 +18,7 @@ can be found here:
    WdSectionStart
    WdStyleType
    WdRowAlignment
+   WdTabAlignment
+   WdTabLeader
    WdTableDirection
    WdUnderline
diff --git a/docx/enum/text.py b/docx/enum/text.py
@@ -195,6 +195,81 @@ class WD_LINE_SPACING(XmlEnumeration):
     )
 
 
+class WD_TAB_ALIGNMENT(XmlEnumeration):
+    """
+    Specifies the alignment of tab stops that can be applied to a paragraph.
+    """
+
+    __ms_name__ = 'WdTabAlignment'
+
+    __url__ = 'https://msdn.microsoft.com/EN-US/library/office/ff195609.aspx'
+
+    __members__ = (
+        XmlMappedEnumMember(
+            'LEFT', 0, 'left', 'Left-aligned.'
+        ),
+        XmlMappedEnumMember(
+            'CENTER', 1, 'center', 'Center-aligned.'
+        ),
+        XmlMappedEnumMember(
+            'RIGHT', 2, 'right', 'Right-aligned.'
+        ),
+        XmlMappedEnumMember(
+            'DECIMAL', 3, 'decimal', 'Decimal-aligned.'
+        ),
+        XmlMappedEnumMember(
+            'BAR', 4, 'bar', 'Bar-aligned.'
+        ),
+        XmlMappedEnumMember(
+            'LIST', 6, 'list', 'List-aligned. (deprecated)'
+        ),
+        XmlMappedEnumMember(
+            'CLEAR', 101, 'clear', 'Clear an inherited tab stop.'
+        ),
+        XmlMappedEnumMember(
+            'END', 102, 'end', 'Right-aligned.  (deprecated)'
+        ),
+        XmlMappedEnumMember(
+            'NUM', 103, 'num', 'Left-aligned!  (deprecated)'
+        ),
+        XmlMappedEnumMember(
+            'START', 104, 'start', 'Left-aligned.  (deprecated)'
+        ),
+    )
+
+
+class WD_TAB_LEADER(XmlEnumeration):
+    """
+    Specifies the leading character for tab stops that can be applied to a
+    paragraph.
+    """
+
+    __ms_name__ = 'WdTabLeader'
+
+    __url__ = 'https://msdn.microsoft.com/en-us/library/office/ff845050.aspx'
+
+    __members__ = (
+        XmlMappedEnumMember(
+            'SPACES', 0, 'none', 'Spaces. Default.'
+        ),
+        XmlMappedEnumMember(
+            'DOTS', 1, 'dot', 'Dots.'
+        ),
+        XmlMappedEnumMember(
+            'DASHES', 2, 'hyphen', 'Dashes.'
+        ),
+        XmlMappedEnumMember(
+            'LINES', 3, 'underscore', 'Double lines.'
+        ),
+        XmlMappedEnumMember(
+            'HEAVY', 4, 'heavy', 'A heavy line.'
+        ),
+        XmlMappedEnumMember(
+            'MIDDLE_DOT', 5, 'middleDot', 'A middle dot.'
+        ),
+    )
+
+
 class WD_UNDERLINE(XmlEnumeration):
     """
     Specifies the style of underline applied to a run of characters.
diff --git a/features/steps/parfmt.py b/features/steps/parfmt.py
@@ -13,12 +13,23 @@
 from docx import Document
 from docx.enum.text import WD_ALIGN_PARAGRAPH, WD_LINE_SPACING
 from docx.shared import Pt
+from docx.oxml.text.parfmt import CT_TabStops
 
 from helpers import test_docx
 
 
 # given ===================================================
 
+@given('a paragraph having {value} tab_stop elements')
+def given_a_paragraph_having_value_tab_stop_elements(context, value):
+    tabstop_idx = {
+      'no':    0,
+      'some':  1
+    }[value]
+    document = Document(test_docx('tab-stops'))
+    context.paragraph = document.paragraphs[tabstop_idx]
+
+
 @given('a paragraph format having {prop_name} set {setting}')
 def given_a_paragraph_format_having_prop_set(context, prop_name, setting):
     style_name = {
@@ -139,6 +150,12 @@ def when_I_assign_value_to_paragraph_format_prop(context, value, prop_name):
 
 # then =====================================================
 
+@then('paragraph_format.tab_stops is a CT_TabStops object')
+def then_paragraph_format_tab_stops_is_a_ct_tabstops_object(context):
+    tab_stops = context.paragraph.paragraph_format.tab_stops
+    assert isinstance(tab_stops, CT_TabStops)
+
+
 @then('paragraph_format.alignment is {value}')
 def then_paragraph_format_alignment_is_value(context, value):
     expected_value = {
diff --git a/features/steps/test_files/tab-stops.docx b/features/steps/test_files/tab-stops.docx
diff --git a/features/txt-parfmt-props.feature b/features/txt-parfmt-props.feature
@@ -4,6 +4,17 @@ Feature: Get or set paragraph formatting properties
   I need a ParagraphFormat object with read/write formatting properties
 
 
+  @wip
+  Scenario Outline: Get tab stops object
+    Given a paragraph having <value> tab_stop elements
+     Then paragraph_format.tab_stops is a CT_TabStops object
+      
+    Examples:  values for paragraph_format.tab_stop elements 
+      | value |
+      | no    |
+      | some  |
+      
+
   Scenario Outline: Get paragraph alignment
     Given a paragraph format having <align-type> alignment
      Then paragraph_format.alignment is <value>
