Class ScyllaCopyMenu

A button that offers the same value in several text formats and copies the chosen one.

Inheritance
object
CallbackEventHandler
Focusable
VisualElement
ScyllaCopyMenu
Implements
IEventHandler
IResolvedStyle
ITransform
ITransitionAnimations
IExperimentalFeatures
IVisualElementScheduler
ICustomStyle
Inherited Members
VisualElement.disabledUssClassName
VisualElement.ReleaseResources()
VisualElement.Focus()
VisualElement.SendEvent(EventBase)
VisualElement.MarkDirtyRepaint()
VisualElement.IsMarkedForRepaint()
VisualElement.ContainsPoint(Vector2)
VisualElement.Overlaps(Rect)
VisualElement.ToString()
VisualElement.GetClasses()
VisualElement.ClearClassList()
VisualElement.FindAncestorUserData()
VisualElement.SetBinding(BindingId, Binding)
VisualElement.GetBinding(BindingId)
VisualElement.TryGetBinding(BindingId, out Binding)
VisualElement.GetBindingInfos()
VisualElement.HasBinding(BindingId)
VisualElement.ClearBinding(BindingId)
VisualElement.ClearBindings()
VisualElement.GetHierarchicalDataSourceContext()
VisualElement.GetDataSourceContext(BindingId)
VisualElement.TryGetDataSourceContext(BindingId, out DataSourceContext)
VisualElement.TryGetLastBindingToUIResult(in BindingId, out BindingResult)
VisualElement.TryGetLastBindingToSourceResult(in BindingId, out BindingResult)
VisualElement.Add(VisualElement)
VisualElement.Remove(VisualElement)
VisualElement.Clear()
VisualElement.Clear(VisualElementClearOptions)
VisualElement.IndexOf(VisualElement)
VisualElement.Children()
VisualElement.BringToFront()
VisualElement.SendToBack()
VisualElement.PlaceBehind(VisualElement)
VisualElement.PlaceInFront(VisualElement)
VisualElement.RemoveFromHierarchy()
VisualElement.GetFirstOfType<T>()
VisualElement.GetFirstAncestorOfType<T>()
VisualElement.Contains(VisualElement)
VisualElement.FindCommonAncestor(VisualElement)
VisualElement.viewDataKey
VisualElement.userData
VisualElement.canGrabFocus
VisualElement.focusController
VisualElement.disablePlayModeTint
VisualElement.usageHints
VisualElement.scaledPixelsPerPoint
VisualElement.layout
VisualElement.contentRect
VisualElement.paddingRect
VisualElement.worldBound
VisualElement.localBound
VisualElement.worldTransform
VisualElement.hasActivePseudoState
VisualElement.hasInactivePseudoState
VisualElement.hasHoverPseudoState
VisualElement.hasCheckedPseudoState
VisualElement.hasEnabledPseudoState
VisualElement.hasDisabledPseudoState
VisualElement.hasFocusPseudoState
VisualElement.hasRootPseudoState
VisualElement.pickingMode
VisualElement.name
VisualElement.resourcesReleased
VisualElement.enabledInHierarchy
VisualElement.enabledSelf
VisualElement.languageDirection
VisualElement.visible
VisualElement.generateVisualContent
VisualElement.dataSource
VisualElement.dataSourcePath
VisualElement.dataSourceType
VisualElement.experimental
VisualElement.hierarchy
VisualElement.parent
VisualElement.panel
VisualElement.contentContainer
VisualElement.visualTreeAssetSource
VisualElement.childCount
VisualElement.schedule
VisualElement.style
VisualElement.resolvedStyle
VisualElement.customStyle
VisualElement.styleSheets
VisualElement.tooltip
Focusable.Blur()
Focusable.focusable
Focusable.tabIndex
Focusable.delegatesFocus
CallbackEventHandler.RegisterCallback<TEventType>(EventCallback<TEventType>, TrickleDown)
CallbackEventHandler.RegisterCallbackOnce<TEventType>(EventCallback<TEventType>, TrickleDown)
CallbackEventHandler.RegisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TUserArgsType, TrickleDown)
CallbackEventHandler.RegisterCallbackOnce<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TUserArgsType, TrickleDown)
CallbackEventHandler.RegisterCallback<TEventType>(EventCallback<TEventType>, CallbackOptions)
CallbackEventHandler.RegisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TUserArgsType, CallbackOptions)
CallbackEventHandler.UnregisterCallback<TEventType>(EventCallback<TEventType>, TrickleDown)
CallbackEventHandler.UnregisterCallback<TEventType>(EventCallback<TEventType>, CallbackOptions)
CallbackEventHandler.UnregisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TrickleDown)
CallbackEventHandler.UnregisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, CallbackOptions)
CallbackEventHandler.UnregisterAllRemovableCallbacks()
CallbackEventHandler.HasTrickleDownHandlers()
CallbackEventHandler.HasBubbleUpHandlers()
CallbackEventHandler.HandleEventBubbleUp(EventBase)
CallbackEventHandler.HandleEventTrickleDown(EventBase)
CallbackEventHandler.NotifyPropertyChanged(in BindingId)
Namespace: Scylla.Core.Editor
Assembly: ScyllaCore.Editor.dll
Syntax
public class ScyllaCopyMenu : VisualElement, IEventHandler, IResolvedStyle, ITransform, ITransitionAnimations, IExperimentalFeatures, IVisualElementScheduler, ICustomStyle
Remarks

Formats are registered rather than fixed, and each is a producer called at click time, so the menu always copies the current value without anyone having to push updates into it. That is the whole difference from writing a copy button by hand: the value and the formatting stay with the caller, and only the menu and clipboard plumbing live here.

Built on UnityEngine.UIElements.GenericDropdownMenu rather than the IMGUI UnityEditor.GenericMenu, matching the UI Toolkit mandate and the precedent set by the configuration export button.

Constructors

ScyllaCopyMenu(string)

Initializes a copy menu.

Declaration
public ScyllaCopyMenu(string label = "Copy")
Parameters
Type Name Description
string label

The button label.

Properties

FormatCount

Gets how many formats are registered.

Declaration
public int FormatCount { get; }
Property Value
Type Description
int

Methods

AddFormat(string, Func<string>)

Registers a format, appended to the end of the menu.

Declaration
public void AddFormat(string label, Func<string> producer)
Parameters
Type Name Description
string label

The menu entry label.
Func<string> producer

Produces the text to copy. Called when the entry is chosen, not when it is registered, so it always sees the current value.
Exceptions
Type Condition
ArgumentException

Thrown when the label is null or empty.
ArgumentNullException

Thrown when the producer is null.

ClearFormats()

Removes every registered format.

Declaration
public void ClearFormats()

SetLabel(string)

Sets the button's label.

Declaration
public void SetLabel(string label)
Parameters
Type Name Description
string label

The new label.

Events

Copied

Raised after a format has been copied, carrying the text placed on the clipboard.

Declaration
public event Action<string> Copied
Event Type
Type Description
Action<string>
Remarks

Callers use this to show a transient confirmation. The copy has already happened by the time it fires.

Implements

UnityEngine.UIElements.IEventHandler
UnityEngine.UIElements.IResolvedStyle
UnityEngine.UIElements.ITransform
UnityEngine.UIElements.Experimental.ITransitionAnimations
UnityEngine.UIElements.IExperimentalFeatures
UnityEngine.UIElements.IVisualElementScheduler
UnityEngine.UIElements.ICustomStyle

Extension Methods

See Also