Art::Paperback::Document Class Reference

Classes
struct	Create_new
struct	Internal

Public Member Functions
	Document (Create_new const &, std::iostream &, int, int)
	Constructor.
	~Document ()
	Destructor.
int	major () const
	Get document major version.
int	minor () const
	Get document minor version.
void	check_minimum_version (int, int) const
	Check that the document meets minimum version requirements.
Document_information &	information ()
	Get document information.
Page &	create_page (Page::Properties const &)
	Create new page.
Carousel::File &	file ()
	Access the underlying COS file.
void	flush ()
	Flush current document state to output stream.

Static Public Attributes
static constexpr Create_new const	create_new {}
	Tag used to indicate the creation of a new document.

Private Member Functions
	Document (Document const &)=delete
	Document (Document &&)=delete
Document &	operator= (Document const &)=delete
Document &	operator= (Document &&)=delete

Private Attributes
std::unique_ptr< Internal >	internal

Constructor & Destructor Documentation

Document()

Art::Paperback::Document::Document	(	Create_new const &	,
		std::iostream &	,
		int	,
		int	)

Constructor.

~Document()

Art::Paperback::Document::~Document

(

)

Destructor.

Member Function Documentation

major()

int Art::Paperback::Document::major

(

)

const

Get document major version.

minor()

int Art::Paperback::Document::minor

(

)

const

Get document minor version.

check_minimum_version()

void Art::Paperback::Document::check_minimum_version	(	int	major,
		int	minor ) const

Check that the document meets minimum version requirements.

Parameters

major	The minimum required major version.
minor	The minimum required minor version.

Exceptions

Upgrade_required

Thrown if the document does not meet the specified version requirements.

information()

Document_information & Art::Paperback::Document::information

(

)

Get document information.

create_page()

Page & Art::Paperback::Document::create_page

(

Page::Properties const &

properties

)

Create new page.

Parameters

properties

The properties of the new page.

file()

Carousel::File & Art::Paperback::Document::file

(

)

Access the underlying COS file.

flush()

void Art::Paperback::Document::flush

(

)

Flush current document state to output stream.

Member Data Documentation

create_new

Create_new const Art::Paperback::Document::create_new {}

staticconstexpr

Tag used to indicate the creation of a new document.