UnityEngine.UIElementsModule Status of the menu item. The item is displayed with a checkmark. The item is disabled and is not be selectable by the user. The item is not displayed. The item is displayed normally. Event sent after an element is added to an element that is a descendent of a panel. Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events. Abstract base class for controls. The value associated with the field. Allow to set a value without being of the change, if any. New Value to set. UxmlTraits for the BaseField. Enumerator to get the child elements of the UxmlTraits of BaseField. Constructor. This is a base class for the Slider fields. This is the actual property to contain the direction of the slider. This is the maximum value that the slider encodes. This is the minimum value that the slider encodes. This is a generic page size used to change the value when clicking in the slider. This is the range from the minimum value to the maximum value of the slider. The actual value of the slider. Method used to adjust the dragelement. Mainly used in a scroller. The factor used to adjust the drag element, where a value > 1 will make it invisible. Element that can be bound to a property. Binding object that will be updated. Path of the target property to be bound. Constructor. Instantiates a BindableElement using the data read from a UXML file. Constructor. UxmlTraits for the BindableElement. Constructor. Initialize EnumField properties using values from the attribute bag. Event sent immediately after an element has lost focus. This event trickles down, it does not bubble up, and it cannot be cancelled. Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events. Styled visual element to match the IMGUI Box Style. Instantiates a Box using the data read from a UXML file. Constructor. A clickable button. Clickable MouseManipulator for this Button. Constructs a Button. Action triggered when the button is clicked. Constructs a Button. Action triggered when the button is clicked. Instantiates a Button using the data read from a UXML file. Constructor. UxmlTraits for the UI.Button. Constructor. Interface for classes capable of having callbacks to handle events. Handle an event, most often by executing the callbacks associated with the event. The event to handle. Return true if event handlers for the event propagation BubbleUp phase have been attached on this object. True if object has event handlers for the BubbleUp phase. Returns true if event handlers, for the event propagation TrickleDown phase, are attached to this object. True if object has event handlers for the TrickleDown phase. Adds an event handler to the instance. If the event handler has already been registered for the same phase (either TrickleDown or BubbleUp) then this method has no effect. The event handler to add. By default, this callback is called during the BubbleUp phase. Pass TrickleDown.TrickleDown to call this callback during the TrickleDown phase. Data to pass to the callback. Adds an event handler to the instance. If the event handler has already been registered for the same phase (either TrickleDown or BubbleUp) then this method has no effect. The event handler to add. By default, this callback is called during the BubbleUp phase. Pass TrickleDown.TrickleDown to call this callback during the TrickleDown phase. Data to pass to the callback. Sends an event to the event handler. The event to send. Remove callback from the instance. The callback to remove. Set this parameter to true to remove the callback from the TrickleDown phase. Set this parameter to false to remove the callback from the BubbleUp phase. Remove callback from the instance. The callback to remove. Set this parameter to true to remove the callback from the TrickleDown phase. Set this parameter to false to remove the callback from the BubbleUp phase. Sends an event when a value in a field changes. The new value. The value before the change occured. Constructor. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained from this method should be released back to the pool using Dispose(). The previous value. The new value. Returns an initialized event. Sets the event to its initial state. Enum which describes the various types of changes that can occur on a VisualElement. All change types have been flagged. Persistence key or parent has changed on the current VisualElement. Persistence key or parent has changed on some child of the current VisualElement. Base class for command events. Name of the command. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained from this method should be released back to the pool using Dispose(). The command name. An IMGUI command event. Returns an initialized event. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained from this method should be released back to the pool using Dispose(). The command name. An IMGUI command event. Returns an initialized event. Resets the event members to their initial values. The event sent when clicking the right mouse button. Constructor. Use this class to display a contextual menu. Displays the contextual menu. The event that triggered the display of the menu. The element for which the menu is displayed. Checks if the event triggers the display of the contextual menu. This method also displays the menu. The element for which the menu is displayed. The event to inspect. Manipulator that displays a contextual menu when the user clicks the right mouse button or presses the menu key on the keyboard. Constructor. Register the event callbacks on the manipulator target. Unregister the event callbacks from the manipulator target. The event sent when a contextual menu requires menu items. The menu to populate. The event that triggered the ContextualMenuPopulateEvent. Constructor. Retrieves an event from the event pool. Use this method to retrieve a mouse event and initialize the event, instead of creating a new mouse event. Events obtained from this method should be released back to the pool using Dispose(). The event that triggered the display of the contextual menu. The menu to populate. The element that triggered the display of the contextual menu. Returns an initialized event. Resets the event members to their initial values. This class is used during UXML template instantiation. Script interface for VisualElement cursor style property IStyle.cursor. The offset from the top left of the texture to use as the target point (must be within the bounds of the cursor). The texture to use for the cursor style. To use a texture as a cursor, import the texture with "Read/Write enabled" in the texture importer (or using the "Cursor" defaults). Event sent just before an element is detach from its parent, if the parent is the descendant of a panel. Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events. Base class for drag and drop events. Use the DragEnterEvent class to manage events that occur when dragging enters an element or one of its descendants. The DragEnterEvent is cancellable, it does not trickle down, and it does not bubble up. Constructor. Avoid renewing events. Instead, use GetPooled() to get an event from a pool of reusable events. Resets the event members to their initial values. The event sent to a dragged element when the drag and drop process ends. Constructor. Resets the event members to their initial values. Use the DragLeaveEvent class to manage events sent when dragging leaves an element or one of its descendants. The DragLeaveEvent is cancellable, it does not trickle down, and it does not bubble up. Constructor. Avoid renewing events. Instead, use GetPooled() to get an event from a pool of reusable events. Resets the event members to their initial values. The event sent to an element when another element is dragged and dropped on the element. Constructor. The event sent when the element being dragged enters a possible drop target. Constructor. A drop-down menu. Add an item that will execute an action in the drop-down menu. The item is added at the end of the current item list. Name of the item. This name will be displayed in the drop-down menu. Callback to execute when the user selects this item in the menu. Callback to execute to determine the status of the item. An object that will be stored in the userData property of the MenuAction item. Add a separator line in the menu. The separator is added at the end of the current item list. The submenu path where the separator will be added. Path components are delimited by forward slashes ('/'). Add a separator line in the menu. The separator is added at the end of the current item list. The submenu path where the separator will be added. Path components are delimited by forward slashes ('/'). Constructor. A class holding information about the event that triggered the display of the drop-down menu. If the triggering event was a mouse event, this property is the mouse position. The position is expressed using the coordinate system of the element that received the mouse event. Otherwise this property is zero. If modifier keys (Alt, Control, Shift, Windows/Command) were pressed to trigger the display of the dropdown menu, this property lists the modifier keys. If the triggering event was a mouse event, this property is the mouse position expressed using the global coordinate system. Otherwise this property is zero. Constructor. Add an item that will execute an action in the drop-down menu. The item is added at the end of the specified index in the list. Name of the item. This name will be displayed in the drop-down menu. Callback to execute when the user selects this item in the menu. Callback to execute to determine the status of the item. Index where the item should be inserted. An object that will be stored in the userData property of the MenuAction item. This object is accessible through the action callback. Add a separator line in the menu. The separator is added at the end of the specified index in the list. Index where the separator should be inserted. The submenu path where the separator is added. Path components are delimited by forward slashes ('/'). A menu action item. Provides information on the event that triggered the drop-down menu. The name of the item. The name can be prefixed by its submenu path. Path components are delimited by forward slashes ('/'). The status of the item. The userData object stored by the constructor. Status callback that always returns StatusFlags.Disabled. Unused parameter. Always return StatusFlags.Disabled. Status callback that always returns StatusFlags.Enabled. Unused parameter. Always return StatusFlags.Enabled. Constructor. The path and name of the menu item. Use the path, delimited by forward slashes ('/'), to place the menu item within a submenu. Action to be executed when the menu item is selected. Function called to determine if the menu item is enabled. An object that will be stored in the userData property. Execute the callback associated with this item. Update the status flag of this item by calling the item status callback. Information about the event that triggered the display of the drop-down menu, such as the mouse position or the key pressed. An item in a drop-down menu. Get the list of menu items. The list of items in the menu. Update the status of all items by calling their status callback and remove the separators in excess. This is called just before displaying the menu. Remove the menu item at index. The index of the item to remove. A separator menu item. The submenu path where the separator will be added. Path components are delimited by forward slashes ('/'). Constructor. The path for the submenu. Path components are delimited by forward slashes ('/'). The base class for all UIElements events. Whether this event type bubbles up in the event propagation path. The current target of the event. The current target is the element in the propagation path for which event handlers are currently being executed. Whether the event is being dispatched to a visual element. An event cannot be redispatched while it being dispatched. If you need to recursively dispatch an event, it is recommended that you use a copy of the event. Flags for the event. The IMGUIEvent at the source of this event. The source can be null since not all events are generated by IMGUI. Return true if the default actions should not be executed for this event. Whether StopImmediatePropagation() was called for this event. Whether StopPropagation() was called for this event. The original mouse position of the IMGUI event, before it is transformed to the current target local coordinates. Whether the event is allocated from a pool of events. The current propagation phase. The target visual element that received this event. Unlike currentTarget, this target does not change when the event is sent to other elements along the propagation path. The time when the event was created. Whether this event is sent down the event propagation path during the TrickleDown phase. Implementation of IDisposable. Retrieves the type id for this event instance. The type ID. Resets all event members to their initial values. Whether the default actions are prevented from being executed for this event. Registers an event class to the event type system. The type ID. Immediately stops the propagation of the event. The event is not sent to other elements along the propagation path. This method prevents other event handlers from executing on the current target. Stops propagating this event. The event is not sent to other elements along the propagation path. This method does not prevent other event handlers from executing on the current target. Generic base class for events, implementing event pooling and automatic registration to the event type system. Implementation of IDispose. Retrieves the type id for this event instance. The type ID. Gets an event from the event pool. Use this function instead of creating new events. Events obtained from this method should be released back to the pool using Dispose(). Returns an initialized event. Resets all event members to their initial values. Gets the type id for the event class. The event class type id. Dispatches events to a IPanel. Gates control when the dispatcher processes events. Constructor. The dispatcher controlled by this gate. Implementation of IDisposable.Dispose. Opens the gate. If all gates are open, events in the queue are processed. The event sent when an element should execute a command. Constructor. Use this structure to set the IStyle.Flex shorthand property which sets the IStyle.flexGrow, IStyle.flexShrink, and IStyle.flexBasis properties. The value for the IStyle.flexBasis property. The value for the IStyle.flexBasis property. The value for the IStyle.flexBasis property. Constructor. Base class for objects that can get the focus. Return true if the element can be focused. Return the focus controller for this element. An integer used to sort focusables in the focus ring. A negative value means that the element can not be focused. Tell the element to release the focus. Attempt to give the focus to this element. Base class for defining in which direction the focus moves in a focus ring. Last value for the direction defined by this class. The null direction. This is usually used when the focus stays on the same element. Focus came from an unspecified direction, for example after a mouse down. The underlying integer value for this direction. Class in charge of managing the focus inside a Panel. The currently focused element. Constructor. Ask the controller to change the focus according to the event. The focus controller will use its focus ring to choose the next element to be focused. Event sent immediately after an element has gained focus. This event trickles down, it does not bubble up, and it cannot be cancelled. Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events. Base class for focus related events. Direction of the focus change. For FocusOut and Blur events, contains the element that gains the focus. For FocusIn and Focus events, contains the element that loses the focus. Gets an event from the event pool and initializes the event with the given values. Use this function instead of creating new events. Events obtained from this method should be released back to the pool using Dispose(). The event target. The related target. The direction of the focus change. Returns an initialized event. Resets the event members to their initial values. Event sent immediately before an element gains focus. This event trickles down and bubbles up. This event cannot be cancelled. Constructor. Resets the event members to their initial values. Event sent immediately before an element loses focus. This event trickles down and bubbles up. This event cannot be cancelled. Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events. Resets the event members to their initial values. Collapsable section of UI. Contains the collapse state. True if the Foldout is open and the contents are visible. False if it's collapsed. Instantiates a Foldout using the data read from a UXML file. Constructor. Event sent after layout calculations, when the position or the dimension of an element changes. This event cannot be cancelled, it does not trickle down, and it does not bubble up. The new dimensions of the element. The old dimensions of the element. Constructor. Gets an event from the event pool and initializes the event with the specified values. Use this method instead of instancing new events. Use Dispose() to release events back to the event pool. The old dimensions of the element. The new dimensions of the element. Returns an initialized event. Resets the event values to their initial values. Interface for all bindable fields. Binding object that will be updated. Path of the target property to be bound. Base interface for Binding objects. Called at regular intervals to synchronize bound properties to their IBindable counterparts. Called before the Update() method. Disconnects the field from its bound property Called at regular intervals to synchronize bound properties to their IBindable counterparts. Extensions methods to provide additional IBindable functionality. Checks if a IBindable is bound to a property. This Bindable object. Returns true if this IBindable is bound to a property. Base interface for ChangeEvent. Interface for Command events. Name of the command. Interface for drag and drop events. Interface for class capable of handling events. Handle an event. The event to handle. Return true if event handlers for the event propagation BubbleUp phase have been attached on this object. True if object has event handlers for the BubbleUp phase. Returns true if event handlers, for the event propagation TrickleDown phase, are attached to this object. Returns true if the object already has event handlers for the TrickleDown phase. Sends an event to the event handler. The event to send. Interface for focus events. Direction of the focus change. Related target. See implementation for specific meaning. Interface for classes implementing focus rings. Get the direction of the focus change for the given event. For example, when the Tab key is pressed, focus should be given to the element to the right. Get the next element in the given direction. Interface for keyboard events. Returns true if the platform specific action key is pressed. This key is Command on macOS and Control otherwise. Return true if the Alt key is pressed. The character. Return true if the Windows/Command key is pressed. Return true if the Control key is pressed. The key code. Flag set holding the pressed modifier keys (Alt, Control, Shift, Windows/Command). Return true if the Shift key is pressed. A VisualElement representing a source texture. The source texture of the Image element. The source rectangle inside the texture relative to the top left corner. The base texture coordinates of the Image relative to the bottom left corner. Instantiates an Image using the data read from a UXML file. Constructor. UxmlTraits for the Image. Returns an empty enumerable, as images generally do not have children. Constructor. An interface for Manipulator classes. The element that handles the interaction. Element that draws IMGUI content. Indicate whether this element can be focused. Indicate the type of context this element is associated with. See ContextType. Construct an element used to draw IMGUI elements. The function called when drawing is in-progress. Construct an element used to draw IMGUI elements. The function called when drawing is in-progress. This method is called whenever a Repaint is required from the VisualElement. This method is called as part of the IEventHandler interface. EventBase representing the event to be handled. Marks layout as dirty to trigger a redraw. Instantiates an IMGUIContainer using the data read from a UXML file. Constructor. UxmlTraits for the IMGUIContainer. Returns an empty enumerable, as IMGUIContainer cannot have VisualElement children. Constructor. Class used to send a IMGUI event that has no equivalent UIElements event. Constructor. Use GetPooled() to get an event from a pool of reusable events. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained from this method should be released back to the pool using Dispose(). The IMGUI event used to initialize the event. Returns an initialized event. Resets the event members to their initial values. Interface for mouse capture events. Interface for mouse events. Returns true if the platform specific action key is pressed. This key is Command on macOS and Control otherwise. Return true if the Alt key is pressed. Integer representing the pressed mouse button: 0 is left, 1 is right, 2 is center. Number of clicks. Return true if the Windows/Command key is pressed. Return true if the Control key is pressed. The mouse position in the current target coordinate system. Flag set holding the pressed modifier keys (Alt, Control, Shift, Windows/Command). Mouse position difference between the last mouse event and this one. The mouse position in the panel coordinate system. Return true if the Shift key is pressed. Interface for controls that hold a value and can notify when it is changed by user input. The Value held by the control. Registers this callback to receive ChangeEvent<T> when value is changed by user input. Unregisters this callback from receiving ChangeEvent<T> when value is changed by user input. Set the value and, if different, notifies registers callbacks with a ChangeEvent<T> The new value to be set. Set the value and, even if different, does not notify registers callbacks with a ChangeEvent<T> The new value to be set. Sends an event when text from a TextField changes. The new text. The text before the change occured. Constructor. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained from this method should be released back to the pool using Dispose(). The new text. The text before the change occured. Returns an initialized event. Resets the event members to their initial values. Interface for classes implementing UI panels. Return the focus controller for this panel. Interface for panel change events. A reference to a scheduled action. A scheduler allows you to register actions to be executed at a later point. Add this item to the list of scheduled tasks. The item to register. Schedule this action to be executed later. The item will be automatically unscheduled after it has ran for the amount of time specified with the durationMs parameter. Action to be executed. The minimum delay in milliseconds before executing the action. The minimum interval in milliseconds between each execution. The total duration in milliseconds where this item will be active. Internal reference to the scheduled action. Schedule this action to be executed later. After the execution, the item will be automatically unscheduled. Action to be executed. The minimum delay in milliseconds before executing the action. Internal reference to the scheduled action. Schedule this action to be executed later. Item will be unscheduled when condition is met. Action to be executed. The minimum delay in milliseconds before executing the action. The minimum interval in milliseconds bettwen each execution. When condition returns true, the item will be unscheduled. Internal reference to the scheduled action. Manually unschedules a previously scheduled action. The item to be removed from this scheduler. This interface provides access to a VisualElement style data. Alignment of the whole area of children on the cross axis if they span over multiple lines in this container. Alignment of children on the cross axis of this container. Similar to align-items, but only for this specific element. Background color to paint in the element's box. Background image to paint in the element's box. Background image scaling in the element's box. Space reserved for the bottom edge of the border during the layout phase. This is the radius of the bottom-left corner when a rounded rectangle is drawn in the element's box. This is the radius of the bottom-right corner when a rounded rectangle is drawn in the element's box. Space reserved for the bottom edge of the border during the layout phase. Color of the border to paint inside the element's box. Space reserved for the left edge of the border during the layout phase. Space reserved for the left edge of the border during the layout phase. This is the radius of every corner when a rounded rectangle is drawn in the element's box. Space reserved for the right edge of the border during the layout phase. Space reserved for the right edge of the border during the layout phase. Space reserved for the top edge of the border during the layout phase. This is the radius of the top-left corner when a rounded rectangle is drawn in the element's box. This is the radius of the top-right corner when a rounded rectangle is drawn in the element's box. Space reserved for the top edge of the border during the layout phase. Color to use when drawing the text of an element. Mouse cursor to display when the mouse pointer is over an element. Ration of this element in its parent during the layout phase. Initial main size of a flex item, on the main flex axis. The final layout mught be smaller or larger, according to the flex shrinking and growing determined by the flex property. Direction of the main axis to layout children in a container. Specifies how much the item will grow relative to the rest of the flexible items inside the same container. Specifies how the item will shrink relative to the rest of the flexible items inside the same container. Placement of children over multiple lines if not enough space is available in this container. Font to draw the element's text. Font size to draw the element's text. Font style and weight (normal, bold, italic) to draw the element's text. Fixed height of an element for the layout. Justification of children on the main axis of this container. Space reserved for the bottom edge of the margin during the layout phase. Space reserved for the left edge of the margin during the layout phase. Space reserved for the right edge of the margin during the layout phase. Space reserved for the top edge of the margin during the layout phase. Maximum height for an element, when it is flexible or measures its own size. Maximum width for an element, when it is flexible or measures its own size. Minimum height for an element, when it is flexible or measures its own size. Minimum height for an element, when it is flexible or measures its own size. Space reserved for the bottom edge of the padding during the layout phase. Space reserved for the left edge of the padding during the layout phase. Space reserved for the right edge of the padding during the layout phase. Space reserved for the top edge of the padding during the layout phase. Bottom distance from the element's box during layout. Left distance from the element's box during layout. Right distance from the element's box during layout. Top distance from the element's box during layout. Element's positioning in its parent container. Size of the 9-slice's bottom edge when painting an element's background image. Size of the 9-slice's left edge when painting an element's background image. Size of the 9-slice's right edge when painting an element's background image. Size of the 9-slice's top edge when painting an element's background image. Clipping if the text does not fit in the element's box. Horizontal and vertical text alignment in the element's box. Specifies whether or not an element is visible. Fixed width of an element for the layout. Word wrapping over multiple lines if not enough space is available to draw the text of an element. This interface provides access to a VisualElement transform data. Transformation matrix calculated from the position, rotation and scale of the transform (Read Only). The position of the VisualElement's transform. The rotation of the VisualElement's transform stored as a Quaternion. The scale of the VisualElement's transform. Interface allowing access to this elements datawatch. Starts watching an object. When watched, all changes on an object will trigger the callback to be invoked. The object to watch. Callback. A reference to this datawatch request. Disposing it will ensure any native resources will also be released. Unregisters a previously watched request. The registered request. An internal reference to a data watch request. This type allows UXML attribute value retrieval during the VisualElement instantiation. An instance will be provided to the factory method - see UXMLFactoryAttribute. Get the value of an attribute as a string. Attribute name. The attribute value or null if not found. True if the attribute was found, false otherwise. Interface for UXML factories. While it is not strictly required, concrete factories should derive from the generic class UxmlFactory. Must return true if the UXML element attributes are not restricted to the values enumerated by uxmlAttributesDescription. The type of element for which this element type can substitute for. The UXML namespace for the type returned by substituteForTypeName. The fully qualified XML name for the type returned by substituteForTypeName. Describes the UXML attributes expected by the element. The attributes enumerated here will appear in the UXML schema. Describes the types of element that can appear as children of this element in a UXML file. The name of the UXML element read by the factory. The namespace of the UXML element read by the factory. The fully qualified name of the UXML element read by the factory. Returns true if the factory accepts the content of the attribute bag. The attribute bag. True if the factory accepts the content of the attribute bag. False otherwise. Instanciate and initialize an object of type T0. A bag of name-value pairs, one for each attribute of the UXML element. This can be used to initialize the properties of the created object. When the element is created as part of a template instance inserted in another document, this contains information about the insertion point. The created object. Represents a scheduled task created with a VisualElement's schedule interface. Returns the VisualElement this object is associated with. Will be true when this item is scheduled. Note that an item's callback will only be executed when it's VisualElement is attached to a panel. Repeats this action after a specified time. Minimum amount of time in milliseconds between each action execution. This ScheduledItem. Cancels any previously scheduled execution of this item and re-schedules the item. Minimum time in milliseconds before this item will be executed. After specified duration, the item will be automatically unscheduled. The total duration in milliseconds where this item will be active. This ScheduledItem. Removes this item from its VisualElement's scheduler. If not already active, will schedule this item on its VisualElement's scheduler. Adds a delay to the first invokation. The minimum number of milliseconds after activation where this item's action will be executed. This ScheduledItem. Item will be unscheduled automatically when specified condition is met. When condition returns true, the item will be unscheduled. This ScheduledItem. A scheduler allows you to register actions to be executed at a later point. Schedule this action to be executed later. The action to be executed. The action to be executed. Reference to the scheduled action. Schedule this action to be executed later. The action to be executed. The action to be executed. Reference to the scheduled action. Base class for keyboard events. Returns true if the platform specific action key is pressed. This key is Command on macOS and Control otherwise. Returns true if the Alt key is pressed. The character. Returns true if the Windows/Command key is pressed. Returns true if the Control key is pressed. The key code. Flags holding the pressed modifier keys (Alt, Control, Shift, Windows/Command). Returns true if the Shift key is pressed. Gets a keyboard event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained from this method should be released back to the pool using Dispose(). The character for this event. The keyCode for this event. Event modifier keys that are active for this event. A keyboard IMGUI event. Returns an initialized event. Gets a keyboard event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained from this method should be released back to the pool using Dispose(). The character for this event. The keyCode for this event. Event modifier keys that are active for this event. A keyboard IMGUI event. Returns an initialized event. Resets the event members to their initial values. Event sent when a key is pressed on the keyboard. This event trickles down and bubbles up. This event is cancellable. Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events. Event sent when a key is released on the keyboard. This event trickles down and bubbles up. This event is cancellable. Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events. Provides an Element displaying text. Constructs a label. The text to be displayed. Constructs a label. The text to be displayed. Instantiates a Label using the data read from a UXML file. Constructor. UxmlTraits for the Label. Constructor. A vertically scrollable area that only creates visual elements for visible items while allowing the binding of many more items. As the user scrolls, visual elements are recycled and re-bound to new data items. Callback for binding a data item to the visual element. ListView requires all visual elements to have the same height so that it can calculate a sensible scroller size. This property must be set for the list view to function. The items data source. This property must be set for the list view to function. Callback for constructing the VisualElement that will serve as the template for each recycled and re-bound element in the list. This property must be set for the list view to function. Callback for when an item is chosen (double-click). This is different from just a selection. The chosen item. Callback for a selection change. List of selected items. Currently selected item index in the items source. If multiple items are selected, this will return the first selected item's index. The currently selected item from the items source. If multiple items are selected, this will return the first selected item. Controls the selection state, whether: selections are disabled, there is only one selectable item, or if there are multiple selectable items. Clear, recreate all visible visual elements, and rebind all items. This should be called whenever the items source changes. Scroll to a specific visual element. Element to scroll to. Scroll so that a specific item index from the items source is visible. Item index to scroll to. Instantiates a ListView using the data read from a UXML file. Constructor. UxmlTraits for the ListView. Returns an empty enumerable, as list views generally do not have children. Constructor. Initialize ListView properties using values from the attribute bag. The object to initialize. The attribute bag. The creation context; unused. Base class for objects that define user interaction with a VisualElement. Most often manipulators hold state for complex interactions, for example interactions that require a mouse down, mouse move mouse up sequence. The element that handles the interaction. Register event callbacks on the target visual element. Unregister event callbacks on the target visual element. Used by manipulators to match events against their requirements. The button that activates the manipulation. Number of mouse clicks required to activate the manipulator. Any modifier keys (ie. ctrl, alt, ...) that are needed to activate the manipulation. Returns true if the current mouse event satisfies the activation requirements. The mouse event. True if the event matches the requirements. A min/max slider containing a representation of a range. This is the high limit of the slider. This is the low limit of the slider. This is the high value of the range represented on the slider. This is the low value of the range represented on the slider. Returns the range of the low/high limits of the slider. This is the value of the slider. This is a Vector2 where the x is the lower bound and the y is the higher bound. Constructor. The minimum value in the range to be represented. The maximum value in the range to be represented. The minimum value of the slider limit. The maximum value of the slider limit. This is the sldier direction, for now, only Horizontal is supported. Constructor. The minimum value in the range to be represented. The maximum value in the range to be represented. The minimum value of the slider limit. The maximum value of the slider limit. This is the sldier direction, for now, only Horizontal is supported. Instantiates a MinMaxSlider using the data read from a UXML file. Constructor. UxmlTraits for the MinMaxSlider. Constructor. Initialize MinMaxSlider properties using values from the attribute bag. The element to initialize. The bag of attributes. Creation Context, unused. Class that manages capturing mouse events. Assigns an event handler to capture mouse events. The event handler that captures mouse events. Checks if the event handler is capturing the mouse. Event handler to check. True if the handler captures the mouse. Checks if there is a handler capturing the mouse. Returns true if a handler is capturing the mouse, false otherwise. Stops an event handler from capturing the mouse. The event handler to stop capturing the mouse. If this handler is not assigned to capturing the mouse, nothing happens. Stops an event handler from capturing the mouse. The event handler to stop capturing the mouse. If this handler is not assigned to capturing the mouse, nothing happens. Event sent after a handler starts capturing the mouse. Constructor. Event sent when the handler capturing the mouse changes. In the case of a MouseCaptureEvent, this property is the IEventHandler that loses the capture. In the case of a MouseCaptureOutEvent, this property is the IEventHandler that gains the capture. Retrieves an event from the event pool. Use this method to retrieve a mouse event and initialize the event, instead of creating a new mouse event. Events obtained from this method should be released back to the pool using Dispose(). The handler taking or releasing the mouse capture. The related target. Returns an initialized event. Resets the event members to their initial values. Event sent before a handler stops capturing the mouse. Constructor. Mouse down event. Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events. Event sent when the mouse pointer enters an element or one of its descendent elements. The event is cancellable, it does not trickle down, and it does not bubble up. Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events. Resets the event members to their initial values. Event sent when the mouse pointer enters a window. The event is cancellable, it does not trickle down, and it does not bubble up. Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events. Resets the event members to their initial values. The base class for mouse events. Returns true if the platform specific action key is pressed. This key is Command on macOS and Control otherwise. Returns true if the Alt key is pressed. Integer representing the pressed mouse button: 0 is left, 1 is right, 2 is center. Number of clicks. Returns true if the Windows/Command key is pressed. Returns true if the Control key is pressed. The current target of the event. The current target is the element in the propagation path for which event handlers are currently being executed. The mouse position in the current target coordinate system. Flags holding the pressed modifier keys (Alt, Control, Shift, Windows/Command). The difference of the mouse position between the previous mouse event and the current mouse event. The mouse position in the screen coordinate system. Returns true if the Shift key is pressed. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained from this method should be released back to the pool using Dispose(). A mouse IMGUI event. Returns an initialized event. Resets the event members to their initial values. Event sent when the mouse pointer exits an element and all its descendent elements. The event is cancellable, it does not trickle down, and it does not bubble up. Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events. Resets the event members to their initial values. Event sent when the mouse pointer exits a window. The event is cancellable, it does not trickle down, and it does not bubble up. Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events. Resets the event members to their initial values. Mouse move event. Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events. Event sent when the mouse pointer exits an element. The event trickles down, it bubbles up, and it is cancellable. Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events. Event sent when the mouse pointer enters an element. The event trickles down, it bubbles up, and it is cancellable. Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events. Mouse up event. Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events. Abstract base class for events notifying of a panel change. In the case of AttachToPanelEvent, the panel to which the event target element is now attached. In the case of DetachFromPanelEvent, the panel to which the event target element will be attached. In the case of AttachToPanelEvent, the panel to which the event target element was attached. In the case of DetachFromPanelEvent, the panel from which the event target element is detached. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained from this method should be released back to the pool using Dispose(). Sets the originPanel property of the event. Sets the destinationPanel property of the event. Returns an initialized event. Resets the event members to their initial values. Styled visual element that matches the EditorGUILayout.Popup IMGUI element. Instantiates a PopupWindow using the data read from a UXML file. Constructor. UxmlTraits for the PopupWindow. Returns an empty enumerable, as popup windows generally do not have children. Constructor. The propagation phases of an event. The event is being sent to the event target. The event is being sent to the event target parent element up to the root element. The event is being sent to the target element for it to execute its default actions for this event. Event handlers do not get the events in this phase. Instead, ExecuteDefaultAction is called on the target. The event is not being propagated. The event is being sent from the root element to the target parent element. A button that executes an action repeatedly while it is pressed. Constructor. The action to execute when the button is pressed. The initial delay before the action is executed for the first time. The interval between each execution of the action. Constructor. The action to execute when the button is pressed. The initial delay before the action is executed for the first time. The interval between each execution of the action. Set the action that should be executed when the button is pressed. The action to execute. The initial delay before the action is executed for the first time. The interval between each execution of the action. Instantiates a RepeatButton using the data read from a UXML file. Constructor. UxmlTraits for the RepeatButton. Constructor. Initialize RepeatButton properties using values from the attribute bag. The object to initialize. The attribute bag. The creation context; unused. A vertical or horizontal scrollbar. Direction of this scrollbar. Top or right scroll button. Maximum value. Bottom or left scroll button. Minimum value. The slider used by this scroller. Value that defines the slider position. It lies between lowValue and highValue. Event sent when the slider value has changed. Updates the slider element size as a ratio of the total range. A value greater than 1 disables the Scroller. Slider size ratio. Constructor for this element. The minimum value represented by lowValue. The maximum value represented by highValue. The event method that is called when the value changes. The slider direction. See SliderDirection. Constructor for this element. The minimum value represented by lowValue. The maximum value represented by highValue. The event method that is called when the value changes. The slider direction. See SliderDirection. Changes the value according to the current slider pageSize. The factor that applies to the scroll down action. Set to 1 to scroll down by 1 page. Set to a value greater than 1 to scroll down by over a page. Changes the value according to the current slider pageSize. The factor that applies to the scroll down action. Set to 1 to scroll down by 1 page. Set to a value greater than 1 to scroll down by over a page. Changes the value according to the current slider pageSize. The factor that applies to the scroll up action. Set to 1 to scroll up by 1 page. Set to a value greater than 1 to scroll up by over a page. Changes the value according to the current slider pageSize. The factor that applies to the scroll up action. Set to 1 to scroll up by 1 page. Set to a value greater than 1 to scroll up by over a page. Instantiates a Scroller using the data read from a UXML file. Constructor. UxmlTraits for the Scroller. Returns an empty enumerable, as scrollers do not have children. Constructor. Initialize Scroller properties using values from the attribute bag. The object to initialize. The attribute bag. The creation context; unused. For internal use only. The button used by the Scroller. Clickable manipulator. Constructor. The method called when a click event occurs. Sets a delay for when the event begins. The delay is only applied if the specified value is greater than 0. Determines the time delta between event repetitions. The interval is only applied if the specified value is greater than 0. Constructor. The method called when a click event occurs. Sets a delay for when the event begins. The delay is only applied if the specified value is greater than 0. Determines the time delta between event repetitions. The interval is only applied if the specified value is greater than 0. Instantiates a ScrollerButton using the data read from a UXML file. Constructor. UxmlTraits for the ScrollerButton. Returns an empty enumerable, as buttons generally do not have children. Constructor. Initialize ScrollerButton properties using values from the attribute bag. The object to initialize. The attribute bag. The creation context; unused. Displays its contents inside a scrollable frame. Contains the full content that could be partially visible. Obsolete. Use contentContainer instead. Represents the visible area of contentContainer. This property is controlling the scrolling speed of the horizontal scroller. Horizontal scrollbar. Whether the view contents fit the horizontal area. Whether the view contents fit the vertical area. The current scrolling position. Whether the horizontal scroller is visible. Whether the vertical scroller is visible. Indicates whether the content of ScrollView should fill the width of its viewport. The default value is false. This property is controlling the scrolling speed of the vertical scroller. Vertical Scrollbar. Constructor. Scroll to a specific child element. The child to scroll to. Replaces the contentContainer with this element. The previous contents container will be removed the hierarchy The element to display in this ScrollView Instantiates a ScrollView using the data read from a UXML file. Constructor. UxmlTraits for the ScrollView. Constructor. Initialize ScrollView properties using values from the attribute bag. The object to initialize. The attribute bag. The creation context; unused. Controls how many items can be selected at once. Multiple items are selectable at once. Selections are disabled. Only one item is selectable. Experimental.UIElements.Slider is a controller allowing the selection of a value from a range (min, max, value). Instantiates a Slider using the data read from a UXML file. Constructor. UxmlTraits for the Slider. Returns an empty enumerable, as sliders generally do not have children. Constructor. Initialize Slider properties using values from the attribute bag. The object to initialize. The attribute bag. The creation context; unused. This is the direction of the Slider and SliderInt. An horizontal slider is made with a SliderDirection Horizontal. An vertical slider is made with a SliderDirection Vertical. A slider containing Integer discrete values. The value to add or remove to the SliderInt.value when it is clicked. Constructors for the SliderInt. This is the low value of the slider. This is the high value of the slider. This is the slider direction, horizontal or vertical. This is the number of values to change when the slider is clicked. Constructors for the SliderInt. This is the low value of the slider. This is the high value of the slider. This is the slider direction, horizontal or vertical. This is the number of values to change when the slider is clicked. Instantiates a SliderInt using the data read from a UXML file. Constructor. UxmlTraits for the SliderInt. Returns an empty enumerable, as sliders generally do not have children. Constructor. Initialize SliderInt properties using values from the attribute bag. The object to initialize. The bag of attributes. The creation context; unused. This enumeration contains values to control how an element is aligned in its parent during the layout phase. Default value (currently FlexStart). Items are centered on the cross axis. Items are aligned at the end on the cross axis. Items are aligned at the beginning on the cross axis. Stretches items on the cross axis. This enumeration defines values used to control in which direction a container will place its children during layout. Vertical layout. Vertical layout in reverse order. Horizontal layout. Horizontal layout in reverse order. This enumeration contains values to control how children are justified during layout. Items are centered. Items are justified towards the end of the layout direction. Items are justified towards the beginning of the main axis. Items are evenly distributed in the line with extra space on each end of the line. Items are evenly distributed in the line; first item is at the beginning of the line, last item is at the end. This enumeration contains values to control how an element is positioned in its parent container. The element is positioned in relation to its parent box and does not contribute to the layout anymore. The element is positioned in relation to its default box as calculated by layout. This enumeration contains values to specify whether or not an element is visible. The picking and rendering of this element is skipped. It still takes space in the layout. The element is drawn normally (default). This enumeration contains values to control how elements are placed in a container if not enough space is available. All elements are placed on the same line. Elements are placed over multiple lines. Elements are placed over multiple lines with new lines occuring in the reverse order set in the container. This interface exposes methods to read custom style properties applied from USS files to visual elements. Read a style property value into the specified StyleValue<T>. Name of the property in USS. Target StyleValue<T> field or variable to write to. Read a style property value into the specified StyleValue<T>. Name of the property in USS. Target StyleValue<T> field or variable to write to. Read a style property value into the specified StyleValue<T>. Name of the property in USS. Target StyleValue<T> field or variable to write to. Read a style property value into the specified StyleValue<T>. Name of the property in USS. Target StyleValue<T> field or variable to write to. Read a style property value into the specified StyleValue<T>. Name of the property in USS. Target StyleValue<T> field or variable to write to. Read a style property value into the specified StyleValue<T>. Name of the property in USS. Target StyleValue<T> field or variable to write to. This generic structure encodes a value type that can come from USS or be specified programmatically. This represents the default value for a StyleValue<T> of the according generic type. The actual value of the StyleValue<T>. Creates a StyleValue of the according generic type directly from a value. Value to be used as inline style. The result StyleValue<T> This constructor can be used to specified an alternate default value but it is recommended to use StyleValue<T>.nil. Default starting value. Utility function to be used when reading custom styles values and provide a default value in one step. Default value to be returned if no value is set. The value to be used for the custom style. Template Container. Instantiates and clones a TemplateContainer using the data read from a UXML file. Constructor. UxmlTraits for the TemplateContainer. Returns an empty enumerable, as template instance do not have children. Constructor. Initialize TemplateContainer properties using values from the attribute bag. The object to initialize. The attribute bag. The creation context; unused. Abstract base class for VisualElement containing text. The text associated with the element. Computes the size needed to display a text string based on element style values such as font, font-size, word-wrap, and so on. The text to measure. Suggested width. Can be zero. Width restrictions. Suggested height. Height restrictions. Returns the horizontal and vertical size needed to display the text string. Instantiates a TextElement using the data read from a UXML file. Constructor. UxmlTraits for the TextElement. Enumerator to get the child elements of the UxmlTraits of TextElement. Constructor. Initializer for the UxmlTraits for the TextElement. VisualElement to initialize. Bag of attributes where to get the value from. Creation Context, not used. A textfield is a rectangular area where the user can edit a string. Set this to true to mask the characters and false if otherwise. Set this to true to allow multiple lines in the textfield and false if otherwise. The string currently being exposed by the field. Creates a new textfield. The maximum number of characters this textfield can hold. If 0, there is no limit. Set this to true to allow multiple lines in the textfield and false if otherwise. Set this to true to mask the characters and false if otherwise. The character used for masking in a password field. Creates a new textfield. The maximum number of characters this textfield can hold. If 0, there is no limit. Set this to true to allow multiple lines in the textfield and false if otherwise. Set this to true to mask the characters and false if otherwise. The character used for masking in a password field. Called when the persistent data is accessible and/or when the data or persistence key have changed (VisualElement is properly parented). Selects text in the textfield between cursorIndex and selectionIndex. The caret and selection start position. The selection end position. Instantiates a TextField using the data read from a UXML file. Constructor. UxmlTraits for the TextField. Constructor. Initialize TextField properties using values from the attribute bag. The object to initialize. The attribute bag. The creation context; unused. Abstract base class used for all text-based fields. Color of the cursor. The current cursor position index in the text input field. Controls whether double clicking selects the word under the mouse pointer or not. If set to true, the value property is not updated until either the user presses Enter or the text field loses focus. Returns true if the field is used to edit a password. The character used for masking in a password field. Maximum number of characters for the field. The current selection position index in the text input field. Background color of selected text. Controls whether triple clicking selects the entire line under the mouse pointer or not. Add menu items to the text field contextual menu. The event holding the menu to populate. Constructor. Maximum number of characters for the field. The character used for masking in a password field. Selects all the text. UxmlTraits for the TextInputFieldBase. Constructor. Initialize TextInputFieldBase properties using values from the attribute bag. The object to initialize. The attribute bag. The creation context; unused. This is the Toggle field. Optional text after the toggle. (Obsolete) Sets the event callback for this toggle button. Use OnValueChanged() instead. The action to be called when this Toggle is clicked. Instantiates a Toggle using the data read from a UXML file. Constructor. UxmlTraits for the Toggle. Constructor. Initialize Toggle properties using values from the attribute bag. The object to initialize. The attribute bag. The creation context; unused. Event sent to find the first element that displays a tooltip. Rectangle of the hovered element in the panel coordinate system. Text to display inside the tooltip box. Resets the event members to their initial values. Use this enum to specify during which phases the event handler is executed. The event handler should be executed during the AtTarget and BubbleUp phases. The event handler should be executed during the TrickleDown and AtTarget phases. UQuery is a set of extension methods allowing you to select individual or collection of visualElements inside a complex hierarchy. Utility Object that contructs a set of selection rules to be ran on a root visual element. Selects all elements that are active. A QueryBuilder with the selection rules. Convenience overload, shorthand for Build().AtIndex(). Compiles the selection rules into a QueryState object. Selects all elements that are checked. Selects all direct child elements of elements matching the previous rules. Selects all direct child elements of elements matching the previous rules. Selects all elements with the given class. Not to be confused with Type (see OfType<>()). Initializes a QueryBuilder. The root element on which to condfuct the search query. Selects all elements that are descendants of currently matching ancestors. Selects all elements that are descendants of currently matching ancestors. Selects all elements that are enabled. Convenience overload, shorthand for Build().First(). The first element matching all the criteria, or null if none was found. Selects all elements that are enabled. Convenience overload, shorthand for Build().ForEach(). The function to be invoked with each matching element. Convenience overload, shorthand for Build().ForEach(). The function to be invoked with each matching element. Each return value will be added to this list. Convenience overload, shorthand for Build().ForEach(). The function to be invoked with each matching element. Returns a list of all the results of the function calls. Selects all elements that are hovered. Convenience overload, shorthand for Build().Last(). The last element matching all the criteria, or null if none was found. Selects element with this name. Selects all elements that are not active. Selects all elements that npot checked. Selects all elements that are not enabled. Selects all elements that don't currently own the focus. Selects all elements that are not hovered. Selects all elements that are not selected. Selects all elements that are not visible. Selects all elements of the specified Type (eg: Label, Button, ScrollView, etc). If specified, will select elements with this name. If specified, will select elements with the given class (not to be confused with Type). If specified, will select elements with the given class (not to be confused with Type). QueryBuilder configured with the associated selection rules. Selects all elements of the specified Type (eg: Label, Button, ScrollView, etc). If specified, will select elements with this name. If specified, will select elements with the given class (not to be confused with Type). If specified, will select elements with the given class (not to be confused with Type). QueryBuilder configured with the associated selection rules. Selects all elements that are selected. Convenience method. shorthand for Build().ToList. Returns a list containing elements satisfying selection rules. Convenience method. Shorthand gor Build().ToList(). Adds all elements satisfying selection rules to the list. Selects all elements that are visible. Selects all elements satifying the predicate. Predicate that must return true for selected elements. QueryBuilder configured with the associated selection rules. Query object containing all the selection rules. Can be saved and rerun later without re-allocating memory. Selects the n th element matching all the criteria, or null if not enough elements were found. The index of the matched element. The match element at the specified index. The first element matching all the criteria, or null if none was found. The first element matching all the criteria, or null if none was found. Invokes function on all elements matching the query. The action to be invoked with each matching element. Invokes function on all elements matching the query. Each return value will be added to this list. The function to be invoked with each matching element. Invokes function on all elements matching the query. Overloaded for convenience. The function to be invoked with each matching element. Returns a list of all the results of the function calls. The last element matching all the criteria, or null if none was found. The last element matching all the criteria, or null if none was found. Creates a new QueryState with the same selection rules, applied on another VisualElement. The element on which to apply the selection rules. A new QueryState with the same selection rules, applied on this element. Returns a list containing elements satisfying selection rules. Returns a list containing elements satisfying selection rules. Adds all elements satisfying selection rules to the list. Adds all elements satisfying selection rules to the list. UQuery is a set of extension methods allowing you to select individual or collection of visualElements inside a complex hierarchy. Convenience overload, shorthand for Query<T>.Build().First(). Root VisualElement on which the selector will be applied. If specified, will select elements with this name. If specified, will select elements with the given class (not to be confused with Type). If specified, will select elements with the given class (not to be confused with Type). The first element matching all the criteria, or null if none was found. Convenience overload, shorthand for Query<T>.Build().First(). Root VisualElement on which the selector will be applied. If specified, will select elements with this name. If specified, will select elements with the given class (not to be confused with Type). If specified, will select elements with the given class (not to be confused with Type). The first element matching all the criteria, or null if none was found. Initializes a QueryBuilder with the specified selection rules. Root VisualElement on which the selector will be applied. If specified, will select elements with this name. If specified, will select elements with the given class (not to be confused with Type). If specified, will select elements with the given class (not to be confused with Type). QueryBuilder configured with the associated selection rules. Initializes a QueryBuilder with the specified selection rules. Root VisualElement on which the selector will be applied. If specified, will select elements with this name. If specified, will select elements with the given class (not to be confused with Type). If specified, will select elements with the given class (not to be confused with Type). QueryBuilder configured with the associated selection rules. Initializes a QueryBuilder with the specified selection rules. Template parameter specifies the type of elements the selector applies to (ie: Label, Button, etc). Root VisualElement on which the selector will be applied. If specified, will select elements with this name. If specified, will select elements with the given class (not to be confused with Type). If specified, will select elements with the given class (not to be confused with Type). QueryBuilder configured with the associated selection rules. Initializes a QueryBuilder with the specified selection rules. Template parameter specifies the type of elements the selector applies to (ie: Label, Button, etc). Root VisualElement on which the selector will be applied. If specified, will select elements with this name. If specified, will select elements with the given class (not to be confused with Type). If specified, will select elements with the given class (not to be confused with Type). QueryBuilder configured with the associated selection rules. Initializes an empty QueryBuilder on a specified root element. Root VisualElement on which the selector will be applied. An empty QueryBuilder on a specified root element. Base class for describing an XML attribute. The default value for the attribute, as a string. The attribute name. A list of obsolete names for this attribute. Restrictions on the possible values of the attribute. Attribute type. Attribute namespace. Whether the attribute is optional, required or prohibited. Get the attribute value from the attribute bag. A bag containg attributes and their values as strings. The context in which the values are retrieved. A function to convert a string value to type T. The value to return if the attribute is not found in the bag. The attribute value from the bag, or defaultValue if the attribute is not found. An enum to describe attribute use. There is no restriction on the use of this attribute with the element. The attribute is optional for the element. The attribute should not appear for the element. The attribute must appear in the element tag. Describes a XML bool attribute. The default value for the attribute. The default value for the attribute, as a string. Constructor. Retrieves the value of this attribute from the attribute bag. Returns it if it is found, otherwise return defaultValue. The bag of attributes. The value of the attribute. Describe an allowed child element for an element. The name of the allowed child element. The namespace name of the allowed child element. Constructor. Describes a XML attribute representing a Color as a string. The default value for the attribute. The default value for the attribute, as a string. Constructor. Retrieves the value of this attribute from the attribute bag. Returns it if it is found, otherwise return defaultValue. The bag of attributes. The value of the attribute. Describes a XML double attribute. The default value for the attribute. The default value for the attribute, as a string. Constructor. Retrieves the value of this attribute from the attribute bag. Returns it if it is found, otherwise return defaultValue. The bag of attributes. The value of the attribute. Describes a XML attribute representing an enum as a string. The default value for the attribute. The default value for the attribute, as a string. Constructor. Retrieves the value of this attribute from the attribute bag. Returns it if it is found, otherwise return defaultValue. The bag of attributes. The value of the attribute. Restricts the value of an attribute to be taken from a list of values. The list of values the attribute can take. Constructor. Indicates whether the current UxmlEnumeration object is equal to another object of the same type. The object to compare with. True if the otheer object is equal to this one. UxmlFactory specialization for classes that derive from VisualElement and that shares its traits, VisualElementTraits. Constructor. Generic base class for UXML factories, which instantiate a VisualElement using the data read from a UXML file. Returns UxmlTraits.canHaveAnyAttribute (where UxmlTraits is the argument for T1). Returns an empty string if T0 is not VisualElement; otherwise, returns "VisualElement". Returns the namespace for substituteForTypeName. Returns the fully qualified name for substituteForTypeName. Returns an empty enumerable. Returns an empty enumerable. Returns the type name of T0. Returns the namespace name of T0. Returns the typefully qualified name of T0. Returns true. The attribute bag. Always true. Instantiate an object of type T0 and initialize it by calling T1 UxmlTraits.Init method. A bag of name-value pairs, one for each attribute of the UXML element. This can be used to initialize the properties of the created object. When the element is created as part of a template instance inserted in another document, this contains information about the insertion point. The created element. Returns the Type of the objects created by this factory. If implemented by your factory, this function will be called to instantiate an object of type T0. Otherwise, the default constructor of T0 will be used. A bag of name-value pairs, one for each attribute of the UXML element. This can be used to initialize the properties of the created object. When the element is created as part of a template instance inserted in another document, this contains information about the insertion point. The created element. Describes a XML float attribute. The default value for the attribute. The default value for the attribute, as a string. Constructor. Retrieves the value of this attribute from the attribute bag. Returns it if it is found, otherwise return defaultValue. The bag of attributes. The value of the attribute. Describes a XML int attribute. The default value for the attribute. The default value for the attribute, as a string. Constructor. Retrieves the value of this attribute from the attribute bag. Returns it if it is found, otherwise return defaultValue. The bag of attributes. The value of the attribute. Describes a XML long attribute. The default value for the attribute. The default value for the attribute, as a string. Constructor. Retrieves the value of this attribute from the attribute bag. Returns it if it is found, otherwise return defaultValue. The bag of attributes. The value of the attribute. Factory for the root UXML element. Returns the empty string, as the root element can not appear anywhere else bit at the root of the document. Returns the empty string, as the root element can not appear anywhere else bit at the root of the document. Returns the empty string, as the root element can not appear anywhere else bit at the root of the document. Returns "UXML". Returns the qualified name for this element. Returns null. Constructor. UxmlTraits for the UXML root element. Returns an enumerable containing UxmlChildElementDescription(typeof(VisualElement)), since the root element can contain VisualElements. Constructor. Describes a XML string attribute. The default value for the attribute. The default value for the attribute, as a string. Constructor. Retrieves the value of this attribute from the attribute bag. Returns it if it is found, otherwise return defaultValue. The bag of attributes. The value of the attribute. Describes a VisualElement derived class for the parsing of UXML files and the generation of UXML schema definition. Must return true if the UXML element attributes are not restricted to the values enumerated by UxmlTraits.uxmlAttributesDescription. Describes the UXML attributes expected by the element. The attributes enumerated here will appear in the UXML schema. Describes the types of element that can appear as children of this element in a UXML file. Initialize a VisualElement instance with values from the UXML element attributes. The VisualElement to initialize. A bag of name-value pairs, one for each attribute of the UXML element. When the element is created as part of a template instance inserted in another document, this contains information about the insertion point. Base class to restricts the value of an attribute. Indicates whether the current UxmlTypeRestriction object is equal to another object of the same type. The object to compare with. True if the otheer object is equal to this one. Restricts the value of an attribute to be within the specified bounds. True if the bounds exclude max. True if the bounds exclude min. The maximum value for the attribute. The minimum value for the attribute. Constructor. Indicates whether the current UxmlValueBounds object is equal to another object of the same type. The object to compare with. True if the otheer object is equal to this one. Restricts the value of an attribute to match a regular expression. The regular expression that should be matched by the value. Constructor. Indicates whether the current UxmlValueMatches object is equal to another object of the same type. The object to compare with. True if the otheer object is equal to this one. The event sent to probe which elements accepts a command. Constructor. Obsolete. Use VisualElement instead. Obsolete. VisualContainer.AddChild will be removed. Use VisualElement.Add or VisualElement.shadow.Add instead. VisualContainer.ClearChildren will be removed. Use VisualElement.Clear or VisualElement.shadow.Clear instead. Obsolete. Use VisualElement instead. Obsolete. VisualContainer.GetChildAt will be removed. Use VisualElement.ElementAt or VisualElement.shadow.ElementAt instead. Obsolete. VisualContainer.InsertChild will be removed. Use VisualElement.Insert or VisualElement.shadow.Insert instead. Obsolete. VisualContainer.RemoveChild will be removed. Use VisualElement.Remove or VisualElement.shadow.Remove instead. Obsolete. VisualContainer.RemoveChildAt will be removed. Use VisualElement.RemoveAt or VisualElement.shadow.RemoveAt instead. Instantiates a VisualElement using the data read from a UXML file. Returns the VisualElement type name. Returns the VisualElement type namespace. Returns the VisualElement qualified name. Returns VisualContainer type name. Returns VisualContainer namespace name. Returns VisualContainer full name. Constructor. Base class for objects that are part of the UIElements visual tree. Number of child elements in this object's contentContainer Should this element clip painting to its boundaries. child elements are added to this element, usually this Access to this element data watch interface. The default focus index for newly created elements. Returns true if the VisualElement is enabled in its own hierarchy. Returns true if the VisualElement is enabled locally. Used for view data persistence (ie. tree expanded states, scroll position, zoom level). Retrieves this VisualElement's IVisualElementScheduler Access to this element physical hierarchy Reference to the style object of this element. Text to display inside an information box after the user hovers the element for a small amount of time. This property can be used to associate application-specific user data with this VisualElement. Add an element to this element's contentContainer Adds this stylesheet file to this element list of applied styles Checks if any of the ChangeTypes have been marked dirty. The ChangeType(s) to check. True if at least one of the checked ChangeTypes have been marked dirty. Brings this element to the end of its parent children list. The element will be visually in front of any overlapping sibling elements. Returns the elements from its contentContainer Remove all child elements from this element's contentContainer Options to select clipping strategy. Enables clipping and renders contents to a cache texture. Will enable clipping. This VisualElement and its children's content will be limited to this element's bounds. Will disable clipping and let children VisualElements paint outside its bounds. Returns true if the element is a direct child of this VisualElement Retrieves the child element at position Enables or disables the class with the given name. The name of the class to enable or disable. A boolean flag that adds or removes the class name from the class list. If true, EnableInClassList adds the class name to the class list. If false, EnableInClassList removes the class name from the class list. Searchs up the hierachy of this VisualElement and retrieves stored userData, if any is found. Finds the lowest commont ancestor between two VisualElements inside the VisualTree hierarchy Allows to iterate into this elements children Walks up the hierarchy, starting from this element's parent, and returns the first VisualElement of this type Walks up the hierarchy, starting from this element, and returns the first VisualElement of this type Combine this VisualElement's VisualElement.persistenceKey with those of its parents to create a more unique key for use with VisualElement.GetOrCreatePersistentData. Full hierarchical persistence key. Takes a reference to an existing persisted object and a key and returns the object either filled with the persisted state or as-is. An existing object to be persisted, or null to create a new object. If no persisted state is found, a non-null object will be returned as-is. The key for the current VisualElement to be used with the persistence store on the EditorWindow. The same object being passed in (or a new one if null was passed in), but possibly with its persistent state restored. Takes a reference to an existing persisted object and a key and returns the object either filled with the persisted state or as-is. An existing object to be persisted, or null to create a new object. If no persisted state is found, a non-null object will be returned as-is. The key for the current VisualElement to be used with the persistence store on the EditorWindow. The same object being passed in (or a new one if null was passed in), but possibly with its persistent state restored. Checks if this stylesheet file is in this element list of applied styles Hierarchy is a sctuct allowing access to the shadow hierarchy of visual elements Number of child elements in this object's contentContainer Access the physical parent of this element in the hierarchy Add an element to this element's contentContainer Returns the elements from its contentContainer Remove all child elements from this element's contentContainer Retrieves the child element at position Retrieves the index of the specified VisualElement in the Hierarchy. The element to return the index for. Returns the index of the element, or -1 if the element is not found. Insert an element into this element's contentContainer Removes this child from the hierarchy Remove the child element located at this position from this element's contentContainer Reorders child elements from this VisualElement contentContainer. Sorting criteria. Access to this element physical hierarchy Retrieves the child index of the specified VisualElement. The child to return the index for. Returns the index of the child, or -1 if the child is not found. Insert an element into this element's contentContainer Triggers a repaint of the VisualElement on the next frame. The modes available to measure VisualElement sizes. At Most. The element should give its preferred width/height but no more than the value passed. The element should give the width/height that is passed in and derive the opposite site from this value (for example, calculate text size from a fixed width). The element should give its preferred width/height without any constraint. Called when the persistent data is accessible and/or when the data or persistence key have changed (VisualElement is properly parented). Callback when the styles of an object have changed. Overwrite object from the persistent data store. The key for the current VisualElement to be used with the persistence store on the EditorWindow. Object to overwrite. Places this element right before the sibling element in their parent children list. If the element and the sibling position overlap, the element will be visually behind of its sibling. The sibling element. Places this element right after the sibling element in their parent children list. If the element and the sibling position overlap, the element will be visually in front of its sibling. The sibling element. Removes this child from the hierarchy Remove the child element located at this position from this element's contentContainer Removes this element from its parent hierarchy Removes this stylesheet file from this element list of applied styles Write persistence data to file. Sends an event to the event handler. The event to send. Sends this element to the beginning of its parent children list. The element will be visually behind any overlapping sibling elements. Changes whether the current VisualElement is enabled or not. When disabled, a VisualElement does not receive most events. New enabled state. Reorders child elements from this VisualElement contentContainer. Sorting criteria. Access to this element physical hierarchy Toggles between adding and removing the given class name from the class list. The class name to add or remove from the class list. Instantiates a VisualElement using the data read from a UXML file. Constructor. UxmlTraits for the VisualElement. Returns an enumerable containing UxmlChildElementDescription(typeof(VisualElement)), since VisualElements can contain other VisualElements. Constructor. Initialize VisualElement properties using values from the attribute bag. The object to initialize. The attribute bag. The creation context; unused. VisualElementExtensions is a set of extension methods useful for VisualElement. Add a manipulator associated to a VisualElement. VisualElement associated to the manipulator. Manipulator to be added to the VisualElement. Remove a manipulator associated to a VisualElement. VisualElement associated to the manipulator. Manipulator to be removed from the VisualElement. The given VisualElement's left and right edges will be aligned with the corresponding edges of the parent element. Define focus change directions for the VisualElementFocusRing. Last value for the direction defined by this class. The focus is moving to the left. The focus is moving to the right. Implementation of a linear focus ring. Elements are sorted according to their focusIndex. The focus order for elements having 0 has a focusIndex. Constructor. The root of the element tree for which we want to build a focus ring. Default ordering of the elements in the ring. Ordering of elements in the focus ring. Order elements using a depth-first pre-order traversal of the element tree. Order elements according to their position, first by X, then by Y. Order elements according to their position, first by Y, then by X. Get the direction of the focus change for the given event. For example, when the Tab key is pressed, focus should be given to the element to the right in the focus ring. Get the next element in the given direction. Instances of this class hold a tree of `VisualElementAsset`s. It is created from an UXML file, and each `VisualElementAsset` represents a UXML node inside this file. A `VisualTreeAsset` can be Cloned to yield a tree of `VisualElement`s. Build a tree of VisualElements from the asset. A mapping of slot names to the VisualElements at their root. Path of the target property to be bound to the cloned tree root. The root of the tree of VisualElements that was just cloned. Build a tree of VisualElements from the asset. A mapping of slot names to the VisualElements at their root. Path of the target property to be bound to the cloned tree root. The root of the tree of VisualElements that was just cloned. Build a tree of VisualElements from the asset. A VisualElement that will act as the root of the cloned tree. A mapping of slot names to the VisualElements at their root. Constructor. Mouse wheel event. The amount of scrolling applied with the mouse wheel. Constructor. Use GetPooled() to get an event from a pool of reusable events. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained from this method should be released back to the pool using Dispose(). A wheel IMGUI event. Returns an initialized event. Resets the event members to their initial values. The UIElements module implements the UIElements retained mode UI framework.