Table of Contents

Class TextView

Namespace
Gtk
Assembly
Gtk-4.0.dll
public class TextView : Widget, IObject, INotifyPropertyChanged, IDisposable, Accessible, AccessibleText, Buildable, ConstraintTarget, Scrollable, IHandle, GTypeProvider
Inheritance
TextView
Implements
Derived
Inherited Members

Constructors

TextView()

public TextView()

TextView(params ConstructArgument[])

protected TextView(params ConstructArgument[] constructArguments)

Parameters

constructArguments ConstructArgument[]

TextView(IntPtr, bool)

protected TextView(IntPtr ptr, bool ownedRef)

Parameters

ptr IntPtr
ownedRef bool

Fields

AcceptsTabPropertyDefinition

public static readonly Property<bool, TextView> AcceptsTabPropertyDefinition

Field Value

Property<bool, TextView>

BackspaceSignal

Signal Descriptor for OnBackspace.

public static readonly Signal<TextView> BackspaceSignal

Field Value

Signal<TextView>

BottomMarginPropertyDefinition

public static readonly Property<int, TextView> BottomMarginPropertyDefinition

Field Value

Property<int, TextView>

BufferPropertyDefinition

public static readonly Property<TextBuffer?, TextView> BufferPropertyDefinition

Field Value

Property<TextBuffer, TextView>

CopyClipboardSignal

Signal Descriptor for OnCopyClipboard.

public static readonly Signal<TextView> CopyClipboardSignal

Field Value

Signal<TextView>

CursorVisiblePropertyDefinition

public static readonly Property<bool, TextView> CursorVisiblePropertyDefinition

Field Value

Property<bool, TextView>

CutClipboardSignal

Signal Descriptor for OnCutClipboard.

public static readonly Signal<TextView> CutClipboardSignal

Field Value

Signal<TextView>

DeleteFromCursorSignal

Signal Descriptor for OnDeleteFromCursor.

public static readonly Signal<TextView, TextView.DeleteFromCursorSignalArgs> DeleteFromCursorSignal

Field Value

Signal<TextView, TextView.DeleteFromCursorSignalArgs>

EditablePropertyDefinition

public static readonly Property<bool, TextView> EditablePropertyDefinition

Field Value

Property<bool, TextView>

ExtendSelectionSignal

Signal Descriptor for OnExtendSelection.

public static readonly ReturningSignal<TextView, TextView.ExtendSelectionSignalArgs, bool> ExtendSelectionSignal

Field Value

ReturningSignal<TextView, TextView.ExtendSelectionSignalArgs, bool>

ExtraMenuPropertyDefinition

public static readonly Property<MenuModel?, TextView> ExtraMenuPropertyDefinition

Field Value

Property<MenuModel, TextView>

ImModulePropertyDefinition

public static readonly Property<string?, TextView> ImModulePropertyDefinition

Field Value

Property<string, TextView>

IndentPropertyDefinition

public static readonly Property<int, TextView> IndentPropertyDefinition

Field Value

Property<int, TextView>

InputHintsPropertyDefinition

public static readonly Property<InputHints, TextView> InputHintsPropertyDefinition

Field Value

Property<InputHints, TextView>

InputPurposePropertyDefinition

public static readonly Property<InputPurpose, TextView> InputPurposePropertyDefinition

Field Value

Property<InputPurpose, TextView>

InsertAtCursorSignal

Signal Descriptor for OnInsertAtCursor.

public static readonly Signal<TextView, TextView.InsertAtCursorSignalArgs> InsertAtCursorSignal

Field Value

Signal<TextView, TextView.InsertAtCursorSignalArgs>

InsertEmojiSignal

Signal Descriptor for OnInsertEmoji.

public static readonly Signal<TextView> InsertEmojiSignal

Field Value

Signal<TextView>

JustificationPropertyDefinition

public static readonly Property<Justification, TextView> JustificationPropertyDefinition

Field Value

Property<Justification, TextView>

LeftMarginPropertyDefinition

public static readonly Property<int, TextView> LeftMarginPropertyDefinition

Field Value

Property<int, TextView>

MonospacePropertyDefinition

public static readonly Property<bool, TextView> MonospacePropertyDefinition

Field Value

Property<bool, TextView>

MoveCursorSignal

Signal Descriptor for OnMoveCursor.

public static readonly Signal<TextView, TextView.MoveCursorSignalArgs> MoveCursorSignal

Field Value

Signal<TextView, TextView.MoveCursorSignalArgs>

MoveViewportSignal

Signal Descriptor for OnMoveViewport.

public static readonly Signal<TextView, TextView.MoveViewportSignalArgs> MoveViewportSignal

Field Value

Signal<TextView, TextView.MoveViewportSignalArgs>

OverwritePropertyDefinition

public static readonly Property<bool, TextView> OverwritePropertyDefinition

Field Value

Property<bool, TextView>

PasteClipboardSignal

Signal Descriptor for OnPasteClipboard.

public static readonly Signal<TextView> PasteClipboardSignal

Field Value

Signal<TextView>

PixelsAboveLinesPropertyDefinition

public static readonly Property<int, TextView> PixelsAboveLinesPropertyDefinition

Field Value

Property<int, TextView>

PixelsBelowLinesPropertyDefinition

public static readonly Property<int, TextView> PixelsBelowLinesPropertyDefinition

Field Value

Property<int, TextView>

PixelsInsideWrapPropertyDefinition

public static readonly Property<int, TextView> PixelsInsideWrapPropertyDefinition

Field Value

Property<int, TextView>

PreeditChangedSignal

Signal Descriptor for OnPreeditChanged.

public static readonly Signal<TextView, TextView.PreeditChangedSignalArgs> PreeditChangedSignal

Field Value

Signal<TextView, TextView.PreeditChangedSignalArgs>

RightMarginPropertyDefinition

public static readonly Property<int, TextView> RightMarginPropertyDefinition

Field Value

Property<int, TextView>

SelectAllSignal

Signal Descriptor for OnSelectAll.

public static readonly Signal<TextView, TextView.SelectAllSignalArgs> SelectAllSignal

Field Value

Signal<TextView, TextView.SelectAllSignalArgs>

SetAnchorSignal

Signal Descriptor for OnSetAnchor.

public static readonly Signal<TextView> SetAnchorSignal

Field Value

Signal<TextView>

TabsPropertyDefinition

public static readonly Property<TabArray, TextView> TabsPropertyDefinition

Field Value

Property<TabArray, TextView>

ToggleCursorVisibleSignal

Signal Descriptor for OnToggleCursorVisible.

public static readonly Signal<TextView> ToggleCursorVisibleSignal

Field Value

Signal<TextView>

ToggleOverwriteSignal

Signal Descriptor for OnToggleOverwrite.

public static readonly Signal<TextView> ToggleOverwriteSignal

Field Value

Signal<TextView>

TopMarginPropertyDefinition

public static readonly Property<int, TextView> TopMarginPropertyDefinition

Field Value

Property<int, TextView>

WrapModePropertyDefinition

public static readonly Property<WrapMode, TextView> WrapModePropertyDefinition

Field Value

Property<WrapMode, TextView>

Properties

AcceptsTab

public bool AcceptsTab { get; set; }

Property Value

bool

AccessibleRole

public AccessibleRole AccessibleRole { get; set; }

Property Value

AccessibleRole

BottomMargin

public int BottomMargin { get; set; }

Property Value

int

Buffer

public TextBuffer? Buffer { get; set; }

Property Value

TextBuffer

CursorVisible

public bool CursorVisible { get; set; }

Property Value

bool

Editable

public bool Editable { get; set; }

Property Value

bool

ExtraMenu

public MenuModel? ExtraMenu { get; set; }

Property Value

MenuModel

Hadjustment

public Adjustment? Hadjustment { get; set; }

Property Value

Adjustment

HscrollPolicy

public ScrollablePolicy HscrollPolicy { get; set; }

Property Value

ScrollablePolicy

ImModule

public string? ImModule { get; set; }

Property Value

string

Indent

public int Indent { get; set; }

Property Value

int

InputHints

public InputHints InputHints { get; set; }

Property Value

InputHints

InputPurpose

public InputPurpose InputPurpose { get; set; }

Property Value

InputPurpose

Justification

public Justification Justification { get; set; }

Property Value

Justification

LeftMargin

public int LeftMargin { get; set; }

Property Value

int

Monospace

public bool Monospace { get; set; }

Property Value

bool

Overwrite

public bool Overwrite { get; set; }

Property Value

bool

PixelsAboveLines

public int PixelsAboveLines { get; set; }

Property Value

int

PixelsBelowLines

public int PixelsBelowLines { get; set; }

Property Value

int

PixelsInsideWrap

public int PixelsInsideWrap { get; set; }

Property Value

int

RightMargin

public int RightMargin { get; set; }

Property Value

int

Tabs

public TabArray Tabs { get; set; }

Property Value

TabArray

TopMargin

public int TopMargin { get; set; }

Property Value

int

Vadjustment

public Adjustment? Vadjustment { get; set; }

Property Value

Adjustment

VscrollPolicy

public ScrollablePolicy VscrollPolicy { get; set; }

Property Value

ScrollablePolicy

WrapMode

public WrapMode WrapMode { get; set; }

Property Value

WrapMode

Methods

AddChildAtAnchor(Widget, TextChildAnchor)

public void AddChildAtAnchor(Widget child, TextChildAnchor anchor)

Parameters

child Widget
anchor TextChildAnchor

AddOverlay(Widget, int, int)

public void AddOverlay(Widget child, int xpos, int ypos)

Parameters

child Widget
xpos int
ypos int

Announce(string, AccessibleAnnouncementPriority)

[Version("4.14")]
public void Announce(string message, AccessibleAnnouncementPriority priority)

Parameters

message string
priority AccessibleAnnouncementPriority

BackwardDisplayLine(TextIter)

public bool BackwardDisplayLine(TextIter iter)

Parameters

iter TextIter

Returns

bool

BackwardDisplayLineStart(TextIter)

public bool BackwardDisplayLineStart(TextIter iter)

Parameters

iter TextIter

Returns

bool

BufferToWindowCoords(TextWindowType, int, int, out int, out int)

public void BufferToWindowCoords(TextWindowType win, int bufferX, int bufferY, out int windowX, out int windowY)

Parameters

win TextWindowType
bufferX int
bufferY int
windowX int
windowY int

ForwardDisplayLine(TextIter)

public bool ForwardDisplayLine(TextIter iter)

Parameters

iter TextIter

Returns

bool

ForwardDisplayLineEnd(TextIter)

public bool ForwardDisplayLineEnd(TextIter iter)

Parameters

iter TextIter

Returns

bool

GetAcceptsTab()

public bool GetAcceptsTab()

Returns

bool

GetAccessibleParent()

[Version("4.10")]
public Accessible? GetAccessibleParent()

Returns

Accessible

GetAccessibleRole()

public AccessibleRole GetAccessibleRole()

Returns

AccessibleRole

GetAtContext()

[Version("4.10")]
public ATContext GetAtContext()

Returns

ATContext

GetBottomMargin()

public int GetBottomMargin()

Returns

int

GetBounds(out int, out int, out int, out int)

[Version("4.10")]
public bool GetBounds(out int x, out int y, out int width, out int height)

Parameters

x int
y int
width int
height int

Returns

bool

GetBuffer()

public TextBuffer GetBuffer()

Returns

TextBuffer

GetBuildableId()

public string? GetBuildableId()

Returns

string

GetCursorVisible()

public bool GetCursorVisible()

Returns

bool

GetEditable()

public bool GetEditable()

Returns

bool

GetExtraMenu()

public MenuModel GetExtraMenu()

Returns

MenuModel

GetFirstAccessibleChild()

[Version("4.10")]
public Accessible? GetFirstAccessibleChild()

Returns

Accessible

GetGType()

public static Type GetGType()

Returns

Type

GetGutter(TextWindowType)

public Widget? GetGutter(TextWindowType win)

Parameters

win TextWindowType

Returns

Widget

GetHadjustment()

public Adjustment? GetHadjustment()

Returns

Adjustment

GetHscrollPolicy()

public ScrollablePolicy GetHscrollPolicy()

Returns

ScrollablePolicy

GetIndent()

public int GetIndent()

Returns

int

GetInputHints()

public InputHints GetInputHints()

Returns

InputHints

GetInputPurpose()

public InputPurpose GetInputPurpose()

Returns

InputPurpose

GetJustification()

public Justification GetJustification()

Returns

Justification

GetLeftMargin()

public int GetLeftMargin()

Returns

int

GetLineYrange(TextIter, out int, out int)

public void GetLineYrange(TextIter iter, out int y, out int height)

Parameters

iter TextIter
y int
height int

GetLtrContext()

[Version("4.4")]
public Context GetLtrContext()

Returns

Context

GetMonospace()

public bool GetMonospace()

Returns

bool

GetNextAccessibleSibling()

[Version("4.10")]
public Accessible? GetNextAccessibleSibling()

Returns

Accessible

GetOverwrite()

public bool GetOverwrite()

Returns

bool

GetPixelsAboveLines()

public int GetPixelsAboveLines()

Returns

int

GetPixelsBelowLines()

public int GetPixelsBelowLines()

Returns

int

GetPixelsInsideWrap()

public int GetPixelsInsideWrap()

Returns

int

GetPlatformState(AccessiblePlatformState)

[Version("4.10")]
public bool GetPlatformState(AccessiblePlatformState state)

Parameters

state AccessiblePlatformState

Returns

bool

GetRightMargin()

public int GetRightMargin()

Returns

int

GetRtlContext()

[Version("4.4")]
public Context GetRtlContext()

Returns

Context

GetTabs()

public TabArray? GetTabs()

Returns

TabArray

GetTopMargin()

public int GetTopMargin()

Returns

int

GetVadjustment()

public Adjustment? GetVadjustment()

Returns

Adjustment

GetVscrollPolicy()

public ScrollablePolicy GetVscrollPolicy()

Returns

ScrollablePolicy

GetWrapMode()

public WrapMode GetWrapMode()

Returns

WrapMode

ImContextFilterKeypress(Event)

public bool ImContextFilterKeypress(Event @event)

Parameters

event Event

Returns

bool

MoveMarkOnscreen(TextMark)

public bool MoveMarkOnscreen(TextMark mark)

Parameters

mark TextMark

Returns

bool

MoveOverlay(Widget, int, int)

public void MoveOverlay(Widget child, int xpos, int ypos)

Parameters

child Widget
xpos int
ypos int

MoveVisually(TextIter, int)

public bool MoveVisually(TextIter iter, int count)

Parameters

iter TextIter
count int

Returns

bool

New()

public static TextView New()

Returns

TextView

NewWithBuffer(TextBuffer)

public static TextView NewWithBuffer(TextBuffer buffer)

Parameters

buffer TextBuffer

Returns

TextView

PlaceCursorOnscreen()

public bool PlaceCursorOnscreen()

Returns

bool

Remove(Widget)

public void Remove(Widget child)

Parameters

child Widget
public void ResetCursorBlink()

ResetImContext()

public void ResetImContext()

ResetProperty(AccessibleProperty)

public void ResetProperty(AccessibleProperty property)

Parameters

property AccessibleProperty

ResetRelation(AccessibleRelation)

public void ResetRelation(AccessibleRelation relation)

Parameters

relation AccessibleRelation

ResetState(AccessibleState)

public void ResetState(AccessibleState state)

Parameters

state AccessibleState

ScrollMarkOnscreen(TextMark)

public void ScrollMarkOnscreen(TextMark mark)

Parameters

mark TextMark

ScrollToIter(TextIter, double, bool, double, double)

public bool ScrollToIter(TextIter iter, double withinMargin, bool useAlign, double xalign, double yalign)

Parameters

iter TextIter
withinMargin double
useAlign bool
xalign double
yalign double

Returns

bool

ScrollToMark(TextMark, double, bool, double, double)

public void ScrollToMark(TextMark mark, double withinMargin, bool useAlign, double xalign, double yalign)

Parameters

mark TextMark
withinMargin double
useAlign bool
xalign double
yalign double

SetAcceptsTab(bool)

public void SetAcceptsTab(bool acceptsTab)

Parameters

acceptsTab bool

SetAccessibleParent(Accessible?, Accessible?)

[Version("4.10")]
public void SetAccessibleParent(Accessible? parent, Accessible? nextSibling)

Parameters

parent Accessible
nextSibling Accessible

SetBottomMargin(int)

public void SetBottomMargin(int bottomMargin)

Parameters

bottomMargin int

SetBuffer(TextBuffer?)

public void SetBuffer(TextBuffer? buffer)

Parameters

buffer TextBuffer

SetCursorVisible(bool)

public void SetCursorVisible(bool setting)

Parameters

setting bool

SetEditable(bool)

public void SetEditable(bool setting)

Parameters

setting bool

SetExtraMenu(MenuModel?)

public void SetExtraMenu(MenuModel? model)

Parameters

model MenuModel

SetGutter(TextWindowType, Widget?)

public void SetGutter(TextWindowType win, Widget? widget)

Parameters

win TextWindowType
widget Widget

SetHadjustment(Adjustment?)

public void SetHadjustment(Adjustment? hadjustment)

Parameters

hadjustment Adjustment

SetHscrollPolicy(ScrollablePolicy)

public void SetHscrollPolicy(ScrollablePolicy policy)

Parameters

policy ScrollablePolicy

SetIndent(int)

public void SetIndent(int indent)

Parameters

indent int

SetInputHints(InputHints)

public void SetInputHints(InputHints hints)

Parameters

hints InputHints

SetInputPurpose(InputPurpose)

public void SetInputPurpose(InputPurpose purpose)

Parameters

purpose InputPurpose

SetJustification(Justification)

public void SetJustification(Justification justification)

Parameters

justification Justification

SetLeftMargin(int)

public void SetLeftMargin(int leftMargin)

Parameters

leftMargin int

SetMonospace(bool)

public void SetMonospace(bool monospace)

Parameters

monospace bool

SetOverwrite(bool)

public void SetOverwrite(bool overwrite)

Parameters

overwrite bool

SetPixelsAboveLines(int)

public void SetPixelsAboveLines(int pixelsAboveLines)

Parameters

pixelsAboveLines int

SetPixelsBelowLines(int)

public void SetPixelsBelowLines(int pixelsBelowLines)

Parameters

pixelsBelowLines int

SetPixelsInsideWrap(int)

public void SetPixelsInsideWrap(int pixelsInsideWrap)

Parameters

pixelsInsideWrap int

SetRightMargin(int)

public void SetRightMargin(int rightMargin)

Parameters

rightMargin int

SetTabs(TabArray)

public void SetTabs(TabArray tabs)

Parameters

tabs TabArray

SetTopMargin(int)

public void SetTopMargin(int topMargin)

Parameters

topMargin int

SetVadjustment(Adjustment?)

public void SetVadjustment(Adjustment? vadjustment)

Parameters

vadjustment Adjustment

SetVscrollPolicy(ScrollablePolicy)

public void SetVscrollPolicy(ScrollablePolicy policy)

Parameters

policy ScrollablePolicy

SetWrapMode(WrapMode)

public void SetWrapMode(WrapMode wrapMode)

Parameters

wrapMode WrapMode

StartsDisplayLine(TextIter)

public bool StartsDisplayLine(TextIter iter)

Parameters

iter TextIter

Returns

bool

UpdateCaretPosition()

[Version("4.14")]
public void UpdateCaretPosition()

UpdateContents(AccessibleTextContentChange, uint, uint)

[Version("4.14")]
public void UpdateContents(AccessibleTextContentChange change, uint start, uint end)

Parameters

change AccessibleTextContentChange
start uint
end uint

UpdateNextAccessibleSibling(Accessible?)

[Version("4.10")]
public void UpdateNextAccessibleSibling(Accessible? newSibling)

Parameters

newSibling Accessible

UpdateSelectionBound()

[Version("4.14")]
public void UpdateSelectionBound()

WindowToBufferCoords(TextWindowType, int, int, out int, out int)

public void WindowToBufferCoords(TextWindowType win, int windowX, int windowY, out int bufferX, out int bufferY)

Parameters

win TextWindowType
windowX int
windowY int
bufferX int
bufferY int

Events

OnBackspace

public event SignalHandler<TextView> OnBackspace

Event Type

SignalHandler<TextView>

OnCopyClipboard

public event SignalHandler<TextView> OnCopyClipboard

Event Type

SignalHandler<TextView>

OnCutClipboard

public event SignalHandler<TextView> OnCutClipboard

Event Type

SignalHandler<TextView>

OnDeleteFromCursor

public event SignalHandler<TextView, TextView.DeleteFromCursorSignalArgs> OnDeleteFromCursor

Event Type

SignalHandler<TextView, TextView.DeleteFromCursorSignalArgs>

OnExtendSelection

public event ReturningSignalHandler<TextView, TextView.ExtendSelectionSignalArgs, bool> OnExtendSelection

Event Type

ReturningSignalHandler<TextView, TextView.ExtendSelectionSignalArgs, bool>

OnInsertAtCursor

public event SignalHandler<TextView, TextView.InsertAtCursorSignalArgs> OnInsertAtCursor

Event Type

SignalHandler<TextView, TextView.InsertAtCursorSignalArgs>

OnInsertEmoji

public event SignalHandler<TextView> OnInsertEmoji

Event Type

SignalHandler<TextView>

OnMoveCursor

public event SignalHandler<TextView, TextView.MoveCursorSignalArgs> OnMoveCursor

Event Type

SignalHandler<TextView, TextView.MoveCursorSignalArgs>

OnMoveViewport

public event SignalHandler<TextView, TextView.MoveViewportSignalArgs> OnMoveViewport

Event Type

SignalHandler<TextView, TextView.MoveViewportSignalArgs>

OnPasteClipboard

public event SignalHandler<TextView> OnPasteClipboard

Event Type

SignalHandler<TextView>

OnPreeditChanged

public event SignalHandler<TextView, TextView.PreeditChangedSignalArgs> OnPreeditChanged

Event Type

SignalHandler<TextView, TextView.PreeditChangedSignalArgs>

OnSelectAll

public event SignalHandler<TextView, TextView.SelectAllSignalArgs> OnSelectAll

Event Type

SignalHandler<TextView, TextView.SelectAllSignalArgs>

OnSetAnchor

public event SignalHandler<TextView> OnSetAnchor

Event Type

SignalHandler<TextView>

OnToggleCursorVisible

public event SignalHandler<TextView> OnToggleCursorVisible

Event Type

SignalHandler<TextView>

OnToggleOverwrite

public event SignalHandler<TextView> OnToggleOverwrite

Event Type

SignalHandler<TextView>