UTFWin namespace

Namespaces

namespace BasicCursorIDs

The cursor IDs that are always available.

Classes

class BehaviourTimeOscillator

class BehaviourTimeRamp

class BehaviourTimeSmoothRamp

class BiStateEffect

class ButtonDrawableRadio

The standard IDrawable for a standard, simple radio or checkbox button component.

class ButtonDrawableStandard

The standard IDrawable for a standard, simple button component.

class CascadeEffect

class cCursorManager

template<typename Pointer, typename Reference>

class ChildrenIterator

class ComboBoxDrawable

The standard IDrawable for a combo box component.

struct ComponentSerialization

A structure that defines how a class is stored in an SPUI.

class cSPUIMessageBox

class DefaultDrawable

A class that implements all the methods of an IDrawable.

class DefaultLayoutElement

A default implementation of ILayoutElement.

template<int eventFlags = kEventFlagBasicInput | kEventFlagAdvanced>

class DefaultWinProc

A helper class to simplify the creation of window procedures (IWinProc).

class DialogDrawable

The standard IDrawable for a dialog component.

class Effect

class EventPropertyObject

class EventTimeFunctionBase

class FadeEffect

class FrameDrawable

FrameDrawable is a procedural drawable that renders multiple frame styles depending on the current state.

struct FrameStyle

class GlideEffect

class Graphics2D

A class that can be used to draw things in the user interface.

class IBiStateEffect

class IButton

An interface that declares all the functions needed by a button component.

class IButtonDrawable

This class is a type of UTFWin::IDrawable capable of rendering an UTFWin::IButton.

class ICascadeEffect

class IComboBox

class IComboBoxDrawable

An abstract class that has the methods that a drawable for a combo box would require.

class IDialog

class IDialogDrawable

An abstract class that has the methods that a drawable for a dialog would require.

class IDrawable

A class that is capable of drawing a user interface component.

class IEventTimeFunction

class IGlideEffect

class IImageDrawable

An abstract class that has the methods that a drawable that renders an image would require.

class IInflateEffect

class ILayoutElement

This class represents an element that is part of a user interfaces.

class ILayoutStyle

This class represents an object that can apply a certain layout to a given Rectangle area.

class Image

A layout element that represents an image.

class ImageDrawable

A standard IDrawable that renders an image.

class IModulateEffect

class InflateEffect

class InteractiveWindow

class InteractiveWinProc

class IPerspectiveEffect

class IRotateEffect

class IScrollbarDrawable

An abstract class that has the methods that a drawable for a scrollbar would require.

class ISlider

class ISliderDrawable

An abstract class that has the methods that a drawable for a slider would require.

class ISpinnerDrawable

An abstract class that has the methods that a drawable for a spinner would require.

class IStdDrawable

An abstract class that has the methods that a standard drawable would require.

class IText

class ITextEdit

class ITreeNode

class ITreeView

class IWindow

An interface that represents a component in the user interface.

class IWindowManager

class IWinProc

This class is a window procedure, also known as an event/message listener.

class LambdaFilterProc

class LambdaProc

class LayoutObjectsContainer

class LayoutReader

class Message

class MessageBoxCallback

class ModulateEffect

class OutlineFormat

class PerspectiveEffect

template<typename Pointer, typename Reference>

class ProcIterator

struct PropertyMethods

Structure used to define access methods for special property types.

class ProportionalLayout

struct RenderParams

A structure used to represent various parameters for the IDrawable::Paint() method, like which image to draw, the current state of the window, etc.

class RotateEffect

class ScrollbarDrawable

The standard IDrawable for a scrollbar component.

class SerializationService

struct SerializedProperty

Defines how a member of a class is stored in an SPUI.

struct Serializer

A structure that defines how an object must be read in an SPUI.

class SimpleLayout

class SliderDrawable

The standard IDrawable for a slider component.

class SpinnerDrawable

The standard IDrawable for a spinner component.

class SporeAnimatedIconWin

class SporeStdDrawable

class SporeStdDrawableImageInfo

A structure that represents an state of a SporeStdDrawable.

class SporeTooltipWinProc

class StdDrawable

The standard IDrawable for user interactive components.

struct StructSerialization

struct TextChange

This struct is used in kMsgTextChanged messages to represent the text in a ITextEdit.

class TreeNode

class UILayout

An object used to load and contain user interfaces.

class UILayoutObjects

class UIRenderer

class UTFWinObject

class VariableWidthDrawable

A drawable that completely fills the window of variable width with a graphic without a horizontal stretch.

class Window

struct Window_intrusive_list_node

class WindowChildren

class WindowProcedures

class WinTreeView

Enums

enum class OscillatorTimeFunction: uint32_t { Wave = 1 }

enum EventFlags { kEventFlagBasicInput = 0x01, kEventFlagUpdate = 0x02, kEventFlagPaint = 0x04, kEventWindowChanged = 0x08, kEventStateChanged = 0x10, kEventRefresh = 0x40, kEventFlagAdvanced = 0x80, kEventFlagLayout = 0x108, kEventFlagElement = 0x400 }

enum MessageType { kMsgKeyDown = 0x01, kMsgKeyUp = 0x02, kMsgKeyDown2 = 0x03, kMsgKeyUp2 = 0x04, kMsgKeyPress = 0x05, kMsgMouseDown = 0x06, kMsgMouseUp = 0x07, kMsgMouseMove = 0x08, kMsgMouseWheel = 0x09, kMsgRefresh = 0x0A, kMsgUpdate = 0x0C, kMsgPaint = 0x0D, kMsgWindowChanged = 0x0E, kMsgLayout = 0x10, kMsgElementAdded = 0x11, kMsgElementRemoved = 0x12, kMsgStateChanged = 0x13, kMsgCollisionDetect = 0x14, kMsgTransformed = 0x15, kMsgButtonClick = 0x17, kMsgButtonSelect = 0x18, kMsgMouseEnter = 0x1B, kMsgMouseLeave = 0x1C, kMsgWinProcAdded = 0x1000, kMsgWinProcRemoved = 0x1001, kMsgComponentActivated = 0x287259F6, kMsgTextChanged = 0x9B1552DA }

enum RefreshType { kRefreshMouse = 1, kRefreshKeyboard = 0 }

enum class BackgroundTiling: uint32_t { Stretch = 0, Tile = 1, CenterStretch = 2, CenterTile = 3 }

enum class TriggerType { Visible = 0, Invisible = 1, Enabled = 2, Disabled = 3, MouseFocus = 4, KeyboardFocus = 5, AnyFocus = 6, NoMouseFocus = 7, NoKeyboardFocus = 8, NoFocus = 9, ButtonSelected = 10, ButtonUnselected = 11 }

enum class InterpolationType { Linear = 0, EaseInEaseOut = 1, DampedSpring = 2 }

enum ButtonFlags { kBtnFlagTriggerOnDown = 0x00000001, kBtnFlagFixedWidth = 0x00000002, kBtnFlagFixedHeight = 0x00000004 }

Flags that can be set to an UTFWin::IButton.

enum ButtonStateFlags { kBtnStateSelected = 4 }

Flags related to the state of a button that can be set to an UTFWin::IButton.

enum ComboBoxFlags { kComboBoxOutline = 0x00000001 }

enum class ComboBoxColors { Foreground = 0, Background = 1, HighlightedForeground = 2, HighlightedBackground = 3, SelectedForeground = 4, SelectedBackground = 5 }

enum class Scaling { StretchImage = 1, StretchCenter = 2, TileImage = 3, TileCenter = 4 }

An enumeration used by certain drawables, that determines how to draw the images.

enum class AlignmentH { Left = 1, Right = 2, Center = 3 }

enum class AlignmentV { Top = 1, Bottom = 2, Middle = 3 }

enum class FontAlignmentH { Default = 0, Left = 1, Right = 2, Center = 3 }

enum class FontAlignmentV { Default = 0, Top = 1, Bottom = 2, Middle = 3 }

enum class Orientation { Horizontal = 1, Vertical = 2 }

enum class ButtonTypes { Standard = 1, Toggle = 2, Radio = 3 }

enum class StateIndices: uint32_t { Normal = 0, Disabled = 1, Highlighted = 2, Active = 3, CheckedNormal = 4, CheckedDisabled = 5, CheckedHighlighted = 6, CheckedActive = 7 }

enum class Sides { Left = 0, Top = 1, Right = 2, Bottom = 3 }

enum class ImageTiling { None = 0, Standard = 1, Edge = 2 }

An enumeration used by ImageDrawable, that determine how the image is tiled.

enum class TextColors { Text = 0, Background = 1, DisabledText = 2, DisabledBackground = 3, SelectedText = 4, SelectedBackground = 5, Caret = 6, CaretBackground = 7 }

enum class TextEditWarpMode: uint32_t { SingleLine = 0, MultiLine = 1, MultiLineWordWrap = 2 }

enum class ScrollbarEnDis: uint32_t { Never = 0, AsNeeded = 1, Always = 2 }

enum WindowFlags { kWinFlagVisible = 0x1, kWinFlagEnabled = 0x2, kWinFlagClickToFront = 0x4, kWinFlagIgnoreMouse = 0x10, kWinFlagAlwaysInFront = 0x40, kWinFlagClip = 0x400, kWinFlagIgnoreMouseChildren = 0x1000 }

enum WindowStates { kStateEnabled = 1, kStateClicked = 2, kStateHover = 8 }

enum SerializedTypes { kTypeParent = 1, kTypeBool = 2, kTypeUInt8 = 3, kTypeUInt16 = 4, kTypeUInt32 = 5, kTypeUInt64 = 6, kTypeInt8 = 7, kTypeInt16 = 8, kTypeInt32 = 9, kTypeInt64 = 10, kTypeFloat = 11, kTypeDim = 15, kTypeVec4 = 16, kTypeVec2 = 17, kTypeText = 18, kTypePointer = 19, kTypeStruct = 20, kFlagArray = 0x8000 }

The possible property types used in SPUI serialization.

enum LayoutAnchor { kAnchorTop = 1, kAnchorBottom = 2, kAnchorLeft = 4, kAnchorRight = 8 }

enum class IconDrawModes: uint32_t { ImageSize = 0, WindowSize = 1 }

enum class ShadowModes: uint32_t { None = 0, Full = 1, Background = 2, Icon = 3 }

enum class TooltipBehaviour: uint32_t { Default = 0, UnderWindow = 1, Offset = 2 }

Typedefs

using IWindowList_t = eastl::intrusive_list<Window_intrusive_list_node>

using HandleUILambda_t = bool(*)(IWindow*, const Message&)

using Tooltip = SporeTooltipWinProc

using ProgressBarDrawable = VariableWidthDrawable

Functions

auto GetAllocator() -> ICoreAllocator*

ASSERT_SIZE(ButtonDrawableRadio, 0x18)

auto Addresses(ButtonDrawableRadio) -> namespace

ASSERT_SIZE(ButtonDrawableStandard, 0x18)

auto Addresses(ButtonDrawableStandard) -> namespace

ASSERT_SIZE(CascadeEffect, 0x40)

auto Addresses(CascadeEffect) -> namespace

ASSERT_SIZE(ComboBoxDrawable, 0x1C)

auto Addresses(ComboBoxDrawable) -> namespace

auto GetEventFlags(MessageType type) -> EventFlags

auto Addresses(cSPUIMessageBox) -> namespace

auto Addresses(cCursorManager) -> namespace

ASSERT_SIZE(DialogDrawable, 0x40)

auto Addresses(DialogDrawable) -> namespace

ASSERT_SIZE(BiStateEffect, 0x60)

auto Addresses(BiStateEffect) -> namespace

ASSERT_SIZE(EventTimeFunctionBase, 0x48)

ASSERT_SIZE(FadeEffect, 0x60)

auto Addresses(FadeEffect) -> namespace

ASSERT_SIZE(FrameDrawable, 0x60)

auto Addresses(FrameDrawable) -> namespace

ASSERT_SIZE(GlideEffect, 0x70)

auto Addresses(GlideEffect) -> namespace

auto Addresses(Graphics2D) -> namespace

auto Addresses(IButton) -> namespace

ASSERT_SIZE(Image, 0x2C)

auto Addresses(Image) -> namespace

ASSERT_SIZE(ImageDrawable, 0x50)

auto Addresses(ImageDrawable) -> namespace

auto Addresses(IImageDrawable) -> namespace

ASSERT_SIZE(InflateEffect, 0xB8)

auto Addresses(InflateEffect) -> namespace

auto Addresses(InteractiveWinProc) -> namespace

auto Addresses(ITextEdit) -> namespace

auto Addresses(IWindowManager) -> namespace

ASSERT_SIZE(Message, 0x1C)

ASSERT_SIZE(ModulateEffect, 0x70)

auto Addresses(ModulateEffect) -> namespace

ASSERT_SIZE(OutlineFormat, 0x28)

ASSERT_SIZE(PerspectiveEffect, 0x14)

auto Addresses(PerspectiveEffect) -> namespace

ASSERT_SIZE(ProportionalLayout, 0x20)

auto Addresses(ProportionalLayout) -> namespace

ASSERT_SIZE(RotateEffect, 0x78)

auto Addresses(RotateEffect) -> namespace

auto Addresses(ScrollbarDrawable) -> namespace

ASSERT_SIZE(ScrollbarDrawable, 0x2C)

ASSERT_SIZE(SerializationService, 0x34)

ASSERT_SIZE(SimpleLayout, 0x14)

auto Addresses(SimpleLayout) -> namespace

ASSERT_SIZE(SliderDrawable, 0x1C)

auto Addresses(SliderDrawable) -> namespace

ASSERT_SIZE(SpinnerDrawable, 0x1C)

auto Addresses(SpinnerDrawable) -> namespace

ASSERT_SIZE(SporeStdDrawable, 0x160)

auto Addresses(SporeStdDrawable) -> namespace

ASSERT_SIZE(SporeStdDrawableImageInfo, 0x98)

auto Addresses(SporeStdDrawableImageInfo) -> namespace

auto CreateTooltip(const char16_t* pText, const char16_t* pDetailedText = u"", const char16_t* pLayoutName = u"tooltips", uint32_t controlID = 0x3754E6C, uint32_t detailControlID = 0x3754E6C) -> Tooltip*

Creates an instance of the Tooltip class that can be used to display the given text as a tooltip.

ASSERT_SIZE(SporeTooltipWinProc, 0x68)

auto Addresses(SporeTooltipWinProc) -> namespace

ASSERT_SIZE(StdDrawable, 0x7C)

auto Addresses(StdDrawable) -> namespace

ASSERT_SIZE(TreeNode, 0x50)

auto Addresses(TreeNode) -> namespace

ASSERT_SIZE(UILayout, 0x18)

auto Addresses(UILayout) -> namespace

ASSERT_SIZE(LayoutObjectsContainer, 0x80)

auto Addresses(UIRenderer) -> namespace

auto Addresses(UTFWinObject) -> namespace

ASSERT_SIZE(VariableWidthDrawable, 0x14)

auto Addresses(VariableWidthDrawable) -> namespace

ASSERT_SIZE(Window, 0x20C)

auto Addresses(Window) -> namespace

ASSERT_SIZE(WinTreeView, 0x368)

Enum documentation

Typedef documentation

Function documentation