parfmt: add ParaFormat.page_break_before getter

Steve Canny · Steve Canny · commit 8f836d4f9b55 · 2015-02-08T00:01:44.000-08:00
diff --git a/docx/oxml/__init__.py b/docx/oxml/__init__.py
@@ -142,6 +142,7 @@ def OxmlElement(nsptag_str, attrs=None, nsdecls=None):
 register_element_cls('w:keepLines',       CT_OnOff)
 register_element_cls('w:keepNext',        CT_OnOff)
 register_element_cls('w:p',               CT_P)
+register_element_cls('w:pageBreakBefore', CT_OnOff)
 register_element_cls('w:pPr',             CT_PPr)
 register_element_cls('w:pStyle',          CT_String)
 register_element_cls('w:spacing',         CT_Spacing)
diff --git a/docx/oxml/text/paragraph.py b/docx/oxml/text/paragraph.py
@@ -119,6 +119,7 @@ class CT_PPr(BaseOxmlElement):
     pStyle = ZeroOrOne('w:pStyle', successors=_tag_seq[1:])
     keepNext = ZeroOrOne('w:keepNext', successors=_tag_seq[2:])
     keepLines = ZeroOrOne('w:keepLines', successors=_tag_seq[3:])
+    pageBreakBefore = ZeroOrOne('w:pageBreakBefore', successors=_tag_seq[4:])
     numPr = ZeroOrOne('w:numPr', successors=_tag_seq[7:])
     spacing = ZeroOrOne('w:spacing', successors=_tag_seq[22:])
     ind = ZeroOrOne('w:ind', successors=_tag_seq[23:])
@@ -228,6 +229,16 @@ def keepNext_val(self):
             return None
         return keepNext.val
 
+    @property
+    def pageBreakBefore_val(self):
+        """
+        The value of `pageBreakBefore/@val` or |None| if not present.
+        """
+        pageBreakBefore = self.pageBreakBefore
+        if pageBreakBefore is None:
+            return None
+        return pageBreakBefore.val
+
     @property
     def spacing_after(self):
         """
diff --git a/docx/text/paragraph.py b/docx/text/paragraph.py
@@ -283,6 +283,18 @@ def line_spacing_rule(self, value):
         else:
             pPr.spacing_lineRule = value
 
+    @property
+    def page_break_before(self):
+        """
+        |True| if the paragraph should appear at the top of the page
+        following the prior paragraph. |None| indicates its effective value
+        is inherited from the style hierarchy.
+        """
+        pPr = self._element.pPr
+        if pPr is None:
+            return None
+        return pPr.pageBreakBefore_val
+
     @property
     def right_indent(self):
         """
diff --git a/tests/text/test_paragraph.py b/tests/text/test_paragraph.py
@@ -534,6 +534,9 @@ def line_spacing_rule_set_fixture(self, request):
         ('w:p',                                  'keep_with_next',    None),
         ('w:p/w:pPr/w:keepNext{w:val=1}',        'keep_with_next',    True),
         ('w:p/w:pPr/w:keepNext{w:val=false}',    'keep_with_next',    False),
+        ('w:p',                                  'page_break_before', None),
+        ('w:p/w:pPr/w:pageBreakBefore',          'page_break_before', True),
+        ('w:p/w:pPr/w:pageBreakBefore{w:val=0}', 'page_break_before', False),
     ])
     def on_off_get_fixture(self, request):
         p_cxml, prop_name, expected_value = request.param
