[tekui-devel] tekui: Object: added missing documentation regarding ui.NOTIFY_S...

[Timm S. Mueller]

details:   http://hg.teklib.org/tekui/rev/2dd876d3095c
changeset: 5:2dd876d3095c
user:      Timm S. Mueller <tmueller at schulze-mueller.de>
date:      Fri Jul 25 01:26:40 2008 +0200
description:
Object: added missing documentation regarding ui.NOTIFY_SELF; Border, Frame:
simplified and unified border numbering scheme and arguments to getBorder()
and drawBorder(); Canvas, Layout, Group: groups now handle inner borders,
corrected some refreshing problems; DirList: externalized
getDirectoryIterator(), getFileStat() and reload(), making them overridable;
ListGadget: refresh problem fixed when items changed but the general layout
remained the same, added getSelectedLines() method for retrieving a
numerically indexed list of selected entries; Slider: improved rendering

diffs (truncated from 947 to 100 lines):

diff -r a259cd1de066 -r 2dd876d3095c bin/tek/ui/class/plasma.lua
--- a/bin/tek/ui/class/plasma.lua	Mon Jul 21 11:09:07 2008 +0200
+++ b/bin/tek/ui/class/plasma.lua	Fri Jul 25 01:26:40 2008 +0200
@@ -7,7 +7,7 @@
 
 local ui = require "tek.ui"
 local db = require "tek.lib.debug"
-local Frame = ui.Area
+local Area = ui.Area
 
 local cos = math.cos
 local floor = math.floor
@@ -18,7 +18,7 @@ local unpack = unpack
 local unpack = unpack
 
 module("tek.ui.class.plasma", tek.ui.class.area)
-_VERSION = "Plasma 1.0"
+_VERSION = "Plasma 1.1"
 
 local WIDTH = 80
 local HEIGHT = 60
@@ -54,7 +54,7 @@ function Plasma.new(class, self)
 	self.PalIndex = 0
 	self.SinTab = { }
 	self.Params = { 0, 0, 0, 0, 0 } -- xp1, xp2, yp1, yp2, yp3
-	return Frame.new(class, self)
+	return Area.new(class, self)
 end
 
 function Plasma.init(self)
@@ -69,11 +69,11 @@ function Plasma.init(self)
 	self.MaxWidth = WIDTH * PIXWIDTH
 	self.MaxHeight = HEIGHT * PIXHEIGHT
 	self.IntervalNotify = { self, "update" }
-	return Frame.init(self)
+	return Area.init(self)
 end
 
 function Plasma:show(display, drawable)
-	if Frame.show(self, display, drawable) then
+	if Area.show(self, display, drawable) then
 		self.Window:addNotify("Interval", ui.NOTIFY_ALWAYS,
 			self.IntervalNotify)
 		return true
@@ -81,7 +81,7 @@ end
 end
 
 function Plasma:hide()
-	Frame.hide(self)
+	Area.hide(self)
 	self.Window:remNotify("Interval", ui.NOTIFY_ALWAYS, self.IntervalNotify)
 end
 
diff -r a259cd1de066 -r 2dd876d3095c doc/manual.html
--- a/doc/manual.html	Mon Jul 21 11:09:07 2008 +0200
+++ b/doc/manual.html	Fri Jul 25 01:26:40 2008 +0200
@@ -203,7 +203,7 @@
 			</blockquote>
 			<hr />
 		</div>
-		<div class="node"><h2><a name="tek.ui.class.frame" id="tek.ui.class.frame">Frame (v2.12)</a></h2>
+		<div class="node"><h2><a name="tek.ui.class.frame" id="tek.ui.class.frame">Frame (v3.1)</a></h2>
 			<div class="definition"><dfn>LINEAGE</dfn>
 				<blockquote>
 					<p>
@@ -314,13 +314,10 @@
 				<blockquote>
 					<ul>
 						<li style="list-style-type: none">
-							<a href="#Frame:drawBorder"><code>Frame:drawBorder()</code></a> - Draws the element's outer border
-						</li>
-						<li style="list-style-type: none">
-							<a href="#Frame:getBorder"><code>Frame:getBorder()</code></a> - Returns the element's outer border
-						</li>
-						<li style="list-style-type: none">
-							<a href="#Frame:getIBorder"><code>Frame:getIBorder()</code></a> - Returns the element's inner border
+							<a href="#Frame:drawBorder"><code>Frame:drawBorder()</code></a> - Draws one of the element's borders
+						</li>
+						<li style="list-style-type: none">
+							<a href="#Frame:getBorder"><code>Frame:getBorder()</code></a> - Returns one of the element's borders
 						</li>
 						<li style="list-style-type: none">
 							<a href="#Frame:onFocus"><code>Frame:onFocus()</code></a> - Handler for <code>Focus</code> 
@@ -372,23 +369,21 @@
 				<hr />
 			</div>
 		</div>
-		<div class="node"><h3><a name="Frame:getBorder" id="Frame:getBorder"><code>border = Frame:getBorder()</code></a></h3>
-			<p>
-				Returns an element's table of outer border
-				strengths &#091;pixels&#093; in the order left, top, right, bottom.
-			</p>
-			<hr />
-		</div>
-		<div class="node"><h3><a name="Frame:getIBorder" id="Frame:getIBorder"><code>iborder = Frame:getIBorder()</code></a></h3>
-			<p>
-				Returns an element's table of
-				inner border strengths &#091;pixels&#093; in the order left, top, right, bottom.
-			</p>
-			<hr />