Widget Reference

From Multiverse

Jump to: navigation, search

The user interface is defined by XML elements (tags) that represent UI controls such as buttons, text strings, edit fields, and so on. These elements must go within a <Ui> element in user interface (FrameXML) files. For a general introduction to FrameXML files, see Overview of Developing Client UI.

Widget inheritance hierarchy

Some widget elements are derived from others, which means they inherit the attributes, property elements, and methods of their parent widget. Thus, the widgets may be arranged into a hierarchy, as illustrated below:

  • Region - the base element from which all other widgets are derived. It is an abstract widget type which itself cannot be created.
    • LayeredRegion - an element for renderable widgets that are not full frames.
    • Frame - a rectangular region with an opacity.
      • Browser - displays a web page in a two-dimensional overlay.
      • Button - a clickable rectangular area that displays text and an image.
        • CheckButton - a button that has checked an unchecked states.
      • EditBox - a widget where users can type in text.
      • ScrollFrame - region that can contain arbitrary widgets, is clipped, and can scroll vertically.
      • ScrollingMessageFrame - displays a sequential set of string messages (for example, chat messages).
      • StatusBar - displays a horizontal bar that indicates a value between minValue and maxValue.
      • Slider - displays a bar that indicates a value between minValue and maxValue.

All widgets are derived from Region, and all except FontString and Texture are also derived from Frame.

Region and LayeredRegion are abstract widgets, which means that you cannot create instances of them, but only instances of widgets derived from them.

Personal tools