openword Namespace Reference

Classes
class	AbstractNumbering
struct	BorderSettings
class	Cell
class	Chart
struct	ChartOptions
struct	ChartSeries
struct	Color
struct	CustomProperty
class	Document
	Represents the main Office Open XML Word document (.docx). More...
class	Font
class	Footer
class	Header
struct	ListLevel
struct	Margins
struct	Metadata
class	NumberingCollection
class	Paragraph
class	ParagraphFormat
class	Row
class	Run
class	SchemaValidator
class	Section
class	Style
class	StyleCollection
class	Table
	Represents a Table in the Word document. More...
class	TextBox

Typedefs
using	BlockElement = std::variant< Paragraph, Table, Section >

Enumerations
enum class	TOCLeader { Dot , Hyphen , Underscore , None }
enum class	HighlightColor {   Yellow , Green , Cyan , Magenta ,   Blue , Red , DarkBlue , DarkCyan ,   DarkGreen , DarkMagenta , DarkRed , DarkYellow ,   DarkGray , LightGray , Black , Default }
enum class	VertAlign { Baseline , Superscript , Subscript }
enum class	Orientation { Portrait , Landscape }
enum class	ListType { None , Bullet , Numbered }
enum class	HeaderFooterType { Default , First , Even }
enum class	BorderStyle {   None , Single , Dashed , Dotted ,   Double , Thick }
enum class	VerticalAlignment { Top , Center , Bottom }
enum class	HeightRule { Auto , AtLeast , Exact }
enum class	ImagePosition { Inline , BehindText , InFrontOfText }
enum class	NumberingFormat {   Decimal , LowerLetter , UpperLetter , LowerRoman ,   UpperRoman , Bullet }
	Represents a Microsoft Word Document (.docx) More...
enum class	ChartType {   Bar , Line , Pie , Area ,   Scatter }
enum class	LegendPosition {   Bottom , Top , Left , Right ,   None }
enum class	AreaGrouping { Standard , Stacked , PercentStacked }
enum class	ScatterStyle { Marker , SmoothMarker , LineMarker }

Functions
std::string	convertToMarkdown (const Document &doc)
	Converts a Word Document object to Markdown text.

Typedef Documentation

BlockElement

using openword::BlockElement = typedef std::variant<Paragraph, Table, Section>

Enumeration Type Documentation

AreaGrouping

enum class openword::AreaGrouping

strong

Enumerator
Standard
Stacked
PercentStacked

BorderStyle

enum class openword::BorderStyle

strong

Enumerator
None
Single
Dashed
Dotted
Double
Thick

ChartType

enum class openword::ChartType

strong

Enumerator
Bar
Line
Pie
Area
Scatter

HeaderFooterType

enum class openword::HeaderFooterType

strong

Enumerator
Default
First
Even

HeightRule

enum class openword::HeightRule

strong

Enumerator
Auto
AtLeast
Exact

HighlightColor

enum class openword::HighlightColor

strong

Enumerator
Yellow
Green
Cyan
Magenta
Blue
Red
DarkBlue
DarkCyan
DarkGreen
DarkMagenta
DarkRed
DarkYellow
DarkGray
LightGray
Black
Default

ImagePosition

enum class openword::ImagePosition

strong

Enumerator
Inline
BehindText
InFrontOfText

LegendPosition

enum class openword::LegendPosition

strong

Enumerator
Bottom
Top
Left
Right
None

ListType

enum class openword::ListType

strong

Enumerator
None
Bullet
Numbered

NumberingFormat

enum class openword::NumberingFormat

strong

Represents a Microsoft Word Document (.docx)

Enumerator
Decimal
LowerLetter
UpperLetter
LowerRoman
UpperRoman
Bullet

Orientation

enum class openword::Orientation

strong

Enumerator
Portrait
Landscape

ScatterStyle

enum class openword::ScatterStyle

strong

Enumerator
Marker
SmoothMarker
LineMarker

TOCLeader

enum class openword::TOCLeader

strong

Enumerator
Dot
Hyphen
Underscore
None

VertAlign

enum class openword::VertAlign

strong

Enumerator
Baseline
Superscript
Subscript

VerticalAlignment

enum class openword::VerticalAlignment

strong

Enumerator
Top
Center
Bottom

Function Documentation

convertToMarkdown()

std::string openword::convertToMarkdown

(

const Document &

doc

)

Converts a Word Document object to Markdown text.

Parameters

doc	The Document to convert.

Returns

A string containing the Markdown representation.