ooodev.format.writer.style package

Subpackages

ooodev.format.writer.style.bullet_list package
- Submodules
  - ooodev.format.writer.style.bullet_list.bullet_list module
    - BulletList
- Module contents
ooodev.format.writer.style.char package
ooodev.format.writer.style.frame package
- Submodules
  - ooodev.format.writer.style.frame.frame module
    - Frame
  - ooodev.format.writer.style.frame.style_frame_kind module
    - StyleFrameKind
- Module contents
  - Frame
ooodev.format.writer.style.lst package
- Submodules
  - ooodev.format.writer.style.lst.style_list_kind module
    - StyleListKind
- Module contents
ooodev.format.writer.style.page package
ooodev.format.writer.style.para package

Submodules

ooodev.format.writer.style.family_names_kind module
- FamilyNamesKind

Module contents

class ooodev.format.writer.style.BulletList(name='')[source]

Bases: StyleName

Style List. Manages List styles for Writer.

Any properties starting with prop_ set or get current instance values.

All methods starting with fmt_ can be used to chain together Border Table properties.

See also

Write Style BulletList Class

New in version 0.9.0.

__init__(name='')[source]

Constructor

Parameters:: name (Any) – Style Name.
Raises:: ValueError – If Name is None or empty string.
Return type:: None

See also

Write Style BulletList Class

default = <ooodev.format.writer.style.bullet_list.bullet_list.BulletList object>[source]

property list_01: BulletList

Gets List style 01 (Bullet •)

Return type:: BulletList

property list_02: BulletList

Gets List style 01 (Dash –)

Return type:: BulletList

property list_03: BulletList

Gets List style 03 (🗹 [checkbox like])

Return type:: BulletList

property list_04: BulletList

Gets List style 0 (triangle like)

Return type:: BulletList

property list_05: BulletList

Gets List style 05 (Bullet ꭗ)

Return type:: BulletList

property none: BulletList

Gets Style that is set to no list style

Return type:: BulletList

property num_123: BulletList

Gets List style Numbering 123

Return type:: BulletList

property num_ABC: BulletList

Gets List style Numbering ABC (upper case)

Return type:: BulletList

property num_IVX: BulletList

Gets List style Numbering IVX (upper case)

Return type:: BulletList

property num_abc: BulletList

Gets List style Numbering abc (lower case)

Return type:: BulletList

property num_ivx: BulletList

Gets List style Numbering ivx (lower case)

Return type:: BulletList

property prop_format_kind: FormatKind

Gets the kind of style

Return type:: FormatKind

property prop_name: str

Gets/Sets Character style name

Return type:: str

class ooodev.format.writer.style.Char(name='')[source]

Bases: StyleName

Characters Style.

Any properties starting with prop_ set or get current instance values.

All methods starting with fmt_ can be used to chain together Border Table properties.

See also

Write Style Char Class

New in version 0.9.0.

__init__(name='')[source]

Constructor

Parameters:: name (StyleCharKind, str, optional) – Style Name. Defaults to “Standard”.
Return type:: None

See also

Write Style Char Class

on_property_setting(source, event_args)[source]

Triggers for each property that is set

Parameters:

event_args (KeyValueCancelArgs) – Event Args
source (Any) –

property bullet_symbols: Char

Style Bullet Symbols

Return type:: Char

property caption_characters: Char

Style Caption characters

Return type:: Char

property citation: Char

Style Citation

Return type:: Char

default = <ooodev.format.writer.style.char.char.Char object>[source]

property definition: Char

Style Definition

Return type:: Char

property drop_caps: Char

Style Drop Caps

Return type:: Char

property emphasis: Char

Style Emphasis

Return type:: Char

property endnote_anchor: Char

Style Endnote anchor

Return type:: Char

property endnote_symbol: Char

Style Endnote Symbol

Return type:: Char

property example: Char

Style Example

Return type:: Char

property footnote_anchor: Char

Style Footnote anchor

Return type:: Char

property footnote_symbol: Char

Style Footnote Symbol

Return type:: Char

property index_link: Char

Style Index Link

Return type:: Char

property internet_link: Char

Style Internet link

Return type:: Char

property line_numbering: Char

Style Line numbering

Return type:: Char

property main_index_entry: Char

Style Main index entry

Return type:: Char

property numbering_symbols: Char

Style Numbering Symbols

Return type:: Char

property page_number: Char

Style Page Number

Return type:: Char

property placeholder: Char

Style Placeholder

Return type:: Char

property prop_format_kind: FormatKind

Gets the kind of style

Return type:: FormatKind

property quotation: Char

Style Citation

Return type:: Char

property rubies: Char

Style Rubies

Return type:: Char

property source_text: Char

Style Source Text

Return type:: Char

property standard: Char

Removes styling

Return type:: Char

property strong_emphasis: Char

Style Strong Emphasis

Return type:: Char

property teletype: Char

Style Teletype

Return type:: Char

property user_entry: Char

Style User Entry

Return type:: Char

property variable: Char

Style Variable

Return type:: Char

property vertical_numbering_symbols: Char

Style Vertical Numbering Symbols

Return type:: Char

property visited_internet_link: Char

Style Visited Internet Link

Return type:: Char

class ooodev.format.writer.style.FamilyNamesKind(value)[source]

Bases: Enum

Style Look ups for Write Families Styles

CELL_STYLES = 'CellStyles'

CHARACTER_STYLES = 'CharacterStyles'

FRAME_STYLES = 'FrameStyles'

NUMBERING_STYLES = 'NumberingStyles'

PAGE_STYLES = 'PageStyles'

PARAGRAPH_STYLES = 'ParagraphStyles'

TABLE_STYLES = 'TableStyles'

class ooodev.format.writer.style.Frame(name='')[source]

Bases: StyleName

Frame Style.

Any properties starting with prop_ set or get current instance values.

All methods starting with fmt_ can be used to chain together Border Table properties.

See also

Write Style Frame Class

New in version 0.9.0.

__init__(name='')[source]

Constructor

Parameters:: name (StyleFrameKind, str, optional) – Style Name. Defaults to “Frame”.
Return type:: None

See also

Write Style Frame Class

on_property_setting(source, event_args)[source]

Triggers for each property that is set

Parameters:

event_args (KeyValueCancelArgs) – Event Args
source (Any) –

property OLE: Frame

Style OLE

Return type:: Frame

default = <ooodev.format.writer.style.frame.frame.Frame object>[source]

property formula: Frame

Style Formula

Return type:: Frame

property frame: Frame

Style Frame

Return type:: Frame

property graphics: Frame

Style graphics

Return type:: Frame

property labels: Frame

Style Labels

Return type:: Frame

property marginalia: Frame

Style Marginalia

Return type:: Frame

property prop_format_kind: FormatKind

Gets the kind of style

Return type:: FormatKind

property watermark: Frame

Style Watermark

Return type:: Frame

class ooodev.format.writer.style.Page(name='')[source]

Bases: StyleName

Page Style.

See also

Write Style Page Class

New in version 0.9.0.

__init__(name='')[source]

Constructor

Parameters:: name (StyleParaKind, str, optional) – Specifies the Page Style that instance applies to.
Return type:: None

See also

Write Style Page Class

copy()[source]

copy(**kwargs)

Gets a copy of instance as a new instance

Return type:: Page

classmethod from_obj(obj)[source]

classmethod from_obj(obj, **kwargs)

Gets instance from object

Parameters:: obj (Any) – UNO object.
Raises:: NotSupportedError – If obj is not supported.
Returns:: Page instance that represents obj style.
Return type:: Page

on_property_setting(source, event_args)[source]

Triggers for each property that is set

Parameters:

event_args (KeyValueCancelArgs) – Event Args
source (Any) –

default = <ooodev.format.writer.style.page.page.Page object>[source]

property prop_format_kind: FormatKind

Gets the kind of style

Return type:: FormatKind

class ooodev.format.writer.style.Para(name='')[source]

Bases: StyleName

Style Paragraph. Manages Paragraph styles for Writer.

Any properties starting with prop_ set or get current instance values.

All methods starting with fmt_ can be used to chain together Border Table properties.

See also

Write Style Para Class

New in version 0.9.0.

__init__(name='')[source]

Constructor

Parameters:: name (StyleCharKind, str, optional) – Style Name. Defaults to “Standard”.
Return type:: None

See also

Write Style Para Class

on_property_setting(source, event_args)[source]

Triggers for each property that is set

Parameters:

event_args (KeyValueCancelArgs) – Event Args
source (Any) –

property addressee: Para

Style Addressee

Return type:: Para

property complimentary_close: Para

Style Complimentary Close

Return type:: Para

default = <ooodev.format.writer.style.para.para.Para object>[source]

property endnote: Para

Style Endnote

Return type:: Para

property footer: Para

Style Footer

Return type:: Para

property footer_left: Para

Style Footer Left

Return type:: Para

property footer_right: Para

Style Footer Right

Return type:: Para

property footnote: Para

Style Footnote

Return type:: Para

property frame_contents: Para

Style Frame Contents

Return type:: Para

property h1: Para

Style Heading 1

Return type:: Para

property h10: Para

Style Heading 10

Return type:: Para

property h2: Para

Style Heading 2

Return type:: Para

property h3: Para

Style Heading 3

Return type:: Para

property h4: Para

Style Heading 4

Return type:: Para

property h5: Para

Style Heading 5

Return type:: Para

property h6: Para

Style Heading 6

Return type:: Para

property h7: Para

Style Heading 7

Return type:: Para

property h8: Para

Style Heading 8

Return type:: Para

property h9: Para

Style Heading 9

Return type:: Para

property header: Para

Style Header

Return type:: Para

property header_footer: Para

Style Header Footer

Return type:: Para

property header_left: Para

Style Header Left

Return type:: Para

property header_right: Para

Style Header Right

Return type:: Para

property heading: Para

Style Heading

Return type:: Para

property horizontal_line: Para

Style Horizontal Line

Return type:: Para

property idx: Para

Style Index

Return type:: Para

property idx_1: Para

Style Index 1

Return type:: Para

property idx_2: Para

Style Index 2

Return type:: Para

property idx_3: Para

Style Index 3

Return type:: Para

property idx_bib1: Para

Style Bibliography 1

Return type:: Para

property idx_c1: Para

Style Contents 1

Return type:: Para

property idx_c10: Para

Style Contents 10

Return type:: Para

property idx_c2: Para

Style Contents 2

Return type:: Para

property idx_c3: Para

Style Contents 3

Return type:: Para

property idx_c4: Para

Style Contents 4

Return type:: Para

property idx_c5: Para

Style Contents 5

Return type:: Para

property idx_c6: Para

Style Contents 6

Return type:: Para

property idx_c7: Para

Style Contents 7

Return type:: Para

property idx_c8: Para

Style Contents 8

Return type:: Para

property idx_c9: Para

Style Contents 9

Return type:: Para

property idx_obj1: Para

Style Object Index 1

Return type:: Para

property idx_separator: Para

Style Index Separator

Return type:: Para

property idx_tbl1: Para

Style Table Index 1

Return type:: Para

property idx_user1: Para

Style User Index 1

Return type:: Para

property idx_user10: Para

Style User Index 10

Return type:: Para

property idx_user2: Para

Style User Index 2

Return type:: Para

property idx_user3: Para

Style User Index 3

Return type:: Para

property idx_user4: Para

Style User Index 4

Return type:: Para

property idx_user5: Para

Style User Index 5

Return type:: Para

property idx_user6: Para

Style User Index 6

Return type:: Para

property idx_user7: Para

Style User Index 7

Return type:: Para

property idx_user8: Para

Style User Index 8

Return type:: Para

property idx_user9: Para

Style User Index 9

Return type:: Para

property list_contents: Para

Style List Contents

Return type:: Para

property list_heading: Para

Style List Heading

Return type:: Para

property pre_text: Para

Style Preformatted text

Return type:: Para

property prop_format_kind: FormatKind

Gets the kind of style

Return type:: FormatKind

property quotations: Para

Style Quotations

Return type:: Para

property salutation: Para

Style Salutation

Return type:: Para

property sender: Para

Style Sender

Return type:: Para

property signature: Para

Style Signature

Return type:: Para

property tbl_contents: Para

Style Table Contents

Return type:: Para

property tbl_heading: Para

Style Table Heading

Return type:: Para

property txt_body: Para

Style Text Body

Return type:: Para

property txt_body_indent: Para

Style Text Body Indent

Return type:: Para

property txt_first_line_indent: Para

Style First Line Indent

Return type:: Para

property txt_hanging_indent: Para

Style Hanging Indent

Return type:: Para

property txt_list_indent: Para

Style List Indent

Return type:: Para

property txt_marginalia: Para

Style Marginalia

Return type:: Para