Class Overlay

Namespace

Gtk

Assembly

Gtk-4.0.dll

public class Overlay : Widget, Accessible, Buildable, ConstraintTarget, IDisposable, GTypeProvider, InstanceFactory

Inheritance

object

Object

InitiallyUnowned

Widget

Overlay

Implements

Accessible

Buildable

ConstraintTarget

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.ComputeExpand(Orientation)

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.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.GetMapped()

Widget.GetMarginBottom()

Widget.GetMarginEnd()

Widget.GetMarginStart()

Widget.GetMarginTop()

Widget.GetName()

Widget.GetNative()

Widget.GetNextSibling()

Widget.GetOpacity()

Widget.GetOverflow()

Widget.GetPangoContext()

Widget.GetParent()

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.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.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.NewValist(Type, string, nint)

Object.NewWithProperties(Type, string[], Value[])

Object.Newv(Type, Parameter[])

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

Overlay(params ConstructArgument[])

public Overlay(params ConstructArgument[] constructArguments)

Parameters

constructArguments ConstructArgument[]

Overlay(OverlayHandle)

public Overlay(OverlayHandle handle)

Parameters

handle OverlayHandle

Fields

ChildPropertyDefinition

public static readonly Property<Widget?, Overlay> ChildPropertyDefinition

Field Value

Property<Widget, Overlay>

GetChildPositionSignal

Signal Descriptor for OnGetChildPosition.

public static readonly ReturningSignal<Overlay, Overlay.GetChildPositionSignalArgs, bool> GetChildPositionSignal

Field Value

ReturningSignal<Overlay, Overlay.GetChildPositionSignalArgs, bool>

Properties

AccessibleRole

public AccessibleRole AccessibleRole { get; set; }

Property Value

AccessibleRole

Child

public Widget? Child { get; set; }

Property Value

Widget

Methods

AddOverlay(Widget)

public void AddOverlay(Widget widget)

Parameters

widget Widget

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

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

GetClipOverlay(Widget)

public bool GetClipOverlay(Widget widget)

Parameters

widget Widget

Returns

bool

GetFirstAccessibleChild()

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

Returns

Accessible

GetGType()

public static Type GetGType()

Returns

Type

GetMeasureOverlay(Widget)

public bool GetMeasureOverlay(Widget widget)

Parameters

widget Widget

Returns

bool

GetNextAccessibleSibling()

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

Returns

Accessible

GetPlatformState(AccessiblePlatformState)

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

Parameters

state AccessiblePlatformState

Returns

bool

New()

public static Overlay New()

Returns

Overlay

RemoveOverlay(Widget)

public void RemoveOverlay(Widget widget)

Parameters

widget Widget

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

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

SetClipOverlay(Widget, bool)

public void SetClipOverlay(Widget widget, bool clipOverlay)

Parameters

widget Widget

clipOverlay bool

SetMeasureOverlay(Widget, bool)

public void SetMeasureOverlay(Widget widget, bool measure)

Parameters

widget Widget

measure bool

UpdateNextAccessibleSibling(Accessible?)

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

Parameters

newSibling Accessible

Events

OnGetChildPosition

public event ReturningSignalHandler<Overlay, Overlay.GetChildPositionSignalArgs, bool> OnGetChildPosition

Event Type

ReturningSignalHandler<Overlay, Overlay.GetChildPositionSignalArgs, bool>