class for generating basic html tags More...

#include <src/PlusCommon/vtkPlusHTMLGenerator.h>

Inheritance diagram for vtkPlusHTMLGenerator:

Collaboration diagram for vtkPlusHTMLGenerator:

Public Types
enum	HEADINGS { H1, H2, H3, H4, H5, H6 }

typedef vtkObject	Superclass

Public Member Functions
virtual void	AddHorizontalLine ()

virtual std::string	AddImageAutoFilename (const char filenamePostfix, const char description, const int widthPx=0, const int heightPx=0)

virtual void	AddLink (const char linkText, const char url)

virtual void	AddParagraph (const char *paragraph)

virtual void	AddTable (vtkTable *table, int borderPx)

virtual void	AddText (const char text, HEADINGS h, const char style=NULL)

virtual char *	GetBaseFilename ()

virtual const char *	GetClassName ()

virtual char *	GetOutputDirectory ()

virtual char *	GetTitle ()

virtual int	IsA (const char *type)

virtual void	PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE

virtual std::string	SaveHtmlPageAutoFilename ()

virtual void	SetBaseFilename (const char *)

virtual void	SetOutputDirectory (const char *)

virtual void	SetTitle (const char *)

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkPlusHTMLGenerator *	New ()

static vtkPlusHTMLGenerator *	SafeDownCast (vtkObject *o)

Protected Member Functions
virtual void	AddImage (const char imageSource, const char alt, const int widthPx=0, const int heightPx=0)

virtual std::string	GetHtmlBody ()

virtual std::string	GetHtmlPage ()

virtual void	SaveHtmlPage (const char *fileName)

	vtkPlusHTMLGenerator ()

virtual	~vtkPlusHTMLGenerator ()

Protected Attributes
char *	BaseFilename

std::ostringstream	HtmlBody

char *	OutputDirectory

char *	Title

Detailed Description

class for generating basic html tags

Definition at line 21 of file vtkPlusHTMLGenerator.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkPlusHTMLGenerator::Superclass

Definition at line 37 of file vtkPlusHTMLGenerator.h.

Member Enumeration Documentation

◆ HEADINGS

enum vtkPlusHTMLGenerator::HEADINGS

HTML headings

Enumerator
H1
H2
H3
H4
H5
H6

Definition at line 26 of file vtkPlusHTMLGenerator.h.

Constructor & Destructor Documentation

◆ vtkPlusHTMLGenerator()

vtkPlusHTMLGenerator::vtkPlusHTMLGenerator ( )

protected

Definition at line 18 of file vtkPlusHTMLGenerator.cxx.

◆ ~vtkPlusHTMLGenerator()

vtkPlusHTMLGenerator::~vtkPlusHTMLGenerator ( )

protectedvirtual

Definition at line 30 of file vtkPlusHTMLGenerator.cxx.

Member Function Documentation

◆ AddHorizontalLine()

void vtkPlusHTMLGenerator::AddHorizontalLine ( )

virtual

Add horizontal line separator to the document

Definition at line 42 of file vtkPlusHTMLGenerator.cxx.

◆ AddImage()

void vtkPlusHTMLGenerator::AddImage	(	const char *	imageSource,
		const char *	alt,
		const int	widthPx = `0`,
		const int	heightPx = `0`
	)

protectedvirtual

Add image to document

Definition at line 49 of file vtkPlusHTMLGenerator.cxx.

◆ AddImageAutoFilename()

std::string vtkPlusHTMLGenerator::AddImageAutoFilename	(	const char *	filenamePostfix,
		const char *	description,
		const int	widthPx = `0`,
		const int	heightPx = `0`
	)

virtual

Add image to document.

Parameters

filenamePostfix Should contain only a simple filename and extension (for example: ErrorHistogram.png).

Returns: Full path to the image file

Definition at line 300 of file vtkPlusHTMLGenerator.cxx.

◆ AddLink()

void vtkPlusHTMLGenerator::AddLink	(	const char *	linkText,
		const char *	url
	)

virtual

Add a link to the document

Definition at line 88 of file vtkPlusHTMLGenerator.cxx.

◆ AddParagraph()

void vtkPlusHTMLGenerator::AddParagraph ( const char * paragraph )

virtual

Add paragraph to document

Definition at line 75 of file vtkPlusHTMLGenerator.cxx.

◆ AddTable()

void vtkPlusHTMLGenerator::AddTable	(	vtkTable *	table,
		int	borderPx
	)

virtual

Add table to document

Definition at line 212 of file vtkPlusHTMLGenerator.cxx.

◆ AddText()

void vtkPlusHTMLGenerator::AddText	(	const char *	text,
		HEADINGS	h,
		const char *	style = `NULL`
	)

virtual

Add text to document

Definition at line 107 of file vtkPlusHTMLGenerator.cxx.

◆ GetBaseFilename()

virtual char* vtkPlusHTMLGenerator::GetBaseFilename ( )

virtual

Get the base filename. The base filename is used for generating output file names (html, images, etc).

◆ GetClassName()

virtual const char* vtkPlusHTMLGenerator::GetClassName ( )

virtual

◆ GetHtmlBody()

std::string vtkPlusHTMLGenerator::GetHtmlBody ( )

protectedvirtual

Get the body

Definition at line 249 of file vtkPlusHTMLGenerator.cxx.

◆ GetHtmlPage()

std::string vtkPlusHTMLGenerator::GetHtmlPage ( )

protectedvirtual

Get the html page source

Definition at line 256 of file vtkPlusHTMLGenerator.cxx.

◆ GetOutputDirectory()

virtual char* vtkPlusHTMLGenerator::GetOutputDirectory ( )

virtual

Get the output directory

◆ GetTitle()

virtual char* vtkPlusHTMLGenerator::GetTitle ( )

virtual

Get the page title

◆ IsA()

virtual int vtkPlusHTMLGenerator::IsA ( const char * type )

virtual

◆ IsTypeOf()

static int vtkPlusHTMLGenerator::IsTypeOf ( const char * type )

static

◆ New()

static vtkPlusHTMLGenerator* vtkPlusHTMLGenerator::New ( )

static

◆ PrintSelf()

void vtkPlusHTMLGenerator::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

virtual

Definition at line 36 of file vtkPlusHTMLGenerator.cxx.

◆ SafeDownCast()

static vtkPlusHTMLGenerator* vtkPlusHTMLGenerator::SafeDownCast ( vtkObject * o )

static

◆ SaveHtmlPage()

void vtkPlusHTMLGenerator::SaveHtmlPage ( const char * fileName )

protectedvirtual

Write the report to html file. Deprecated - use SaveHtmlPageAutoFilename instead.

Definition at line 275 of file vtkPlusHTMLGenerator.cxx.

◆ SaveHtmlPageAutoFilename()

std::string vtkPlusHTMLGenerator::SaveHtmlPageAutoFilename ( )

virtual

Write the report to html file. Create file in the output directory, including the application start time in the filename.

Definition at line 285 of file vtkPlusHTMLGenerator.cxx.

◆ SetBaseFilename()

virtual void vtkPlusHTMLGenerator::SetBaseFilename ( const char * )

virtual

Set the base filename. The base filename is used for generating output file names (html, images, etc). Set it before adding any images, because image file names are generated using this base filename.

◆ SetOutputDirectory()

virtual void vtkPlusHTMLGenerator::SetOutputDirectory ( const char * )

virtual

Set the output directory

◆ SetTitle()

virtual void vtkPlusHTMLGenerator::SetTitle ( const char * )

virtual

Set the page title

Member Data Documentation

◆ BaseFilename

char* vtkPlusHTMLGenerator::BaseFilename

protected

Definition at line 103 of file vtkPlusHTMLGenerator.h.

◆ HtmlBody

std::ostringstream vtkPlusHTMLGenerator::HtmlBody

protected

Definition at line 105 of file vtkPlusHTMLGenerator.h.

◆ OutputDirectory

char* vtkPlusHTMLGenerator::OutputDirectory

protected

Definition at line 102 of file vtkPlusHTMLGenerator.h.

◆ Title

char* vtkPlusHTMLGenerator::Title

protected

Definition at line 101 of file vtkPlusHTMLGenerator.h.

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

src/PlusCommon/vtkPlusHTMLGenerator.h
src/PlusCommon/vtkPlusHTMLGenerator.cxx

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ HEADINGS

Constructor & Destructor Documentation

◆ vtkPlusHTMLGenerator()

◆ ~vtkPlusHTMLGenerator()

Member Function Documentation

◆ AddHorizontalLine()

◆ AddImage()

◆ AddImageAutoFilename()

◆ AddLink()

◆ AddParagraph()

◆ AddTable()

◆ AddText()

◆ GetBaseFilename()

◆ GetClassName()

◆ GetHtmlBody()

◆ GetHtmlPage()

◆ GetOutputDirectory()

◆ GetTitle()

◆ IsA()

◆ IsTypeOf()

◆ New()

◆ PrintSelf()

◆ SafeDownCast()

◆ SaveHtmlPage()

◆ SaveHtmlPageAutoFilename()

◆ SetBaseFilename()

◆ SetOutputDirectory()

◆ SetTitle()

Member Data Documentation

◆ BaseFilename

◆ HtmlBody

◆ OutputDirectory

◆ Title