parfmt: add ParagraphFormat.keep_with_next getter

Steve Canny · Steve Canny · commit 8ed7151dc092 · 2015-02-08T00:01:44.000-08:00
diff --git a/docx/oxml/__init__.py b/docx/oxml/__init__.py
@@ -140,6 +140,7 @@ def OxmlElement(nsptag_str, attrs=None, nsdecls=None):
 register_element_cls('w:ind',             CT_Ind)
 register_element_cls('w:jc',              CT_Jc)
 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:pPr',             CT_PPr)
 register_element_cls('w:pStyle',          CT_String)
diff --git a/docx/oxml/text/paragraph.py b/docx/oxml/text/paragraph.py
@@ -117,6 +117,7 @@ class CT_PPr(BaseOxmlElement):
         'w:rPr', 'w:sectPr', 'w:pPrChange'
     )
     pStyle = ZeroOrOne('w:pStyle', successors=_tag_seq[1:])
+    keepNext = ZeroOrOne('w:keepNext', successors=_tag_seq[2:])
     keepLines = ZeroOrOne('w:keepLines', successors=_tag_seq[3:])
     numPr = ZeroOrOne('w:numPr', successors=_tag_seq[7:])
     spacing = ZeroOrOne('w:spacing', successors=_tag_seq[22:])
@@ -217,6 +218,16 @@ def keepLines_val(self):
             return None
         return keepLines.val
 
+    @property
+    def keepNext_val(self):
+        """
+        The value of `keepNext/@val` or |None| if not present.
+        """
+        keepNext = self.keepNext
+        if keepNext is None:
+            return None
+        return keepNext.val
+
     @property
     def spacing_after(self):
         """
diff --git a/docx/text/paragraph.py b/docx/text/paragraph.py
@@ -189,6 +189,20 @@ def keep_together(self):
             return None
         return pPr.keepLines_val
 
+    @property
+    def keep_with_next(self):
+        """
+        |True| if the paragraph should be kept on the same page as the
+        subsequent paragraph when the document is rendered. For example, this
+        property could be used to keep a section heading on the same page as
+        its first paragraph. |None| indicates its effective value is
+        inherited from the style hierarchy.
+        """
+        pPr = self._element.pPr
+        if pPr is None:
+            return None
+        return pPr.keepNext_val
+
     @property
     def left_indent(self):
         """
diff --git a/tests/text/test_paragraph.py b/tests/text/test_paragraph.py
@@ -531,6 +531,9 @@ def line_spacing_rule_set_fixture(self, request):
         ('w:p',                                  'keep_together',     None),
         ('w:p/w:pPr/w:keepLines{w:val=on}',      'keep_together',     True),
         ('w:p/w:pPr/w:keepLines{w:val=0}',       'keep_together',     False),
+        ('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),
     ])
     def on_off_get_fixture(self, request):
         p_cxml, prop_name, expected_value = request.param
