OpenSiv3D  v0.6.5
C++20 framework for creative coding
s3d::HTMLWriter Class Reference

HTML 文書の書き出し More...

#include <HTMLWriter.hpp>

Public Member Functions

SIV3D_NODISCARD_CXX20 HTMLWriter ()
 
SIV3D_NODISCARD_CXX20 HTMLWriter (FilePathView path, StringView title=U"Untitled", StringView styleSheet=DefaultStyle())
 
 ~HTMLWriter ()
 
bool open (FilePathView path, StringView title=U"Untitled", StringView styleSheet=DefaultStyle())
 
void close ()
 
bool isOpen () const noexcept
 
 operator bool () const noexcept
 
void writeRaw (StringView s)
 
void writeParagraph (StringView s, const Color &color=Palette::Black)
 
void writeHeader (StringView s, int32 level=1)
 
void writeList (const Array< String > &items)
 
void writeOrderedList (const Array< String > &items)
 
void writeTable (const Grid< String > &items, HasHeader hasHeader=HasHeader::No)
 
void writeLine (int32 thickness=2, const Color &color=Color(223, 226, 229))
 
void writeImage (const Image &image, const Optional< Size > &size=unspecified)
 
void writeImage (FilePathView url, const Optional< Size > &size=unspecified)
 
const FilePathpath () const
 

Static Public Member Functions

static String DefaultStyle ()
 

Detailed Description

HTML 文書の書き出し

Constructor & Destructor Documentation

◆ HTMLWriter() [1/2]

SIV3D_NODISCARD_CXX20 s3d::HTMLWriter::HTMLWriter ( )

◆ HTMLWriter() [2/2]

SIV3D_NODISCARD_CXX20 s3d::HTMLWriter::HTMLWriter ( FilePathView  path,
StringView  title = U"Untitled",
StringView  styleSheet = DefaultStyle() 
)

◆ ~HTMLWriter()

s3d::HTMLWriter::~HTMLWriter ( )

Member Function Documentation

◆ close()

void s3d::HTMLWriter::close ( )

◆ DefaultStyle()

static String s3d::HTMLWriter::DefaultStyle ( )
static

◆ isOpen()

bool s3d::HTMLWriter::isOpen ( ) const
noexcept

◆ open()

bool s3d::HTMLWriter::open ( FilePathView  path,
StringView  title = U"Untitled",
StringView  styleSheet = DefaultStyle() 
)

◆ operator bool()

s3d::HTMLWriter::operator bool ( ) const
explicitnoexcept

◆ path()

const FilePath& s3d::HTMLWriter::path ( ) const

◆ writeHeader()

void s3d::HTMLWriter::writeHeader ( StringView  s,
int32  level = 1 
)

◆ writeImage() [1/2]

void s3d::HTMLWriter::writeImage ( const Image image,
const Optional< Size > &  size = unspecified 
)

◆ writeImage() [2/2]

void s3d::HTMLWriter::writeImage ( FilePathView  url,
const Optional< Size > &  size = unspecified 
)

◆ writeLine()

void s3d::HTMLWriter::writeLine ( int32  thickness = 2,
const Color color = Color(223, 226, 229) 
)

◆ writeList()

void s3d::HTMLWriter::writeList ( const Array< String > &  items)

◆ writeOrderedList()

void s3d::HTMLWriter::writeOrderedList ( const Array< String > &  items)

◆ writeParagraph()

void s3d::HTMLWriter::writeParagraph ( StringView  s,
const Color color = Palette::Black 
)

◆ writeRaw()

void s3d::HTMLWriter::writeRaw ( StringView  s)

◆ writeTable()

void s3d::HTMLWriter::writeTable ( const Grid< String > &  items,
HasHeader  hasHeader = HasHeader::No 
)

The documentation for this class was generated from the following file: