Controls

From ESOUI Wiki

(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
 +
=== Control (WINDOW_MANAGER) ===
 +
 +
* ClearAnchors '''protected-attributes''' ()
 +
 +
* CreateControl('''string''' ''arg1'', '''integer''' ''type'')
 +
** ''Returns:'' '''object''' ''apRet''
 +
 +
* GetAlpha()
 +
** ''Returns:'' '''number''' ''alpha''
 +
 +
* GetAnchor('''integer''' ''anchorIndex'')
 +
** ''Returns:'' '''bool''' ''isValidAnchor'', '''integer''' ''point'', '''object''' ''relativeTo'', '''integer''' ''relativePoint'', '''number''' ''offsetX'', '''number''' ''offsetY''
 +
 +
* GetBottom()
 +
** ''Returns:'' '''number''' ''bottom''
 +
 +
* GetCenter()
 +
** ''Returns:'' '''number''' ''centerX'', '''number''' ''centerY''
 +
 +
* GetChild('''luaindex''' ''childIndex'')
 +
** ''Returns:'' '''object''' ''childControl''
 +
 +
* GetClampedToScreen()
 +
** ''Returns:'' '''bool''' ''clamped''
 +
 +
* GetClampedToScreenInsets()
 +
** ''Returns:'' '''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom''
 +
 +
* GetDesiredHeight()
 +
** ''Returns:'' '''number''' ''height''
 +
 +
* GetDesiredWidth()
 +
** ''Returns:'' '''number''' ''width''
 +
 +
* GetDimensionConstraints()
 +
** ''Returns:'' '''number''' ''minWidth'', '''number''' ''minHeight'', '''number''' ''maxWidth'', '''number''' ''maxHeight''
 +
 +
* GetDimensions()
 +
** ''Returns:'' '''number''' ''width'', '''number''' ''height''
 +
 +
* GetDrawLayer()
 +
** ''Returns:'' '''integer''' ''layer''
 +
 +
* GetDrawLevel()
 +
** ''Returns:'' '''integer''' ''level''
 +
 +
* GetDrawTier()
 +
** ''Returns:'' '''integer''' ''tier''
 +
 +
* GetExcludeFromResizeToFitExtents()
 +
** ''Returns:'' '''bool''' ''excludes''
 +
 +
* GetHandler('''string''' ''handlerName'')
 +
** ''Returns:'' '''function''' ''functionRef''
 +
 +
* GetHeight()
 +
** ''Returns:'' '''number''' ''height''
 +
 +
* GetHitInsets()
 +
** ''Returns:'' '''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom''
 +
 +
* GetId()
 +
** ''Returns:'' '''integer''' ''id''
 +
 +
* GetInheritsAlpha()
 +
** ''Returns:'' '''bool''' ''inheritAlpha''
 +
 +
* GetInheritsScale()
 +
** ''Returns:'' '''bool''' ''inheritScale''
 +
 +
* GetLeft()
 +
** ''Returns:'' '''number''' ''left''
 +
 +
* GetName()
 +
** ''Returns:'' '''string''' ''name''
 +
 +
* GetNamedChild('''string''' ''childName'')
 +
** ''Returns:'' '''object''' ''returnedControl''
 +
 +
* GetNumChildren()
 +
** ''Returns:'' '''integer''' ''numChildren''
 +
 +
* GetOwningWindow()
 +
** ''Returns:'' '''object''' ''OwningTopLevelWindow''
 +
 +
* GetParent()
 +
** ''Returns:'' '''object''' ''ret1''
 +
 +
* GetResizeToFitDescendents()
 +
** ''Returns:'' '''bool''' ''resizes''
 +
 +
* GetResizeToFitPadding()
 +
** ''Returns:'' '''number''' ''width'', '''number''' ''height''
 +
 +
* GetRight()
 +
** ''Returns:'' '''number''' ''right''
 +
 +
* GetScale()
 +
** ''Returns:'' '''number''' ''scale''
 +
 +
* GetScreenRect()
 +
** ''Returns:'' '''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom''
 +
 +
* GetTop()
 +
** ''Returns:'' '''number''' ''top''
 +
 +
* GetType()
 +
** ''Returns:'' '''integer''' ''type''
 +
 +
* GetWidth()
 +
** ''Returns:'' '''number''' ''width''
 +
 +
* IsChildOf('''object''' ''desiredParent'')
 +
** ''Returns:'' '''bool''' ''isChild''
 +
 +
* IsControlHidden()
 +
** ''Returns:'' '''bool''' ''hidden''
 +
 +
* IsHandlerSet('''string''' ''handlerName'')
 +
** ''Returns:'' '''bool''' ''isSet''
 +
 +
* IsHidden()
 +
** ''Returns:'' '''bool''' ''hidden''
 +
 +
* IsKeyboardEnabled()
 +
** ''Returns:'' '''bool''' ''enabled''
 +
 +
* IsMouseEnabled()
 +
** ''Returns:'' '''bool''' ''enabled''
 +
 +
* SetAlpha '''protected-attributes''' ('''number''' ''alpha'')
 +
 +
* SetAnchor '''protected-attributes''' ('''integer''' ''whereOnMe'', '''object''' ''anchorTargetControl'', '''integer''' ''whereOnTarget'', '''number''' ''offsetX'', '''number''' ''offsetY'')
 +
 +
* SetAnchorFill '''protected-attributes''' ('''object''' ''anchorTargetControl'')
 +
 +
* SetClampedToScreen('''bool''' ''clamped'')
 +
 +
* SetClampedToScreenInsets('''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom'')
 +
 +
* SetDimensionConstraints('''number''' ''minWidth'', '''number''' ''minHeight'', '''number''' ''maxWidth'', '''number''' ''maxHeight'')
 +
 +
* SetDimensions '''protected-attributes''' ('''number''' ''width'', '''number''' ''height'')
 +
 +
* SetDrawLayer '''protected-attributes''' ('''integer''' ''layer'')
 +
 +
* SetDrawLevel '''protected-attributes''' ('''integer''' ''level'')
 +
 +
* SetDrawTier '''protected-attributes''' ('''integer''' ''tier'')
 +
 +
* SetExcludeFromResizeToFitExtents '''protected-attributes''' ('''bool''' ''exclude'')
 +
 +
* SetHandler('''string''' ''handlerName'', '''function''' ''functionRef'')
 +
 +
* SetHeight '''protected-attributes''' ('''number''' ''height'')
 +
 +
* SetHidden '''protected-attributes''' ('''bool''' ''aHidden'')
 +
 +
* SetHitInsets('''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom'')
 +
 +
* SetId('''integer''' ''id'')
 +
 +
* SetInheritAlpha('''bool''' ''inheritAlpha'')
 +
 +
* SetInheritScale('''bool''' ''inheritScale'')
 +
 +
* SetKeyboardEnabled '''protected-attributes''' ('''bool''' ''enabled'')
 +
 +
* SetMouseEnabled '''protected-attributes''' ('''bool''' ''enabled'')
 +
 +
* SetMovable('''bool''' ''isMovable'')
 +
 +
* SetParent '''protected-attributes''' ('''object''' ''newParent'')
 +
 +
* SetResizeHandleSize('''number''' ''handleSize'')
 +
 +
* SetResizeToFitDescendents '''protected-attributes''' ('''bool''' ''resize'')
 +
 +
* SetResizeToFitPadding('''number''' ''width'', '''number''' ''height'')
 +
 +
* SetScale '''protected-attributes''' ('''number''' ''scale'')
 +
 +
* SetShapeType '''public''' ('''integer''' ''shapeType'')
 +
 +
* SetSimpleAnchor '''protected-attributes''' ('''object''' ''anchorTargetControl'', '''number''' ''offsetX'', '''number''' ''offsetY'')
 +
 +
* SetSimpleAnchorParent '''protected-attributes''' ('''number''' ''offsetX'', '''number''' ''offsetY'')
 +
 +
* SetWidth '''protected-attributes''' ('''number''' ''width'')
 +
 +
* StartMoving '''protected-attributes''' ()
 +
** ''Returns:'' '''bool''' ''isMoving''
 +
 +
* StopMovingOrResizing '''protected-attributes''' ()
 +
 +
* ToggleHidden '''protected-attributes''' ()
 +
 +
==== Objects that inherit behavior from '''Control''' ====
 +
* [[#BackdropControl|BackdropControl]]
 +
* [[#BrowserControl|BrowserControl]]
 +
* [[#ButtonControl|ButtonControl]]
 +
* [[#ColorSelectControl|ColorSelectControl]]
 +
* [[#CompassDisplayControl|CompassDisplayControl]]
 +
* [[#CooldownControl|CooldownControl]]
 +
* [[#DebugTextControl|DebugTextControl]]
 +
* [[#EditControl|EditControl]]
 +
* [[#LabelControl|LabelControl]]
 +
* [[#LineControl|LineControl]]
 +
* [[#MapDisplayControl|MapDisplayControl]]
 +
* [[#RootWindow|RootWindow]]
 +
* [[#ScrollControl|ScrollControl]]
 +
* [[#SliderControl|SliderControl]]
 +
* [[#StatusBarControl|StatusBarControl]]
 +
* [[#TextBufferControl|TextBufferControl]]
 +
* [[#TextureControl|TextureControl]]
 +
* [[#TooltipControl|TooltipControl]]
 +
* [[#TopLevelWindow|TopLevelWindow]]
 +
=== AddOnManager ===
=== AddOnManager ===
* AddRelevantFilter('''string''' ''relevantFilter'')
* AddRelevantFilter('''string''' ''relevantFilter'')
Line 477: Line 695:
-
=== Event Manager (EVENT_MANAGER) ===
+
=== EventManager (EVENT_MANAGER) ===
* RegisterForEvent('''integer''' ''event'', '''function''' ''callback'')
* RegisterForEvent('''integer''' ''event'', '''function''' ''callback'')
Line 485: Line 703:
** ''Returns:'' '''bool''' ''success''
** ''Returns:'' '''bool''' ''success''
-
 
-
=== Control (WINDOW_MANAGER) ===
 
-
 
-
* ClearAnchors '''protected-attributes''' ()
 
-
 
-
* CreateControl('''string''' ''arg1'', '''integer''' ''type'')
 
-
** ''Returns:'' '''object''' ''apRet''
 
-
 
-
* GetAlpha()
 
-
** ''Returns:'' '''number''' ''alpha''
 
-
 
-
* GetAnchor('''integer''' ''anchorIndex'')
 
-
** ''Returns:'' '''bool''' ''isValidAnchor'', '''integer''' ''point'', '''object''' ''relativeTo'', '''integer''' ''relativePoint'', '''number''' ''offsetX'', '''number''' ''offsetY''
 
-
 
-
* GetBottom()
 
-
** ''Returns:'' '''number''' ''bottom''
 
-
 
-
* GetCenter()
 
-
** ''Returns:'' '''number''' ''centerX'', '''number''' ''centerY''
 
-
 
-
* GetChild('''luaindex''' ''childIndex'')
 
-
** ''Returns:'' '''object''' ''childControl''
 
-
 
-
* GetClampedToScreen()
 
-
** ''Returns:'' '''bool''' ''clamped''
 
-
 
-
* GetClampedToScreenInsets()
 
-
** ''Returns:'' '''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom''
 
-
 
-
* GetDesiredHeight()
 
-
** ''Returns:'' '''number''' ''height''
 
-
 
-
* GetDesiredWidth()
 
-
** ''Returns:'' '''number''' ''width''
 
-
 
-
* GetDimensionConstraints()
 
-
** ''Returns:'' '''number''' ''minWidth'', '''number''' ''minHeight'', '''number''' ''maxWidth'', '''number''' ''maxHeight''
 
-
 
-
* GetDimensions()
 
-
** ''Returns:'' '''number''' ''width'', '''number''' ''height''
 
-
 
-
* GetDrawLayer()
 
-
** ''Returns:'' '''integer''' ''layer''
 
-
 
-
* GetDrawLevel()
 
-
** ''Returns:'' '''integer''' ''level''
 
-
 
-
* GetDrawTier()
 
-
** ''Returns:'' '''integer''' ''tier''
 
-
 
-
* GetExcludeFromResizeToFitExtents()
 
-
** ''Returns:'' '''bool''' ''excludes''
 
-
 
-
* GetHandler('''string''' ''handlerName'')
 
-
** ''Returns:'' '''function''' ''functionRef''
 
-
 
-
* GetHeight()
 
-
** ''Returns:'' '''number''' ''height''
 
-
 
-
* GetHitInsets()
 
-
** ''Returns:'' '''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom''
 
-
 
-
* GetId()
 
-
** ''Returns:'' '''integer''' ''id''
 
-
 
-
* GetInheritsAlpha()
 
-
** ''Returns:'' '''bool''' ''inheritAlpha''
 
-
 
-
* GetInheritsScale()
 
-
** ''Returns:'' '''bool''' ''inheritScale''
 
-
 
-
* GetLeft()
 
-
** ''Returns:'' '''number''' ''left''
 
-
 
-
* GetName()
 
-
** ''Returns:'' '''string''' ''name''
 
-
 
-
* GetNamedChild('''string''' ''childName'')
 
-
** ''Returns:'' '''object''' ''returnedControl''
 
-
 
-
* GetNumChildren()
 
-
** ''Returns:'' '''integer''' ''numChildren''
 
-
 
-
* GetOwningWindow()
 
-
** ''Returns:'' '''object''' ''OwningTopLevelWindow''
 
-
 
-
* GetParent()
 
-
** ''Returns:'' '''object''' ''ret1''
 
-
 
-
* GetResizeToFitDescendents()
 
-
** ''Returns:'' '''bool''' ''resizes''
 
-
 
-
* GetResizeToFitPadding()
 
-
** ''Returns:'' '''number''' ''width'', '''number''' ''height''
 
-
 
-
* GetRight()
 
-
** ''Returns:'' '''number''' ''right''
 
-
 
-
* GetScale()
 
-
** ''Returns:'' '''number''' ''scale''
 
-
 
-
* GetScreenRect()
 
-
** ''Returns:'' '''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom''
 
-
 
-
* GetTop()
 
-
** ''Returns:'' '''number''' ''top''
 
-
 
-
* GetType()
 
-
** ''Returns:'' '''integer''' ''type''
 
-
 
-
* GetWidth()
 
-
** ''Returns:'' '''number''' ''width''
 
-
 
-
* IsChildOf('''object''' ''desiredParent'')
 
-
** ''Returns:'' '''bool''' ''isChild''
 
-
 
-
* IsControlHidden()
 
-
** ''Returns:'' '''bool''' ''hidden''
 
-
 
-
* IsHandlerSet('''string''' ''handlerName'')
 
-
** ''Returns:'' '''bool''' ''isSet''
 
-
 
-
* IsHidden()
 
-
** ''Returns:'' '''bool''' ''hidden''
 
-
 
-
* IsKeyboardEnabled()
 
-
** ''Returns:'' '''bool''' ''enabled''
 
-
 
-
* IsMouseEnabled()
 
-
** ''Returns:'' '''bool''' ''enabled''
 
-
 
-
* SetAlpha '''protected-attributes''' ('''number''' ''alpha'')
 
-
 
-
* SetAnchor '''protected-attributes''' ('''integer''' ''whereOnMe'', '''object''' ''anchorTargetControl'', '''integer''' ''whereOnTarget'', '''number''' ''offsetX'', '''number''' ''offsetY'')
 
-
 
-
* SetAnchorFill '''protected-attributes''' ('''object''' ''anchorTargetControl'')
 
-
 
-
* SetClampedToScreen('''bool''' ''clamped'')
 
-
 
-
* SetClampedToScreenInsets('''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom'')
 
-
 
-
* SetDimensionConstraints('''number''' ''minWidth'', '''number''' ''minHeight'', '''number''' ''maxWidth'', '''number''' ''maxHeight'')
 
-
 
-
* SetDimensions '''protected-attributes''' ('''number''' ''width'', '''number''' ''height'')
 
-
 
-
* SetDrawLayer '''protected-attributes''' ('''integer''' ''layer'')
 
-
 
-
* SetDrawLevel '''protected-attributes''' ('''integer''' ''level'')
 
-
 
-
* SetDrawTier '''protected-attributes''' ('''integer''' ''tier'')
 
-
 
-
* SetExcludeFromResizeToFitExtents '''protected-attributes''' ('''bool''' ''exclude'')
 
-
 
-
* SetHandler('''string''' ''handlerName'', '''function''' ''functionRef'')
 
-
 
-
* SetHeight '''protected-attributes''' ('''number''' ''height'')
 
-
 
-
* SetHidden '''protected-attributes''' ('''bool''' ''aHidden'')
 
-
 
-
* SetHitInsets('''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom'')
 
-
 
-
* SetId('''integer''' ''id'')
 
-
 
-
* SetInheritAlpha('''bool''' ''inheritAlpha'')
 
-
 
-
* SetInheritScale('''bool''' ''inheritScale'')
 
-
 
-
* SetKeyboardEnabled '''protected-attributes''' ('''bool''' ''enabled'')
 
-
 
-
* SetMouseEnabled '''protected-attributes''' ('''bool''' ''enabled'')
 
-
 
-
* SetMovable('''bool''' ''isMovable'')
 
-
 
-
* SetParent '''protected-attributes''' ('''object''' ''newParent'')
 
-
 
-
* SetResizeHandleSize('''number''' ''handleSize'')
 
-
 
-
* SetResizeToFitDescendents '''protected-attributes''' ('''bool''' ''resize'')
 
-
 
-
* SetResizeToFitPadding('''number''' ''width'', '''number''' ''height'')
 
-
 
-
* SetScale '''protected-attributes''' ('''number''' ''scale'')
 
-
 
-
* SetShapeType '''public''' ('''integer''' ''shapeType'')
 
-
 
-
* SetSimpleAnchor '''protected-attributes''' ('''object''' ''anchorTargetControl'', '''number''' ''offsetX'', '''number''' ''offsetY'')
 
-
 
-
* SetSimpleAnchorParent '''protected-attributes''' ('''number''' ''offsetX'', '''number''' ''offsetY'')
 
-
 
-
* SetWidth '''protected-attributes''' ('''number''' ''width'')
 
-
 
-
* StartMoving '''protected-attributes''' ()
 
-
** ''Returns:'' '''bool''' ''isMoving''
 
-
 
-
* StopMovingOrResizing '''protected-attributes''' ()
 
-
 
-
* ToggleHidden '''protected-attributes''' ()
 
-
 
-
==== Objects that inherit behavior from '''Control''' ====
 
-
* [[#BackdropControl|BackdropControl]]
 
-
* [[#BrowserControl|BrowserControl]]
 
-
* [[#ButtonControl|ButtonControl]]
 
-
* [[#ColorSelectControl|ColorSelectControl]]
 
-
* [[#CompassDisplayControl|CompassDisplayControl]]
 
-
* [[#CooldownControl|CooldownControl]]
 
-
* [[#DebugTextControl|DebugTextControl]]
 
-
* [[#EditControl|EditControl]]
 
-
* [[#LabelControl|LabelControl]]
 
-
* [[#LineControl|LineControl]]
 
-
* [[#MapDisplayControl|MapDisplayControl]]
 
-
* [[#RootWindow|RootWindow]]
 
-
* [[#ScrollControl|ScrollControl]]
 
-
* [[#SliderControl|SliderControl]]
 
-
* [[#StatusBarControl|StatusBarControl]]
 
-
* [[#TextBufferControl|TextBufferControl]]
 
-
* [[#TextureControl|TextureControl]]
 
-
* [[#TooltipControl|TooltipControl]]
 
-
* [[#TopLevelWindow|TopLevelWindow]]
 
=== CooldownControl ===
=== CooldownControl ===

Revision as of 14:51, 1 April 2014

Contents

Control (WINDOW_MANAGER)

Objects that inherit behavior from Control

AddOnManager


AnimationManager


AnimationObject

Objects that inherit behavior from AnimationObject


AnimationObjectAlpha


AnimationObjectColor


AnimationObjectCustom


AnimationObjectScale


AnimationObjectScroll


AnimationObjectSize


AnimationObjectTexture


AnimationObjectTextureRotate


AnimationObjectTextureSlide


AnimationObjectTranslate


AnimationTimeline


BackdropControl


BrowserControl


ButtonControl


ColorSelectControl


CompassDisplayControl


EventManager (EVENT_MANAGER)


CooldownControl


DebugTextControl


EditControl (ZO_ChatWindowTextEntryEditBox)


FontObject


LabelControl


LineControl


MapDisplayControl


RootWindow

ScrollControl


SliderControl


StatusBarControl


TextBufferControl (CHAT_SYSTEM)


TextureControl


TooltipControl


TopLevelWindow


WindowManager

Personal tools
Namespaces
Variants
Actions
Menu
Wiki
Toolbox