From bf10878e481f4f230dc20e00a7a2a1e02e42e291 Mon Sep 17 00:00:00 2001 From: Rui Guo Date: Mon, 3 Aug 2009 23:52:38 +0800 Subject: [PATCH] Update document on display interface. --- src/drafts/scripting | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/src/drafts/scripting b/src/drafts/scripting index 293acb8..2368c8f 100644 --- a/src/drafts/scripting +++ b/src/drafts/scripting @@ -125,18 +125,32 @@ layout: type: Layout. description: Active layout on this display. +idle_timeout: + mode: write only. + type: Int. + description: Set the idle timeout for this display, and actives the idle + event. It differs from the idle command, which uses a global + value for all attached displays. + ---------- Methods: ---------- get_canvases: Get a list of canvases on this display. +top_canvas: Get the top (or top-left) canvas on the display. +bottom_canvas: Get the bottom canvas on the display. ---------- Events: ---------- -on_resize: Triggered after the geometry of the display is changed. +on_idle: (Display) + Triggerred whenever the idle timeout is reached. The handler will be + called with a reference to the idling display. If the handler returns + non-zero, the internal idle processing will be overriden. Please note that the + The idle timeout is not reseted on such a situation, remember to setup + idle timout in the handler if multiple activation is needed.. B. Window -- 2.11.4.GIT