Documentation
¶
Overview ¶
Package TextParagraph provides methods for working with TextParagraph object instances.
Index ¶
- type Advanced
- type Any
- type Expanded
- func (self Expanded) AddObject(key any, size Vector2.XY, inline_align GUI.InlineAlignment, length int, ...) bool
- func (self Expanded) AddString(text string, font Font.Instance, font_size int, language string, meta any) bool
- func (self Expanded) Draw(canvas RID.Canvas, pos Vector2.XY, color Color.RGBA, dc_color Color.RGBA)
- func (self Expanded) DrawDropcap(canvas RID.Canvas, pos Vector2.XY, color Color.RGBA)
- func (self Expanded) DrawDropcapOutline(canvas RID.Canvas, pos Vector2.XY, outline_size int, color Color.RGBA)
- func (self Expanded) DrawLine(canvas RID.Canvas, pos Vector2.XY, line int, color Color.RGBA)
- func (self Expanded) DrawLineOutline(canvas RID.Canvas, pos Vector2.XY, line int, outline_size int, ...)
- func (self Expanded) DrawOutline(canvas RID.Canvas, pos Vector2.XY, outline_size int, color Color.RGBA, ...)
- func (self Expanded) ResizeObject(key any, size Vector2.XY, inline_align GUI.InlineAlignment, baseline Float.X) bool
- func (self Expanded) SetDropcap(text string, font Font.Instance, font_size int, ...) bool
- type Extension
- type ID
- type Instance
- func (self Instance) AddObject(key any, size Vector2.XY) bool
- func (self Instance) AddString(text string, font Font.Instance, font_size int) bool
- func (self Instance) Alignment() GUI.HorizontalAlignment
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsRefCounted() [1]gd.RefCounted
- func (self Instance) AsTextParagraph() Instance
- func (self Instance) BreakFlags() TextServer.LineBreakFlag
- func (self Instance) Clear()
- func (self Instance) ClearDropcap()
- func (self Instance) CustomPunctuation() string
- func (self Instance) Direction() TextServer.Direction
- func (self Instance) Draw(canvas RID.Canvas, pos Vector2.XY)
- func (self Instance) DrawDropcap(canvas RID.Canvas, pos Vector2.XY)
- func (self Instance) DrawDropcapOutline(canvas RID.Canvas, pos Vector2.XY)
- func (self Instance) DrawLine(canvas RID.Canvas, pos Vector2.XY, line int)
- func (self Instance) DrawLineOutline(canvas RID.Canvas, pos Vector2.XY, line int)
- func (self Instance) DrawOutline(canvas RID.Canvas, pos Vector2.XY)
- func (self Instance) EllipsisChar() string
- func (self Instance) GetDropcapLines() int
- func (self Instance) GetDropcapRid() RID.TextBuffer
- func (self Instance) GetDropcapSize() Vector2.XY
- func (self Instance) GetLineAscent(line int) Float.X
- func (self Instance) GetLineCount() int
- func (self Instance) GetLineDescent(line int) Float.X
- func (self Instance) GetLineObjectRect(line int, key any) Rect2.PositionSize
- func (self Instance) GetLineObjects(line int) []any
- func (self Instance) GetLineRange(line int) Vector2i.XY
- func (self Instance) GetLineRid(line int) RID.TextBuffer
- func (self Instance) GetLineSize(line int) Vector2.XY
- func (self Instance) GetLineUnderlinePosition(line int) Float.X
- func (self Instance) GetLineUnderlineThickness(line int) Float.X
- func (self Instance) GetLineWidth(line int) Float.X
- func (self Instance) GetNonWrappedSize() Vector2.XY
- func (self Instance) GetRid() RID.TextBuffer
- func (self Instance) GetSize() Vector2.XY
- func (self Instance) HitTest(coords Vector2.XY) int
- func (self Instance) ID() ID
- func (self Instance) JustificationFlags() TextServer.JustificationFlag
- func (self Instance) LineSpacing() Float.X
- func (self Instance) MaxLinesVisible() int
- func (self Instance) Orientation() TextServer.Orientation
- func (self Instance) PreserveControl() bool
- func (self Instance) PreserveInvalid() bool
- func (self Instance) ResizeObject(key any, size Vector2.XY) bool
- func (self Instance) SetAlignment(value GUI.HorizontalAlignment)
- func (self Instance) SetBidiOverride(override []any)
- func (self Instance) SetBreakFlags(value TextServer.LineBreakFlag)
- func (self Instance) SetCustomPunctuation(value string)
- func (self Instance) SetDirection(value TextServer.Direction)
- func (self Instance) SetDropcap(text string, font Font.Instance, font_size int) bool
- func (self Instance) SetEllipsisChar(value string)
- func (self Instance) SetJustificationFlags(value TextServer.JustificationFlag)
- func (self Instance) SetLineSpacing(value Float.X)
- func (self Instance) SetMaxLinesVisible(value int)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetOrientation(value TextServer.Orientation)
- func (self Instance) SetPreserveControl(value bool)
- func (self Instance) SetPreserveInvalid(value bool)
- func (self Instance) SetTextOverrunBehavior(value TextServer.OverrunBehavior)
- func (self Instance) SetWidth(value Float.X)
- func (self Instance) TabAlign(tab_stops []float32)
- func (self Instance) TextOverrunBehavior() TextServer.OverrunBehavior
- func (self Instance) Virtual(name string) reflect.Value
- func (self Instance) Width() Float.X
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 Expanded ¶
type Expanded [1]gdclass.TextParagraph
func (Expanded) AddObject ¶
func (self Expanded) AddObject(key any, size Vector2.XY, inline_align GUI.InlineAlignment, length int, baseline Float.X) 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 (Expanded) AddString ¶
func (self Expanded) AddString(text string, font Font.Instance, font_size int, language string, meta any) bool
Adds text span and font to draw it.
func (Expanded) Draw ¶
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 (Expanded) DrawDropcap ¶
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 (Expanded) DrawDropcapOutline ¶
func (self Expanded) DrawDropcapOutline(canvas RID.Canvas, pos Vector2.XY, outline_size int, color Color.RGBA)
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 (Expanded) DrawLine ¶
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 (Expanded) DrawLineOutline ¶
func (self Expanded) DrawLineOutline(canvas RID.Canvas, pos Vector2.XY, line int, outline_size int, color Color.RGBA)
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 (Expanded) DrawOutline ¶
func (self Expanded) DrawOutline(canvas RID.Canvas, pos Vector2.XY, outline_size int, color Color.RGBA, dc_color Color.RGBA)
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 (Expanded) ResizeObject ¶
func (self Expanded) ResizeObject(key any, size Vector2.XY, inline_align GUI.InlineAlignment, baseline Float.X) bool
Sets new size and alignment of embedded object.
func (Expanded) SetDropcap ¶
func (self Expanded) SetDropcap(text string, font Font.Instance, font_size int, dropcap_margins Rect2.PositionSize, language string) 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.
type Extension ¶
Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension
func (*Extension[T]) AsRefCounted ¶
func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
func (*Extension[T]) AsTextParagraph ¶
type ID ¶
ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.
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 (Instance) AddObject ¶
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) Alignment ¶
func (self Instance) Alignment() GUI.HorizontalAlignment
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
func (Instance) AsTextParagraph ¶
func (Instance) BreakFlags ¶
func (self Instance) BreakFlags() TextServer.LineBreakFlag
func (Instance) Clear ¶
func (self Instance) Clear()
Clears text paragraph (removes text and inline objects).
func (Instance) CustomPunctuation ¶
func (Instance) Direction ¶
func (self Instance) Direction() TextServer.Direction
func (Instance) Draw ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 (Instance) GetDropcapLines ¶
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 ¶
Returns drop cap bounding box size.
func (Instance) GetLineAscent ¶
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 ¶
Returns number of lines in the paragraph.
func (Instance) GetLineDescent ¶
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 ¶
Returns array of inline objects in the line.
func (Instance) GetLineRange ¶
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 ¶
Returns size of the bounding box of the line of text. Returned size is rounded up.
func (Instance) GetLineUnderlinePosition ¶
Returns pixel offset of the underline below the baseline.
func (Instance) GetLineUnderlineThickness ¶
Returns thickness of the underline.
func (Instance) GetLineWidth ¶
Returns width (for horizontal layout) or height (for vertical) of the line of text.
func (Instance) GetNonWrappedSize ¶
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) HitTest ¶
Returns caret character offset at the specified coordinates. This function always returns a valid position.
func (Instance) JustificationFlags ¶
func (self Instance) JustificationFlags() TextServer.JustificationFlag
func (Instance) LineSpacing ¶
func (Instance) MaxLinesVisible ¶
func (Instance) Orientation ¶
func (self Instance) Orientation() TextServer.Orientation
func (Instance) PreserveControl ¶
func (Instance) PreserveInvalid ¶
func (Instance) ResizeObject ¶
Sets new size and alignment of embedded object.
func (Instance) SetAlignment ¶
func (self Instance) SetAlignment(value GUI.HorizontalAlignment)
func (Instance) SetBidiOverride ¶
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 TextServer.LineBreakFlag)
func (Instance) SetCustomPunctuation ¶
func (Instance) SetDirection ¶
func (self Instance) SetDirection(value TextServer.Direction)
func (Instance) SetDropcap ¶
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 (Instance) SetJustificationFlags ¶
func (self Instance) SetJustificationFlags(value TextServer.JustificationFlag)
func (Instance) SetLineSpacing ¶
func (Instance) SetMaxLinesVisible ¶
func (Instance) SetOrientation ¶
func (self Instance) SetOrientation(value TextServer.Orientation)
func (Instance) SetPreserveControl ¶
func (Instance) SetPreserveInvalid ¶
func (Instance) SetTextOverrunBehavior ¶
func (self Instance) SetTextOverrunBehavior(value TextServer.OverrunBehavior)
func (Instance) TextOverrunBehavior ¶
func (self Instance) TextOverrunBehavior() TextServer.OverrunBehavior
Source Files