Class LinkTextComponent

Namespace

Vintagestory.API.Client

Assembly

VintagestoryAPI.dll

public class LinkTextComponent : RichTextComponent

Inheritance

object

RichTextComponentBase

RichTextComponent

LinkTextComponent

Inherited Members

RichTextComponent.textUtil

RichTextComponent.linebreak

RichTextComponent.DisplayText

RichTextComponent.Font

RichTextComponent.Lines

RichTextComponent.init()

RichTextComponent.GetFontOrientOffsetX()

RichTextComponentBase.MouseOverCursor

RichTextComponentBase.api

RichTextComponentBase.BoundsPerLine

RichTextComponentBase.UnscaledMarginTop

RichTextComponentBase.PaddingRight

RichTextComponentBase.PaddingLeft

RichTextComponentBase.Float

RichTextComponentBase.RenderColor

RichTextComponentBase.VerticalAlign

RichTextComponentBase.GetCurrentFlowPathSection(TextFlowPath[], double)

RichTextComponentBase.OnMouseMove(MouseEvent)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ObjectHandleExtensions.ToGcHandle(object)

ObjectHandleExtensions.ToIntPtr(object)

Constructors

LinkTextComponent(string)

Create a dummy link text component for use with triggering link protocols through code. Not usable for anything gui related (it'll crash if you try)

public LinkTextComponent(string href)

Parameters

href string

LinkTextComponent(ICoreClientAPI, string, CairoFont, Action<LinkTextComponent>)

A text component with an embedded link.

public LinkTextComponent(ICoreClientAPI api, string displayText, CairoFont font, Action<LinkTextComponent> onLinkClicked)

Parameters

api ICoreClientAPI

displayText string

The text of the Text.

font CairoFont

onLinkClicked Action<LinkTextComponent>

Fields

Href

public string Href

Field Value

string

Properties

Clickable

public bool Clickable { get; set; }

Property Value

bool

Methods

CalcBounds(TextFlowPath[], double, double, double, out double)

Initializes the size and stuff. Return true if you had to enter the next line

public override EnumCalcBoundsResult CalcBounds(TextFlowPath[] flowPath, double currentLineHeight, double offsetX, double lineY, out double nextOffsetX)

Parameters

flowPath TextFlowPath[]

currentLineHeight double

offsetX double

lineY double

nextOffsetX double

Returns

EnumCalcBoundsResult

True when longer than 1 line

ComposeElements(Context, ImageSurface)

Composes the element.

public override void ComposeElements(Context ctxStatic, ImageSurface surfaceStatic)

Parameters

ctxStatic Context

surfaceStatic ImageSurface

Dispose()

public override void Dispose()

HandleLink()

public void HandleLink()

OnMouseDown(MouseEvent)

public override void OnMouseDown(MouseEvent args)

Parameters

args MouseEvent

OnMouseUp(MouseEvent)

public override void OnMouseUp(MouseEvent args)

Parameters

args MouseEvent

RenderInteractiveElements(float, double, double, double)

Renders the text component.

public override void RenderInteractiveElements(float deltaTime, double renderX, double renderY, double renderZ)

Parameters

deltaTime float

renderX double

renderY double

renderZ double

SetHref(string)

public LinkTextComponent SetHref(string href)

Parameters

href string

Returns

LinkTextComponent

Trigger()

public void Trigger()

UseMouseOverCursor(ElementBounds)

public override bool UseMouseOverCursor(ElementBounds richtextBounds)

Parameters

richtextBounds ElementBounds

Returns

bool