private.lockScrnFrame - WIN

Class lockScrnFrame
Inherits from applicationFrame.

The lockScrnFrame class provides a full work area system page that prompts the user for a password, blocking all other user interaction until the password is correctly entered. The class is privately defined in the win API. To invoke the lock screen use desktopWindow:lock_screen. Note that the lock screen will not invoke if a system password is not set or for a desktop if locking is disabled. Also, the lock screen responds to the enter key on the password field as an Ok action.

Properties

title labelWindow Displays the "Locked" label.
password inputWindow Password input window.
ok buttonWindow Ok button.

Methods

See also API Reference, WIN.

private.lockScrnFrame:constructor

frame lockScrnFrame:constructor (dir)

Constructs and returns the instantiated lock screen frame window.

Parameters
dir
string
Desktop directory under /win/devices.

Returns
frame
lockScrnFrame
The instantiated frame window.

Remarks


top


private.lockScrnFrame:on_child_key

result lockScrnFrame:on_child_key (wnd, key, ctrl, alt, shift)

Implements the Ok action on enter key.

Parameters
child window Child window the event is for.
key number Key code.
ctrl boolean True if control key is depressed.
alt boolean True if alternate key is depressed.
shift boolean True if shift key is depressed.

Returns
result boolean True if handled, false if not.

Remarks
See window:on_child_key.


top


private.lockScrnFrame:on_event

result lockScrnFrame:on_event (event, p1, p2, p3, p4, p5, ...)

Implements control events.

Parameters
event string The event type.
p1 any First parameter to event or nil if not used.
p2 any Second parameter to event or nil if not used.
p3 any Third parameter to event or nil if not used.
p4 any Fourth parameter to event or nil if not used.
p5 any Fifth parameter to event or nil if not used.
...
any Any additional parameters.

Returns
result boolean True if handled, otherwise false.

Remarks
See window:on_event.


top


private.lockScrnFrame:on_frame_activate

lockScrnFrame:on_frame_activate (active)

If active, sets to full screen and disables task bar.

Parameters
active boolean True if made active, false if inactive.

Returns
none


Remarks
See parentFrame:on_frame_activate.


top


private.lockScrnFrame:on_quit

result lockScrnFrame:on_quit ()

Ensures the lock screen cannot be quit.

Parameters
none



Returns
result boolean Always true.

Remarks
See applicationFrame:on_quit.


top


private.lockScrnFrame:on_resize

result lockScrnFrame:on_resize ()

Resizes and reconfigures the lock screen frame.

Parameters
none


Returns
result boolean Always true.

Remarks
See applicationFrame:on_resize.


top


See also API Reference, WIN.