Module dmc-ui

A Lua module which creates UI widgets for the Corona SDK.

Usage:

    local dUI = require 'dmc_ui'
     local widget = dUI.newPushButton()

Widget Constructors

newBackground ([options]) contructor for Background widgets.
newBackgroundParams Optional parameters for newBackground()
new9SliceBackground (options) convenience function for Rectangle Background widgets.
newRectangleBackground ([options]) convenience function for Rectangle Background widgets.
newRoundedBackground ([options]) convenience function for Rounded Background widgets.
newButton ([options]) constructor for Button widgets.
newPushButton ([options]) convenience function for Push Buttons.
newRadioButton ([options]) convenience function for Radio Buttons.
newToggleButton ([options]) convenience function for Toggle Buttons.
newNavBar ([options]) constructor for Nav Bar widgets.
newNavItem ([options]) constructor for Nav Bar Item.
newScrollView ([options]) constructor for a ScrollView widget.
newScrollView ([options]) constructor for a SegmentedControl widget.
newTableView ([options]) constructor for a TableView widget.
newTableViewCell ([options]) constructor for a TableViewCell widget.
newText ([options]) constructor for a Text widget.
newTextField ([options]) constructor for a TextField widget.

Style Constructors

newBackgroundStyle () the gesture's delegate (object/table)

Control Constructors

newTableViewControl () the gesture's delegate (object/table)


Widget Constructors

newBackground ([options])
contructor for Background widgets.

Parameters:

Returns:

    object Widget.Background

Usage:

    local widget = dUI.newBackground()
newBackgroundParams
Optional parameters for newBackground()

Fields:

  • x int minimum number of taps, default 1
  • y int maximum number of taps, default 1
  • type string a name for the gesture, available in events
  • style object a delegate object to control this gesture
new9SliceBackground (options)
convenience function for Rectangle Background widgets.

Parameters:

  • options parameters used to create Background
    • sheet newImageSheet the image sheet
    • frames table of frames

Returns:

    object Widget.Background

Usage:

    local widget = dUI.new9SliceBackground()
newRectangleBackground ([options])
convenience function for Rectangle Background widgets.

Parameters:

  • options tab parameters used to create Background (optional)

Returns:

    object Widget.Background

Usage:

    local widget = dUI.newRectangleBackground()
newRoundedBackground ([options])
convenience function for Rounded Background widgets.

Parameters:

  • options tab parameters used to create Background (optional)

Returns:

    object Widget.Background

Usage:

    local widget = dUI.newRoundedBackground()
newButton ([options])
constructor for Button widgets. the default button type is a Push Button widget.

Parameters:

  • options tab parameters used to create Button widget (optional)

Returns:

    object Widget.Button

Usage:

    local widget = dUI.newButton()
newPushButton ([options])
convenience function for Push Buttons.

Parameters:

  • options tab parameters used to create Button (optional)

Returns:

    object Widget.Button

Usage:

    local widget = dUI.newPushButton()
newRadioButton ([options])
convenience function for Radio Buttons.

Parameters:

  • options tab parameters used to create Button (optional)

Returns:

    object Widget.Button

Usage:

    local widget = dUI.newRadioButton()
newToggleButton ([options])
convenience function for Toggle Buttons.

Parameters:

  • options tab parameters used to create Button (optional)

Returns:

    object Widget.Button

Usage:

    local widget = dUI.newToggleButton()
newNavBar ([options])
constructor for Nav Bar widgets.

Parameters:

  • options tab parameters used to create a Nav Bar (optional)

Returns:

    object Widget.NavBar

Usage:

    local widget = dUI.newNavBar()
newNavItem ([options])
constructor for Nav Bar Item.

Parameters:

  • options tab parameters used to create a Nav Item (optional)

Returns:

    object Widget.NavItem

Usage:

    local widget = dUI.newNavItem()
newScrollView ([options])
constructor for a ScrollView widget.

Parameters:

  • options tab parameters used to create a ScrollView (optional)

Returns:

    object Widget.ScrollView

Usage:

    local widget = dUI.newScrollView()
newScrollView ([options])
constructor for a SegmentedControl widget.

Parameters:

  • options tab parameters used to create a SegmentedControl (optional)

Returns:

    object ???

Usage:

    local widget = dUI.newSegmentedControl()
newTableView ([options])
constructor for a TableView widget.

Parameters:

  • options tab parameters used to create a TableView (optional)

Returns:

    object Widget.TableView

Usage:

    local widget = dUI.newTableView()
newTableViewCell ([options])
constructor for a TableViewCell widget.

Parameters:

  • options tab parameters used to create a Table View Cell (optional)

Returns:

    object Widget.TableViewCell

Usage:

    local widget = dUI.newTableViewCell()
newText ([options])
constructor for a Text widget.

Parameters:

  • options tab parameters used to create a Text widget (optional)

Returns:

    object Widget.Text

Usage:

    local widget = dUI.newText()
newTextField ([options])
constructor for a TextField widget.

Parameters:

  • options tab parameters used to create a TextField widget (optional)

Returns:

    object Widget.TextField

Usage:

    local widget = dUI.newTextField()

Style Constructors

newBackgroundStyle ()
the gesture's delegate (object/table)

Usage:

  • print( gesture.delegate )
  • gesture.delegate = DisplayObject

Control Constructors

newTableViewControl ()
the gesture's delegate (object/table)

Usage:

  • print( gesture.delegate )
  • gesture.delegate = DisplayObject
generated by LDoc 1.4.3 Last updated 2015-05-14 11:55:05