From bf77979b5108f604012cb7eb8d5801aa8780632d Mon Sep 17 00:00:00 2001 From: =?utf8?q?Jean-Philippe=20Andr=C3=A9?= Date: Sat, 20 Mar 2010 17:17:52 +0100 Subject: [PATCH] Lua: update documentation --- share/lua/README.txt | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/share/lua/README.txt b/share/lua/README.txt index aebf0b15b0..3fbc242122 100644 --- a/share/lua/README.txt +++ b/share/lua/README.txt @@ -54,13 +54,15 @@ Dialog local d = vlc.dialog( "My VLC Extension" ): Create a new UI dialog, with a human-readble title: "My VLC Extension" d:show(): Show this dialog. d:hide(): Hide (but not close) this dialog. -d:close(): Close and delete this dialog. +d:delete(): Close and delete this dialog. d:del_widget( widget ): Delete 'widget'. It disappears from the dialog and repositionning may occur. +d:update(): Update the dialog immediately (don't wait for the current function to return) -In the following functions, you can always add some optional parameters: col, row, col_span, row_span. +In the following functions, you can always add some optional parameters: col, row, col_span, row_span, width, height. They define the position of a widget in the dialog: - row, col are the absolute positions on a grid of widgets. First row, col are 1. - row_span, col_span represent the relative size of a widget on the grid. A widget with col_span = 4 will be displayed as wide as 4 widgets of col_span = 1. +- width and height are size hints (in pixels) but may be discarded by the GUI module Example: w = d:add_label( "My Label", 2, 3, 4, 5 ) will create a label at row 3, col 2, with a relative width of 4, height of 5. d:add_button( text, func, ... ): Create a button with caption "text" (string). When clicked, call function "func". func is a function reference. -- 2.39.5