Skip to content

Commit d7e5c9b

Browse files
author
Steve Canny
committed
docs: document analysis for Font.color
1 parent 1d4f9bc commit d7e5c9b

File tree

7 files changed

+511
-0
lines changed

7 files changed

+511
-0
lines changed

‎docs/api/enum/MsoColorType.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
.. _MsoColorType:
2+
3+
``MSO_COLOR_TYPE``
4+
==================
5+
6+
Specifies the color specification scheme
7+
8+
Example::
9+
10+
from docx.enum.dml import MSO_COLOR_TYPE
11+
12+
assert font.color.type == MSO_COLOR_TYPE.THEME
13+
14+
----
15+
16+
RGB
17+
Color is specified by an |RGBColor| value.
18+
19+
THEME
20+
Color is one of the preset theme colors.
21+
22+
AUTO
23+
Color is determined automatically be the application.

‎docs/api/enum/MsoThemeColorIndex.rst

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
.. _MsoThemeColorIndex:
2+
3+
``MSO_THEME_COLOR_INDEX``
4+
=========================
5+
6+
Indicates the Office theme color, one of those shown in the color gallery on
7+
the formatting ribbon.
8+
9+
Alias: ``MSO_THEME_COLOR``
10+
11+
Example::
12+
13+
from docx.enum.dml import MSO_THEME_COLOR
14+
15+
font.color.theme_color = MSO_THEME_COLOR.ACCENT_1
16+
17+
----
18+
19+
NOT_THEME_COLOR
20+
Indicates the color is not a theme color.
21+
22+
ACCENT_1
23+
Specifies the Accent 1 theme color.
24+
25+
ACCENT_2
26+
Specifies the Accent 2 theme color.
27+
28+
ACCENT_3
29+
Specifies the Accent 3 theme color.
30+
31+
ACCENT_4
32+
Specifies the Accent 4 theme color.
33+
34+
ACCENT_5
35+
Specifies the Accent 5 theme color.
36+
37+
ACCENT_6
38+
Specifies the Accent 6 theme color.
39+
40+
BACKGROUND_1
41+
Specifies the Background 1 theme color.
42+
43+
BACKGROUND_2
44+
Specifies the Background 2 theme color.
45+
46+
DARK_1
47+
Specifies the Dark 1 theme color.
48+
49+
DARK_2
50+
Specifies the Dark 2 theme color.
51+
52+
FOLLOWED_HYPERLINK
53+
Specifies the theme color for a clicked hyperlink.
54+
55+
HYPERLINK
56+
Specifies the theme color for a hyperlink.
57+
58+
LIGHT_1
59+
Specifies the Light 1 theme color.
60+
61+
LIGHT_2
62+
Specifies the Light 2 theme color.
63+
64+
TEXT_1
65+
Specifies the Text 1 theme color.
66+
67+
TEXT_2
68+
Specifies the Text 2 theme color.
69+
70+
MIXED
71+
Indicates multiple theme colors are used.

‎docs/api/enum/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ can be found here:
88
.. toctree::
99
:titlesonly:
1010

11+
MsoColorType
12+
MsoThemeColorIndex
1113
WdAlignParagraph
1214
WdBuiltinStyle
1315
WdLineSpacing

‎docs/conf.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,8 @@
141141
142142
.. |Relationships| replace:: :class:`._Relationships`
143143
144+
.. |RGBColor| replace:: :class:`.RGBColor`
145+
144146
.. |_Row| replace:: :class:`._Row`
145147
146148
.. |_Rows| replace:: :class:`._Rows`

0 commit comments

Comments
 (0)