Class Assistant

Namespace

Gtk

Assembly

Gtk-4.0.dll

public class Assistant : Window, IObject, INotifyPropertyChanged, IDisposable, Accessible, Buildable, ConstraintTarget, Native, Root, ShortcutManager, IHandle, GTypeProvider

Inheritance

object

Object

InitiallyUnowned

Widget

Window

Assistant

Implements

IObject

INotifyPropertyChanged

IDisposable

Accessible

Buildable

ConstraintTarget

Native

Root

ShortcutManager

IHandle

GTypeProvider

Inherited Members

Window.GetDefaultIconName()

Window.GetToplevels()

Window.SetAutoStartupNotification(bool)

Window.SetDefaultIconName(string)

Window.SetInteractiveDebugging(bool)

Window.Close()

Window.Destroy()

Window.Fullscreen()

Window.FullscreenOnMonitor(Monitor)

Window.GetApplication()

Window.GetChild()

Window.GetDecorated()

Window.GetDefaultSize(out int, out int)

Window.GetDefaultWidget()

Window.GetDeletable()

Window.GetDestroyWithParent()

Window.GetFocus()

Window.GetFocusVisible()

Window.GetGroup()

Window.GetHandleMenubarAccel()

Window.GetHideOnClose()

Window.GetIconName()

Window.GetMnemonicsVisible()

Window.GetModal()

Window.GetResizable()

Window.GetTitle()

Window.GetTitlebar()

Window.GetTransientFor()

Window.HasGroup()

Window.GetIsActive()

Window.IsFullscreen()

Window.IsMaximized()

Window.IsSuspended()

Window.Maximize()

Window.Minimize()

Window.Present()

Window.PresentWithTime(uint)

Window.SetApplication(Application)

Window.SetChild(Widget)

Window.SetDecorated(bool)

Window.SetDefaultSize(int, int)

Window.SetDefaultWidget(Widget)

Window.SetDeletable(bool)

Window.SetDestroyWithParent(bool)

Window.SetDisplay(Display)

Window.SetFocus(Widget)

Window.SetFocusVisible(bool)

Window.SetHandleMenubarAccel(bool)

Window.SetHideOnClose(bool)

Window.SetIconName(string)

Window.SetMnemonicsVisible(bool)

Window.SetModal(bool)

Window.SetResizable(bool)

Window.SetStartupId(string)

Window.SetTitle(string)

Window.SetTitlebar(Widget)

Window.SetTransientFor(Window)

Window.Unfullscreen()

Window.Unmaximize()

Window.Unminimize()

Window.ApplicationPropertyDefinition

Window.Application

Window.ChildPropertyDefinition

Window.Child

Window.DecoratedPropertyDefinition

Window.Decorated

Window.DefaultHeightPropertyDefinition

Window.DefaultHeight

Window.DefaultWidgetPropertyDefinition

Window.DefaultWidget

Window.DefaultWidthPropertyDefinition

Window.DefaultWidth

Window.DeletablePropertyDefinition

Window.Deletable

Window.DestroyWithParentPropertyDefinition

Window.DestroyWithParent

Window.DisplayPropertyDefinition

Window.Display

Window.FocusVisiblePropertyDefinition

Window.FocusVisible

Window.FocusWidgetPropertyDefinition

Window.FocusWidget

Window.FullscreenedPropertyDefinition

Window.Fullscreened

Window.HandleMenubarAccelPropertyDefinition

Window.HandleMenubarAccel

Window.HideOnClosePropertyDefinition

Window.HideOnClose

Window.IconNamePropertyDefinition

Window.IconName

Window.IsActivePropertyDefinition

Window.IsActive

Window.MaximizedPropertyDefinition

Window.Maximized

Window.MnemonicsVisiblePropertyDefinition

Window.MnemonicsVisible

Window.ModalPropertyDefinition

Window.Modal

Window.ResizablePropertyDefinition

Window.Resizable

Window.StartupIdPropertyDefinition

Window.StartupId

Window.SuspendedPropertyDefinition

Window.Suspended

Window.TitlePropertyDefinition

Window.Title

Window.TitlebarPropertyDefinition

Window.Titlebar

Window.TransientForPropertyDefinition

Window.TransientFor

Window.ActivateDefaultSignal

Window.OnActivateDefault

Window.ActivateFocusSignal

Window.OnActivateFocus

Window.CloseRequestSignal

Window.OnCloseRequest

Window.EnableDebuggingSignal

Window.OnEnableDebugging

Window.KeysChangedSignal

Window.OnKeysChanged

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.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.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.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, IntPtr)

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

Object.Newv(Type, Parameter[])

Object.PropertyChanged

Object.Handle

Object.Initialize()

Object.OnPropertyChanged(string)

Object.Dispose()

Object.CompatControl(nuint, IntPtr)

Object.InterfaceFindProperty(TypeInterface, string)

Object.InterfaceInstallProperty(TypeInterface, ParamSpec)

Object.AddWeakPointer(ref IntPtr)

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, IntPtr)

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

Object.IsFloating()

Object.Notify(string)

Object.NotifyByPspec(ParamSpec)

Object.Ref()

Object.RefSink()

Object.RemoveWeakPointer(ref IntPtr)

Object.RunDispose()

Object.SetData(string, IntPtr)

Object.SetProperty(string, Value)

Object.SetQdata(Quark, IntPtr)

Object.SetValist(string, IntPtr)

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

Assistant()

public Assistant()

Assistant(params ConstructArgument[])

protected Assistant(params ConstructArgument[] constructArguments)

Parameters

constructArguments ConstructArgument[]

Assistant(IntPtr, bool)

protected Assistant(IntPtr ptr, bool ownedRef)

Parameters

ptr IntPtr

ownedRef bool

Fields

ApplySignal

Signal Descriptor for OnApply.

public static readonly Signal<Assistant> ApplySignal

Field Value

Signal<Assistant>

CancelSignal

Signal Descriptor for OnCancel.

public static readonly Signal<Assistant> CancelSignal

Field Value

Signal<Assistant>

CloseSignal

Signal Descriptor for OnClose.

public static readonly Signal<Assistant> CloseSignal

Field Value

Signal<Assistant>

EscapeSignal

Signal Descriptor for OnEscape.

public static readonly Signal<Assistant> EscapeSignal

Field Value

Signal<Assistant>

PagesPropertyDefinition

public static readonly Property<ListModel, Assistant> PagesPropertyDefinition

Field Value

Property<ListModel, Assistant>

PrepareSignal

Signal Descriptor for OnPrepare.

public static readonly Signal<Assistant, Assistant.PrepareSignalArgs> PrepareSignal

Field Value

Signal<Assistant, Assistant.PrepareSignalArgs>

UseHeaderBarPropertyDefinition

public static readonly Property<int, Assistant> UseHeaderBarPropertyDefinition

Field Value

Property<int, Assistant>

Properties

AccessibleRole

public AccessibleRole AccessibleRole { get; set; }

Property Value

AccessibleRole

Pages

public ListModel Pages { get; }

Property Value

ListModel

UseHeaderBar

public int UseHeaderBar { get; }

Property Value

int

Methods

AddActionWidget(Widget)

public void AddActionWidget(Widget child)

Parameters

child Widget

Announce(string, AccessibleAnnouncementPriority)

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

Parameters

message string

priority AccessibleAnnouncementPriority

AppendPage(Widget)

public int AppendPage(Widget page)

Parameters

page Widget

Returns

int

Commit()

public void Commit()

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

GetCurrentPage()

public int GetCurrentPage()

Returns

int

GetDisplay()

public Display GetDisplay()

Returns

Display

GetFirstAccessibleChild()

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

Returns

Accessible

GetGType()

public static Type GetGType()

Returns

Type

GetNPages()

public int GetNPages()

Returns

int

GetNextAccessibleSibling()

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

Returns

Accessible

GetNthPage(int)

public Widget? GetNthPage(int pageNum)

Parameters

pageNum int

Returns

Widget

GetPage(Widget)

public AssistantPage GetPage(Widget child)

Parameters

child Widget

Returns

AssistantPage

GetPageComplete(Widget)

public bool GetPageComplete(Widget page)

Parameters

page Widget

Returns

bool

GetPageTitle(Widget)

public string GetPageTitle(Widget page)

Parameters

page Widget

Returns

string

GetPageType(Widget)

public AssistantPageType GetPageType(Widget page)

Parameters

page Widget

Returns

AssistantPageType

GetPages()

public ListModel GetPages()

Returns

ListModel

GetPlatformState(AccessiblePlatformState)

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

Parameters

state AccessiblePlatformState

Returns

bool

GetRenderer()

public Renderer? GetRenderer()

Returns

Renderer

GetSurface()

public Surface? GetSurface()

Returns

Surface

GetSurfaceTransform(out double, out double)

public void GetSurfaceTransform(out double x, out double y)

Parameters

x double

y double

InsertPage(Widget, int)

public int InsertPage(Widget page, int position)

Parameters

page Widget

position int

Returns

int

New()

public static Assistant New()

Returns

Assistant

NextPage()

public void NextPage()

PrependPage(Widget)

public int PrependPage(Widget page)

Parameters

page Widget

Returns

int

PreviousPage()

public void PreviousPage()

Realize()

public void Realize()

RemoveActionWidget(Widget)

public void RemoveActionWidget(Widget child)

Parameters

child Widget

RemovePage(int)

public void RemovePage(int pageNum)

Parameters

pageNum int

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

SetCurrentPage(int)

public void SetCurrentPage(int pageNum)

Parameters

pageNum int

SetForwardPageFunc(AssistantPageFunc?)

public void SetForwardPageFunc(AssistantPageFunc? pageFunc)

Parameters

pageFunc AssistantPageFunc

SetPageComplete(Widget, bool)

public void SetPageComplete(Widget page, bool complete)

Parameters

page Widget

complete bool

SetPageTitle(Widget, string)

public void SetPageTitle(Widget page, string title)

Parameters

page Widget

title string

SetPageType(Widget, AssistantPageType)

public void SetPageType(Widget page, AssistantPageType type)

Parameters

page Widget

type AssistantPageType

Unrealize()

public void Unrealize()

UpdateButtonsState()

public void UpdateButtonsState()

UpdateNextAccessibleSibling(Accessible?)

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

Parameters

newSibling Accessible

Events

OnApply

public event SignalHandler<Assistant> OnApply

Event Type

SignalHandler<Assistant>

OnCancel

public event SignalHandler<Assistant> OnCancel

Event Type

SignalHandler<Assistant>

OnClose

public event SignalHandler<Assistant> OnClose

Event Type

SignalHandler<Assistant>

OnEscape

public event SignalHandler<Assistant> OnEscape

Event Type

SignalHandler<Assistant>

OnPrepare

public event SignalHandler<Assistant, Assistant.PrepareSignalArgs> OnPrepare

Event Type

SignalHandler<Assistant, Assistant.PrepareSignalArgs>