TextParagraph

package
v0.0.0-...-b67d1b4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 4, 2025 License: MIT Imports: 23 Imported by: 0

Documentation

Overview

Package TextParagraph provides methods for working with TextParagraph object instances.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Advanced 

type Advanced = class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

type Any 

type Any interface {
	gd.IsClass
	AsTextParagraph() Instance
}

type HorizontalAlignment 

type HorizontalAlignment int
const (
	/*Horizontal left alignment, usually for text-derived classes.*/
	HorizontalAlignmentLeft HorizontalAlignment = 0
	/*Horizontal center alignment, usually for text-derived classes.*/
	HorizontalAlignmentCenter HorizontalAlignment = 1
	/*Horizontal right alignment, usually for text-derived classes.*/
	HorizontalAlignmentRight HorizontalAlignment = 2
	/*Expand row to fit width, usually for text-derived classes.*/
	HorizontalAlignmentFill HorizontalAlignment = 3
)

type InlineAlignment 

type InlineAlignment int
const (
	/*Aligns the top of the inline object (e.g. image, table) to the position of the text specified by [code]INLINE_ALIGNMENT_TO_*[/code] constant.*/
	InlineAlignmentTopTo InlineAlignment = 0
	/*Aligns the center of the inline object (e.g. image, table) to the position of the text specified by [code]INLINE_ALIGNMENT_TO_*[/code] constant.*/
	InlineAlignmentCenterTo InlineAlignment = 1
	/*Aligns the baseline (user defined) of the inline object (e.g. image, table) to the position of the text specified by [code]INLINE_ALIGNMENT_TO_*[/code] constant.*/
	InlineAlignmentBaselineTo InlineAlignment = 3
	/*Aligns the bottom of the inline object (e.g. image, table) to the position of the text specified by [code]INLINE_ALIGNMENT_TO_*[/code] constant.*/
	InlineAlignmentBottomTo InlineAlignment = 2
	/*Aligns the position of the inline object (e.g. image, table) specified by [code]INLINE_ALIGNMENT_*_TO[/code] constant to the top of the text.*/
	InlineAlignmentToTop InlineAlignment = 0
	/*Aligns the position of the inline object (e.g. image, table) specified by [code]INLINE_ALIGNMENT_*_TO[/code] constant to the center of the text.*/
	InlineAlignmentToCenter InlineAlignment = 4
	/*Aligns the position of the inline object (e.g. image, table) specified by [code]INLINE_ALIGNMENT_*_TO[/code] constant to the baseline of the text.*/
	InlineAlignmentToBaseline InlineAlignment = 8
	/*Aligns inline object (e.g. image, table) to the bottom of the text.*/
	InlineAlignmentToBottom InlineAlignment = 12
	/*Aligns top of the inline object (e.g. image, table) to the top of the text. Equivalent to [code]INLINE_ALIGNMENT_TOP_TO | INLINE_ALIGNMENT_TO_TOP[/code].*/
	InlineAlignmentTop InlineAlignment = 0
	/*Aligns center of the inline object (e.g. image, table) to the center of the text. Equivalent to [code]INLINE_ALIGNMENT_CENTER_TO | INLINE_ALIGNMENT_TO_CENTER[/code].*/
	InlineAlignmentCenter InlineAlignment = 5
	/*Aligns bottom of the inline object (e.g. image, table) to the bottom of the text. Equivalent to [code]INLINE_ALIGNMENT_BOTTOM_TO | INLINE_ALIGNMENT_TO_BOTTOM[/code].*/
	InlineAlignmentBottom InlineAlignment = 14
	/*A bit mask for [code]INLINE_ALIGNMENT_*_TO[/code] alignment constants.*/
	InlineAlignmentImageMask InlineAlignment = 3
	/*A bit mask for [code]INLINE_ALIGNMENT_TO_*[/code] alignment constants.*/
	InlineAlignmentTextMask InlineAlignment = 12
)

type Instance 

type Instance [1]gdclass.TextParagraph

Abstraction over [TextServer] for handling a single paragraph of text. 

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New 

func New() Instance

func (Instance) AddObject 

func (self Instance) AddObject(key any, size Vector2.XY) bool

Adds inline object to the text buffer, [param key] must be unique. In the text, object is represented as [param length] object replacement characters.

func (Instance) AddString 

func (self Instance) AddString(text string, font [1]gdclass.Font, font_size int) bool

Adds text span and font to draw it.

func (Instance) Alignment 

func (self Instance) Alignment() HorizontalAlignment

func (Instance) AsObject 

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsRefCounted 

func (self Instance) AsRefCounted() [1]gd.RefCounted

func (Instance) AsTextParagraph 

func (self Instance) AsTextParagraph() Instance

func (Instance) BreakFlags 

func (self Instance) BreakFlags() gdclass.TextServerLineBreakFlag

func (Instance) Clear 

func (self Instance) Clear()

Clears text paragraph (removes text and inline objects).

func (Instance) ClearDropcap 

func (self Instance) ClearDropcap()

Removes dropcap.

func (Instance) CustomPunctuation 

func (self Instance) CustomPunctuation() string

func (Instance) Direction 

func (self Instance) Direction() gdclass.TextServerDirection

func (Instance) Draw 

func (self Instance) Draw(canvas RID.Canvas, pos Vector2.XY)

Draw all lines of the text and drop cap into a canvas item at a given position, with [param color]. [param pos] specifies the top left corner of the bounding box.

func (Instance) DrawDropcap 

func (self Instance) DrawDropcap(canvas RID.Canvas, pos Vector2.XY)

Draw drop cap into a canvas item at a given position, with [param color]. [param pos] specifies the top left corner of the bounding box.

func (Instance) DrawDropcapOutline 

func (self Instance) DrawDropcapOutline(canvas RID.Canvas, pos Vector2.XY)

Draw drop cap outline into a canvas item at a given position, with [param color]. [param pos] specifies the top left corner of the bounding box.

func (Instance) DrawLine 

func (self Instance) DrawLine(canvas RID.Canvas, pos Vector2.XY, line int)

Draw single line of text into a canvas item at a given position, with [param color]. [param pos] specifies the top left corner of the bounding box.

func (Instance) DrawLineOutline 

func (self Instance) DrawLineOutline(canvas RID.Canvas, pos Vector2.XY, line int)

Draw outline of the single line of text into a canvas item at a given position, with [param color]. [param pos] specifies the top left corner of the bounding box.

func (Instance) DrawOutline 

func (self Instance) DrawOutline(canvas RID.Canvas, pos Vector2.XY)

Draw outlines of all lines of the text and drop cap into a canvas item at a given position, with [param color]. [param pos] specifies the top left corner of the bounding box.

func (Instance) EllipsisChar 

func (self Instance) EllipsisChar() string

func (Instance) GetDropcapLines 

func (self Instance) GetDropcapLines() int

Returns number of lines used by dropcap.

func (Instance) GetDropcapRid 

func (self Instance) GetDropcapRid() RID.TextBuffer

Returns drop cap text buffer RID.

func (Instance) GetDropcapSize 

func (self Instance) GetDropcapSize() Vector2.XY

Returns drop cap bounding box size.

func (Instance) GetLineAscent 

func (self Instance) GetLineAscent(line int) Float.X

Returns the text line ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical).

func (Instance) GetLineCount 

func (self Instance) GetLineCount() int

Returns number of lines in the paragraph.

func (Instance) GetLineDescent 

func (self Instance) GetLineDescent(line int) Float.X

Returns the text line descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical).

func (Instance) GetLineObjectRect 

func (self Instance) GetLineObjectRect(line int, key any) Rect2.PositionSize

Returns bounding rectangle of the inline object.

func (Instance) GetLineObjects 

func (self Instance) GetLineObjects(line int) []any

Returns array of inline objects in the line.

func (Instance) GetLineRange 

func (self Instance) GetLineRange(line int) Vector2i.XY

Returns character range of the line.

func (Instance) GetLineRid 

func (self Instance) GetLineRid(line int) RID.TextBuffer

Returns TextServer line buffer RID.

func (Instance) GetLineSize 

func (self Instance) GetLineSize(line int) Vector2.XY

Returns size of the bounding box of the line of text. Returned size is rounded up.

func (Instance) GetLineUnderlinePosition 

func (self Instance) GetLineUnderlinePosition(line int) Float.X

Returns pixel offset of the underline below the baseline.

func (Instance) GetLineUnderlineThickness 

func (self Instance) GetLineUnderlineThickness(line int) Float.X

Returns thickness of the underline.

func (Instance) GetLineWidth 

func (self Instance) GetLineWidth(line int) Float.X

Returns width (for horizontal layout) or height (for vertical) of the line of text.

func (Instance) GetNonWrappedSize 

func (self Instance) GetNonWrappedSize() Vector2.XY

Returns the size of the bounding box of the paragraph, without line breaks.

func (Instance) GetRid 

func (self Instance) GetRid() RID.TextBuffer

Returns TextServer full string buffer RID.

func (Instance) GetSize 

func (self Instance) GetSize() Vector2.XY

Returns the size of the bounding box of the paragraph.

func (Instance) HitTest 

func (self Instance) HitTest(coords Vector2.XY) int

Returns caret character offset at the specified coordinates. This function always returns a valid position.

func (Instance) JustificationFlags 

func (self Instance) JustificationFlags() gdclass.TextServerJustificationFlag

func (Instance) LineSpacing 

func (self Instance) LineSpacing() Float.X

func (Instance) MaxLinesVisible 

func (self Instance) MaxLinesVisible() int

func (Instance) Orientation 

func (self Instance) Orientation() gdclass.TextServerOrientation

func (Instance) PreserveControl 

func (self Instance) PreserveControl() bool

func (Instance) PreserveInvalid 

func (self Instance) PreserveInvalid() bool

func (Instance) ResizeObject 

func (self Instance) ResizeObject(key any, size Vector2.XY) bool

Sets new size and alignment of embedded object.

func (Instance) SetAlignment 

func (self Instance) SetAlignment(value HorizontalAlignment)

func (Instance) SetBidiOverride 

func (self Instance) SetBidiOverride(override []any)

Overrides BiDi for the structured text. Override ranges should cover full source text without overlaps. BiDi algorithm will be used on each range separately.

func (Instance) SetBreakFlags 

func (self Instance) SetBreakFlags(value gdclass.TextServerLineBreakFlag)

func (Instance) SetCustomPunctuation 

func (self Instance) SetCustomPunctuation(value string)

func (Instance) SetDirection 

func (self Instance) SetDirection(value gdclass.TextServerDirection)

func (Instance) SetDropcap 

func (self Instance) SetDropcap(text string, font [1]gdclass.Font, font_size int) bool

Sets drop cap, overrides previously set drop cap. Drop cap (dropped capital) is a decorative element at the beginning of a paragraph that is larger than the rest of the text.

func (Instance) SetEllipsisChar 

func (self Instance) SetEllipsisChar(value string)

func (Instance) SetJustificationFlags 

func (self Instance) SetJustificationFlags(value gdclass.TextServerJustificationFlag)

func (Instance) SetLineSpacing 

func (self Instance) SetLineSpacing(value Float.X)

func (Instance) SetMaxLinesVisible 

func (self Instance) SetMaxLinesVisible(value int)

func (Instance) SetOrientation 

func (self Instance) SetOrientation(value gdclass.TextServerOrientation)

func (Instance) SetPreserveControl 

func (self Instance) SetPreserveControl(value bool)

func (Instance) SetPreserveInvalid 

func (self Instance) SetPreserveInvalid(value bool)

func (Instance) SetTextOverrunBehavior 

func (self Instance) SetTextOverrunBehavior(value gdclass.TextServerOverrunBehavior)

func (Instance) SetWidth 

func (self Instance) SetWidth(value Float.X)

func (Instance) TabAlign 

func (self Instance) TabAlign(tab_stops []float32)

Aligns paragraph to the given tab-stops.

func (Instance) TextOverrunBehavior 

func (self Instance) TextOverrunBehavior() gdclass.TextServerOverrunBehavior

func (*Instance) UnsafePointer 

func (self *Instance) UnsafePointer() unsafe.Pointer

func (Instance) Virtual 

func (self Instance) Virtual(name string) reflect.Value

func (Instance) Width 

func (self Instance) Width() Float.X

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.