font: add Font boolean properties

Steve Canny · Steve Canny · commit a618e0abc872 · 2015-02-08T00:01:41.000-08:00
Transplanted essentially intact from Run.
diff --git a/docx/oxml/text/run.py b/docx/oxml/text/run.py
@@ -131,12 +131,12 @@ def underline(self):
         rPr = self.rPr
         if rPr is None:
             return None
-        return rPr.underline
+        return rPr.u_val
 
     @underline.setter
     def underline(self, value):
         rPr = self.get_or_add_rPr()
-        rPr.underline = value
+        rPr.u_val = value
 
 
 class CT_RPr(BaseOxmlElement):
@@ -275,23 +275,22 @@ def u_val(self, value):
         if value is not None:
             self._add_u().val = value
 
-    @property
-    def underline(self):
+    def _get_bool_val(self, name):
         """
-        Underline type specified in <w:u> child, or None if that element is
-        not present.
+        Return the value of the boolean child element having *name*, e.g.
+        'b', 'i', and 'smallCaps'.
         """
-        u = self.u
-        if u is None:
+        element = getattr(self, name)
+        if element is None:
             return None
-        return u.val
+        return element.val
 
-    @underline.setter
-    def underline(self, value):
-        self._remove_u()
-        if value is not None:
-            u = self._add_u()
-            u.val = value
+    def _set_bool_val(self, name, value):
+        if value is None:
+            getattr(self, '_remove_%s' % name)()
+            return
+        element = getattr(self, 'get_or_add_%s' % name)()
+        element.val = value
 
 
 class CT_Text(BaseOxmlElement):
diff --git a/docx/text/run.py b/docx/text/run.py
@@ -381,6 +381,139 @@ class Font(ElementProxy):
 
     __slots__ = ()
 
+    @property
+    def all_caps(self):
+        """
+        Read/write. Causes text in this font to appear in capital letters.
+        """
+        return self._get_bool_prop('caps')
+
+    @all_caps.setter
+    def all_caps(self, value):
+        self._set_bool_prop('caps', value)
+
+    @property
+    def bold(self):
+        """
+        Read/write. Causes text in this font to appear in bold.
+        """
+        return self._get_bool_prop('b')
+
+    @bold.setter
+    def bold(self, value):
+        self._set_bool_prop('b', value)
+
+    @property
+    def complex_script(self):
+        """
+        Read/write tri-state value. When |True|, causes the characters in the
+        run to be treated as complex script regardless of their Unicode
+        values.
+        """
+        return self._get_bool_prop('cs')
+
+    @complex_script.setter
+    def complex_script(self, value):
+        self._set_bool_prop('cs', value)
+
+    @property
+    def cs_bold(self):
+        """
+        Read/write tri-state value. When |True|, causes the complex script
+        characters in the run to be displayed in bold typeface.
+        """
+        return self._get_bool_prop('bCs')
+
+    @cs_bold.setter
+    def cs_bold(self, value):
+        self._set_bool_prop('bCs', value)
+
+    @property
+    def cs_italic(self):
+        """
+        Read/write tri-state value. When |True|, causes the complex script
+        characters in the run to be displayed in italic typeface.
+        """
+        return self._get_bool_prop('iCs')
+
+    @cs_italic.setter
+    def cs_italic(self, value):
+        self._set_bool_prop('iCs', value)
+
+    @property
+    def double_strike(self):
+        """
+        Read/write tri-state value. When |True|, causes the text in the run
+        to appear with double strikethrough.
+        """
+        return self._get_bool_prop('dstrike')
+
+    @double_strike.setter
+    def double_strike(self, value):
+        self._set_bool_prop('dstrike', value)
+
+    @property
+    def emboss(self):
+        """
+        Read/write tri-state value. When |True|, causes the text in the run
+        to appear as if raised off the page in relief.
+        """
+        return self._get_bool_prop('emboss')
+
+    @emboss.setter
+    def emboss(self, value):
+        self._set_bool_prop('emboss', value)
+
+    @property
+    def hidden(self):
+        """
+        Read/write tri-state value. When |True|, causes the text in the run
+        to be hidden from display, unless applications settings force hidden
+        text to be shown.
+        """
+        return self._get_bool_prop('vanish')
+
+    @hidden.setter
+    def hidden(self, value):
+        self._set_bool_prop('vanish', value)
+
+    @property
+    def italic(self):
+        """
+        Read/write tri-state value. When |True|, causes the text of the run
+        to appear in italics. |None| indicates the effective value is
+        inherited from the style hierarchy.
+        """
+        return self._get_bool_prop('i')
+
+    @italic.setter
+    def italic(self, value):
+        self._set_bool_prop('i', value)
+
+    @property
+    def imprint(self):
+        """
+        Read/write tri-state value. When |True|, causes the text in the run
+        to appear as if pressed into the page.
+        """
+        return self._get_bool_prop('imprint')
+
+    @imprint.setter
+    def imprint(self, value):
+        self._set_bool_prop('imprint', value)
+
+    @property
+    def math(self):
+        """
+        Read/write tri-state value. When |True|, specifies this run contains
+        WML that should be handled as though it was Office Open XML Math.
+        """
+        return self._get_bool_prop('oMath')
+
+    @math.setter
+    def math(self, value):
+        self._set_bool_prop('oMath', value)
+
     @property
     def name(self):
         """
@@ -400,6 +533,56 @@ def name(self, value):
         rPr.rFonts_ascii = value
         rPr.rFonts_hAnsi = value
 
+    @property
+    def no_proof(self):
+        """
+        Read/write tri-state value. When |True|, specifies that the contents
+        of this run should not report any errors when the document is scanned
+        for spelling and grammar.
+        """
+        return self._get_bool_prop('noProof')
+
+    @no_proof.setter
+    def no_proof(self, value):
+        self._set_bool_prop('noProof', value)
+
+    @property
+    def outline(self):
+        """
+        Read/write tri-state value. When |True| causes the characters in the
+        run to appear as if they have an outline, by drawing a one pixel wide
+        border around the inside and outside borders of each character glyph.
+        """
+        return self._get_bool_prop('outline')
+
+    @outline.setter
+    def outline(self, value):
+        self._set_bool_prop('outline', value)
+
+    @property
+    def rtl(self):
+        """
+        Read/write tri-state value. When |True| causes the text in the run
+        to have right-to-left characteristics.
+        """
+        return self._get_bool_prop('rtl')
+
+    @rtl.setter
+    def rtl(self, value):
+        self._set_bool_prop('rtl', value)
+
+    @property
+    def shadow(self):
+        """
+        Read/write tri-state value. When |True| causes the text in the run
+        to appear as if each character has a shadow.
+        """
+        return self._get_bool_prop('shadow')
+
+    @shadow.setter
+    def shadow(self, value):
+        self._set_bool_prop('shadow', value)
+
     @property
     def size(self):
         """
@@ -426,6 +609,60 @@ def size(self, emu):
         rPr = self._element.get_or_add_rPr()
         rPr.sz_val = emu
 
+    @property
+    def small_caps(self):
+        """
+        Read/write tri-state value. When |True| causes the lowercase
+        characters in the run to appear as capital letters two points smaller
+        than the font size specified for the run.
+        """
+        return self._get_bool_prop('smallCaps')
+
+    @small_caps.setter
+    def small_caps(self, value):
+        self._set_bool_prop('smallCaps', value)
+
+    @property
+    def snap_to_grid(self):
+        """
+        Read/write tri-state value. When |True| causes the run to use the
+        document grid characters per line settings defined in the docGrid
+        element when laying out the characters in this run.
+        """
+        return self._get_bool_prop('snapToGrid')
+
+    @snap_to_grid.setter
+    def snap_to_grid(self, value):
+        self._set_bool_prop('snapToGrid', value)
+
+    @property
+    def spec_vanish(self):
+        """
+        Read/write tri-state value. When |True|, specifies that the given run
+        shall always behave as if it is hidden, even when hidden text is
+        being displayed in the current document. The property has a very
+        narrow, specialized use related to the table of contents. Consult the
+        spec (§17.3.2.36) for more details.
+        """
+        return self._get_bool_prop('specVanish')
+
+    @spec_vanish.setter
+    def spec_vanish(self, value):
+        self._set_bool_prop('specVanish', value)
+
+    @property
+    def strike(self):
+        """
+        Read/write tri-state value. When |True| causes the text in the run
+        to appear with a single horizontal line through the center of the
+        line.
+        """
+        return self._get_bool_prop('strike')
+
+    @strike.setter
+    def strike(self, value):
+        self._set_bool_prop('strike', value)
+
     @property
     def underline(self):
         """
@@ -446,6 +683,35 @@ def underline(self, value):
         rPr = self._element.get_or_add_rPr()
         rPr.u_val = value
 
+    @property
+    def web_hidden(self):
+        """
+        Read/write tri-state value. When |True|, specifies that the contents
+        of this run shall be hidden when the document is displayed in web
+        page view.
+        """
+        return self._get_bool_prop('webHidden')
+
+    @web_hidden.setter
+    def web_hidden(self, value):
+        self._set_bool_prop('webHidden', value)
+
+    def _get_bool_prop(self, name):
+        """
+        Return the value of boolean child of `w:rPr` having *name*.
+        """
+        rPr = self._element.rPr
+        if rPr is None:
+            return None
+        return rPr._get_bool_val(name)
+
+    def _set_bool_prop(self, name, value):
+        """
+        Assign *value* to the boolean child *name* of `w:rPr`.
+        """
+        rPr = self._element.get_or_add_rPr()
+        rPr._set_bool_val(name, value)
+
 
 class _Text(object):
     """
diff --git a/tests/text/test_run.py b/tests/text/test_run.py
