VCLua 0.2.2

Table of Contents

1. Using VCLua
2. Forms
3. Bevels
4. Buttons
5. BitButtons
6. CheckBoxes
7. ComboBoxes
8. Edit fields
9. GroupBoxes
10. Image
11. Labels
12. ListBoxes
13. Memos
14. Panels
15. PageControl
16. ProgressBar
17. RadioButtons
18. RadioGroups
19. SpeedButtons
20. Splitters
21. StatusBars
22. StringGrids
23. TabSheets
24. Timer
25. ToolBar
26. TrackBar
27. TrayIcon
28. Trees
29. Using menus
• MainMenu
• PopupMenus
• MenuItems
30. Events

Using VCLua library

object hierarchy

VCL object structure similar to luatables
	Object
		Object
			Object
				Object
				...
			Object
			Object
			Object
		...

 example:
	Form
		Panel
			Edit
			CheckBox
			Button
		Panel 
			ListBox
	
to access an objects type:
	Form.Panel.Button
        

creating vcl form

myForm = VCL.Form("NameOfMyForm")
                                                                

creating parented object

myListBox = VCL.ListBox(MyForm, "MyListboxName") 
or 
myForm.myListBox = VCL.ListBox(myForm, "MyListboxName")

defining single object property

myListBox.width = 100

defining multiple properties

objectid._ = { propertyname = value, propertyname = value, ... }

example:
	myListBox._ = { top=160,
             left=30,
             height=60,
             align="alClient",
        }                                

defining and handling object events

objectname.eventname = luafunctionname

example:
myForm.OnClick = "onformclick"
function onformclick(Sender)
    print(Sender.Name)
end

see Events section for more details

creating form with properties and child object from xml file using xfm.lua module

    myForm = xfm.loadfromxml("myxmlformfilename.xml")                                                                

        where xml describes the form

	<Form name="myForm">
		<!-- form properties -->
		<property name="formstyle" value="fsStayOnTop" />
    		<property name="caption" value="List of opened files" />
	    	<property name="position" value="poDesktopCenter" />
    		<property name="width" value="400" />
	    	<property name="height" value="300" />
    		<property name="borderstyle" value="bsDialog" />
		<!-- end of form properties -->

		<!-- listbox object -->
 		<ListBox name="fileList">
			<!-- object properties -->
        		<property name="align" value="alClient" />
			<!-- end of object properties -->
    		</ListBox>
		<!-- end of listbox object -->

	</Form>
																																

running of simple forms:

myForm:ShowModal()

running of complex application:

• prepare the application

Application():Initialize()

• create your vcl objects

• run the application

Application():Run()

skinning forms

local myForm = VCL.Form("myForm")

myForm:SetSkin("skins","wood")
myForm:SetSkinState(true)
 

Forms

Create

object = VCL.Form(string)
myForm = VCL.Form("myFormName")

Destroy

object:Free()

Icon

object:Icon(string) -- .ico filename

ParentName

string = object:ParentName()

Show

object:Show()

ShowModal

string = object:ShowModal()
if myForm:ShowModal() == "mrOk" then ...
 

Hide

object:Hide()

Close

object:Close()

Dock

object:Dock(object)
myForm:Dock(yourForm.dockPanel) 

Undock

object:UnDock(table)
myForm:UnDock({left=10,right=100,top=10,bottom=100})

IsDocked

boolean = object:isDocked() 

Bevels

Create

object = VCL.Bevel(object, string)
    

Destroy

object:Free()

ParentName

string = object:ParentName()

Shape types

bsBox   	The entire client area appears raised or lowered.
bsFrame 	The client area is outlined by a raised or lowered frame.
bsTopLine   	The bevel displays a line at the top of the client area.
bsBottomLine    The bevel displays a line at the bottom of the client area.
bsLeftLine  	The bevel displays a line at the left side of the client area.
bsRightLine 	The bevel displays a line at the right side of the client area.
bsSpacer    	The bevel is an empty space.

Buttons

Create

object = VCL.Button(object, string)
myButton = VCL.Button(myForm, "myButton")

Destroy

object:Free()

ParentName

string = object:ParentName()

SetFocus

object:SetFocus()

BitButtons

Create

object = VCL.SpeedButton(object, string)        

Destroy

object:Free()

ParentName

string = object:ParentName()

SetFocus

object:SetFocus()

Image

object:Image(object)

CheckBoxes

Create

object = VCL.CheckBox(object, string)

Destroy

object:Free()

ParentName

string = object:ParentName()

SetFocus

object:SetFocus()

ComboBoxes

Create

object = VCL.CheckBox(object, string)

Destroy

object:Free()

ParentName

string = object:ParentName()

SetFocus

object:SetFocus()

GetText

table = object:GetText()

SetText

object:SetText(table)
germanCarSelector:SetText({"Audi","Porsche","Trabant"})

Addt

object:Add(string)
germanCarSelector:Add("Volkswagen")

Insert

object:Insert(number, string)
germanCarSelector:Insert(2,"Mercedes")

Delete

object:Delete(number)
germanCarSelector:Delete(4)

Count

number = object:Count()

Clear

object:Clear()

Edit fields

Create

object = VCL.Edit(object, string)    

Destroy

object:Free()

ParentName

string = object:ParentName()

SetFocus

object:SetFocus()

GroupBoxes

Create

object = VCL.GroupBox(object, string)    

Destroy

object:Free()

ParentName

string = object:ParentName()

Image

Create

object = VCL.Image(object, string)                

Destroy

object:Free()

ParentName

string = object:ParentName()

Load

object:Load(string)

Labels

Create

object = VCL.Label(object, string)        

Destroy

object:Free()

ParentName

string = object:ParentName()

SetFocus

object:SetFocus()

ListBoxes

Create

object = VCL.ListkBox(object, string)

Destroy

object:Free()

ParentName

string = object:ParentName()

SetFocus

object:SetFocus()

GetText

table = object:GetText()    

SetText

object:SetText(table)

Addt

object:Add(string)

Insert

object:Insert(number, string)

Delete

object:Delete(number)

Count

number = object:Count()

Clear

object:Clear()

Memos

Create

object = VCL.Memo(object, string)

Destroy

object:Free()

ParentName

string = object:ParentName()

SetFocus

object:SetFocus()

GetText

table = object:GetText()

SetText

object:SetText(table)

Addt

object:Add(string)
    

Insert

object:Insert(number, string)

Delete

object:Delete(number)    

Count

number = object:Count() 

Clear

object:Clear()

Panels

Create

object = VCL.Memo(object, string)    

Destroy

object:Free()

ParentName

string = object:ParentName()

PageControl

Create

object = VCL.Memo(object, string)    

Destroy

object:Free()

ParentName

string = object:ParentName()

SetFocus

object:SetFocus()

GetControl

object = object:GetControl()
activeTabSheet = myPageControl:GetControl() 

SetControl

object = object:SetControl(object)
	myPageControl:SetControl(inactiveTabsheet) 

ProgressBar

Create

object = VCL.ProgressBar(object, string)    

Destroy

object:Free()

ParentName

string = object:ParentName()

StepIt

object:StepIt()

RadioButtons

Create

object = VCL.RadioButton(object, string)    

Destroy

object:Free()

ParentName

string = object:ParentName()

SetFocus

object:SetFocus()

RadioGroups

Create

object = VCL.RadioGroup(object, string)    

Destroy

object:Free()

ParentName

string = object:ParentName()