Skip to content

Style Defaults

Predefined default styles used in templates.

Functions:

Name Description
default_boolean_style

Return a default boolean style.
default_currency_style

Return a default currency style (€).
default_date_style

Return a default date style (Y-M-D).
default_number_style

Return a default number style with two decimals.
default_percentage_style

Return a default percentage style with two decimals.
default_time_style

Return a default time style.

__all__ module-attribute 

__all__ = [
    "default_boolean_style",
    "default_currency_style",
    "default_date_style",
    "default_number_style",
    "default_percentage_style",
    "default_time_style",
]

default_boolean_style 

default_boolean_style() -> Style

Return a default boolean style.

Returns:

Type Description
Style

An Element representing a default boolean style.
Source code in odfdo/style_defaults.py 
41
42
43
44
45
46
47
48
49
50
51
def default_boolean_style() -> Style:
    """Return a default boolean style.

    Returns:
        An Element representing a default boolean style.
    """
    return Element.from_tag(  # type: ignore[return-value]
        '<number:boolean-style style:name="lpod-default-boolean-style">\n'
        "  <number:boolean/>\n"
        "</number:boolean-style>\n"
    )

default_currency_style 

default_currency_style() -> Style

Return a default currency style (€).

Returns:

Name Type Description
Style Style

An Element representing a default currency style configured for Euro.
Source code in odfdo/style_defaults.py 
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
def default_currency_style() -> Style:
    """Return a default currency style (€).

    Returns:
        Style: An Element representing a default currency style configured for Euro.
    """
    return Element.from_tag(  # type: ignore[return-value]
        '<number:currency-style style:name="lpod-default-currency-style">\n'
        "  <number:text>-</number:text>\n"
        '  <number:number number:decimal-places="2" '
        'number:min-integer-digits="1" number:grouping="true"/>\n'
        "  <number:text> </number:text>\n"
        '  <number:currency-symbol number:language="fr" '
        'number:country="FR">€</number:currency-symbol>\n'
        "</number:currency-style>\n"
    )

default_date_style 

default_date_style() -> Style

Return a default date style (Y-M-D).

Returns:

Name Type Description
Style Style

An Element representing a default date style formatted as Y-M-D.
Source code in odfdo/style_defaults.py 
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
def default_date_style() -> Style:
    """Return a default date style (Y-M-D).

    Returns:
        Style: An Element representing a default date style formatted as Y-M-D.
    """
    return Element.from_tag(  # type: ignore[return-value]
        '<number:date-style style:name="lpod-default-date-style">\n'
        '  <number:year number:style="long"/>\n'
        "  <number:text>-</number:text>\n"
        '  <number:month number:style="long"/>\n'
        "  <number:text>-</number:text>\n"
        '  <number:day number:style="long"/>\n'
        "</number:date-style>\n"
    )

default_number_style 

default_number_style() -> Style

Return a default number style with two decimals.

Returns:

Name Type Description
Style Style

An Element representing a default number style with two decimal places.
Source code in odfdo/style_defaults.py 
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
def default_number_style() -> Style:
    """Return a default number style with two decimals.

    Returns:
        Style: An Element representing a default number style with two decimal places.
    """
    return Element.from_tag(  # type: ignore[return-value]
        '<number:number-style style:name="lpod-default-number-style">\n'
        '  <number:number number:decimal-places="2" '
        'number:min-integer-digits="1"/>\n'
        "</number:number-style>\n"
    )

default_percentage_style 

default_percentage_style() -> Style

Return a default percentage style with two decimals.

Returns:

Name Type Description
Style Style

An Element representing a default percentage style with two decimal places.
Source code in odfdo/style_defaults.py 
103
104
105
106
107
108
109
110
111
112
113
114
def default_percentage_style() -> Style:
    """Return a default percentage style with two decimals.

    Returns:
        Style: An Element representing a default percentage style with two decimal places.
    """
    return Element.from_tag(  # type: ignore[return-value]
        '<number:percentage-style style:name="lpod-default-percentage-style">\n'
        '  <number:number number:decimal-places="2" number:min-integer-digits="1"/>\n'
        "  <number:text>%</number:text>\n"
        "</number:percentage-style>\n"
    )

default_time_style 

default_time_style() -> Style

Return a default time style.

Returns:

Type Description
Style

An Element representing a default time style.
Source code in odfdo/style_defaults.py 
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
def default_time_style() -> Style:
    """Return a default time style.

    Returns:
        An Element representing a default time style.
    """
    return Element.from_tag(  # type: ignore[return-value]
        '<number:time-style style:name="lpod-default-time-style">\n'
        '  <number:hours number:style="long"/>\n'
        "  <number:text>:</number:text>\n"
        '  <number:minutes number:style="long"/>\n'
        "  <number:text>:</number:text>\n"
        '  <number:seconds number:style="long"/>\n'
        "</number:time-style>\n"
    )