Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.Close
For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.Close
The UIElements module implements the UIElements retained mode UI framework.
See Also: Manual pages on UIElements.
|Event sent after an element is added to an element that is a descendent of a panel.
|Abstract base class for controls.
|Traits for the BaseField.
|This is a base class for the Slider fields.
|Element that can be bound to a property.
|Event sent immediately after an element has lost focus. This event trickles down, it does not bubble up, and it cannot be cancelled.
|Styled visual element to match the IMGUI Box Style.
|A clickable button.
|Interface for classes capable of having callbacks to handle events.
|Sends an event when a value in a field changes.
|Manipulator that tracks Mouse events on an element and callbacks when the elements is clicked.
|The event sent when the left mouse button is clicked.
|Base class for command events.
|The event sent when clicking the right mouse button.
|Use this class to display a contextual menu.
|Manipulator that displays a contextual menu when the user clicks the right mouse button or presses the menu key on the keyboard.
|The event sent when a contextual menu requires menu items.
|Event sent after the custom style properties of a VisualElement have been resolved.
|Event sent just before an element is detach from its parent, if the parent is the descendant of a panel.
|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.
|The event sent to a dragged element when the drag and drop process ends.
|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.
|The event sent to an element when another element is dragged and dropped on the element.
|The event sent when the element being dragged enters a possible drop target.
|A drop-down menu.
|A menu action item.
|This class provides information about the event that triggered displaying the drop-down menu.
|An item in a drop-down menu.
|A separator menu item.
|A collection of easing curves to be used with ValueAnimations.
|The base class for all UIElements events.
|Generic base class for events, implementing event pooling and automatic registration to the event type system.
|Dispatches events to a IPanel.
|The event sent when an element should execute a command.
|Base class for objects that can get the focus.
|Base class for defining in which direction the focus moves in a focus ring.
|Class in charge of managing the focus inside a Panel.
|Event sent immediately after an element has gained focus. This event trickles down, it does not bubble up, and it cannot be cancelled.
|Base class for focus related events.
|Event sent immediately before an element gains focus. This event trickles down and bubbles up. This event cannot be cancelled.
|Event sent immediately before an element loses focus. This event trickles down and bubbles up. This event cannot be cancelled.
|Collapsable section of UI.
|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.
|Makes a help box with a message to the user.
|Extensions methods to provide additional IBindable functionality.
|A VisualElement representing a source texture.
|Element that draws IMGUI content.
|Class used to send a IMGUI event that has no equivalent UIElements event.
|VisualElement that can implement custom immediate mode rendering.
|INotifyValueChangedExtensions is a set of extension methods useful for objects implementing INotifyValueChanged.
|Sends an event when text from a TextField changes.
|Base class for keyboard events.
|Event sent when a key is pressed on the keyboard. This event trickles down and bubbles up. This event is cancellable.
|Event sent when a key is released on the keyboard. This event trickles down and bubbles up. This event is cancellable.
|Provides an Element displaying text.
|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.
|Base class for all Manipulator implementations.
|Offers functionality for generating visual content of a VisualElement during the generateVisualContent callback.
|A class that represents the vertex and index data allocated for drawing the content of a VisualElement.
|A min/max slider containing a representation of a range.
|Class that manages capturing mouse events.
|Event sent after a handler starts capturing the mouse.
|Event sent when the handler capturing the mouse changes.
|Event sent before a handler stops capturing the mouse.
|Mouse down event.
|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.
|Event sent when the mouse pointer enters a window. The event is cancellable, it does not trickle down, and it does not bubble up.
|The base class for mouse events.
|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.
|Event sent when the mouse pointer exits a window. The event is cancellable, it does not trickle down, and it does not bubble up.
|MouseManipulators have a list of activation filters.
|Mouse move event.
|Event sent when the mouse pointer exits an element. The event trickles down, it bubbles up, and it is cancellable.
|Event sent when the mouse pointer enters an element. The event trickles down, it bubbles up, and it is cancellable.
|Mouse up event.
|Abstract base class for events notifying of a panel change.
|Event sent when pointer interaction is cancelled.
|Event sent when a pointer is captured by a VisualElement.
|Base class for pointer capture events and mouse capture events.
|A static class to capture and release pointers.
|Event sent when a VisualElement releases a pointer.
|Event sent when a pointer is pressed.
|Event sent when a pointer enters a VisualElement or one of its descendant.
|Base class for pointer events.
|A static class that holds pointer ID values.
|Event sent when a pointer exits an element and all of its descendant.
|PointerManipulators have a list of activation filters.
|Event sent when a pointer changes state.
|Event sent when a pointer exits an element.
|Event sent when a pointer enters a VisualElement.
|An event sent when a pointer does not change for a set amount of time determined by the operating system.
|A static class that holds pointer type values.
|Event sent when the last depressed button of a pointer is released.
|Styled visual element that matches the EditorGUILayout.Popup IMGUI element.
|A button that executes an action repeatedly while it is pressed.
|A vertical or horizontal scrollbar.
|Displays its contents inside a scrollable frame.
|A slider containing floating point values.
|A slider containing Integer discrete values.
|Style sheets are applied to visual elements in order to control the layout and visual appearance of the user interface.
|Abstract base class for VisualElement containing text.
|A textfield is a rectangular area where the user can edit a string.
|Abstract base class used for all text-based fields.
|The theme style sheet is a collection of themes, style sheets, and rules used to define default UI appearance.
|This is the Toggle field.
|Event sent to find the first VisualElement that displays a tooltip.
|Base class for all the uxml specific attributes.
|UQuery is a set of extension methods allowing you to select individual or collection of visualElements inside a complex hierarchy.
|UQuery is a set of extension methods allowing you to select individual or collection of visualElements inside a complex hierarchy.
|Base class for describing an XML attribute.
|Factory for the root AttributeOverrides element.
|Defines UxmlTraits for the <AttributeOverrides> tag.
|Describes a XML bool attribute.
|Describe an allowed child element for an element.
|Describes a XML attribute representing a Color as a string.
|Describes a XML double attribute.
|Describes a XML attribute representing an enum as a string.
|Restricts the value of an attribute to be taken from a list of values.
|Generic base class for UXML factories, which instantiate a VisualElement using the data read from a UXML file.
|UxmlFactory specialization for classes that derive from VisualElement and that shares its traits, VisualElementTraits.
|Describes a XML float attribute.
|Describes a XML int attribute.
|Describes a XML long attribute.
|Factory for the root UXML element.
|Defines UxmlTraits for the UXML root element.
|Describes a XML string attribute.
|Factory for the root Style element.
|Defines UxmlTraits for the <Style> tag.
|Factory for the root Template element.
|Defines UxmlTraits for the <Template> tag.
|Describes a VisualElement derived class for the parsing of UXML files and the generation of UXML schema definition.
|Describes an XML System.Type attribute.
|Base class to restricts the value of an attribute.
|Restricts the value of an attribute to be within the specified bounds.
|Restricts the value of an attribute to match a regular expression.
|The event sent to probe which elements accepts a command.
|Implementation object for transition animations.
|An asset that represents a vector image.
|Base class for objects that are part of the UIElements visual tree.
|VisualElementExtensions is a set of extension methods useful for VisualElement.
|Define focus change directions for the VisualElementFocusRing.
|Implementation of a linear focus ring. Elements are sorted according to their focusIndex.
|An instance of this class holds a tree of `VisualElementAsset`s, created from a UXML file. Each node in the file corresponds to a `VisualElementAsset`. You can clone a `VisualTreeAsset` to yield a tree of `VisualElement`s.
|Mouse wheel event.
|Describes a VisualElement background.
|This class is used during UXML template instantiation.
|Script interface for VisualElement cursor style property IStyle.cursor.
|Define a custom style property for an element to be retrieved with CustomStyleResolvedEvent.
|Gates control when the dispatcher processes events.
|Reprensents a distance value.
|Used by manipulators to match events against their requirements.
|Style value that can be either a Background or a StyleKeyword.
|Style value that can be either a Color or a StyleKeyword.
|Style value that can be either a Cursor or a StyleKeyword.
|Style value that can be either an enum or a StyleKeyword.
|Style value that can be either a float or a StyleKeyword.
|Style value that can be either a Font or a StyleKeyword.
|Style value that can be either an integer or a StyleKeyword.
|Style value that can be either a Length or a StyleKeyword.
|Container object used to animate multiple style values at once.
|Contains timing information of scheduler events.
|Utility Object that contructs a set of selection rules to be ran on a root visual element.
|Query object containing all the selection rules. Can be saved and rerun later without re-allocating memory.
|Represents a vertex of geometry for drawing content of VisualElement.
|This structure manipulates the set of StyleSheet objects attached to the owner VisualElement.
|Defines the alignement behavior along an axis.
|Options for displaying alternating background colors for ListView rows.
|Describes in which context a VisualElement hierarchy is being ran.
|Defines how an element is displayed in the layout.
|Defines the main-axis of the flex layout.
|User message types.
|Defines the alignment along the main axis, how is extra space distributed.
|Describes how to interpret a Length value.
|Describes a MouseButton.
|Defines what should happend if content overflows an element bounds.
|Boxes against which the VisualElement content is clipped.
|Describes the picking behavior.
|Defaines how the position values are interpreted by the layout engine.
|The propagation phases of an event.
|Mode configuring the ScrollView for the intended usage.
|Controls how many items can be selected at once.
|This is the direction of the Slider and SliderInt.
|Keyword that can be used on any style value types.
|Specifies how the text Element treats hidden overflow content.
|Specifies which part of the text the Element replaces with an ellipsis when textOverflow is set to TextOverflow.Ellipsis.
|Use this enum to specify during which phases the event handler is executed.
|Offers a set of values that describe the intended usage patterns of a specific VisualElement.
|Specifies whether or not a VisualElement is visible.
|Word wrapping over multiple lines if not enough space is available to draw the text of an element.
|By default, items will all try to fit onto one line. You can change that and allow the items to wrap as needed with this property.