Add TODOs for four new widget methods.

[mkws-moved-to-github.git] / doc / mkws-developer.markdown

diff --git a/doc/mkws-developer.markdown b/doc/mkws-developer.markdown
index d302027..2689eb6 100644 (file)
--- a/doc/mkws-developer.markdown
+++ b/doc/mkws-developer.markdown
@@ -134,6 +134,21 @@ be used by the derived widget.
 * `String this.value()` --
        A function returning the value of the widget's HTML element.
 
+* TODO autosearch()
+
+* TODO hideWhenNarrow()
+
+* TODO subwidget()
+
+* TODO expandValue()
+
+In addition to these properties and methods of the bare widget object,
+some kinds of specific widget add other properties of their own. For
+example, the `Builder` widget uses a `callback` property as the
+function that it use to publish the widget definition that it
+constructs. This defaults to the builtin function `alert`, but can be
+overridden by derived widgets such as `ConsoleBuilder`.
+
 
 Team methods
 ------------
@@ -148,9 +163,10 @@ properties.
 * `Num team.totalRecordCount()`
 * `Num team.currentPage();`
 * `String team.currentRecordId()`
-* `String team.currentRecordData()` --
-       Simple accessor functions that provide the ability to read
-       properties of the team.
+* `String team.currentRecordData()`
+
+These are all simple accessor functions that provide the ability to
+read properties of the team.
 
 * `Array team.filters()` --
        Another accessor function, providing access to the array of
@@ -160,13 +176,17 @@ properties.
        convenient to do it this way. If you must insist on using
        this, see the `Navi` widget, which is the only place it's used.
 
+* `Bool team.targetFiltered(targetId)` --
+       Indicates whether the specified target has been filtered by
+       selection as a facet. This is used only by the `Facet` widget,
+       and there is probably no reason for you to use it.
+
 * `Hash team.config()` --
        Access to the team's configuration settings. There is almost
        certainly no reason to use this: the settings that haven't
        been overridden are accessible via `this.config`.
 
-* `Void team.set_sortOrder(string)`
-* `Void team.set_perpage(number)` --
+* `Void team.set_sortOrder(string)`, `Void team.set_perpage(number)` --
        "Setter" functions for the team's sortOrder and perpage
        functions. Unlikely to be needed outside of the `Sort` and
        `Perpage` widgets.
@@ -175,10 +195,6 @@ properties.
        Returns the queue associated with the named event: this can be
        used to subscribe to the event (or more rarely to publish it).
 
-* `Bool team.targetFiltered(targetId)` --
-       Indicates whether the specified target has been filtered by
-       selection as a facet.
-
 * `Void team.newSearch(query, sortOrder, maxrecs, perpage, limit, targets, targetfilter)` --
        Starts a new search with the specified parameters. All but the
        query may be omitted, in which case the prevailing defaults