GUI styled text node. More...

#include <tdme/gui/nodes/GUIStyledTextNode.h>

Inheritance diagram for GUIStyledTextNode:

Collaboration diagram for GUIStyledTextNode:

Classes
struct	Line

struct	TextStyle

Public Member Functions
int	getContentWidth () override

int	getContentHeight () override

void	computeContentAlignment () override
	Do content alignment. More...

void	dispose () override
	Dispose node. More...

void	render (GUIRenderer *guiRenderer) override
	Render. More...

const MutableString &	getText () const

void	setText (const MutableString &text)
	Set text. More...

void	unsetTextStyle (int startIdx, int endIdx)
	Unset text style. More...

void	setTextStyle (int startIdx, int endIdx, const GUIColor &color, const string &font=string(), const string &url=string())
	Set text style. More...

void	setTextStyle (int startIdx, int endIdx, const string &font, const string &url=string())
	Set text style. More...

void	setImage (int idx, const string &image, const string &url=string(), int width=-1, int height=-1)
	Set image. More...

Public Member Functions inherited from GUINode
GUIScreenNode *	getScreenNode ()

GUIParentNode *	getParentNode ()

const string &	getId ()

const string	getHierarchicalId ()

virtual const string	getNodeType ()=0

virtual int	getContentWidth ()=0

virtual int	getContentHeight ()=0

virtual int	getAutoWidth ()

virtual int	getAutoHeight ()

GUINode_Border &	getBorder ()

GUINode_Padding &	getPadding ()

GUINode_RequestedConstraints &	getRequestsConstraints ()

GUINode_ComputedConstraints &	getComputedConstraints ()

GUIColor &	getBackgroundColor ()

virtual void	dispose ()
	Dispose node. More...

bool	isConditionsMet ()
	Determine if conditions are set. More...

virtual void	setConditionsMet ()
	Set conditions met for this node and its subnodes. More...

virtual void	layoutOnDemand ()
	Layout on demand. More...

bool	hasEffects ()

virtual void	applyEffects (GUIRenderer *guiRenderer)
	Apply effects. More...

virtual void	undoEffects (GUIRenderer *guiRenderer)
	Undo effects. More...

virtual void	render (GUIRenderer *guiRenderer)
	Render. More...

float	computeParentChildrenRenderOffsetXTotal ()

float	computeParentChildrenRenderOffsetYTotal ()

bool	isEventBelongingToNode (GUIMouseEvent *event, Vector2 &position)
	Is event belonging to node. More...

bool	isEventBelongingToNode (GUIMouseEvent *event)
	Is event belonging to node. More...

void	getEventOffNodeRelativePosition (GUIMouseEvent *event, Vector2 &position)
	Get event off node relative position TODO: use Vector2 instead of array<float, 2> More...

void	getEventNodePosition (GUIMouseEvent *event, Vector2 &position)
	Get event position clamped to node constraints TODO: use Vector2 instead of array<float, 2> More...

GUIParentNode *	getParentControllerNode ()

virtual void	determineMouseEventNodes (GUIMouseEvent *event, bool floatingNode, unordered_set< string > &eventNodeIds, unordered_set< string > &eventFloatingNodeIds)
	Determine mouse event nodes. More...

GUINodeController *	getController ()

void	setController (GUINodeController *controller)
	Set up node controller. More...

void	scrollToNodeY (GUIParentNode *toNode=nullptr)
	Scroll to node Y. More...

void	scrollToNodeX (GUIParentNode *toNode=nullptr)
	Scroll to node X. More...

void	setBackgroundImage (const string &backgroundImage)
	Set background image. More...

int	getGUIEffectOffsetX ()

void	setGUIEffectOffsetX (int guiEffectOffsetX)
	Set GUI effect offset X. More...

int	getGUIEffectOffsetY ()

void	setGUIEffectOffsetY (int guiEffectOffsetY)
	Set GUI effect offset Y. More...

GUIEffectState *	getEffectState ()

GUIEffect *	getEffect (const string &id)
	Get effect. More...

void	addEffect (const string &id, GUIEffect *effect)
	Add effect, effect already registered with the is will be removed. More...

void	removeEffect (const string &id)
	Remove effect. More...

Protected Member Functions
	GUIStyledTextNode (GUIScreenNode screenNode, GUIParentNode parentNode, const string &id, GUINode_Flow *flow, const GUINode_Alignments &alignments, const GUINode_RequestedConstraints &requestedConstraints, const GUIColor &backgroundColor, const string &backgroundImage, const GUINode_Scale9Grid &backgroundImageScale9Grid, const GUIColor &backgroundImageEffectColorMul, const GUIColor &backgroundImageEffectColorAdd, const GUINode_Border &border, const GUINode_Padding &padding, const GUINodeConditions &showOn, const GUINodeConditions &hideOn, bool preformatted, const string &font, const string &color, const MutableString &text)
	Constructor. More...

void	disposeStyles ()
	Dispose styles. More...

const string	getNodeType () override

bool	isContentNode () override

Protected Member Functions inherited from GUINode
	GUINode (GUIScreenNode screenNode, GUIParentNode parentNode, const string &id, GUINode_Flow *flow, const GUINode_Alignments &alignments, const GUINode_RequestedConstraints &requestedConstraints, const GUIColor &backgroundColor, const string &backgroundImage, const GUINode_Scale9Grid &backgroundImageScale9Grid, const GUIColor &backgroundImageEffectColorMul, const GUIColor &backgroundImageEffectColorAdd, const GUINode_Border &border, const GUINode_Padding &padding, const GUINodeConditions &showOn, const GUINodeConditions &hideOn)
	Public constructor. More...

virtual	~GUINode ()
	Destructor. More...

virtual bool	isContentNode ()=0

virtual void	setLeft (int left)
	Set computed left. More...

virtual void	setTop (int top)
	Set computed top. More...

virtual void	layout ()
	Layout. More...

virtual void	computeContentAlignment ()
	Do content alignment. More...

int	layoutConstraintPixel (GUINode_RequestedConstraints_RequestedConstraintsType *type, int autoValue, int parentValue, int value)
	Layout constraint. More...

bool	checkConditions ()
	Check if conditions are met. More...

void	onSetConditions (const vector< string > &conditions)
	On set condition. More...

bool	haveActiveOutEffect ()
	Determine if we have a out effect active. More...

bool	shouldRender ()
	Determine if to render. More...

void	_scrollToNodeX (GUIParentNode *toNode=nullptr)
	Scroll to node X. More...

void	_scrollToNodeY (GUIParentNode *toNode=nullptr)
	Scroll to node Y. More...

Private Member Functions
TextStyle *	getTextStyle (const vector< int > &lineCharIdxs, int lineCharIdx, int &textStyleIdx)
	Get text style for. More...

void	determineNextLineConstraints (int &i, int charEndIdx, int textStyleIdx)
	Determine next line constraints. More...

Private Attributes
bool	preformatted

GUIFont *	font { nullptr }

GUIColor	color

MutableString	text

int	autoWidth

int	autoHeight

bool	parentOffsetsChanged

float	parentXOffsetLast

float	parentYOffsetLast

int	charStartIdx

int	charEndIdx

int	startRenderY

int	widthLast

int	heightLast

vector< TextStyle >	styles

int	startTextStyleIdx { -1 }

string	spaceString { " " }

string	tabString3 { " " }

string	tabString4 { " " }

string	line

vector< int >	lineCharIdxs

vector< Line >	lineConstraints

Friends
class	tdme::gui::GUIParser

Additional Inherited Members
Static Public Member Functions inherited from GUINode
static GUINode_Alignments	createAlignments (const string &horizontal, const string &vertical)
	Create alignments. More...

static GUINode_RequestedConstraints	createRequestedConstraints (const string &left, const string &top, const string &width, const string &height, int factor)
	Create requested constraints. More...

static GUIColor	getRequestedColor (const string &color, const GUIColor &defaultColor)
	Get color. More...

static GUINode_Flow *	createFlow (const string &flow)
	Create flow. More...

static GUINode_Border	createBorder (const string &allBorder, const string &left, const string &top, const string &right, const string &bottom, const string &allBorderColor, const string &leftColor, const string &topColor, const string &rightColor, const string &bottomColor)
	Create border. More...

static GUINode_Padding	createPadding (const string &allPadding, const string &left, const string &top, const string &right, const string &bottom)
	Create padding. More...

static GUINode_Scale9Grid	createScale9Grid (const string &all, const string &left, const string &top, const string &right, const string &bottom)
	Create scale 9 grid. More...

static GUINodeConditions	createConditions (const string &conditions)
	Create conditions. More...

static void	dumpNode (GUINode *node, int depth=0, int indent=0, int depthIdx=0)
	Dump node. More...

static void	dumpParentNodes (GUINode *node, int indent=0)
	Dump parent nodes. More...

Static Protected Member Functions inherited from GUINode
static GUINode_RequestedConstraints_RequestedConstraintsType *	getRequestedConstraintsType (const string &constraint, GUINode_RequestedConstraints_RequestedConstraintsType *defaultConstraintsType)
	Get requested constraints type. More...

static int	getRequestedConstraintsValue (const string &constraint, int defaultConstraintsValue)
	Get requested constraints value. More...

static int	getRequestedPixelValue (const string &value, int defaultValue)
	Get requested pixel value. More...

Protected Attributes inherited from GUINode
GUIScreenNode *	screenNode { nullptr }

GUIParentNode *	parentNode { nullptr }

string	id

GUINode_Alignments	alignments

GUINode_RequestedConstraints	requestedConstraints

GUINode_ComputedConstraints	computedConstraints

GUIColor	backgroundColor

Texture *	backgroundTexture { nullptr }

int	backgroundTextureId

GUINode_Scale9Grid	backgroundImageScale9Grid

GUIColor	backgroundImageEffectColorMul

GUIColor	backgroundImageEffectColorAdd

GUINode_Padding	padding

GUINode_Border	border

GUINodeConditions	showOn

GUINodeConditions	hideOn

GUINodeController *	controller { nullptr }

unordered_map< string, GUIEffect * >	effects

int	guiEffectOffsetX

int	guiEffectOffsetY

bool	conditionsMet

bool	layouted

bool	haveOutEffect

vector< string >	lastConditions

GUIEffectState *	effectState { nullptr }

Detailed Description

GUI styled text node.

Author: Andreas Drewke

Version: $Id$

Definition at line 42 of file GUIStyledTextNode.h.

Constructor & Destructor Documentation

◆ GUIStyledTextNode()

GUIStyledTextNode	(	GUIScreenNode *	screenNode,
		GUIParentNode *	parentNode,
		const string &	id,
		GUINode_Flow *	flow,
		const GUINode_Alignments &	alignments,
		const GUINode_RequestedConstraints &	requestedConstraints,
		const GUIColor &	backgroundColor,
		const string &	backgroundImage,
		const GUINode_Scale9Grid &	backgroundImageScale9Grid,
		const GUIColor &	backgroundImageEffectColorMul,
		const GUIColor &	backgroundImageEffectColorAdd,
		const GUINode_Border &	border,
		const GUINode_Padding &	padding,
		const GUINodeConditions &	showOn,
		const GUINodeConditions &	hideOn,
		bool	preformatted,
		const string &	font,
		const string &	color,
		const MutableString &	text
	)

protected

Constructor.

Parameters

screenNode	screen node
parentNode	parent node
id	id
flow	flow
alignments	alignments
requestedConstraints	requested constraints
backgroundColor	background color
backgroundImage	background image
backgroundImageScale9Grid	background image scale 9 grid
backgroundImageEffectColorMul	background image effect color mul
backgroundImageEffectColorAdd	background image effect color add
border	border
padding	padding
showOn	show on
hideOn	hide on
preformatted	preformatted
font	font
color	color
text	text

Exceptions

tdme::gui::GUIParserException

Definition at line 58 of file GUIStyledTextNode.cpp.

Member Function Documentation

◆ computeContentAlignment()

void computeContentAlignment ( )

overridevirtual

Do content alignment.

Reimplemented from GUINode.

Definition at line 126 of file GUIStyledTextNode.cpp.

◆ determineNextLineConstraints()

void determineNextLineConstraints	(	int &	i,
		int	charEndIdx,
		int	textStyleIdx
	)

private

Determine next line constraints.

Parameters

i	current loop index
charEndIdx	character end index
textStyleIdx	text style index to start with

Definition at line 343 of file GUIStyledTextNode.cpp.

◆ dispose()

void dispose ( )

overridevirtual

Dispose node.

Reimplemented from GUINode.

Definition at line 336 of file GUIStyledTextNode.cpp.

◆ disposeStyles()

void disposeStyles ( )

protected

Dispose styles.

Definition at line 945 of file GUIStyledTextNode.cpp.

◆ getContentHeight()

int getContentHeight ( )

overridevirtual

Returns: content height including border, margin

Implements GUINode.

Definition at line 118 of file GUIStyledTextNode.cpp.

◆ getContentWidth()

int getContentWidth ( )

overridevirtual

Returns: content width including border, margin

Implements GUINode.

Definition at line 109 of file GUIStyledTextNode.cpp.

◆ getNodeType()

const string getNodeType ( )

overrideprotectedvirtual

Returns: node type

Implements GUINode.

Definition at line 99 of file GUIStyledTextNode.cpp.

◆ getText()

const MutableString & getText ( ) const

inline

Returns: text

Definition at line 212 of file GUIStyledTextNode.h.

◆ getTextStyle()

TextStyle * getTextStyle	(	const vector< int > &	lineCharIdxs,
		int	lineCharIdx,
		int &	textStyleIdx
	)

inlineprivate

Get text style for.

Parameters

lineCharIdxs	line character indices
lineCharIdx	line character idx
textStyleIdx	text style to start looking up with, will also be written

Returns: text style

Definition at line 103 of file GUIStyledTextNode.h.

◆ isContentNode()

bool isContentNode ( )

overrideprotectedvirtual

Returns: is content node

Implements GUINode.

Definition at line 104 of file GUIStyledTextNode.cpp.

◆ render()

void render ( GUIRenderer * guiRenderer )

overridevirtual

Render.

Parameters

guiRenderer	gui renderer
floatingNodes	floating nodes

Reimplemented from GUINode.

Definition at line 554 of file GUIStyledTextNode.cpp.

◆ setImage()

void setImage	(	int	idx,
		const string &	image,
		const string &	url = `string()`,
		int	width = `-1`,
		int	height = `-1`
	)

Set image.

Parameters

idx	index
image	image
url	url
width	width or -1 for original image width
height	height or -1 for original image height

Definition at line 924 of file GUIStyledTextNode.cpp.

◆ setText()

void setText ( const MutableString & text )

Set text.

Parameters

text text

Definition at line 190 of file GUIStyledTextNode.cpp.

◆ setTextStyle() [1/2]

void setTextStyle	(	int	startIdx,
		int	endIdx,
		const GUIColor &	color,
		const string &	font = `string()`,
		const string &	url = `string()`
	)

Set text style.

Parameters

startIdx	text start index
endIdx	text end index
color	color
font	font
url	url

Definition at line 871 of file GUIStyledTextNode.cpp.

◆ setTextStyle() [2/2]

void setTextStyle	(	int	startIdx,
		int	endIdx,
		const string &	font,
		const string &	url = `string()`
	)

Set text style.

Parameters

startIdx	text start index
endIdx	text end index
font	font
url	url

Definition at line 898 of file GUIStyledTextNode.cpp.

◆ unsetTextStyle()

void unsetTextStyle	(	int	startIdx,
		int	endIdx
	)

Unset text style.

Parameters

startIdx	text start index
endIdx	text end index

Definition at line 867 of file GUIStyledTextNode.cpp.

Friends And Related Function Documentation

◆ tdme::gui::GUIParser

friend class tdme::gui::GUIParser

friend

Definition at line 45 of file GUIStyledTextNode.h.

Member Data Documentation

◆ autoHeight

int autoHeight

private

Definition at line 66 of file GUIStyledTextNode.h.

◆ autoWidth

int autoWidth

private

Definition at line 65 of file GUIStyledTextNode.h.

◆ charEndIdx

int charEndIdx

private

Definition at line 72 of file GUIStyledTextNode.h.

◆ charStartIdx

int charStartIdx

private

Definition at line 71 of file GUIStyledTextNode.h.

◆ color

GUIColor color

private

Definition at line 62 of file GUIStyledTextNode.h.

◆ font

GUIFont* font { nullptr }

private

Definition at line 61 of file GUIStyledTextNode.h.

◆ heightLast

int heightLast

private

Definition at line 75 of file GUIStyledTextNode.h.

◆ line

string line

private

Definition at line 92 of file GUIStyledTextNode.h.

◆ lineCharIdxs

vector<int> lineCharIdxs

private

Definition at line 93 of file GUIStyledTextNode.h.

◆ lineConstraints

vector<Line> lineConstraints

private

Definition at line 94 of file GUIStyledTextNode.h.

◆ parentOffsetsChanged

bool parentOffsetsChanged

private

Definition at line 68 of file GUIStyledTextNode.h.

◆ parentXOffsetLast

float parentXOffsetLast

private

Definition at line 69 of file GUIStyledTextNode.h.

◆ parentYOffsetLast

float parentYOffsetLast

private

Definition at line 70 of file GUIStyledTextNode.h.

◆ preformatted

bool preformatted

private

Definition at line 60 of file GUIStyledTextNode.h.

◆ spaceString

string spaceString { " " }

private

Definition at line 89 of file GUIStyledTextNode.h.

◆ startRenderY

int startRenderY

private

Definition at line 73 of file GUIStyledTextNode.h.

◆ startTextStyleIdx

int startTextStyleIdx { -1 }

private

Definition at line 78 of file GUIStyledTextNode.h.

◆ styles

vector<TextStyle> styles

private

Definition at line 77 of file GUIStyledTextNode.h.

◆ tabString3

string tabString3 { " " }

private

Definition at line 90 of file GUIStyledTextNode.h.

◆ tabString4

string tabString4 { " " }

private

Definition at line 91 of file GUIStyledTextNode.h.

◆ text

MutableString text

private

Definition at line 63 of file GUIStyledTextNode.h.

◆ widthLast

int widthLast

private

Definition at line 74 of file GUIStyledTextNode.h.

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

/home/andreas/Development/drewke.net/tdme2/src/tdme/gui/nodes/GUIStyledTextNode.h
/home/andreas/Development/drewke.net/tdme2/src/tdme/gui/nodes/GUIStyledTextNode.cpp

Classes

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GUIStyledTextNode()

Member Function Documentation

◆ computeContentAlignment()

◆ determineNextLineConstraints()

◆ dispose()

◆ disposeStyles()

◆ getContentHeight()

◆ getContentWidth()

◆ getNodeType()

◆ getText()

◆ getTextStyle()

◆ isContentNode()

◆ render()

◆ setImage()

◆ setText()

◆ setTextStyle() [1/2]

◆ setTextStyle() [2/2]

◆ unsetTextStyle()

Friends And Related Function Documentation

◆ tdme::gui::GUIParser

Member Data Documentation

◆ autoHeight

◆ autoWidth

◆ charEndIdx

◆ charStartIdx

◆ color

◆ font

◆ heightLast

◆ line

◆ lineCharIdxs

◆ lineConstraints

◆ parentOffsetsChanged

◆ parentXOffsetLast

◆ parentYOffsetLast

◆ preformatted

◆ spaceString

◆ startRenderY

◆ startTextStyleIdx

◆ styles

◆ tabString3

◆ tabString4

◆ text

◆ widthLast