A library for working with phylogenetic and population genetic data.
v0.32.0
SvgDocument Class Reference

#include <genesis/utils/formats/svg/document.hpp>

Detailed Description

Definition at line 50 of file svg/document.hpp.

Public Member Functions

 SvgDocument ()=default
 
 SvgDocument (SvgDocument &&)=default
 
 SvgDocument (SvgDocument const &)=default
 
 ~SvgDocument ()=default
 
self_typeadd (SvgObject &&object)
 
self_typeadd (SvgObject const &object)
 Add an SvgObject to the document. More...
 
SvgBox bounding_box () const
 
self_typeoperator<< (SvgObject &&object)
 
self_typeoperator<< (SvgObject const &object)
 Shortcut operator for add(), which allows an even more fluent interface. More...
 
SvgDocumentoperator= (SvgDocument &&)=default
 
SvgDocumentoperator= (SvgDocument const &)=default
 
void write (std::ostream &out) const
 Write the SvgDocument to an output stream. More...
 
void write (std::shared_ptr< utils::BaseOutputTarget > target) const
 

Public Types

enum  Overflow {
  kNone, kVisible, kHidden, kScroll,
  kAuto, kInherit
}
 
using self_type = SvgDocument
 

Public Attributes

Color background_color = Color( 1.0, 1.0, 1.0, 1.0 )
 
std::vector< SvgDefinitionsdefs
 
SvgMargin margin
 
Overflow overflow = Overflow::kNone
 

Static Public Attributes

static std::string indentation_string = " "
 

Constructor & Destructor Documentation

◆ SvgDocument() [1/3]

SvgDocument ( )
default

◆ ~SvgDocument()

~SvgDocument ( )
default

◆ SvgDocument() [2/3]

SvgDocument ( SvgDocument const &  )
default

◆ SvgDocument() [3/3]

SvgDocument ( SvgDocument &&  )
default

Member Function Documentation

◆ add() [1/2]

SvgDocument & add ( SvgObject &&  object)

Definition at line 163 of file svg/document.cpp.

◆ add() [2/2]

SvgDocument & add ( SvgObject const &  object)

Add an SvgObject to the document.

Returns the SvgDocument in order to allow for a fluent interface.

Definition at line 157 of file svg/document.cpp.

◆ bounding_box()

SvgBox bounding_box ( ) const

Definition at line 57 of file svg/document.cpp.

◆ operator<<() [1/2]

SvgDocument & operator<< ( SvgObject &&  object)

Definition at line 174 of file svg/document.cpp.

◆ operator<<() [2/2]

SvgDocument & operator<< ( SvgObject const &  object)

Shortcut operator for add(), which allows an even more fluent interface.

Definition at line 169 of file svg/document.cpp.

◆ operator=() [1/2]

SvgDocument& operator= ( SvgDocument &&  )
default

◆ operator=() [2/2]

SvgDocument& operator= ( SvgDocument const &  )
default

◆ write() [1/2]

void write ( std::ostream &  out) const

Write the SvgDocument to an output stream.

Definition at line 70 of file svg/document.cpp.

◆ write() [2/2]

void write ( std::shared_ptr< utils::BaseOutputTarget target) const

Definition at line 151 of file svg/document.cpp.

Member Typedef Documentation

◆ self_type

Definition at line 58 of file svg/document.hpp.

Member Enumeration Documentation

◆ Overflow

enum Overflow
strong
Enumerator
kNone 
kVisible 
kHidden 
kScroll 
kAuto 
kInherit 

Definition at line 62 of file svg/document.hpp.

Member Data Documentation

◆ background_color

Color background_color = Color( 1.0, 1.0, 1.0, 1.0 )

Definition at line 126 of file svg/document.hpp.

◆ defs

std::vector< SvgDefinitions > defs

Definition at line 125 of file svg/document.hpp.

◆ indentation_string

std::string indentation_string = " "
static

Definition at line 60 of file svg/document.hpp.

◆ margin

SvgMargin margin

Definition at line 122 of file svg/document.hpp.

◆ overflow

Definition at line 123 of file svg/document.hpp.


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