Class Sidebar

Namespace

Adw

Assembly

Adw-1.dll

public sealed class Sidebar : Widget, Accessible, Buildable, ConstraintTarget, NativeObject, IDisposable, GTypeProvider, InstanceFactory

Inheritance

object

Object

InitiallyUnowned

Widget

Sidebar

Implements

Accessible

Buildable

ConstraintTarget

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.ReferenceEquals(object, object)

object.ToString()

Constructors

Sidebar(SidebarHandle)

protected Sidebar(SidebarHandle handle)

Parameters

handle SidebarHandle

Sidebar(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 Sidebar(params ConstructArgument[] constructArguments)

Parameters

constructArguments ConstructArgument[]

Sidebar(CreationData)

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

Parameters

data CreationData

Fields

ActivatedSignal

Signal Descriptor for OnActivated.

public static readonly Signal<Sidebar, Sidebar.ActivatedSignalArgs> ActivatedSignal

Field Value

Signal<Sidebar, Sidebar.ActivatedSignalArgs>

DropEnterSignal

Signal Descriptor for OnDropEnter.

public static readonly ReturningSignal<Sidebar, Sidebar.DropEnterSignalArgs, DragAction> DropEnterSignal

Field Value

ReturningSignal<Sidebar, Sidebar.DropEnterSignalArgs, DragAction>

DropPreloadPropertyDefinition

public static readonly Property<bool, Sidebar> DropPreloadPropertyDefinition

Field Value

Property<bool, Sidebar>

DropSignal

Signal Descriptor for OnDrop.

public static readonly ReturningSignal<Sidebar, Sidebar.DropSignalArgs, bool> DropSignal

Field Value

ReturningSignal<Sidebar, Sidebar.DropSignalArgs, bool>

DropValueLoadedSignal

Signal Descriptor for OnDropValueLoaded.

public static readonly ReturningSignal<Sidebar, Sidebar.DropValueLoadedSignalArgs, DragAction> DropValueLoadedSignal

Field Value

ReturningSignal<Sidebar, Sidebar.DropValueLoadedSignalArgs, DragAction>

FilterPropertyDefinition

public static readonly Property<Filter?, Sidebar> FilterPropertyDefinition

Field Value

Property<Filter, Sidebar>

ItemsPropertyDefinition

public static readonly Property<SelectionModel, Sidebar> ItemsPropertyDefinition

Field Value

Property<SelectionModel, Sidebar>

MenuModelPropertyDefinition

public static readonly Property<MenuModel?, Sidebar> MenuModelPropertyDefinition

Field Value

Property<MenuModel, Sidebar>

ModePropertyDefinition

public static readonly Property<SidebarMode, Sidebar> ModePropertyDefinition

Field Value

Property<SidebarMode, Sidebar>

PlaceholderPropertyDefinition

public static readonly Property<Widget?, Sidebar> PlaceholderPropertyDefinition

Field Value

Property<Widget, Sidebar>

SectionsPropertyDefinition

public static readonly Property<ListModel, Sidebar> SectionsPropertyDefinition

Field Value

Property<ListModel, Sidebar>

SelectedItemPropertyDefinition

public static readonly Property<SidebarItem?, Sidebar> SelectedItemPropertyDefinition

Field Value

Property<SidebarItem, Sidebar>

SelectedPropertyDefinition

public static readonly Property<uint, Sidebar> SelectedPropertyDefinition

Field Value

Property<uint, Sidebar>

SetupMenuSignal

Signal Descriptor for OnSetupMenu.

public static readonly Signal<Sidebar, Sidebar.SetupMenuSignalArgs> SetupMenuSignal

Field Value

Signal<Sidebar, Sidebar.SetupMenuSignalArgs>

Properties

AccessibleRole

public AccessibleRole AccessibleRole { get; set; }

Property Value

AccessibleRole

DropPreload

public bool DropPreload { get; set; }

Property Value

bool

Filter

public Filter? Filter { get; set; }

Property Value

Filter

Items

public SelectionModel Items { get; }

Property Value

SelectionModel

MenuModel

public MenuModel? MenuModel { get; set; }

Property Value

MenuModel

Mode

public SidebarMode Mode { get; set; }

Property Value

SidebarMode

Placeholder

public Widget? Placeholder { get; set; }

Property Value

Widget

Sections

public ListModel Sections { get; }

Property Value

ListModel

Selected

public uint Selected { get; set; }

Property Value

uint

SelectedItem

public SidebarItem? SelectedItem { get; }

Property Value

SidebarItem

Methods

Announce(string, AccessibleAnnouncementPriority)

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

Parameters

message string

priority AccessibleAnnouncementPriority

Append(SidebarSection)

[Version("1.9")]
public void Append(SidebarSection section)

Parameters

section SidebarSection

GetAccessibleId()

[Version("4.22")]
public string? GetAccessibleId()

Returns

string

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

GetDropPreload()

[Version("1.9")]
public bool GetDropPreload()

Returns

bool

GetFilter()

[Version("1.9")]
public Filter? GetFilter()

Returns

Filter

GetFirstAccessibleChild()

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

Returns

Accessible

GetGType()

public static Type GetGType()

Returns

Type

GetItem(uint)

[Version("1.9")]
public SidebarItem? GetItem(uint index)

Parameters

index uint

Returns

SidebarItem

GetItems()

[Version("1.9")]
public SelectionModel GetItems()

Returns

SelectionModel

GetMenuModel()

[Version("1.9")]
public MenuModel? GetMenuModel()

Returns

MenuModel

GetMode()

[Version("1.9")]
public SidebarMode GetMode()

Returns

SidebarMode

GetNextAccessibleSibling()

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

Returns

Accessible

GetPlaceholder()

[Version("1.9")]
public Widget? GetPlaceholder()

Returns

Widget

GetPlatformState(AccessiblePlatformState)

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

Parameters

state AccessiblePlatformState

Returns

bool

GetSection(uint)

[Version("1.9")]
public SidebarSection? GetSection(uint index)

Parameters

index uint

Returns

SidebarSection

GetSections()

[Version("1.9")]
public ListModel GetSections()

Returns

ListModel

GetSelected()

[Version("1.9")]
public uint GetSelected()

Returns

uint

GetSelectedItem()

[Version("1.9")]
public SidebarItem? GetSelectedItem()

Returns

SidebarItem

Insert(SidebarSection, int)

[Version("1.9")]
public void Insert(SidebarSection section, int position)

Parameters

section SidebarSection

position int

New()

[Version("1.9")]
public static Sidebar New()

Returns

Sidebar

NewFromPointer(nint, bool)

Creates a new managed Sidebar instance for a given pointer.

public static Sidebar NewFromPointer(nint ptr, bool ownsHandle)

Parameters

ptr nint

ownsHandle bool

Returns

Sidebar

NewWithProperties(ConstructArgument[])

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

public static Sidebar NewWithProperties(ConstructArgument[] constructArguments)

Parameters

constructArguments ConstructArgument[]

The properties to set.

Returns

Sidebar

Prepend(SidebarSection)

[Version("1.9")]
public void Prepend(SidebarSection section)

Parameters

section SidebarSection

Remove(SidebarSection)

[Version("1.9")]
public void Remove(SidebarSection section)

Parameters

section SidebarSection

RemoveAll()

[Version("1.9")]
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

SetAccessibleParent(Accessible?, Accessible?)

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

Parameters

parent Accessible

nextSibling Accessible

SetDropPreload(bool)

[Version("1.9")]
public void SetDropPreload(bool preload)

Parameters

preload bool

SetFilter(Filter?)

[Version("1.9")]
public void SetFilter(Filter? filter)

Parameters

filter Filter

SetMenuModel(MenuModel?)

[Version("1.9")]
public void SetMenuModel(MenuModel? menuModel)

Parameters

menuModel MenuModel

SetMode(SidebarMode)

[Version("1.9")]
public void SetMode(SidebarMode mode)

Parameters

mode SidebarMode

SetPlaceholder(Widget?)

[Version("1.9")]
public void SetPlaceholder(Widget? placeholder)

Parameters

placeholder Widget

SetSelected(uint)

[Version("1.9")]
public void SetSelected(uint selected)

Parameters

selected uint

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

Events

OnActivated

public event SignalHandler<Sidebar, Sidebar.ActivatedSignalArgs> OnActivated

Event Type

SignalHandler<Sidebar, Sidebar.ActivatedSignalArgs>

OnDrop

public event ReturningSignalHandler<Sidebar, Sidebar.DropSignalArgs, bool> OnDrop

Event Type

ReturningSignalHandler<Sidebar, Sidebar.DropSignalArgs, bool>

OnDropEnter

public event ReturningSignalHandler<Sidebar, Sidebar.DropEnterSignalArgs, DragAction> OnDropEnter

Event Type

ReturningSignalHandler<Sidebar, Sidebar.DropEnterSignalArgs, DragAction>

OnDropValueLoaded

public event ReturningSignalHandler<Sidebar, Sidebar.DropValueLoadedSignalArgs, DragAction> OnDropValueLoaded

Event Type

ReturningSignalHandler<Sidebar, Sidebar.DropValueLoadedSignalArgs, DragAction>

OnSetupMenu

public event SignalHandler<Sidebar, Sidebar.SetupMenuSignalArgs> OnSetupMenu

Event Type

SignalHandler<Sidebar, Sidebar.SetupMenuSignalArgs>