====== ToggleButtons ======

//(Information and examples taken from the DroidScript documentation)//

===== Description =====
Create toggle buttons using the **CreateToggle** method of the **[[built_in:app|app]]** object:
<code>btn = app.CreateToggle( text, width, height, options );</code>
You can allow the toggle button to auto-size by leaving out the dimensions or you can specify a **width** and **height** as decimal fractions of the screen's width and height.

Use the **SetOnTouch** method of your button object to set the name of a function you want to be called when the button is touched.

You can get the state of the toggle button at any time using the **GetChecked** method of the button. The button state is also passed into your OnTouch callback function as a parameter every time the button is touched.

==== Example ====
<code javascript>
function OnStart()
{
  lay = app.CreateLayout( "Linear", "VCenter,FillXY" );

  btn = app.CreateToggle( "Toggle Me" );
  btn.SetOnTouch( ShowState );
  lay.AddChild( btn );

  app.AddLayout( lay );
}

function ShowState( isChecked )
{
  app.ShowPopup( "Checked = " + isChecked, "Short" );
}
</code>


===== Methods =====
Some controls use the same methods.\\
For examples of the **[[same methods]]** look here.
^ Method                                                ^ Description  ^
| ToggleButton.Destroy()                                |              |
| ToggleButton.GetAbsHeight()                           |              |
| ToggleButton.GetAbsWidth()                            |              |
| ToggleButton.GetChecked()                             |              |
| ToggleButton.GetHeight()                              |              |
| ToggleButton.GetPosition()                            |              |
| ToggleButton.GetText()                                |              |
| ToggleButton.GetTextSize( mode )                      |              |
| ToggleButton.GetType()                                |              |
| ToggleButton.GetVisibility()                          |              |
| ToggleButton.GetWidth()                               |              |
| ToggleButton.SetChecked( checked )                    |              |
| ToggleButton.SetMargins( left,top,right,bottom )      |              |
| ToggleButton.SetOnTouch( callback )                   |              |
| ToggleButton.SetPadding( left, top, right, bottom )   |              |
| ToggleButton.SetPosition( left, top, width, height )  |              |
| ToggleButton.SetScale( x,y )                          |              |
| ToggleButton.SetSize( width, height )                 |              |
| ToggleButton.SetText( text )                          |              |
| ToggleButton.SetTextColor( colorCode )                |              |
| ToggleButton.SetTextSize( size,mode )                 |              |
| ToggleButton.SetVisibility( HideShow )                |              |