Chapter 26. databaseforms

Chapter 26. databaseforms
	Part III. SIMPOL-Language Libraries

Chapter 26. databaseforms

Table of Contents

The databaseforms library is the implementation of data-aware display and print forms for SIMPOL. The dataform1 family of objects are a wrapper around the wxform* objects and the printform1 family of objects are a wrapper around the print architecture supplied by the WXWN component. The databaseforms library provides a multi-page, data-aware layer that includes the data-aware bitmap, data-aware scrollbar, data-aware grid, and detail block implentations, among others. It also provides the grouping mechanism for option buttons. This library is key to efficiently creating database-aware GUIs using SIMPOL. One significant difference between dataform1* and the native wxform* types is the use of drings in dataform1 for collections of objects. To traverse a dring use the dring.getfirst() to retrieve the first object, and then the getnext() method of the appropriate node property of the object to get to the next.

dataform1

Description

Type Tags

dataform1linkcontainer, dataform1

Object Value

Objects of type dataform1 have no value, and it is an error to try to get or set this value.

dataform1.new()

Description

Prototype

dataform1.new ( dataform1 me, integer defpagewidth, integer defpageheight, integer defpagebackcolor, string defbooleanformat, string defintegerformat, string defnumberformat, string defdateformat, string deftimeformat, string defdatetimeformat, SBLlocaledateinfo defdatelocale, SBLNumSettings defnumericlocale, wxfont deffont, integer designdpi, string currentworkingdirectory, boolean loading, integer error )

Parameters

Parameter	Default value	Type name
me	None	dataform1
defpagewidth	`50`	integer
defpageheight	`50`	integer
defpagebackcolor	`16777215`	integer
defbooleanformat	`T\|F`	string
defintegerformat	`.`	string
defnumberformat	`999999.00`	string
defdateformat	`yyyy.0m.0d`	string
deftimeformat	`hh:mm:ss`	string
defdatetimeformat	None	string
defdatelocale	None	SBLlocaledateinfo
defnumericlocale	None	SBLNumSettings
deffont	None	wxfont
designdpi	`96`	integer
currentworkingdirectory	None	string
loading	`.false`	boolean
error	None	integer

Properties

Property	Type	Description
_	type(*)
__	type(*)
_private	dataform1private
addbitmap	function
addcontrol	function
adddatasource	function
adddetailblock	function
addgraphic	function
addlink	function
addoptiongroup	function
addpage	function
addsiblinglink	function
addtable	function
assignfilterobject	function
autolocking	boolean
bitmaps	dring
blank	function
checkdirtyrecords	function
clearlinks	function
clearsiblinglinks	function
container	type(wxcontainer)
controls	dring
currentdpi	integer
currentpage	dataform1page
currentworkingdirectory	string
datasources	dring
defbooleanformat	string
defdateformat	string
defdatelocale	SBLlocaledateinfo
defdatetimeformat	string
deffont	wxfont
defintegerformat	string
defnumberformat	string
defnumericlocale	SBLNumSettings
defpagebackcolor	integer
defpageheight	integer
defpagewidth	integer
deftimeformat	string
deleterecord	function
designdpi	integer
designmode	boolean
detailblocks	dring
dirty	boolean
discardrecord	function
dpiadjfactor	number
duplicaterecord	function
filename	string
filllists	function
filter	dataform1filter
findbitmapsource	function
findcontrol	function
finddatasource	function
findgraphic	function
findnextfocusablecontrol	function
findsiblinglink	function
findtable	function
fonts	array
getfieldandtable	function
getfont	function
getlinkedrecord	function
graphics	dring
lastusedrecord	dataform1record
links	dring
loading	boolean
lock	function
locked	boolean
masterrecord	dataform1record
mastertable	dataform1table
name	string
nameinuse	function
newrecord	function
obgroups	dring
onchangerecord	event
ondelete	event
ondiscard	event
onkey	event
onkeylostfocus	event
onnewrecord	event
onsave	event
onselect	event
pages	dring
preventfocus	boolean
preventfocusmode	boolean
refresh	function
saverecord	function
selectcurrent	function
selectfirst	function
selectkey	function
selectlast	function
selectnext	function
selectprevious	function
setcontainer	function
setdirtystate	function
setfilter	function
setkeyfocus	function
setlastusedrecord	function
setmasterrecord	function
setmastertable	function
showpage	function
siblinglinks	dring
tables	dring
type	type
unlock	function
valid	boolean

Methods

!()

Description

Prototype

dataform1var.! ( dataform1 me, string controlname )

Parameters

Parameter	Default value	Type name	Description
me	None	dataform1
controlname	None	string

addbitmap()

Description

Prototype

dataform1var.addbitmap ( dataform1 me, string filename, string format, blob rgb, integer width, integer height, integer error )

Parameters

Parameter	Default value	Type name
me	None	dataform1
filename	None	string
format	`xpm`	string
rgb	None	blob
width	None	integer
height	None	integer
error	None	integer

addcontrol()

Description

Prototype

dataform1var.addcontrol ( dataform1 me, type controltype, integer left, integer top, integer width, integer height, string text, boolean enabled, boolean visible, wxbitmap bitmap, string scaling, wxbitmap selectedbitmap, wxbitmap disabledbitmap, wxbitmap focusbitmap, integer backgroundrgb, integer textrgb, integer rgb, string edittype, string selectiontype, integer rowcount, integer colcount, integer rowheight, integer colwidth, boolean rowheightdraggable, boolean colwidthdraggable, integer rowlabelwidth, integer collabelheight, string rowlabelalignment, string collabelalignment, string alignment, string editstyle, string orientation, integer range, integer position, integer pagesize, integer thumbsize, wxfont font, wxfont labelfont, string tooltip, integer onmousemask, string name, type(dataform1control) next, dataform1page page, anyvalue valueon, anyvalue valueoff, type(db1field) field, dataform1table table, string displayformat, dataform1optiongroup obgroup, boolean suppressfill, integer error )

Parameters

Parameter	Default value	Type name
me	None	dataform1
controltype	None	type
left	None	integer
top	None	integer
width	None	integer
height	None	integer
text	None	string
enabled	`.true`	boolean
visible	`.true`	boolean
bitmap	None	wxbitmap
scaling	None	string
selectedbitmap	None	wxbitmap
disabledbitmap	None	wxbitmap
focusbitmap	None	wxbitmap
backgroundrgb	None	integer
textrgb	`0`	integer
rgb	None	integer
edittype	`droplist`	string
selectiontype	`single`	string
rowcount	`1`	integer
colcount	`1`	integer
rowheight	`20`	integer
colwidth	`80`	integer
rowheightdraggable	`.true`	boolean
colwidthdraggable	`.true`	boolean
rowlabelwidth	`80`	integer
collabelheight	`20`	integer
rowlabelalignment	`right`	string
collabelalignment	`left,top`	string
alignment	`left,top`	string
editstyle	None	string
orientation	None	string
range	`1`	integer
position	`0`	integer
pagesize	`1`	integer
thumbsize	`1`	integer
font	None	wxfont
labelfont	None	wxfont
tooltip	None	string
onmousemask	`0`	integer
name	None	string
next	None	type(dataform1control)
page	None	dataform1page
valueon	None	anyvalue
valueoff	None	anyvalue
field	None	type(db1field)
table	None	dataform1table
displayformat	None	string
obgroup	None	dataform1optiongroup
suppressfill	`.false`	boolean
error	None	integer

adddatasource()

Description

Prototype

dataform1var.adddatasource ( dataform1 me, type(*) datasource, string source, string username, string password, integer codepage, integer error )

Parameters

Parameter	Default value	Type name
me	None	dataform1
datasource	None	type(*)
source	None	string
username	None	string
password	None	string
codepage	None	integer
error	None	integer

adddetailblock()

Description

Prototype

dataform1var.adddetailblock ( dataform1 me, dataform1page page, array controls, integer rows, integer rowoffset, integer columns, integer columnoffset, string scrollbar, integer scrollbaroffset, boolean tabacross, string name, boolean readonly, integer error )

Parameters

Parameter	Default value	Type name
me	None	dataform1
page	None	dataform1page
controls	None	array
rows	`1`	integer
rowoffset	`30`	integer
columns	`1`	integer
columnoffset	`200`	integer
scrollbar	`right`	string
scrollbaroffset	`15`	integer
tabacross	`.true`	boolean
name	None	string
readonly	`.true`	boolean
error	None	integer

addgraphic()

Description

Prototype

dataform1var.addgraphic ( dataform1 me, type graphictype, point point1, point point2, point point3, point midpoint, integer rgb, integer borderrgb, integer width, integer borderwidth, boolean visible, boolean bordervisible, string name, type(dataform1graphic) next, dataform1page page, integer error )

Parameters

Parameter	Default value	Type name
me	None	dataform1
graphictype	None	type
point1	None	point
point2	None	point
point3	None	point
midpoint	None	point
rgb	None	integer
borderrgb	None	integer
width	None	integer
borderwidth	None	integer
visible	None	boolean
bordervisible	None	boolean
name	None	string
next	None	type(dataform1graphic)
page	None	dataform1page
error	None	integer

addlink()

Description

Prototype

dataform1var.addlink ( dataform1 me, type(db1field) srcfield, dataform1table srctable, type(db1field) destfield, dataform1table desttable, type(dataform1linkcontainer) container, integer error )

Parameters

Parameter	Default value	Type name
me	None	dataform1
srcfield	None	type(db1field)
srctable	None	dataform1table
destfield	None	type(db1field)
desttable	None	dataform1table
container	None	type(dataform1linkcontainer)
error	None	integer

addoptiongroup()

Description

Prototype

dataform1var.addoptiongroup ( dataform1 me, string name, type(db1field) field, dataform1table table, string displayformat, integer error )

Parameters

Parameter	Default value	Type name
me	None	dataform1
name	None	string
field	None	type(db1field)
table	None	dataform1table
displayformat	None	string
error	None	integer

addpage()

Description

Prototype

dataform1var.addpage ( dataform1 me, integer width, integer height, integer backgroundrgb, dataform1page after, integer error )

Parameters

Parameter	Default value	Type name
me	None	dataform1
width	None	integer
height	None	integer
backgroundrgb	None	integer
after	None	dataform1page
error	None	integer

addsiblinglink()

Description

Prototype

dataform1var.addsiblinglink ( dataform1 me, type(db1field) srcfield, dataform1table srctable, type(db1field) destfield, dataform1table desttable, type(dataform1linkcontainer) container, integer error )

Parameters

Parameter	Default value	Type name
me	None	dataform1
srcfield	None	type(db1field)
srctable	None	dataform1table
destfield	None	type(db1field)
desttable	None	dataform1table
container	None	type(dataform1linkcontainer)
error	None	integer

addtable()

Description

Prototype

dataform1var.addtable ( dataform1 me, type(db1table) table, dataform1datasource source, integer error )

Parameters

Parameter	Default value	Type name
me	None	dataform1
table	None	type(db1table)
source	None	dataform1datasource
error	None	integer

assignfilterobject()

Description

Prototype

dataform1var.assignfilterobject ( dataform1 me, dataform1filter dffilter )

Parameters

Parameter	Default value	Type name	Description
me	None	dataform1
dffilter	None	dataform1filter

blank()

Description

Prototype

dataform1var.blank ( dataform1 me, boolean datacontrolsonly )

Parameters

Parameter	Default value	Type name	Description
me	None	dataform1
datacontrolsonly	`.true`	boolean

checkdirtyrecords()

Description

Prototype

dataform1var.checkdirtyrecords ( dataform1 me )

Parameters

Parameter	Default value	Type name	Description
me	None	dataform1

clearlinks()

Description

Prototype

dataform1var.clearlinks ( dataform1 me )

Parameters

Parameter	Default value	Type name	Description
me	None	dataform1

clearsiblinglinks()

Description

Prototype

dataform1var.clearsiblinglinks ( dataform1 me )

Parameters

Parameter	Default value	Type name	Description
me	None	dataform1

deleterecord()

Description

Prototype

dataform1var.deleterecord ( dataform1 me, integer error )

Parameters

Parameter	Default value	Type name	Description
me	None	dataform1
error	None	integer

discardrecord()

Description

Prototype

dataform1var.discardrecord ( dataform1 me, integer error )

Parameters

Parameter	Default value	Type name	Description
me	None	dataform1
error	None	integer

duplicaterecord()

Description

Prototype

dataform1var.duplicaterecord ( dataform1 me, integer error )

Parameters

Parameter	Default value	Type name	Description
me	None	dataform1
error	None	integer

filllists()

Description

Prototype

dataform1var.filllists ( dataform1 me )

Parameters

Parameter	Default value	Type name	Description
me	None	dataform1

findbitmapsource()

Description

Prototype

dataform1var.findbitmapsource ( dataform1 me, string sourcename )

Parameters

Parameter	Default value	Type name	Description
me	None	dataform1
sourcename	None	string

findcontrol()

Description

Prototype

dataform1var.findcontrol ( dataform1 me, string controlname )

Parameters

Parameter	Default value	Type name	Description
me	None	dataform1
controlname	None	string

finddatasource()

Description

Prototype

dataform1var.finddatasource ( dataform1 me, string sourcename )

Parameters

Parameter	Default value	Type name	Description
me	None	dataform1
sourcename	None	string

findgraphic()

Description

Prototype

dataform1var.findgraphic ( dataform1 me, string graphicname )

Parameters

Parameter	Default value	Type name	Description
me	None	dataform1
graphicname	None	string

findsiblinglink()

Description

Prototype

dataform1var.findsiblinglink ( dataform1 me, dataform1table desttable )

Parameters

Parameter	Default value	Type name	Description
me	None	dataform1
desttable	None	dataform1table

findtable()

Description

Prototype

dataform1var.findtable ( dataform1 me, string tablename )

Parameters

Parameter	Default value	Type name	Description
me	None	dataform1
tablename	None	string

getfieldandtable()

Description

Prototype

dataform1var.getfieldandtable ( dataform1 me, string fieldname, string tablename )

Parameters

Parameter	Default value	Type name
me	None	dataform1
fieldname	None	string
tablename	None	string

getfont()

Description

Prototype

dataform1var.getfont ( dataform1 me, string facename, integer size, string style, string weight, string decoration )

Parameters

Parameter	Default value	Type name
me	None	dataform1
facename	None	string
size	None	integer
style	None	string
weight	None	string
decoration	None	string

getlinkedrecord()

Description

Prototype

dataform1var.getlinkedrecord ( dataform1 me, dataform1table desttable )

Parameters

Parameter	Default value	Type name	Description
me	None	dataform1
desttable	None	dataform1table

lock()

Description

Prototype

dataform1var.lock ( dataform1 me, integer error )

Parameters

Parameter	Default value	Type name	Description
me	None	dataform1
error	None	integer

nameinuse()

Description

Prototype

dataform1var.nameinuse ( dataform1 me, string controlname )

Parameters

Parameter	Default value	Type name	Description
me	None	dataform1
controlname	None	string

newrecord()

Description

Prototype

dataform1var.newrecord ( dataform1 me, integer error )

Parameters

Parameter	Default value	Type name	Description
me	None	dataform1
error	None	integer

refresh()

Description

Prototype

dataform1var.refresh ( dataform1 me, boolean clearfocus )

Parameters

Parameter	Default value	Type name	Description
me	None	dataform1
clearfocus	`.true`	boolean

saverecord()

Description

Prototype

dataform1var.saverecord ( dataform1 me, boolean lock, integer error )

Parameters

Parameter	Default value	Type name
me	None	dataform1
lock	`.false`	boolean
error	None	integer

selectcurrent()

Description

Prototype

dataform1var.selectcurrent ( dataform1 me, type(db1index) index, boolean lock, integer error )

Parameters

Parameter	Default value	Type name
me	None	dataform1
index	None	type(db1index)
lock	`.false`	boolean
error	None	integer

selectfirst()

Description

Prototype

dataform1var.selectfirst ( dataform1 me, boolean lock, integer error )

Parameters

Parameter	Default value	Type name
me	None	dataform1
lock	`.false`	boolean
error	None	integer

selectkey()

Description

Prototype

dataform1var.selectkey ( dataform1 me, anyvalue value, type(db1index) index, boolean lock, boolean found, integer error )

Parameters

Parameter	Default value	Type name
me	None	dataform1
value	None	anyvalue
index	None	type(db1index)
lock	`.false`	boolean
found	None	boolean
error	None	integer

selectlast()

Description

Prototype

dataform1var.selectlast ( dataform1 me, boolean lock, integer error )

Parameters

Parameter	Default value	Type name
me	None	dataform1
lock	`.false`	boolean
error	None	integer

selectnext()

Description

Prototype

dataform1var.selectnext ( dataform1 me, boolean lock, integer error )

Parameters

Parameter	Default value	Type name
me	None	dataform1
lock	`.false`	boolean
error	None	integer

selectprevious()

Description

Prototype

dataform1var.selectprevious ( dataform1 me, boolean lock, integer error )

Parameters

Parameter	Default value	Type name
me	None	dataform1
lock	`.false`	boolean
error	None	integer

setcontainer()

Description

Prototype

dataform1var.setcontainer ( dataform1 me, type(wxcontainer) container )

Parameters

Parameter	Default value	Type name	Description
me	None	dataform1
container	None	type(wxcontainer)

setdirtystate()

Description

Prototype

dataform1var.setdirtystate ( dataform1 me, boolean dirty )

Parameters

Parameter	Default value	Type name	Description
me	None	dataform1
dirty	`.true`	boolean

setfilter()

Description

Prototype

dataform1var.setfilter ( dataform1 me, string filter, string errtext, integer errindex )

Parameters

Parameter	Default value	Type name
me	None	dataform1
filter	None	string
errtext	None	string
errindex	None	integer

setkeyfocus()

Description

Prototype

dataform1var.setkeyfocus ( dataform1 me, function onkey, type(*) onkeyreference, function onlostfocus, type(*) onlostfocusreference )

Parameters

Parameter	Default value	Type name
me	None	dataform1
onkey	None	function
onkeyreference	None	type(*)
onlostfocus	None	function
onlostfocusreference	None	type(*)

setlastusedrecord()

Description

Prototype

dataform1var.setlastusedrecord ( dataform1 me, dataform1record record )

Parameters

Parameter	Default value	Type name	Description
me	None	dataform1
record	None	dataform1record

setmasterrecord()

Description

Prototype

dataform1var.setmasterrecord ( dataform1 me, type(db1record) r, boolean dorefresh, boolean retaindetailblockpositions, integer error )

Parameters

Parameter	Default value	Type name
me	None	dataform1
r	None	type(db1record)
dorefresh	`.true`	boolean
retaindetailblockpositions	`.false`	boolean
error	None	integer

setmastertable()

Description

Prototype

dataform1var.setmastertable ( dataform1 me, dataform1table table )

Parameters

Parameter	Default value	Type name	Description
me	None	dataform1
table	None	dataform1table

showpage()

Description

Prototype

dataform1var.showpage ( dataform1 me, integer pagenum, boolean clearfocus )

Parameters

Parameter	Default value	Type name
me	None	dataform1
pagenum	None	integer
clearfocus	`.true`	boolean

unlock()

Description

Prototype

dataform1var.unlock ( dataform1 me )

Parameters

Parameter	Default value	Type name	Description
me	None	dataform1