Class ListBox

Namespace

Gtk

Assembly

Gtk-4.0.dll

public class ListBox : Widget, IObject, INotifyPropertyChanged, IDisposable, Accessible, Buildable, ConstraintTarget, IHandle, GTypeProvider

Inheritance

object

Object

InitiallyUnowned

Widget

ListBox

Implements

IObject

INotifyPropertyChanged

IDisposable

Accessible

Buildable

ConstraintTarget

IHandle

GTypeProvider

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

ListBox()

public ListBox()

ListBox(params ConstructArgument[])

protected ListBox(params ConstructArgument[] constructArguments)

Parameters

constructArguments ConstructArgument[]

ListBox(IntPtr, bool)

protected ListBox(IntPtr ptr, bool ownedRef)

Parameters

ptr IntPtr

ownedRef bool

Fields

AcceptUnpairedReleasePropertyDefinition

public static readonly Property<bool, ListBox> AcceptUnpairedReleasePropertyDefinition

Field Value

Property<bool, ListBox>

ActivateCursorRowSignal

Signal Descriptor for OnActivateCursorRow.

public static readonly Signal<ListBox> ActivateCursorRowSignal

Field Value

Signal<ListBox>

ActivateOnSingleClickPropertyDefinition

public static readonly Property<bool, ListBox> ActivateOnSingleClickPropertyDefinition

Field Value

Property<bool, ListBox>

MoveCursorSignal

Signal Descriptor for OnMoveCursor.

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

Field Value

Signal<ListBox, ListBox.MoveCursorSignalArgs>

RowActivatedSignal

Signal Descriptor for OnRowActivated.

public static readonly Signal<ListBox, ListBox.RowActivatedSignalArgs> RowActivatedSignal

Field Value

Signal<ListBox, ListBox.RowActivatedSignalArgs>

RowSelectedSignal

Signal Descriptor for OnRowSelected.

public static readonly Signal<ListBox, ListBox.RowSelectedSignalArgs> RowSelectedSignal

Field Value

Signal<ListBox, ListBox.RowSelectedSignalArgs>

SelectAllSignal

Signal Descriptor for OnSelectAll.

public static readonly Signal<ListBox> SelectAllSignal

Field Value

Signal<ListBox>

SelectedRowsChangedSignal

Signal Descriptor for OnSelectedRowsChanged.

public static readonly Signal<ListBox> SelectedRowsChangedSignal

Field Value

Signal<ListBox>

SelectionModePropertyDefinition

public static readonly Property<SelectionMode, ListBox> SelectionModePropertyDefinition

Field Value

Property<SelectionMode, ListBox>

ShowSeparatorsPropertyDefinition

public static readonly Property<bool, ListBox> ShowSeparatorsPropertyDefinition

Field Value

Property<bool, ListBox>

ToggleCursorRowSignal

Signal Descriptor for OnToggleCursorRow.

public static readonly Signal<ListBox> ToggleCursorRowSignal

Field Value

Signal<ListBox>

UnselectAllSignal

Signal Descriptor for OnUnselectAll.

public static readonly Signal<ListBox> UnselectAllSignal

Field Value

Signal<ListBox>

Properties

AcceptUnpairedRelease

public bool AcceptUnpairedRelease { get; set; }

Property Value

bool

AccessibleRole

public AccessibleRole AccessibleRole { get; set; }

Property Value

AccessibleRole

ActivateOnSingleClick

public bool ActivateOnSingleClick { get; set; }

Property Value

bool

SelectionMode

public SelectionMode SelectionMode { get; set; }

Property Value

SelectionMode

ShowSeparators

public bool ShowSeparators { get; set; }

Property Value

bool

Methods

Announce(string, AccessibleAnnouncementPriority)

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

Parameters

message string

priority AccessibleAnnouncementPriority

Append(Widget)

public void Append(Widget child)

Parameters

child Widget

BindModel(ListModel?, ListBoxCreateWidgetFunc?)

public void BindModel(ListModel? model, ListBoxCreateWidgetFunc? createWidgetFunc)

Parameters

model ListModel

createWidgetFunc ListBoxCreateWidgetFunc

DragHighlightRow(ListBoxRow)

public void DragHighlightRow(ListBoxRow row)

Parameters

row ListBoxRow

DragUnhighlightRow()

public void DragUnhighlightRow()

GetAccessibleParent()

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

Returns

Accessible

GetAccessibleRole()

public AccessibleRole GetAccessibleRole()

Returns

AccessibleRole

GetActivateOnSingleClick()

public bool GetActivateOnSingleClick()

Returns

bool

GetAdjustment()

public Adjustment? GetAdjustment()

Returns

Adjustment

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

GetFirstAccessibleChild()

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

Returns

Accessible

GetGType()

public static Type GetGType()

Returns

Type

GetNextAccessibleSibling()

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

Returns

Accessible

GetPlatformState(AccessiblePlatformState)

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

Parameters

state AccessiblePlatformState

Returns

bool

GetRowAtIndex(int)

public ListBoxRow? GetRowAtIndex(int index)

Parameters

index int

Returns

ListBoxRow

GetRowAtY(int)

public ListBoxRow? GetRowAtY(int y)

Parameters

y int

Returns

ListBoxRow

GetSelectedRow()

public ListBoxRow? GetSelectedRow()

Returns

ListBoxRow

GetSelectionMode()

public SelectionMode GetSelectionMode()

Returns

SelectionMode

GetShowSeparators()

public bool GetShowSeparators()

Returns

bool

Insert(Widget, int)

public void Insert(Widget child, int position)

Parameters

child Widget

position int

InvalidateFilter()

public void InvalidateFilter()

InvalidateHeaders()

public void InvalidateHeaders()

InvalidateSort()

public void InvalidateSort()

New()

public static ListBox New()

Returns

ListBox

Prepend(Widget)

public void Prepend(Widget child)

Parameters

child Widget

Remove(Widget)

public void Remove(Widget child)

Parameters

child Widget

RemoveAll()

[Version("4.12")]
public void RemoveAll()

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

SelectAll()

public void SelectAll()

SelectRow(ListBoxRow?)

public void SelectRow(ListBoxRow? row)

Parameters

row ListBoxRow

SelectedForeach(ListBoxForeachFunc)

public void SelectedForeach(ListBoxForeachFunc func)

Parameters

func ListBoxForeachFunc

SetAccessibleParent(Accessible?, Accessible?)

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

Parameters

parent Accessible

nextSibling Accessible

SetActivateOnSingleClick(bool)

public void SetActivateOnSingleClick(bool single)

Parameters

single bool

SetAdjustment(Adjustment?)

public void SetAdjustment(Adjustment? adjustment)

Parameters

adjustment Adjustment

SetFilterFunc(ListBoxFilterFunc?)

public void SetFilterFunc(ListBoxFilterFunc? filterFunc)

Parameters

filterFunc ListBoxFilterFunc

SetHeaderFunc(ListBoxUpdateHeaderFunc?)

public void SetHeaderFunc(ListBoxUpdateHeaderFunc? updateHeader)

Parameters

updateHeader ListBoxUpdateHeaderFunc

SetPlaceholder(Widget?)

public void SetPlaceholder(Widget? placeholder)

Parameters

placeholder Widget

SetSelectionMode(SelectionMode)

public void SetSelectionMode(SelectionMode mode)

Parameters

mode SelectionMode

SetShowSeparators(bool)

public void SetShowSeparators(bool showSeparators)

Parameters

showSeparators bool

SetSortFunc(ListBoxSortFunc?)

public void SetSortFunc(ListBoxSortFunc? sortFunc)

Parameters

sortFunc ListBoxSortFunc

UnselectAll()

public void UnselectAll()

UnselectRow(ListBoxRow)

public void UnselectRow(ListBoxRow row)

Parameters

row ListBoxRow

UpdateNextAccessibleSibling(Accessible?)

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

Parameters

newSibling Accessible

Events

OnActivateCursorRow

public event SignalHandler<ListBox> OnActivateCursorRow

Event Type

SignalHandler<ListBox>

OnMoveCursor

public event SignalHandler<ListBox, ListBox.MoveCursorSignalArgs> OnMoveCursor

Event Type

SignalHandler<ListBox, ListBox.MoveCursorSignalArgs>

OnRowActivated

public event SignalHandler<ListBox, ListBox.RowActivatedSignalArgs> OnRowActivated

Event Type

SignalHandler<ListBox, ListBox.RowActivatedSignalArgs>

OnRowSelected

public event SignalHandler<ListBox, ListBox.RowSelectedSignalArgs> OnRowSelected

Event Type

SignalHandler<ListBox, ListBox.RowSelectedSignalArgs>

OnSelectAll

public event SignalHandler<ListBox> OnSelectAll

Event Type

SignalHandler<ListBox>

OnSelectedRowsChanged

public event SignalHandler<ListBox> OnSelectedRowsChanged

Event Type

SignalHandler<ListBox>

OnToggleCursorRow

public event SignalHandler<ListBox> OnToggleCursorRow

Event Type

SignalHandler<ListBox>

OnUnselectAll

public event SignalHandler<ListBox> OnUnselectAll

Event Type

SignalHandler<ListBox>