Navigation menu
Personal tools
Not logged in
Talk
Contributions
Create account
Log in
Namespaces
WoW
Talk
English
Views
Read
Edit
History
More
Search
Navigation
Home
Random page
Help using wiki
Editions
for WoW
for WildStar
for Solar2D
Documentation
for WoW
for WildStar
Reference
WoW
⦁ FrameXML
⦁ AddOns
⦁ API
⦁ WoW Lua
WildStar
⦁ AddOns
⦁ API
⦁ WildStar Lua
Engine
Tools
What links here
Related changes
Special pages
Page information
Site
Recent Changes
Editing
WoW:UISUMMARY CheckButton
Jump to navigation
Jump to search
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
{{widget}} {{tocright}} == Summary == (See [[UIOBJECT CheckButton|CheckButton object information]] for details) == Methods == === Inherited UIObject Methods === [[UISUMMARY UIObject|UIObject object summary]] : [[API UIObject GetAlpha|CheckButton:GetAlpha]] : [[API UIObject GetName|CheckButton:GetName]] : [[API UIObject GetObjectType|CheckButton:GetObjectType()]] - Get the type of this object - New in 1.10 : [[API UIObject IsObjectType|CheckButton:IsObjectType("type")]] - Determine if this object is of the specified type, or a subclass of that type - New in 1.10. : [[API UIObject SetAlpha|CheckButton:SetAlpha]] === Inherited Region Methods === [[UISUMMARY Region|Region object summary]] : [[API Region ClearAllPoints|CheckButton:ClearAllPoints]] : [[API Region GetBottom|CheckButton:GetBottom]] : [[API Region GetCenter|CheckButton:GetCenter]] : [[API Region GetHeight|CheckButton:GetHeight]] : [[API Region GetLeft|CheckButton:GetLeft]] : [[API Region GetNumPoints|CheckButton:GetNumPoints]] : [[API Region GetParent|CheckButton:GetParent]] : [[API Region GetPoint|CheckButton:GetPoint]] : [[API Region GetRight|CheckButton:GetRight]] : [[API Region GetTop|CheckButton:GetTop]] : [[API Region GetWidth|CheckButton:GetWidth]] : [[API Region Hide|CheckButton:Hide]] : [[API Region IsShown|CheckButton:IsShown]] : [[API Region IsVisible|CheckButton:IsVisible]] : [[API Region SetAllPoints|CheckButton:SetAllPoints]] : [[API Region SetHeight|CheckButton:SetHeight]] : [[API Region SetParent|CheckButton:SetParent]] : [[API Region SetPoint|CheckButton:SetPoint]] : [[API Region SetWidth|CheckButton:SetWidth]] : [[API Region Show|CheckButton:Show]] === Inherited Frame Methods === [[UISUMMARY Frame|Frame object summary]] : [[API Frame CreateFontString|CheckButton:CreateFontString(["name"[,"layer"]])]] - Create and return a new FontString as a child of this Frame. : [[API Frame CreateTexture|CheckButton:CreateTexture(["name"[,"layer"]])]] - Create and return a new Texture as a child of this Frame. : [[API Frame CreateTitleRegion|CheckButton:CreateTitleRegion]] : [[API Frame DisableDrawLayer|CheckButton:DisableDrawLayer("layer")]] - Disable rendering of regions in the specified draw layer. : [[API Frame EnableDrawLayer|CheckButton:EnableDrawLayer("layer")]] - Enable rendering of regions in the specified draw layer. : [[API Frame EnableKeyboard|CheckButton:EnableKeyboard(enableFlag)]] - Set whether this frame will get keyboard input. : [[API Frame EnableMouse|CheckButton:EnableMouse(enableFlag)]] - Set whether this frame will get mouse input. : [[API Frame EnableMouseWheel|CheckButton:EnableMouseWheel(enableFlag)]] - Set whether this frame will get mouse wheel events. : [[API Frame GetBackdrop|CheckButton:GetBackdrop]] : [[API Frame GetBackdropBorderColor|CheckButton:GetBackdropBorderColor]] : [[API Frame GetBackdropColor|CheckButton:GetBackdropColor]] : [[API Frame GetChildren|CheckButton:GetChildren()]] - Get children of this frame. : [[API Frame GetEffectiveScale|CheckButton:GetEffectiveScale()]] - Get the scale factor of this object relative to the root window. : [[API Frame GetFrameLevel|CheckButton:GetFrameLevel()]] - Get the level of this frame. : [[API Frame GetFrameStrata|CheckButton:GetFrameStrata()]] - Get the strata of this frame. : [[API Frame GetFrameType|CheckButton:GetFrameType()]] - Get the type of this frame. : [[API Frame GetHitRectInsets|CheckButton:GetHitRectInsets]] : [[API Frame GetID|CheckButton:GetID()]] - Get the ID of this frame. : [[API Frame GetMaxResize|CheckButton:GetMaxResize]] : [[API Frame GetMinResize|CheckButton:GetMinResize]] : [[API Frame GetNumChildren|CheckButton:GetNumChildren()]] - Get the number of children this frame has. : [[API Frame GetNumRegions|CheckButton:GetNumRegions()]] - Return the number of Regions that are children of this frame. : [[API Frame GetRegions|CheckButton:GetRegions()]] - Return the regions of the frame (multiple return values). : [[API Frame GetScale|CheckButton:GetScale()]] - Get the scale factor of this object relative to its parent. : [[API Frame GetScript|CheckButton:GetScript("handler")]] - Get the function for one of this frame's handlers. : [[API Frame GetTitleRegion|CheckButton:GetTitleRegion]] : [[API Frame HasScript|CheckButton:HasScript("handler")]] - Return true if the frame can be given a handler of the specified type (NOT whether it actually HAS one, use GetScript for that) - Since 1.8. : [[API Frame IsClampedToScreen|CheckButton:IsClampedToScreen]] : [[API Frame IsFrameType|CheckButton:IsFrameType("type")]] - Determine if this frame is of the specified type, or a subclass of that type. : [[API Frame IsKeyboardEnabled|CheckButton:IsKeyboardEnabled]] : [[API Frame IsMouseEnabled|CheckButton:IsMouseEnabled]] : [[API Frame IsMouseWheelEnabled|CheckButton:IsMouseWheelEnabled]] : [[API Frame IsMovable|CheckButton:IsMovable()]] - Determine if the frame can be moved. : [[API Frame IsResizable|CheckButton:IsResizable()]] - Determine if the frame can be resized. : [[API Frame IsToplevel|CheckButton:IsToplevel]] : [[API Frame IsUserPlaced|CheckButton:IsUserPlaced()]] - Determine if this frame has been relocated by the user. : [[API Frame Lower|CheckButton:Lower()]] - Lower this frame behind other frames. : [[API Frame Raise|CheckButton:Raise()]] - Raise this frame above other frames. : [[API Frame RegisterAllEvents|CheckButton:RegisterAllEvents]] : [[API Frame RegisterEvent|CheckButton:RegisterEvent("event")]] - Indicate that this frame should be notified when event occurs. : [[API Frame RegisterForDrag|CheckButton:RegisterForDrag("buttonType"[,"buttonType"...])]] - Inidicate that this frame should be notified of drag events for the specified buttons. : [[API Frame SetBackdrop|CheckButton:SetBackdrop([backdropTable])]] - Set the backdrop of the frame according to the specification provided. : [[API Frame SetBackdropBorderColor|CheckButton:SetBackdropBorderColor(r,g,b[,a])]] - Set the frame's backdrop's border's color. : [[API Frame SetBackdropColor|CheckButton:SetBackdropColor(r,g,b[,a])]] - Set the frame's backdrop color. : [[API Frame SetClampedToScreen|CheckButton:SetClampedToScreen]] : [[API Frame SetFrameLevel|CheckButton:SetFrameLevel(level)]] - Set the level of this frame (determines which of overlapping frames shows on top). : [[API Frame SetFrameStrata|CheckButton:SetFrameStrata("strata")]] - Set the strata of this frame. : [[API Frame SetHitRectInsets|CheckButton:SetHitRectInsets]] : [[API Frame SetID|CheckButton:SetID(id)]] - Set the ID of this frame. : [[API Frame SetMaxResize|CheckButton:SetMaxResize(maxWidth,maxHeight)]] - Set the maximum dimensions this frame can be resized to. : [[API Frame SetMinResize|CheckButton:SetMinResize(minWidth,minHeight)]] - Set the minimum dimensions this frame can be resized to. : [[API Frame SetMovable|CheckButton:SetMovable(isMovable)]] - Set whether the frame can be moved. : [[API Frame SetResizable|CheckButton:SetResizable(isResizable)]] - Set whether the frame can be resized. : [[API Frame SetScale|CheckButton:SetScale(scale)]] - Set the scale factor of this frame relative to its parent. : [[API Frame SetScript|CheckButton:SetScript("handler",function)]] - Set the function to use for a handler on this frame. : [[API Frame SetToplevel|CheckButton:SetToplevel]] : [[API Frame SetUserPlaced|CheckButton:SetUserPlaced(isUserPlaced)]] - Set whether the frame has been relocated by the user (and will thus be saved in the layout cache). : [[API Frame StartMoving|CheckButton:StartMoving()]] - Start moving this frame. : [[API Frame StartSizing|CheckButton:StartSizing("point")]] - Start sizing this frame using the specified anchor point. : [[API Frame StopMovingOrSizing|CheckButton:StopMovingOrSizing()]] - Stop moving and/or sizing this frame. : [[API Frame UnregisterAllEvents|CheckButton:UnregisterAllEvents()]] - Indicate that this frame should no longer be notified when any events occur. : [[API Frame UnregisterEvent|CheckButton:UnregisterEvent("event")]] - Indicate that this frame should no longer be notified when event occurs. === Inherited Button Methods === [[UISUMMARY Button|Button object summary]] : [[API Button Click|CheckButton:Click()]] - Execute the click action of the button. : [[API Button Disable|CheckButton:Disable()]] - Disable the Button so that it cannot be clicked. : [[API Button Enable|CheckButton:Enable()]] - Enable to the Button so that it may be clicked. : [[API Button GetButtonState|CheckButton:GetButtonState()]] - Return the current state ("PUSHED","NORMAL") of the Button. : [[API Button GetDisabledFontObject|CheckButton:GetDisabledFontObject()]] - Return the font object for the Button when disabled - New in 1.10. : [[API Button GetDisabledTextColor|CheckButton:GetDisabledTextColor]] : [[API Button GetDisabledTexture|CheckButton:GetDisabledTexture]] : [[API Button GetFont|CheckButton:GetFont()]] - Returns the font, size, and flags currently used for display on the Button. : [[API Button GetFontString|CheckButton:GetFontString]] : [[API Button GetHighlightFontObject|CheckButton:GetHighlightFontObject()]] - Return the font object for the Button when highlighted - New in 1.10. : [[API Button GetHighlightTextColor|CheckButton:GetHighlightTextColor]] : [[API Button GetHighlightTexture|CheckButton:GetHighlightTexture]] : [[API Button GetNormalTexture|CheckButton:GetNormalTexture]] : [[API Button GetPushedTextOffset|CheckButton:GetPushedTextOffset]] : [[API Button GetPushedTexture|CheckButton:GetPushedTexture]] : [[API Button GetText|CheckButton:GetText()]] - Get the text label for the Button. : [[API Button GetTextColor|CheckButton:GetTextColor]] : [[API Button GetTextFontObject|CheckButton:GetTextFontObject()]] - Return the font object for the Button's normal text - New in 1.10. : [[API Button GetTextHeight|CheckButton:GetTextHeight()]] - Get the height of the Button's text. : [[API Button GetTextWidth|CheckButton:GetTextWidth()]] - Get the width of the Button's text. : [[API Button IsEnabled|CheckButton:IsEnabled()]] - Determine whether the Button is enabled. : [[API Button LockHighlight|CheckButton:LockHighlight()]] - Set the Button to always be drawn highlighted. : [[API Button RegisterForClicks|CheckButton:RegisterForClicks("clickType"[,"clickType"...])]] - Indicate which types of clicks this Button should receive. : [[API Button SetButtonState|CheckButton:SetButtonState("state"[,lock])]] - Set the state of the Button ("PUSHED", "NORMAL") and whether it is locked. : [[API Button SetDisabledFontObject|CheckButton:SetDisabledFontObject([font])]] - Set the font object for settings when disabled - New in 1.10. : [[API Button SetDisabledTextColor|CheckButton:SetDisabledTextColor(r,g,b[,a])]] - Set the disabled text color for the Button. : [[API Button SetDisabledTexture|CheckButton:SetDisabledTexture(texture or "texturePath")]] - Set the disabled texture for the Button - Updated in 1.10. : [[API Button SetFont|CheckButton:SetFont("font",size[,"flags"])]] - Set the font to use for display. : [[API Button SetFontString|CheckButton:SetFontString]] : [[API Button SetHighlightFontObject|CheckButton:SetHighlightFontObject([font])]] - Set the font object for settings when highlighted - New in 1.10. : [[API Button SetHighlightTextColor|CheckButton:SetHighlightTextColor(r,g,b[,a])]] - Set the highlight text color for the Button. : [[API Button SetHighlightTexture|CheckButton:SetHighlightTexture(texture or "texturePath")]] - Set the highlight texture for the Button - Updated in 1.10. : [[API Button SetNormalTexture|CheckButton:SetNormalTexture(texture or "texturePath")]] - Set the normal texture for the Button - Updated in 1.10. : [[API Button SetPushedTextOffset|CheckButton:SetPushedTextOffset]] : [[API Button SetPushedTexture|CheckButton:SetPushedTexture(texture or "texturePath")]] - Set the pushed texture for the Button - Updated in 1.10. : [[API Button SetText|CheckButton:SetText("text")]] - Set the text label for the Button. : [[API Button SetTextColor|CheckButton:SetTextColor(r,g,b)]] - Set the text color for the Button. : [[API Button SetTextFontObject|CheckButton:SetTextFontObject([font])]] - Set the font object from which to get settings for this Button's normal state - New in 1.10. : [[API Button UnlockHighlight|CheckButton:UnlockHighlight()]] - Set the Button to not always be drawn highlighted. === CheckButton Methods === : [[API CheckButton GetChecked|CheckButton:GetChecked()]] - Get the status of the checkbox. : [[API CheckButton GetCheckedTexture|CheckButton:GetCheckedTexture]] : [[API CheckButton GetDisabledCheckedTexture|CheckButton:GetDisabledCheckedTexture]] : [[API CheckButton SetChecked|CheckButton:SetChecked([state])]] - Set the status of the checkbox. : [[API CheckButton SetCheckedTexture|CheckButton:SetCheckedTexture("texture")]] - Set the texture to use for a checked box. : [[API CheckButton SetDisabledCheckedTexture|CheckButton:SetDisabledCheckedTexture("texture")]] - Set the texture to use for an unchecked box. == Script Handlers == === Inherited Frame Script Handlers === [[UISUMMARY Frame|Frame object summary]] : [[API HANDLER OnChar|OnChar]] : [[API HANDLER OnDragStart|OnDragStart]] : [[API HANDLER OnDragStop|OnDragStop]] : [[API HANDLER OnEnter|OnEnter]] : [[API HANDLER OnEvent|OnEvent]] : [[API HANDLER OnHide|OnHide]] : [[API HANDLER OnKeyDown|OnKeyDown]] : [[API HANDLER OnKeyUp|OnKeyUp]] : [[API HANDLER OnLeave|OnLeave]] : [[API HANDLER OnLoad|OnLoad]] : [[API HANDLER OnMouseDown|OnMouseDown]] : [[API HANDLER OnMouseUp|OnMouseUp]] : [[API HANDLER OnMouseWheel|OnMouseWheel]] : [[API HANDLER OnReceiveDrag|OnReceiveDrag]] : [[API HANDLER OnShow|OnShow]] : [[API HANDLER OnSizeChanged|OnSizeChanged]] : [[API HANDLER OnUpdate|OnUpdate]] === Inherited Button Script Handlers === [[UISUMMARY Button|Button object summary]] : [[API HANDLER OnClick|OnClick]] : [[API HANDLER OnDoubleClick|OnDoubleClick]]
Summary:
Please note that all contributions to AddOn Studio are considered to be released under the Creative Commons Attribution-NonCommercial-ShareAlike (see
AddOn Studio Wiki:Copyrights
for details).
Submissions must be written by you, or copied from a public domain or similar free resource (see
AddOn Studio Wiki:Copyrights
for details).
Cancel
Editing help
(opens in new window)
Templates used on this page:
Template:Apinav
(
edit
)
Template:Editlink
(
edit
)
Template:Tocright
(
edit
)
Template:Widget
(
edit
)