Requires Corona Build 645 or higher!

The segmented control widget has been removed from the upcoming widget version 0.2, so the source has been made publicly available here as a separate module. Here is the API documentation:

Returns a set of UI buttons (placed in a single display group) that stay depressed when you press each one. Most common use is to act like tabs, but they theoretically behave just like individual UI buttons, but are grouped together.

Syntax

segmentedcontrol.new( buttonTable [, params] )

Example

    local segmentedControl = require( "segmentedcontrol" )
 
    local buttonHandler = function( event )
        local id = event.target.id
 
        if id == "btn1" then
 
            print( "Button handler for 1st button." )
 
        elseif id == "btn2" then
 
            print( "Button handler for 2nd button." )
 
        elseif id == "btn3" then
 
            print( "Button handler for 3rd button." )
        end
    end
 
    local buttonTable = {
        { id="btn1", label="Button 1", onPress=buttonHandler, isDown=true },
        { id="btn2", label="Button 2", onPress=buttonHandler },
        { id="btn3", label="Button 3", onPress=buttonHandler }
    }
 
    local segmentedButtons = segmentedControl.new( buttonTable, { x=50, y=100 } )

Parameters

buttonTable

Table. This is the table that will hold individual tables for each button in the segmented control group. The structure of the table is as follows:

    buttonTable = {
        { label=(string), onPress=(function), isDown=(boolean) },
        { ... }
    }
 
    -- each individual table within buttonTable (above) represents a
    -- different ui button in the segmented control group.

params

Table. Optional settings and options for the segmented control group. Parameters can include any or all of the following:

id

String. An optional id you can use to identify this widget (internally).

x, y

Numbers. The initial x/y coordinates of the widget from the top left reference point. Default is 0, 0.

labelColor

Table. The label text color for the individual buttons. Default is white ( { 255, 255, 255 } ).

font

String. The font to be used for label text on individual buttons.

size

Number. The size of the font that will be used for label text on individual buttons.

padding

Number. The padding on the left and right side of the label text (for each button).

emboss

Boolean (true/false). If set to false, the label text on individual buttons will not have the embossed effect. Default is true.

Properties:

view

This property is used to access the widget's display group.

Removing the Widget:

Remove this widget (and all of it's children buttons) using display.remove or removeSelf() as you normally would with any other Corona display object.