A piece of text. More...

#include <Shapes.h>

Inheritance diagram for LibBoard::Text:

Public Member Functions
	Text (double x, double y, const std::string &text, const Fonts::Font font, double size, Color color=Color::Black, int depth=-1)

	Text (Point p, const std::string &text, const Fonts::Font font, double size, Color color=Color::Black, int depth=-1)

	Text (double x, double y, const std::string &text, const Fonts::Font font, const std::string &svgFont, double size, Color color=Color::Black, int depth=-1)

	Text (Point p, const std::string &text, const Fonts::Font font, const std::string &svgFont, double size, Color color=Color::Black, int depth=-1)

const std::string &	name () const override

Point	center (LineWidthFlag lineWidthFlag=IgnoreLineWidth) const override

Text &	rotate (double angle, const Point &center) override

Text	rotated (double angle, const Point &center) const

Text &	rotate (double angle) override

Text	rotated (double angle) const

Text &	translate (double dx, double dy) override

Text	translated (double dx, double dy) const

Text &	scale (double sx, double sy) override

Text &	scale (double s) override

Text	scaled (double sx, double sy) const

Text	scaled (double s) const

void	scaleAll (double s) override

void	flushPostscript (std::ostream &stream, const TransformEPS &transform) const override

void	flushFIG (std::ostream &stream, const TransformFIG &transform, std::map< Color, int > &colormap) const override

void	flushSVG (std::ostream &stream, const TransformSVG &transform) const override

void	flushTikZ (std::ostream &stream, const TransformTikZ &transform) const override

Rect	boundingBox (LineWidthFlag) const override

Text *	clone () const override

Public Member Functions inherited from LibBoard::Shape
	Shape (Color penColor, Color fillColor, double lineWidth, LineStyle style, const LineCap cap, const LineJoin join, int depth)

virtual	~Shape ()

bool	filled () const

Shape &	rotateDeg (double angle, const Point &center)

Shape &	rotateDeg (double angle)

Shape &	moveCenter (double x, double y, LineWidthFlag lineWidthFlag=IgnoreLineWidth)

Shape &	moveCenter (Point p, LineWidthFlag lineWidthFlag=IgnoreLineWidth)

Shape &	scaleToWidth (double w, LineWidthFlag lineWidthFlag)

Shape &	scaleToHeight (double h, LineWidthFlag lineWidthFlag)

Rect	bbox (LineWidthFlag) const

Shape &	operator-- ()

Shape &	operator++ ()

int	depth () const

virtual void	depth (int)

virtual void	shiftDepth (int shift)

const Color &	penColor () const

const Color &	fillColor () const

virtual void	accept (ShapeVisitor &visitor)
	Accepts a visitor object. More...

virtual void	accept (const ShapeVisitor &visitor)
	Accepts a visitor object. More...

Protected Attributes
std::string	_text

Fonts::Font	_font

std::string	_svgFont

double	_size

double	_xScale

double	_yScale

Path	_box

Protected Attributes inherited from LibBoard::Shape
int	_depth

Color	_penColor

Color	_fillColor

double	_lineWidth

LineStyle	_lineStyle

LineCap	_lineCap

LineJoin	_lineJoin

Additional Inherited Members
Public Types inherited from LibBoard::Shape
enum	LineCap { ButtCap = 0, RoundCap, SquareCap }

enum	LineJoin { MiterJoin = 0, RoundJoin, BevelJoin }

enum	LineStyle { SolidStyle = 0, DashStyle, DotStyle, DashDotStyle, DashDotDotStyle, DashDotDotDotStyle }

enum	LineWidthFlag { IgnoreLineWidth, UseLineWidth }

Static Public Member Functions inherited from LibBoard::Shape
static void	enableLineWidthScaling ()

static void	disableLineWidthScaling ()

static void	setLineWidthScaling (bool)

static void	setDefaultLineWidth (double)

static void	setDefaultPenColor (Color)

static void	setDefaultFillColor (Color)

static void	setDefaultLineStyle (Shape::LineStyle)

static void	setDefaultLineCap (Shape::LineCap)

static void	setDefaultLineJoin (Shape::LineJoin)

static double	defaultLineWidth ()
	defaultLineWidth More...

static Color	defaultPenColor ()
	defaultPenColor More...

static Color	defaultFillColor ()
	defaultFillColor More...

static Shape::LineStyle	defaultLineStyle ()
	defaultLineStyle More...

static Shape::LineCap	defaultLineCap ()
	defaultLineCap More...

static Shape::LineJoin	defaultLineJoin ()
	defaultLineJoin More...

Protected Member Functions inherited from LibBoard::Shape
void	updateLineWidth (double s)

std::string	svgProperties (const TransformSVG &transform) const

std::string	postscriptProperties (const TransformEPS &transform) const

std::string	tikzProperties (const TransformTikZ &transform) const

Static Protected Attributes inherited from LibBoard::Shape
static bool	_lineWidthScaling = true

static double	_defaultLineWidth = 1.0

static Color	_defaultPenColor = Color::Black

static Color	_defaultFillColor = Color::Null

static Shape::LineStyle	_defaultLineStyle = Shape::SolidStyle

static Shape::LineCap	_defaultLineCap = Shape::ButtCap

static Shape::LineJoin	_defaultLineJoin = Shape::MiterJoin

Detailed Description

A piece of text.

The text structure.

Examples:: examples/example2.cpp, examples/logo.cpp, examples/ruler.cpp, and examples/stroke_path.cpp.

Constructor & Destructor Documentation

LibBoard::Text::Text	(	double	x,
		double	y,
		const std::string &	text,
		const Fonts::Font	font,
		double	size,
		Color	color = `Color::Black`,
		int	depth = `-1`
	)

Create a Text sctucture.

Parameters

x	x-coordinate of the bottom-left corner.
y	y-coordinate of the bottom-left corner.
text
font
size
color
depth

Returns

Referenced by clone(), scaled(), and translated().

LibBoard::Text::Text	(	Point	p,
		const std::string &	text,
		const Fonts::Font	font,
		double	size,
		Color	color = `Color::Black`,
		int	depth = `-1`
	)

Create a Text sctucture.

Parameters

p	Position of the bottom-left corner.
text
font
size
color
depth

Returns

LibBoard::Text::Text	(	double	x,
		double	y,
		const std::string &	text,
		const Fonts::Font	font,
		const std::string &	svgFont,
		double	size,
		Color	color = `Color::Black`,
		int	depth = `-1`
	)

Create a Text sctucture.

Parameters

x	x-coordinate of the bottom-left corner.
y	y-coordinate of the bottom-left corner.
text
font
svgFont	The font family for an SVG file. (E.g. "Verdana, Arial" or "'Time New Roman', Serif" )
size
color
depth

Returns

LibBoard::Text::Text	(	Point	p,
		const std::string &	text,
		const Fonts::Font	font,
		const std::string &	svgFont,
		double	size,
		Color	color = `Color::Black`,
		int	depth = `-1`
	)

Create a Text sctucture.

Parameters

p	Position of the bottom-left corner.
text
font
svgFont	The font family for an SVG file. (E.g. "Verdana, Arial" or "'Time New Roman', Serif" )
size
color
depth

Returns

Member Function Documentation

Rect LibBoard::Text::boundingBox ( LineWidthFlag ) const

overridevirtual

Compute the bounding box of the figure.

Returns: The rectangle of the bounding box.

Implements LibBoard::Shape.

References LibBoard::Path::boundingBox().

Point LibBoard::Text::center ( LineWidthFlag lineWidthFlag = IgnoreLineWidth ) const

overridevirtual

Returns the center of the shape.

Parameters

lineWidthFlag Should the line width be considered when computing bounding boxes.

Returns: The center of the shape, i.e. the center of its bounding box.

Reimplemented from LibBoard::Shape.

References LibBoard::Path::center().

Text * LibBoard::Text::clone ( ) const

overridevirtual

Return a copy of the shape.

Returns: A copy of the shape.

Implements LibBoard::Shape.

References Text().

void LibBoard::Text::flushFIG	(	std::ostream &	stream,
		const TransformFIG &	transform,
		std::map< Color, int > &	colormap
	)		const

overridevirtual

Write the FIG code of the shape in a stream according to a transform.

Parameters

stream	The output stream.
transform	A 2D transform to be applied.

Implements LibBoard::Shape.

References LibBoard::Shape::_depth, and LibBoard::Shape::_penColor.

void LibBoard::Text::flushPostscript	(	std::ostream &	stream,
		const TransformEPS &	transform
	)		const

overridevirtual

Write the EPS code of the shape in a stream according to a transform.

Parameters

stream	The output stream.
transform	A 2D transform to be applied.

Implements LibBoard::Shape.

References LibBoard::Shape::_penColor.

void LibBoard::Text::flushSVG	(	std::ostream &	stream,
		const TransformSVG &	transform
	)		const

overridevirtual

Write the SVG code of the shape in a stream according to a transform.

Parameters

stream	The output stream.
transform	A 2D transform to be applied.

Implements LibBoard::Shape.

References LibBoard::Shape::_penColor, and LibBoard::Color::svgAlpha().

void LibBoard::Text::flushTikZ	(	std::ostream &	stream,
		const TransformTikZ &	transform
	)		const

overridevirtual

Write the TikZ code of the shape in a stream according to a transform.

Parameters

stream	The output stream.
transform	A 2D transform to be applied.

Implements LibBoard::Shape.

References LibBoard::Shape::tikzProperties().

const std::string & LibBoard::Text::name ( ) const

overridevirtual

Returns the generic name of the shape (e.g., Circle, Rectangle, etc.)

Returns

Reimplemented from LibBoard::Shape.

Text & LibBoard::Text::rotate	(	double	angle,
		const Point &	center
	)

overridevirtual

Rotate the shape around a given center of rotation.

Parameters

angle	The rotation angle in radian.
center	The center of rotation.

Returns: A reference to the shape itself.

Implements LibBoard::Shape.

References LibBoard::Path::rotate().

Text & LibBoard::Text::rotate ( double angle )

overridevirtual

Rotate the shape around its center.

Parameters

angle The rotation angle in radian.

Returns: A reference to the shape itself.

Implements LibBoard::Shape.

References LibBoard::Path::rotate().

Text & LibBoard::Text::scale	(	double	sx,
		double	sy
	)

overridevirtual

Scale the text, given two scaling factors.

Parameters

sx	Scaling factor along the x axis.
sy	Scaling factor along the y axis.

Returns: A reference to the text itself, once scaled.

Implements LibBoard::Shape.

References LibBoard::Path::scale().

Text & LibBoard::Text::scale ( double s )

overridevirtual

Scale the text, given a scaling factor.

Parameters

s	Scaling factor.

Returns: A reference to the text itself, once scaled.

Implements LibBoard::Shape.

References LibBoard::Path::scale().

void LibBoard::Text::scaleAll ( double s )

overridevirtual

Scales all the values (positions, dimensions, etc.) associated with the shape.

Parameters

s	The scaling factor.

Implements LibBoard::Shape.

References LibBoard::Path::scaleAll().

Text LibBoard::Text::scaled	(	double	sx,
		double	sy
	)		const

Returns a scaled copy of the text.

Parameters

sx	The scaling factor along the x axis.
sy	The scaling factor along the y axis.

Returns: A scaled copy of the text.

References Text().

Text LibBoard::Text::scaled ( double s ) const

Returns a scaled copy of the text.

Parameters

s	The scaling factor.

Returns: A scaled copy of the text.

References Text().

Text & LibBoard::Text::translate	(	double	dx,
		double	dy
	)

overridevirtual

Translate the text by a given offset.

Parameters

dx	The x offset.
dy	The y offset.

Returns: A reference to the text itself.

Implements LibBoard::Shape.

References LibBoard::Path::translate().

Text LibBoard::Text::translated	(	double	dx,
		double	dy
	)		const

Returns a translated copy of the text.

Parameters

dx	Shift of the first coordinate.
dy	Shift of the second coordinate.

Returns: A copy of the text, translated.

References Text().

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

include/board/Shapes.h
src/Shapes.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation