Class Viewport

Namespace

Gtk

Assembly

Gtk-4.0.dll

public class Viewport : Widget, Accessible, Buildable, ConstraintTarget, Scrollable, NativeObject, IDisposable, GTypeProvider, InstanceFactory

Inheritance

object

Object

InitiallyUnowned

Widget

Viewport

Implements

Accessible

Buildable

ConstraintTarget

Scrollable

NativeObject

IDisposable

GTypeProvider

InstanceFactory

Inherited Members

Widget.GetDefaultDirection()

Widget.SetDefaultDirection(TextDirection)

Widget.ActionSetEnabled(string, bool)

Widget.Activate()

Widget.ActivateAction(string, Variant)

Widget.ActivateDefault()

Widget.AddController(EventController)

Widget.AddCssClass(string)

Widget.AddMnemonicLabel(Widget)

Widget.AddTickCallback(TickCallback)

Widget.Allocate(int, int, int, Transform)

Widget.ChildFocus(DirectionType)

Widget.ComputeBounds(Widget, out Rect)

Widget.ComputeExpand(Orientation)

Widget.ComputePoint(Widget, Point, out Point)

Widget.ComputeTransform(Widget, out Matrix)

Widget.Contains(double, double)

Widget.CreatePangoContext()

Widget.CreatePangoLayout(string)

Widget.DisposeTemplate(Type)

Widget.DragCheckThreshold(int, int, int, int)

Widget.ErrorBell()

Widget.GetAllocatedBaseline()

Widget.GetAllocatedHeight()

Widget.GetAllocatedWidth()

Widget.GetAncestor(Type)

Widget.GetBaseline()

Widget.GetCanFocus()

Widget.GetCanTarget()

Widget.GetChildVisible()

Widget.GetClipboard()

Widget.GetColor(out RGBA)

Widget.GetCssClasses()

Widget.GetCssName()

Widget.GetCursor()

Widget.GetDirection()

Widget.GetDisplay()

Widget.GetFirstChild()

Widget.GetFocusChild()

Widget.GetFocusOnClick()

Widget.GetFocusable()

Widget.GetFontMap()

Widget.GetFontOptions()

Widget.GetFrameClock()

Widget.GetHalign()

Widget.GetHasTooltip()

Widget.GetHeight()

Widget.GetHexpand()

Widget.GetHexpandSet()

Widget.GetLastChild()

Widget.GetLayoutManager()

Widget.GetLimitEvents()

Widget.GetMapped()

Widget.GetMarginBottom()

Widget.GetMarginEnd()

Widget.GetMarginStart()

Widget.GetMarginTop()

Widget.GetName()

Widget.GetNative()

Widget.GetNextSibling()

Widget.GetOpacity()

Widget.GetOverflow()

Widget.GetPangoContext()

Widget.GetParent()

Widget.GetPreferredSize(out Requisition, out Requisition)

Widget.GetPrevSibling()

Widget.GetPrimaryClipboard()

Widget.GetRealized()

Widget.GetReceivesDefault()

Widget.GetRequestMode()

Widget.GetRoot()

Widget.GetScaleFactor()

Widget.GetSensitive()

Widget.GetSettings()

Widget.GetSize(Orientation)

Widget.GetSizeRequest(out int, out int)

Widget.GetStateFlags()

Widget.GetStyleContext()

Widget.GetTemplateChild(Type, string)

Widget.GetTooltipMarkup()

Widget.GetTooltipText()

Widget.GetValign()

Widget.GetVexpand()

Widget.GetVexpandSet()

Widget.GetVisible()

Widget.GetWidth()

Widget.GrabFocus()

Widget.HasCssClass(string)

Widget.GetHasDefault()

Widget.GetHasFocus()

Widget.HasVisibleFocus()

Widget.Hide()

Widget.InDestruction()

Widget.InitTemplate()

Widget.InsertActionGroup(string, ActionGroup)

Widget.InsertAfter(Widget, Widget)

Widget.InsertBefore(Widget, Widget)

Widget.IsAncestor(Widget)

Widget.IsDrawable()

Widget.IsFocus()

Widget.IsSensitive()

Widget.IsVisible()

Widget.KeynavFailed(DirectionType)

Widget.Map()

Widget.Measure(Orientation, int, out int, out int, out int, out int)

Widget.MnemonicActivate(bool)

Widget.ObserveChildren()

Widget.ObserveControllers()

Widget.Pick(double, double, PickFlags)

Widget.QueueAllocate()

Widget.QueueDraw()

Widget.QueueResize()

Widget.Realize()

Widget.RemoveController(EventController)

Widget.RemoveCssClass(string)

Widget.RemoveMnemonicLabel(Widget)

Widget.RemoveTickCallback(uint)

Widget.SetCanFocus(bool)

Widget.SetCanTarget(bool)

Widget.SetChildVisible(bool)

Widget.SetCssClasses(string[])

Widget.SetCursor(Cursor)

Widget.SetCursorFromName(string)

Widget.SetDirection(TextDirection)

Widget.SetFocusChild(Widget)

Widget.SetFocusOnClick(bool)

Widget.SetFocusable(bool)

Widget.SetFontMap(FontMap)

Widget.SetFontOptions(FontOptions)

Widget.SetHalign(Align)

Widget.SetHasTooltip(bool)

Widget.SetHexpand(bool)

Widget.SetHexpandSet(bool)

Widget.SetLayoutManager(LayoutManager)

Widget.SetLimitEvents(bool)

Widget.SetMarginBottom(int)

Widget.SetMarginEnd(int)

Widget.SetMarginStart(int)

Widget.SetMarginTop(int)

Widget.SetName(string)

Widget.SetOpacity(double)

Widget.SetOverflow(Overflow)

Widget.SetParent(Widget)

Widget.SetReceivesDefault(bool)

Widget.SetSensitive(bool)

Widget.SetSizeRequest(int, int)

Widget.SetStateFlags(StateFlags, bool)

Widget.SetTooltipMarkup(string)

Widget.SetTooltipText(string)

Widget.SetValign(Align)

Widget.SetVexpand(bool)

Widget.SetVexpandSet(bool)

Widget.SetVisible(bool)

Widget.ShouldLayout()

Widget.Show()

Widget.SnapshotChild(Widget, Snapshot)

Widget.TranslateCoordinates(Widget, double, double, out double, out double)

Widget.TriggerTooltipQuery()

Widget.Unmap()

Widget.Unparent()

Widget.Unrealize()

Widget.UnsetStateFlags(StateFlags)

Widget.CanFocusPropertyDefinition

Widget.CanFocus

Widget.CanTargetPropertyDefinition

Widget.CanTarget

Widget.CssClassesPropertyDefinition

Widget.CssClasses

Widget.CssNamePropertyDefinition

Widget.CssName

Widget.CursorPropertyDefinition

Widget.Cursor

Widget.FocusOnClickPropertyDefinition

Widget.FocusOnClick

Widget.FocusablePropertyDefinition

Widget.Focusable

Widget.HalignPropertyDefinition

Widget.Halign

Widget.HasDefaultPropertyDefinition

Widget.HasDefault

Widget.HasFocusPropertyDefinition

Widget.HasFocus

Widget.HasTooltipPropertyDefinition

Widget.HasTooltip

Widget.HeightRequestPropertyDefinition

Widget.HeightRequest

Widget.HexpandPropertyDefinition

Widget.Hexpand

Widget.HexpandSetPropertyDefinition

Widget.HexpandSet

Widget.LayoutManagerPropertyDefinition

Widget.LayoutManager

Widget.LimitEventsPropertyDefinition

Widget.LimitEvents

Widget.MarginBottomPropertyDefinition

Widget.MarginBottom

Widget.MarginEndPropertyDefinition

Widget.MarginEnd

Widget.MarginStartPropertyDefinition

Widget.MarginStart

Widget.MarginTopPropertyDefinition

Widget.MarginTop

Widget.NamePropertyDefinition

Widget.Name

Widget.OpacityPropertyDefinition

Widget.Opacity

Widget.OverflowPropertyDefinition

Widget.Overflow

Widget.ParentPropertyDefinition

Widget.Parent

Widget.ReceivesDefaultPropertyDefinition

Widget.ReceivesDefault

Widget.RootPropertyDefinition

Widget.Root

Widget.ScaleFactorPropertyDefinition

Widget.ScaleFactor

Widget.SensitivePropertyDefinition

Widget.Sensitive

Widget.TooltipMarkupPropertyDefinition

Widget.TooltipMarkup

Widget.TooltipTextPropertyDefinition

Widget.TooltipText

Widget.ValignPropertyDefinition

Widget.Valign

Widget.VexpandPropertyDefinition

Widget.Vexpand

Widget.VexpandSetPropertyDefinition

Widget.VexpandSet

Widget.VisiblePropertyDefinition

Widget.Visible

Widget.WidthRequestPropertyDefinition

Widget.WidthRequest

Widget.DestroySignal

Widget.OnDestroy

Widget.DirectionChangedSignal

Widget.OnDirectionChanged

Widget.HideSignal

Widget.OnHide

Widget.KeynavFailedSignal

Widget.OnKeynavFailed

Widget.MapSignal

Widget.OnMap

Widget.MnemonicActivateSignal

Widget.OnMnemonicActivate

Widget.MoveFocusSignal

Widget.OnMoveFocus

Widget.QueryTooltipSignal

Widget.OnQueryTooltip

Widget.RealizeSignal

Widget.OnRealize

Widget.ShowSignal

Widget.OnShow

Widget.StateFlagsChangedSignal

Widget.OnStateFlagsChanged

Widget.UnmapSignal

Widget.OnUnmap

Widget.UnrealizeSignal

Widget.OnUnrealize

Object.Handle

Object.Dispose()

Object.CompatControl(nuint, nint)

Object.InterfaceFindProperty(TypeInterface, string)

Object.InterfaceInstallProperty(TypeInterface, ParamSpec)

Object.AddWeakPointer(ref nint)

Object.BindProperty(string, Object, string, BindingFlags)

Object.BindPropertyFull(string, Object, string, BindingFlags, Closure, Closure)

Object.ForceFloating()

Object.FreezeNotify()

Object.GetData(string)

Object.GetProperty(string, Value)

Object.GetQdata(Quark)

Object.GetValist(string, nint)

Object.Getv(string[], Value[])

Object.IsFloating()

Object.Notify(string)

Object.NotifyByPspec(ParamSpec)

Object.Ref()

Object.RefSink()

Object.RemoveWeakPointer(ref nint)

Object.RunDispose()

Object.SetData(string, nint)

Object.SetProperty(string, Value)

Object.SetQdata(Quark, nint)

Object.SetValist(string, nint)

Object.Setv(string[], Value[])

Object.StealData(string)

Object.StealQdata(Quark)

Object.TakeRef()

Object.ThawNotify()

Object.Unref()

Object.WatchClosure(Closure)

Object.NotifySignal

Object.OnNotify

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Viewport(params ConstructArgument[])

[Obsolete("Regular C# constructors on native classes will be removed in a future version. Please see the linked documentation for more details. It contains scenarios and possible solutions to prepare for the upcoming changes.", DiagnosticId = "GirCore1007", UrlFormat = "https://gircore.github.io/docs/integration/diagnostic/1007.html")]
public Viewport(params ConstructArgument[] constructArguments)

Parameters

constructArguments ConstructArgument[]

Viewport(CreationData)

[Obsolete("This constructor is a workaround to keep legacy APIs alive. Do not use it.")]
protected Viewport(CreationData data)

Parameters

data CreationData

Viewport(ViewportHandle)

protected Viewport(ViewportHandle handle)

Parameters

handle ViewportHandle

Fields

ChildPropertyDefinition

public static readonly Property<Widget?, Viewport> ChildPropertyDefinition

Field Value

Property<Widget, Viewport>

ScrollToFocusPropertyDefinition

public static readonly Property<bool, Viewport> ScrollToFocusPropertyDefinition

Field Value

Property<bool, Viewport>

Properties

AccessibleRole

public AccessibleRole AccessibleRole { get; set; }

Property Value

AccessibleRole

Child

public Widget? Child { get; set; }

Property Value

Widget

Hadjustment

public Adjustment? Hadjustment { get; set; }

Property Value

Adjustment

HscrollPolicy

public ScrollablePolicy HscrollPolicy { get; set; }

Property Value

ScrollablePolicy

ScrollToFocus

public bool ScrollToFocus { get; set; }

Property Value

bool

Vadjustment

public Adjustment? Vadjustment { get; set; }

Property Value

Adjustment

VscrollPolicy

public ScrollablePolicy VscrollPolicy { get; set; }

Property Value

ScrollablePolicy

Methods

Announce(string, AccessibleAnnouncementPriority)

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

Parameters

message string

priority AccessibleAnnouncementPriority

GetAccessibleParent()

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

Returns

Accessible

GetAccessibleRole()

public AccessibleRole GetAccessibleRole()

Returns

AccessibleRole

GetAtContext()

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

Returns

ATContext

GetBorder(out Border)

public bool GetBorder(out Border border)

Parameters

border Border

Returns

bool

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

GetBuildableId()

public string? GetBuildableId()

Returns

string

GetChild()

public Widget? GetChild()

Returns

Widget

GetFirstAccessibleChild()

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

Returns

Accessible

GetGType()

public static Type GetGType()

Returns

Type

GetHadjustment()

public Adjustment? GetHadjustment()

Returns

Adjustment

GetHscrollPolicy()

public ScrollablePolicy GetHscrollPolicy()

Returns

ScrollablePolicy

GetNextAccessibleSibling()

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

Returns

Accessible

GetPlatformState(AccessiblePlatformState)

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

Parameters

state AccessiblePlatformState

Returns

bool

GetScrollToFocus()

public bool GetScrollToFocus()

Returns

bool

GetVadjustment()

public Adjustment? GetVadjustment()

Returns

Adjustment

GetVscrollPolicy()

public ScrollablePolicy GetVscrollPolicy()

Returns

ScrollablePolicy

New(Adjustment?, Adjustment?)

public static Viewport New(Adjustment? hadjustment, Adjustment? vadjustment)

Parameters

hadjustment Adjustment

vadjustment Adjustment

Returns

Viewport

NewFromPointer(nint, bool)

Creates a new managed Viewport instance for a given pointer.

public static Viewport NewFromPointer(nint ptr, bool ownsHandle)

Parameters

ptr nint

ownsHandle bool

Returns

Viewport

NewWithProperties(ConstructArgument[])

Creates a new Viewport and sets the properties specified by the construct arguments.

public static Viewport NewWithProperties(ConstructArgument[] constructArguments)

Parameters

constructArguments ConstructArgument[]

The properties to set.

Returns

Viewport

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

ScrollTo(Widget, ScrollInfo?)

[Version("4.12")]
public void ScrollTo(Widget descendant, ScrollInfo? scroll)

Parameters

descendant Widget

scroll ScrollInfo

SetAccessibleParent(Accessible?, Accessible?)

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

Parameters

parent Accessible

nextSibling Accessible

SetChild(Widget?)

public void SetChild(Widget? child)

Parameters

child Widget

SetHadjustment(Adjustment?)

public void SetHadjustment(Adjustment? hadjustment)

Parameters

hadjustment Adjustment

SetHscrollPolicy(ScrollablePolicy)

public void SetHscrollPolicy(ScrollablePolicy policy)

Parameters

policy ScrollablePolicy

SetScrollToFocus(bool)

public void SetScrollToFocus(bool scrollToFocus)

Parameters

scrollToFocus bool

SetVadjustment(Adjustment?)

public void SetVadjustment(Adjustment? vadjustment)

Parameters

vadjustment Adjustment

SetVscrollPolicy(ScrollablePolicy)

public void SetVscrollPolicy(ScrollablePolicy policy)

Parameters

policy ScrollablePolicy

UpdateNextAccessibleSibling(Accessible?)

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

Parameters

newSibling Accessible

UpdatePlatformState(AccessiblePlatformState)

[Version("4.18")]
public void UpdatePlatformState(AccessiblePlatformState state)

Parameters

state AccessiblePlatformState