Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

(windowinstance)
windowinstance representing the created entry, or nil in case of errors.

createWindowWithClass

Code Block
languagelua
function createWindowWithClass(class, dbnode, [focus])

...

(windowinstance)
windowinstance representing the created entry, or nil in case of errors.

getColumnWidth

Code Block
languagelua
function getColumnWidth()

...

(number)
The column width of the list

getEmptyText

Code Block
function getEmptyText()

Retrieve the text to display in the control when the underlying data is an empty list.

Return values

(string)
The value of the empty text display string for this control.

getNextWindow

Code Block
languagelua
function getNextWindow(source)

...

(windowinstance)
windowinstance representing the entry following the given entry. If the entry given as the parameter is the last one in the list, the return value will be nil.

getPrevWindow

Code Block
languagelua
function getPrevWindow(source)

...

(windowinstance)
windowinstance representing the entry preceding the given entry. If the entry given as the parameter is the first one in the list, the return value will be nil.

getWindowAt

Code Block
languagelua
function getWindowAt(x, y)

...

(windowinstance)
windowinstance representing the entry at the given position. If no entry was found at the position, the return value will be nil.

getWindowCount

Code Block
languagelua
function getWindowCount([visibleonly])

...

(number)
The number of child windows

getWindows

Code Block
languagelua
function getWindows([visibleonly])

...

(table)
An integer indexed table containing references to the windowinstance entries in the list

hasFocus

Code Block
languagelua
function hasFocus()

...

(boolean)
Returns true if the control has the keyboard focus, false otherwise.

onFilter

Code Block
languagelua
function onFilter(w)

...

(boolean)
A return value of true indicates the entry passes the filter, a value of false hides it from the currently displayed selection of entries

onGainFocus

Code Block
languagelua
function onGainFocus()

...

(boolean)
A return value of true indicates the entry represented by w1 is greater than (should be located later in the list) than the entry represented by w2. Otherwise, the function should return false.

scrollToWindow

Code Block
languagelua
function scrollToWindow(win, ctrl)

...

A reference to one or more databasenode objects representing the new data source(s) for the window list.

setEmptyText

Code Block
function setEmptyText(value)

Set the text to display in the control when the underlying data is an empty list.

Parameters

value   (string)   

The new value for the empty text display string

setFocus

Code Block
languagelua
function setFocus([state])

...