WoW:API CheckButton SetChecked - Revision history

Move page script: Move page script moved page API CheckButton SetChecked to WoW:API CheckButton SetChecked without leaving a redirect

2023-08-15T04:45:17Z

Move page script moved page API CheckButton SetChecked to API CheckButton SetChecked without leaving a redirect

← Older revision	Revision as of 04:45, 15 August 2023
(No difference)

Bear: /* Parameters */

2014-12-29T00:49:20Z

Parameters

← Older revision		Revision as of 00:49, 29 December 2014
Line 1:		Line 1:
	{{widgetmethod}} __NOTOC__		{{widgetmethod}} __NOTOC__

	Sets the status of a CheckButton.		Sets the checked status of a CheckButton frame.

	CheckButton:SetChecked(State);		CheckButton:SetChecked(State);

	== Parameters ==		== Parameters ==
	=== Arguments ===		=== Arguments ===
	~~:(State)~~		:;state :{{api\|boolean\|t=t}} - 'true' sets the button state to checked. Default is 'false'.

	:;~~State~~ : ~~Mixed~~ - ~~Basically expressions LUA evaluates to ''~~'true'~~'' will check~~ the button. ~~Everything else will uncheck~~.

	=== Returns ===		=== Returns ===
	:~~nil~~		: none

	~~:;nil : This function will always return nil.~~
	~~----~~

	== ~~Example~~ ==		== Examples ==
	CheckButton:SetChecked(true);		CheckButton:SetChecked(true)
	~~CheckButton:SetChecked(1);~~
	~~CheckButton:SetChecked(-2397);~~
	~~CheckButton:SetChecked("-2397");~~
	~~CheckButton:SetChecked({1,2,3});~~
	~~CheckButton:SetChecked("foo");~~
	~~CheckButton:SetChecked();~~

	~~====Result====~~
	Button is checked		Button is checked

	~~== Example ==~~		CheckButton:SetChecked(false)
	CheckButton:SetChecked(false);		CheckButton:SetChecked(0)
	CheckButton:SetChecked(0);		CheckButton:SetChecked(nil)
	CheckButton:SetChecked(nil);		CheckButton:SetChecked()
			CheckButton:SetChecked({1,2,3})
			CheckButton:SetChecked("true")

	~~====Result====~~
	Button is unchecked		Button is unchecked

	==Notes==		== Notes ==
	Passing "nil" will uncheck the button, but passing no argument (although it should end up being nil for Lua) will enable it, also passing a table ({...}) will now check the button.		* Passing "nil" will uncheck the button, but passing no argument (although it should end up being nil for Lua) will enable it, also passing a table ({...}) will now check the button.
			* As of WoW 6.0 both GetChecked() and SetChecked() use Lua boolean values only. Passing value other than Lua {{api\|boolean\|t=t}} 'true' is the same as passing 'false', and GetChecked() will only return true or false. Prior to 6.0.2 values such as true, 1, -2397, {1,2,3}, "foo" would all set state as checked. Values such as false, 0, nil would set state as not checked.

			== See also ==
			* {{api\|CheckButton:GetChecked\|t=w}}

WoWWiki>Egingell: Removed "talk".

2010-01-15T20:37:20Z

Removed "talk".

← Older revision		Revision as of 20:37, 15 January 2010
Line 37:		Line 37:
	Button is unchecked		Button is unchecked

			==Notes==
	~~----~~		Passing "nil" will uncheck the button, but passing no argument (although it should end up being nil for Lua) will enable it, also passing a table ({...}) will now check the button.
	~~====Patch 1.11 WARNING~~====
	~~In patch 1.11 it seems like this method was changed so that it no longer works when passing '''nil''' as argument. I have tested that it works as intended when passing '''true''' and '''false'''.~~

	~~That's not really correct.~~ Passing "nil" will ~~still~~ uncheck the button, but passing no argument (although it should end up being nil for ~~LUA~~) will enable it, also passing a table ({...}) will now check the button.

	~~Yep, you're right watchout. Also, I think this behavior was changed in 1.11.1, as it was fine right after 1.11. [[Krellmax]] 14:34, 29 June 2006 (MDT)~~

WoWWiki>VoidvectorBot: Remove singature made using ~ in main namespace

2007-02-10T06:15:33Z

Remove singature made using ~ in main namespace

← Older revision		Revision as of 06:15, 10 February 2007
Line 42:		Line 42:
	In patch 1.11 it seems like this method was changed so that it no longer works when passing '''nil''' as argument. I have tested that it works as intended when passing '''true''' and '''false'''.		In patch 1.11 it seems like this method was changed so that it no longer works when passing '''nil''' as argument. I have tested that it works as intended when passing '''true''' and '''false'''.

	That's not really correct. Passing "nil" will still uncheck the button, but passing no argument (although it should end up being nil for LUA) will enable it, also passing a table ({...}) will now check the button. ~~[[User:Watchout\|watchout]] 12:43, 29 June 2006 (EDT)~~		That's not really correct. Passing "nil" will still uncheck the button, but passing no argument (although it should end up being nil for LUA) will enable it, also passing a table ({...}) will now check the button.

	Yep, you're right watchout. Also, I think this behavior was changed in 1.11.1, as it was fine right after 1.11. [[Krellmax]] 14:34, 29 June 2006 (MDT)		Yep, you're right watchout. Also, I think this behavior was changed in 1.11.1, as it was fine right after 1.11. [[Krellmax]] 14:34, 29 June 2006 (MDT)

WoWWiki>Krellmax: /* Patch 1.11 WARNING */

2006-06-29T21:01:47Z

Patch 1.11 WARNING

← Older revision		Revision as of 21:01, 29 June 2006
Line 43:		Line 43:

	That's not really correct. Passing "nil" will still uncheck the button, but passing no argument (although it should end up being nil for LUA) will enable it, also passing a table ({...}) will now check the button. [[User:Watchout\|watchout]] 12:43, 29 June 2006 (EDT)		That's not really correct. Passing "nil" will still uncheck the button, but passing no argument (although it should end up being nil for LUA) will enable it, also passing a table ({...}) will now check the button. [[User:Watchout\|watchout]] 12:43, 29 June 2006 (EDT)

			Yep, you're right watchout. Also, I think this behavior was changed in 1.11.1, as it was fine right after 1.11. [[Krellmax]] 14:34, 29 June 2006 (MDT)

WoWWiki>Watchout: /* Arguments */

2006-06-29T16:51:45Z

Arguments

← Older revision		Revision as of 16:51, 29 June 2006
Line 9:		Line 9:
	:(State)		:(State)

	:;State : Mixed - Basically expressions LUA evaluates to ~~a number~~ will check the button. Everything else will uncheck.		:;State : Mixed - Basically expressions LUA evaluates to '''true''' will check the button. Everything else will uncheck.

	=== Returns ===		=== Returns ===
	:nil		:nil
Line 21:		Line 22:
	CheckButton:SetChecked(-2397);		CheckButton:SetChecked(-2397);
	CheckButton:SetChecked("-2397");		CheckButton:SetChecked("-2397");
			CheckButton:SetChecked({1,2,3});
			CheckButton:SetChecked("foo");
			CheckButton:SetChecked();

	====Result====		====Result====
Line 28:		Line 32:
	CheckButton:SetChecked(false);		CheckButton:SetChecked(false);
	CheckButton:SetChecked(0);		CheckButton:SetChecked(0);
	CheckButton:SetChecked(~~"foo");~~		CheckButton:SetChecked(nil);
	~~CheckButton:SetChecked();~~
	~~CheckButton:SetChecked({1,2,3}~~);

	====Result====		====Result====
Line 39:		Line 41:
	====Patch 1.11 WARNING====		====Patch 1.11 WARNING====
	In patch 1.11 it seems like this method was changed so that it no longer works when passing '''nil''' as argument. I have tested that it works as intended when passing '''true''' and '''false'''.		In patch 1.11 it seems like this method was changed so that it no longer works when passing '''nil''' as argument. I have tested that it works as intended when passing '''true''' and '''false'''.

			That's not really correct. Passing "nil" will still uncheck the button, but passing no argument (although it should end up being nil for LUA) will enable it, also passing a table ({...}) will now check the button. [[User:Watchout\|watchout]] 12:43, 29 June 2006 (EDT)

WoWWiki>WoWWiki-Bam at 05:19, 22 June 2006

2006-06-22T05:19:04Z

← Older revision		Revision as of 05:19, 22 June 2006
Line 34:		Line 34:
	====Result====		====Result====
	Button is unchecked		Button is unchecked


			----
			====Patch 1.11 WARNING====
			In patch 1.11 it seems like this method was changed so that it no longer works when passing '''nil''' as argument. I have tested that it works as intended when passing '''true''' and '''false'''.

WoWWiki>Watchout at 02:49, 18 June 2006

2006-06-18T02:49:31Z

← Older revision		Revision as of 02:49, 18 June 2006
Line 1:		Line 1:
	{{widgetmethod}}		{{widgetmethod}} __NOTOC__
	~~{{stub/api}}~~

	Sets the status of a CheckButton. ~~Set~~ to 1 ~~for~~ checked ~~status~~, ~~or 0 for~~ unchecked.		Sets the status of a CheckButton.

			CheckButton:SetChecked(State);

			== Parameters ==
			=== Arguments ===
			:(State)

			:;State : Mixed - Basically expressions LUA evaluates to a number will check the button. Everything else will uncheck.
			=== Returns ===
			:nil

			:;nil : This function will always return nil.
			----

			== Example ==
			CheckButton:SetChecked(true);
			CheckButton:SetChecked(1);
			CheckButton:SetChecked(-2397);
			CheckButton:SetChecked("-2397");

			====Result====
			Button is checked

			== Example ==
			CheckButton:SetChecked(false);
			CheckButton:SetChecked(0);
			CheckButton:SetChecked("foo");
			CheckButton:SetChecked();
			CheckButton:SetChecked({1,2,3});

			====Result====
			Button is unchecked

WoWWiki>Mikk: {{widgetmethod}}

2006-06-10T11:44:34Z

← Older revision		Revision as of 11:44, 10 June 2006
Line 1:		Line 1:
			{{widgetmethod}}
			{{stub/api}}

	Sets the status of a CheckButton. Set to 1 for checked status, or 0 for unchecked.		Sets the status of a CheckButton. Set to 1 for checked status, or 0 for unchecked.

	~~{{API/Uncategorized}}~~

WoWWiki>Anticrash at 17:36, 22 December 2005

2005-12-22T17:36:19Z

← Older revision		Revision as of 17:36, 22 December 2005
Line 1:		Line 1:
	Sets the status of a CheckButton. Set to 1 for checked status, or 0 for unchecked.		Sets the status of a CheckButton. Set to 1 for checked status, or 0 for unchecked.

			{{API/Uncategorized}}