WoW:API EditBox SetAutoFocus: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
mNo edit summary
(Updated to match the current API boilerplate.)
Line 1: Line 1:
{{Stub/API}}
{{widgetmethod}} __NOTOC__
Arguments: true, false.


Sets the autofocus of an EditBox UIObject to either true or false.


AutoFocus causes the keyboard inline to automatically enter the EditBox when the EditBox is shown. Otherwise Focux is established by clicking on the EditBox.
Sets whether the cursor should automatically focus on the EditBox when it is shown.
EditBox:SetAutoFocus(autoFocus)


Initial setting appears to be true.


Example:
== Arguments ==
:; autoFocus : [[Boolean]] - Whether autofocus should be enabled


  <Scripts>
        <OnLoad>
              myEditBox:SetAutoFocus( false );
        </OnLoad>
  </Scripts>


--Will disable AutoFocus on myEditBox when the addon loads.
== Returns ==
:nil
 
 
== Example ==
<Scripts>
    <OnLoad>
        myEditBox:SetAutoFocus( false );
    </OnLoad>
</Scripts>
 
<big>'''Result'''</big>
 
Will disable AutoFocus on myEditBox when the addon loads.
 
 
== Details ==
: Initial setting appears to be true.

Revision as of 14:25, 27 June 2007

Widget API ← EditBox < SetAutoFocus


Sets whether the cursor should automatically focus on the EditBox when it is shown.

EditBox:SetAutoFocus(autoFocus)


Arguments

autoFocus
Boolean - Whether autofocus should be enabled


Returns

nil


Example

<Scripts>
    <OnLoad>
        myEditBox:SetAutoFocus( false );
    </OnLoad>
</Scripts>

Result

Will disable AutoFocus on myEditBox when the addon loads.


Details

Initial setting appears to be true.