- From: Max Froumentin via cvs-syncmail <cvsmail@w3.org>
- Date: Wed, 02 Dec 2009 16:37:35 +0000
- To: public-dap-commits@w3.org
Update of /sources/public/2009/dap/system-info
In directory hutz:/tmp/cvs-serv20077
Modified Files:
Overview.html
Log Message:
- renamed callback types to *CB
- remove obsolete description of battery thresholds
Index: Overview.html
===================================================================
RCS file: /sources/public/2009/dap/system-info/Overview.html,v
retrieving revision 1.19
retrieving revision 1.20
diff -u -d -r1.19 -r1.20
--- Overview.html 2 Dec 2009 16:24:41 -0000 1.19
+++ Overview.html 2 Dec 2009 16:37:32 -0000 1.20
@@ -56,7 +56,7 @@
<dl title='[NoInterfaceObject] interface Power' class='idl'>
- <dt>PendingOperation getCurrentPower(in SuccessCallback successCallback, [Optional] in ErrorCallback errorCallback)</dt>
+ <dt>PendingOp getCurrentPower(in SuccessCB successCallback, [Optional] in ErrorCB errorCallback)</dt>
<dd>The <code>getCurrentPower</code> function retrieves the
current state of the power source. When called, the function
MUST immediately return and asynchronously acquires the current
@@ -67,7 +67,7 @@
invoked and is passed a <code>PowerError</code> object
indicating the cause of error.</dd>
- <dt>PendingOperation watchPower(in SuccessCallback successCallback, [Optional] in ErrorCallback errorCallback, [Optional] in PowerOptions options)</dt>
+ <dt>PendingOp watchPower(in SuccessCB successCallback, [Optional] in ErrorCB errorCallback, [Optional] in PowerOptions options)</dt>
<dd>The <code>watchPowerSource</code> method takes one, two or
three arguments. When called, it MUST immediately return and
then asynchronously start a watch process defined as the
@@ -109,31 +109,10 @@
<dl title='interface PowerOptions' class='idl'>
<dt>attribute double highThreshold</dt>
- <dd>If the <code>highThreshold</code> is greater than zero,
- when system power level rises above the specified value, the
- <code>PowerLevelCallback</code> MUST be invoked with the
- <code>crossedHighThreshold</code> value of the
- <code>PowerLevel</code> parameter set to <code>true</code>.
- If the <code>PowerLevelOptions</code> object is not null, and
- the <code>highThreshold</code> value is 1.0 (the default), the
- <code>PowerLevelCallback</code> MUST not be invoked with the
- <code>crossedHighThreshold</code> value set to
- <code>true</code>. The value must be greater or equal to 0.0,
- and no greater than 1.0. If the value is different from null, then the callback in only called when the power level is higher than the value passed</dd>
-
+ <dd>...</dd>
<dt>attribute double lowThreshold</dt>
- <dd>If the <code>lowThreshold</code> is less than 1.0, when
- the system power level falls below the specified value, the
- <code>PowerLevelCallback</code> MUST be invoked with the
- <code>crossedLowThreshold</code> value of the
- <code>PowerLevel</code> parameter set to <code>true</code>. If
- the <code>PowerLevelOptions</code> object is not null, and the
- <code>lowThreshold</code> value is 0.0 (default), the
- <code>PowerLevelCallback</code> MUST not be invoked with the
- <code> crossedLowThreshold</code> value set to
- <code>true</code>. The value MUST be greater than or equal to
- 0.0, and no greater than 1.0. If the value is different from null, then the callback in only called when the power level is higher than the value passed</dd>
+ <dd>...</dd>
</dl>
</section>
@@ -263,7 +242,7 @@
<dd>The brand attribute MUST include information about both the manufacturer and the
model number. It MAY contain information identifying the supported instruction set.
</dd>
- <dt>long watchCpuUsage(in CpuUsageCallback successCallback, [Optional] in CpuUsageErrorCallback errorCallback, [Optional] in CpuUsageOptions options) </dt>
+ <dt>long watchCpuUsage(in CpuUsageCB successCallback, [Optional] in CpuUsageErrorCB errorCallback, [Optional] in CpuUsageOptions options) </dt>
<dd>The <code>watchCpuUsage</code> function allows callers to monitor a delivery
context's CPU utilization and takes one, two or three parameters. When called, it
must immediately return and then asynchronously start a watch process defined by
@@ -291,16 +270,16 @@
</dd>
</dl>
<section>
- <h4>CpuUsageCallback</h4>
- <dl title='[Callback=FunctionOnly, NoInterfaceObject] interface CpuUsageCallback' class='idl'>
+ <h4>CpuUsageCB</h4>
+ <dl title='[Callback=FunctionOnly, NoInterfaceObject] interface CpuUsageCB' class='idl'>
<dt>void handleEvent(in CpuUsage usage)</dt>
<dd>This function is supplied by a call to <code>watchCpuUsage()</code>. Use the
parameter to retrieve information about system cpu utilization.</dd>
</dl>
</section>
<section>
- <h4>CpuUsageErrorCallback</h4>
- <dl title='[Callback=FunctionOnly, NoInterfaceObject] interface CpuUsageErrorCallback' class='idl'>
+ <h4>CpuUsageErrorCB</h4>
+ <dl title='[Callback=FunctionOnly, NoInterfaceObject] interface CpuUsageErrorCB' class='idl'>
<dt>void handleEvent(in CPUUsageError error)</dt>
<dd>This function is supplied by a call to <code>watchCpuUsage()</code>. Use the
parameter to retrieve information about the error that occured while the implementation
@@ -312,30 +291,30 @@
<dl title='interface CpuUsageOptions' class='idl'>
<dt>attribute unsigned short highThreshold</dt>
<dd>The <code>highThreshold</code> attribute allows the caller to specify that the
- implementation MUST only invoke the <code>CpuUsageCallback</code> when the device
+ implementation MUST only invoke the <code>CpuUsageCB</code> when the device
CPU utilization rises above the value specified. The maximum value is 100, the
- minimum value is 0. The default value is 100, meaning that the <code>CpuUsageCallback
+ minimum value is 0. The default value is 100, meaning that the <code>CpuUsageCB
</code> MUST NOT be invoked with the <code>CpuUsage</code> <code>
crossedHighThreshold</code> attribute set to <code>true</code>.
</dd>
<dt>attribute unsigned short lowThreshold</dt>
<dd>The <code>lowThreshold </code> attribute allows the caller to specify that the
- implementation MUST only invoke the <code>CpuUsageCallback</code> when the device
+ implementation MUST only invoke the <code>CpuUsageCB</code> when the device
CPU utilization falls below the value specified. The maximum value is 100, the
- minimum value is 0. The default value is 0, meaning that the <code>CpuUsageCallback
+ minimum value is 0. The default value is 0, meaning that the <code>CpuUsageCB
</code> MUST NOT be invoked with the <code>CpuUsage crossedLowThreshold </code>
attribute set to <code>true</code>.
</dd>
<dt>attribute unsigned short highThresholdSampleCount</dt>
<dd>The <code>highThresholdSampleCount</code> attribute allows the caller to specify
how many consecutive samples must be taken above the value specified by <code>
- highThreshold</code> before the <code>CpuUsageCallback</code> function is invoked
+ highThreshold</code> before the <code>CpuUsageCB</code> function is invoked
with the <code>crossedHighThreshold</code> attribute set to <code>true</code>. For
example, If
- the value is 1, the <code>CpuUsageCallback</code> function MUST be invoked with the
+ the value is 1, the <code>CpuUsageCB</code> function MUST be invoked with the
<code>crossedHighThreshold</code> attribute set to <code>true </code> every time the
implementation samples the CPU utilization. If the value is 2, the
- <code>CpuUsageCallback</code> function MUST be invoked with the
+ <code>CpuUsageCB</code> function MUST be invoked with the
<code>crossedHighThreshold</code> attribute set to <code>true</code> only if the
implementation collects two consecutive samples that are greater than the value
specified by the <code>highThreshold</code> attribute. The default value is 1,
@@ -344,12 +323,12 @@
<dt>attribute unsigned short lowThresholdSampleCount</dt>
<dd>The <code>lowThresholdSampleCount</code> attribute allows the caller to specify
how many consecutive samples must be taken below the value specified by <code>
- lowThreshold</code> before the <code>CpuUsageCallback</code> function is invoked
+ lowThreshold</code> before the <code>CpuUsageCB</code> function is invoked
with the <code>crossedLowThreshold</code> attribute set to <code>true</code>. For
- example, If the value is 1, the <code>CpuUsageCallback</code> function MUST be
+ example, If the value is 1, the <code>CpuUsageCB</code> function MUST be
invoked with the <code>crossedLowThreshold</code> attribute set to <code>true</code>
every time the implementation samples the CPU utilization. If the value is
- 2, the <code>CpuUsageCallback</code> function must be invoked with the
+ 2, the <code>CpuUsageCB</code> function must be invoked with the
<code>crossedLowThreshold</code> attribute set to <code>true</code> only if the
implementation collects two consecutive samples that are greater than the value
specified by the <code>lowThreshold</code> attribute. The default value is 1, which
@@ -361,7 +340,7 @@
implementation SHOULD sample at the suggested rate, but MAY chose to ignore values
that are too small and which are likely to hamper system performance. If no
<code>highThreshold</code> or <code>lowThreshold</code> values are specified, the
- implementation MUST invoke the <code>CpuUsageCallback</code> each time CPU
+ implementation MUST invoke the <code>CpuUsageCB</code> each time CPU
utilization is sampled. The default sample interval is 2000, or once every two
seconds.
</dd>
@@ -369,7 +348,7 @@
<dd>
The <code>timeout</code> attribute specifies how long (in milliseconds) an
implementation SHOULD attempt to measure CPU utilization before invoking the
- <code>CpuUsageErrorCallback</code> with the <code>TIMEOUT</code> error code. The
+ <code>CpuUsageErrorCB</code> with the <code>TIMEOUT</code> error code. The
default value is 5000, or five seconds.
</dd>
</dl>
@@ -380,7 +359,7 @@
<dt>readonly attribute unsigned short usage</dt>
<dd>
The <code>usage</code> attribute MUST indicate what percentage of the total CPU
- resources are in use when the <code>CpuUsageCallback</code> method is invoked. If
+ resources are in use when the <code>CpuUsageCB</code> method is invoked. If
the device has more than one CPU, this attribute MUST be the average usage of all
CPUs on the system. The maximum value is 100; the minimum value is 0.
</dd>
@@ -391,7 +370,7 @@
</dd>
<dt>readonly attribute boolean crossedHighThreshold</dt>
<dd>
- When a <code>CpuUsageCallback</code> is invoked with a <code>CpuUsage</code>
+ When a <code>CpuUsageCB</code> is invoked with a <code>CpuUsage</code>
object whose <code>crossedHighThreshold</code> attribute set to <code>true</code>,
the cpu usage high threshold has been crossed. This threshold value is set in
the <code>CpuUsageOptions</code> parameter of a call to <code>watchCpuUsage()
@@ -407,7 +386,7 @@
</dd>
<dt>readonly attribute boolean crossedLowThreshold</dt>
<dd>
- When a <code>CpuUsageCallback</code> is invoked with a <code>CpuUsage</code>
+ When a <code>CpuUsageCB</code> is invoked with a <code>CpuUsage</code>
object whose <code>crossedLowThreshold</code> attribute set to <code>true</code>,
the cpu utilization low threshold has been crossed. This threshold value MUST be set
in the <code>CpuUsageOptions</code> parameter of a prior call to <code>
@@ -454,7 +433,7 @@
CPU usage information because one or more of the values in the <code>CpuUsageOptions
</code> parameter of the <code>watchCpuUsage()</code> call was invalid. For example,
if the <code>CpuUsageOptions highThreshold</code> attribute is set to a value
- greater than 100, the <code>CpuErrorCallback</code> must be invoked with the
+ greater than 100, the <code>CpuErrorCB</code> must be invoked with the
<code>CpuUsageError code</code> attribute set with a value of INVALID_VALUE (4).
</dd>
<dt>readonly attribute unsigned short code</dt>
@@ -556,7 +535,7 @@
<dd>
The refresh rate of the display in Hertz. Zero if the refresh rate cannot be determined.
</dd-->
- <dt>int watchOrientation ( in OrientationChangedCallback successCallback, [Optional] in DisplayErrorCallback errorCallback)</dt>
+ <dt>int watchOrientation ( in OrientationChangedCB successCallback, [Optional] in DisplayErrorCB errorCallback)</dt>
<dd>
The <code>watchOrientation()</code> function takes one or two arguments. When called,
it must immediately return and then asynchronously start a watch process defined as
@@ -569,7 +548,7 @@
</ol>
<p/>This method returns an integer value that uniquely identifies the watch process. When the <code>clearWatch()</code> method is called with this identifier, the watch process must stop acquiring any new position fixes and must cease invoking any callbacks. When this value is used in a call to <code>updatePosition()</code>, the watch process SHOULD update the position information that it is using in its orientation caluculations.
</dd>
- <dt>int watchColorDepth ( in ColorDepthChangedCallback successCallback, [Optional] in DisplayErrorCallback errorCallback)</dt>
+ <dt>int watchColorDepth ( in ColorDepthChangedCB successCallback, [Optional] in DisplayErrorCB errorCallback)</dt>
<dd>
The <code>watchColorDepth()</code> function takes one or two arguments. When called,
it must immediately return and then asynchronously start a watch process defined as
@@ -582,7 +561,7 @@
</ol>
<p/>This method returns an integer value that uniquely identifies the watch process. When the <code>clearWatch()</code> method is called with this identifier, the watch process must stop acquiring any new position fixes and must cease invoking any callbacks. When this value is used in a call to <code>updatePosition()</code>, the watch process SHOULD update the position information that it is using in its orientation caluculations.
</dd>
- <dt>int watchResolution ( in ResolutionChangedCallback successCallback, [Optional] in DisplayErrorCallback errorCallback)</dt>
+ <dt>int watchResolution ( in ResolutionChangedCB successCallback, [Optional] in DisplayErrorCB errorCallback)</dt>
<dd>
The <code>watchResolution()</code> function takes one or two arguments. When called,
it must immediately return and then asynchronously start a watch process defined as
@@ -595,7 +574,7 @@
</ol>
<p/>This method returns an integer value that uniquely identifies the watch process. When the <code>clearWatch()</code> method is called with this identifier, the watch process must stop acquiring any new position fixes and must cease invoking any callbacks. When this value is used in a call to <code>updatePosition()</code>, the watch process SHOULD update the position information that it is using in its orientation caluculations.
</dd>
- <dt>int watchBrightness ( in BrightnessChangedCallback successCallback, [Optional] in DisplayErrorCallback errorCallback)</dt>
+ <dt>int watchBrightness ( in BrightnessChangedCB successCallback, [Optional] in DisplayErrorCB errorCallback)</dt>
<dd>
The <code>watchBrightness()</code> function takes one or two arguments. When called,
it must immediately return and then asynchronously start a watch process defined as
@@ -643,8 +622,8 @@
</dl>
</section>
<section>
- <h3>OrientationChangedCallback</h3>
- <dl title='interface OrientationChangedCallback' class='idl'>
+ <h3>OrientationChangedCB</h3>
+ <dl title='interface OrientationChangedCB' class='idl'>
<dt>void handleEvent(in DisplayOrientation displayOrientation)</dt>
<dd>
Called whenever the implementation detects that the orientation of the display
@@ -653,8 +632,8 @@
</dl>
</section>
<section>
- <h3>ColorDepthChangedCallback</h3>
- <dl title='interface ColorDepthChangedCallback' class='idl'>
+ <h3>ColorDepthChangedCB</h3>
+ <dl title='interface ColorDepthChangedCB' class='idl'>
<dt>void handleEvent(in unsigned int colorDepth)</dt>
<dd>
Called whenever the implementation detects that the color depth of the display
@@ -663,8 +642,8 @@
</dl>
</section>
<section>
- <h3>ResolutionChangedCallback</h3>
- <dl title='interface ResolutionChangedCallback' class='idl'>
+ <h3>ResolutionChangedCB</h3>
+ <dl title='interface ResolutionChangedCB' class='idl'>
<dt>void handleEvent(in int resolution)</dt>
<dd>
Called whenever the implementation detects that the resolution of the display
@@ -673,8 +652,8 @@
</dl>
</section>
<section>
- <h3>BrightnessChangedCallback</h3>
- <dl title='interface BrightnessChangedCallback' class='idl'>
+ <h3>BrightnessChangedCB</h3>
+ <dl title='interface BrightnessChangedCB' class='idl'>
<dt>void handleEvent(in int displayBrightness)</dt>
<dd>
Called whenever the implementation detects that the brightness of the display
@@ -683,8 +662,8 @@
</dl>
</section>
<section>
- <h3>DisplayErrorCallback</h3>
- <dl title='interface DisplayErrorCallback' class='idl'>
+ <h3>DisplayErrorCB</h3>
+ <dl title='interface DisplayErrorCB' class='idl'>
<dt>void handleEvent(in DisplayError displayError)</dt>
<dd>
Called whenever the implementation encounters an error while monitoring the
@@ -811,7 +790,7 @@
<p>An implementation SHOULD attempt to use the device's default proxy settings for
HTTP, HTTPS, and FTP. </p>
</dd>
- <dt>long watchServiceChange(in DOMString uriDestination, in ServiceChangeCallback changeCallback, [Optional] in ServiceChangeErrorCallback errorCallback, [Optional] in ServiceChangeOptions options)</dt>
+ <dt>long watchServiceChange(in DOMString uriDestination, in ServiceChangeCB changeCallback, [Optional] in ServiceChangeErrorCB errorCallback, [Optional] in ServiceChangeOptions options)</dt>
<dd>
The <code>watchServiceChange()</code> function takes two, three or four arguments.
<p><code>uriDestination</code> MUST be in the form of:</p>
@@ -847,7 +826,7 @@
<li>If an error occurs, invoke the errorCallback if it was provided.</li>
</ol>
</dd>
- <dt>long watchNetworkChange(in NetworkChangeCallback changeCallback, [Optional] in NetworkChangeErrorCallback errorCallback, [Optional] in NetworkChangeOptions options)</dt>
+ <dt>long watchNetworkChange(in NetworkChangeCB changeCallback, [Optional] in NetworkChangeErrorCB errorCallback, [Optional] in NetworkChangeOptions options)</dt>
<dd>
The <code>watchNetworkChange()</code> function takes one, two, or three arguments.
When called, <code>watchNetworkChange()</code> MUST immediately return and then
@@ -856,7 +835,7 @@
<ol>
<li>Monitor the network resources specified in the <code>NetworkChangeOptions</code>
object.</li>
- <li>When the specififed network resources change, invoke the <code>NetworkChangeCallback</code>
+ <li>When the specififed network resources change, invoke the <code>NetworkChangeCB</code>
with the appropriate flag set in the <code>NetworkChange</code> parameter to
indicate what change occured.</li>
<li>If the monitoring fails at any point, and the method was invoked with a
@@ -1325,16 +1304,16 @@
</dl>
</section>
<section>
- <h4>ServiceChangeCallback</h4>
- <dl title='[Callback=FunctionOnly, NoInterfaceObject] interface ServiceChangeCallback' class='idl'>
+ <h4>ServiceChangeCB</h4>
+ <dl title='[Callback=FunctionOnly, NoInterfaceObject] interface ServiceChangeCB' class='idl'>
<dt>void handleEvent(in ServiceChange change)</dt>
<dd>This function is supplied by a call to <code>watchServiceChange()</code>. Use the
parameter to retrieve information about the visibility of a service.</dd>
</dl>
</section>
<section>
- <h4>ServiceChangeErrorCallback</h4>
- <dl title='[Callback=FunctionOnly, NoInterfaceObject] interface ServiceChangeErrorCallback' class='idl'>
+ <h4>ServiceChangeErrorCB</h4>
+ <dl title='[Callback=FunctionOnly, NoInterfaceObject] interface ServiceChangeErrorCB' class='idl'>
<dt>void handleEvent(in ServiceChangeError error)</dt>
<dd>This function is supplied by a call to <code>watchServiceChange()</code>. Use the
parameter to retrieve information about an error that occured while the implementation
@@ -1361,16 +1340,16 @@
</dl>
</section>
<section>
- <h4>NetworkChangeCallback</h4>
- <dl title='[Callback=FunctionOnly, NoInterfaceObject] interface NetworkChangeCallback' class='idl'>
+ <h4>NetworkChangeCB</h4>
+ <dl title='[Callback=FunctionOnly, NoInterfaceObject] interface NetworkChangeCB' class='idl'>
<dt>void handleEvent(in NetworkChange change)</dt>
<dd>This function is supplied by a call to <code>watchNetworkChange()</code>. Use the
parameter to retrieve information about network changes that the device detects.</dd>
</dl>
</section>
<section>
- <h4>NetworkChangeErrorCallback</h4>
- <dl title='[Callback=FunctionOnly, NoInterfaceObject] interface NetworkChangeErrorCallback' class='idl'>
+ <h4>NetworkChangeErrorCB</h4>
+ <dl title='[Callback=FunctionOnly, NoInterfaceObject] interface NetworkChangeErrorCB' class='idl'>
<dt>void handleEvent(in NetworkChangeError error)</dt>
<dd>This function is supplied by a call to <code>watchNetworkChange()</code>. Use the
parameter to retrieve information about errors that occur while the implementation
@@ -1392,25 +1371,25 @@
<dt>attribute boolean watchIpAddress</dt>
<dd>
When the implementation detects that the IpAddress(es) assigned to the device have
- changed, it MUST invoke the <code>NetworkChangeCallback</code> with the <code>NetworkChange.ipAddressChanged</code>
+ changed, it MUST invoke the <code>NetworkChangeCB</code> with the <code>NetworkChange.ipAddressChanged</code>
attribute set to <code>true</code>. If this value is not specified, or if it is set
to false, IP Addresses SHOULD not be monitored, and the implementation MUST NOT invoke
- the <code>NetworkChangeCallback</code> with the <code>NetworkChange.ipAddressChanged</code> attribute set to
+ the <code>NetworkChangeCB</code> with the <code>NetworkChange.ipAddressChanged</code> attribute set to
<code>true</code>.
</dd>
<dt>attribute boolean watchRouteTable</dt>
<dd>
When the implementation detects that the system route table has
- changed, it MUST invoke the <code>NetworkChangeCallback</code> with the <code>NetworkChange.routeTableChanged</code>
+ changed, it MUST invoke the <code>NetworkChangeCB</code> with the <code>NetworkChange.routeTableChanged</code>
attribute set to <code>true</code>. If this value is not specified, or if it is set
to false, the system Route Table SHOULD not be monitored, and the implementation
MUST NOT invoke
- the <code>NetworkChangeCallback</code> with the <code>NetworkChange.routeTableChanged</code> attribute set to
+ the <code>NetworkChangeCB</code> with the <code>NetworkChange.routeTableChanged</code> attribute set to
<code>true</code>.
</dd>
<dt>attribute boolean watchConnection</dt>
<dd>
- Invoke the <code>NetworkChangeCallback</code> when the device connection state changes.
+ Invoke the <code>NetworkChangeCB</code> when the device connection state changes.
If all connections are lost, the <code>NetworkChange.disconnected</code> attribute
will be <code>true</code>. If there were no connections and one was established, the
<code>NetworkChange.connected</code> attribute will be <code>true</code>.
@@ -1490,7 +1469,7 @@
The implementation failed to retrieve information about service availability because one or more of
the parameters in the <code>watchMovement()
</code> call was invalid. For example, if the <code>uriDestination</code> is not a valid
- [[URI]], the <code>ServiceChangeErrorCallback</code> must be invoked with the <code>
+ [[URI]], the <code>ServiceChangeErrorCB</code> must be invoked with the <code>
ServiceChangeError.code</code> attribute equal to <code>INVALID_PARAMETER</code> (3).
</dd>
<dt>readonly attribute unsigned short code</dt>
@@ -1571,7 +1550,7 @@
<dd>
The temperature in degrees Celsius.
</dd>
- <dt>long watchTemperature(in TemperatureChangeCallback changeCallback, [Optional] in TemperatureErrorCallback errorCallback, [Optional] in TemperatureChangeOptions options)</dt>
+ <dt>long watchTemperature(in TemperatureChangeCB changeCallback, [Optional] in TemperatureErrorCB errorCallback, [Optional] in TemperatureChangeOptions options)</dt>
<dd>
The <code>watchTemperature()</code> function takes one, two, or three arguments.
When called, <code>watchTemperature()</code> MUST immediately return and then
@@ -1579,7 +1558,7 @@
<ol>
<li>Monitor the ambient temperature. </li>
<li>When the temperature changes in a manner specified by the <code>options</code> parameter,
- invoke the <code>TemperatureChangeCallback</code>
+ invoke the <code>TemperatureChangeCB</code>
with the appropriate attribute set in the <code>TemperatureChange</code> parameter to
indicate what change occured.</li>
<li>If the monitoring fails at any point, and the method was invoked with a
@@ -1647,8 +1626,8 @@
</dl>
</section>
<section>
- <h3>TemperatureErrorCallback</h3>
- <dl title='[Callback=FunctionOnly, NoInterfaceObject] interface TemperatureErrorCallback' class='idl'>
+ <h3>TemperatureErrorCB</h3>
+ <dl title='[Callback=FunctionOnly, NoInterfaceObject] interface TemperatureErrorCB' class='idl'>
<dt>void handleEvent(in TemperatureError error)</dt>
<dd>
If provided, this function MUST be called whenever the implementation is unable to
@@ -1658,8 +1637,8 @@
</dl>
</section>
<section>
- <h3>TemperatureChangeCallback</h3>
- <dl title='[Callback=FunctionOnly, NoInterfaceObject] interface TemperatureChangeCallback' class='idl'>
+ <h3>TemperatureChangeCB</h3>
+ <dl title='[Callback=FunctionOnly, NoInterfaceObject] interface TemperatureChangeCB' class='idl'>
<dt>void handleEvent(in TemperatureChange temperature)</dt>
<dd>
This function MUST be called whenever the implementation successfully retrieves
@@ -1699,21 +1678,21 @@
<dt>attribute float highThreshold</dt>
<dd>
If the <code>highThreshold</code> attribute is not null, when system temperature
- rises above the specified temperature (in Celsius), the <code>TemperatureChangeCallback</code> MUST be invoked
+ rises above the specified temperature (in Celsius), the <code>TemperatureChangeCB</code> MUST be invoked
with the <code>crossedHighThreshold</code> value of the <code>TemperatureChange</code>
parameter set to <code>true</code>. If the <code>TemperatureChangeOptions
highThreshold</code> attribute is null or not specified,
- <code>TemperatureChangeCallback</code> MUST NOT be invoked with the <code>crossedHighThreshold</code>
+ <code>TemperatureChangeCB</code> MUST NOT be invoked with the <code>crossedHighThreshold</code>
value set to <code>true</code>.
</dd>
<dt>attribute float lowThreshold</dt>
<dd>
If the <code>lowThreshold</code> attribute is not null, when system temperature
- falls below the specified temperature (in Celsius), the <code>TemperatureChangeCallback</code> MUST be invoked
+ falls below the specified temperature (in Celsius), the <code>TemperatureChangeCB</code> MUST be invoked
with the <code>crossedLowThreshold</code> attribute of the <code>TemperatureChange</code>
parameter set to <code>true</code>. If the <code>TemperatureChangeOptions
lowThreshold</code> attribute is null or not specified,
- <code>TemperatureChangeCallback</code> MUST NOT be invoked with the <code>crossedHighThreshold</code>
+ <code>TemperatureChangeCB</code> MUST NOT be invoked with the <code>crossedHighThreshold</code>
value set to <code>true</code>.
</dd>
</dl>
@@ -2050,7 +2029,7 @@
<dd>
Indicates whether the soft keyboard is visible on the screen.
</dd>
- <dt>int watchPhysicalKeyboardChange ( in PhysicalKeyboardChangeCallback successCallback, [Optional] in InputErrorCallback errorCallback)</dt>
+ <dt>int watchPhysicalKeyboardChange ( in PhysicalKeyboardChangeCB successCallback, [Optional] in InputErrorCB errorCallback)</dt>
<dd>
The <code>watchPhysicalKeyboardChange()</code> function takes one or two arguments.
When called, it must immediately return and then asynchronously start a watch
@@ -2067,7 +2046,7 @@
</ol>
<p/>This method returns an integer value that uniquely identifies the watch process. When the <code>clearWatch()</code> method is called with this identifier, the watch process must stop acquiring any new position fixes and must cease invoking any callbacks. When this value is used in a call to <code>updatePosition()</code>, the watch process SHOULD update the position information that it is using in its orientation caluculations.
</dd>
- <dt>int watchPhysicalPointerChange ( in PhysicalPointerChangeCallback successCallback, [Optional] in InputErrorCallback errorCallback)</dt>
+ <dt>int watchPhysicalPointerChange ( in PhysicalPointerChangeCB successCallback, [Optional] in InputErrorCB errorCallback)</dt>
<dd>
The <code>watchPhysicalPointerChange()</code> function takes one or two arguments.
When called, it must immediately return and then asynchronously start a watch
@@ -2095,8 +2074,8 @@
</dd>
</dl>
<section>
- <h3>PhysicalKeyboardChangeCallback</h3>
- <dl title='[Callback=FunctionOnly, NoInterfaceObject] interface PhysicalKeyboardChangeCallback' class='idl'>
+ <h3>PhysicalKeyboardChangeCB</h3>
+ <dl title='[Callback=FunctionOnly, NoInterfaceObject] interface PhysicalKeyboardChangeCB' class='idl'>
<dt>void handleEvent(in PhysicalKeyboardChange physicalKeyboardChange)</dt>
<dd>
This function is called whenever the implementation determines that a physical keyboard has
@@ -2105,8 +2084,8 @@
</dl>
</section>
<section>
- <h3>PhysicalPointerChangeCallback</h3>
- <dl title='[Callback=FunctionOnly, NoInterfaceObject] interface PhysicalPointerChangeCallback' class='idl'>
+ <h3>PhysicalPointerChangeCB</h3>
+ <dl title='[Callback=FunctionOnly, NoInterfaceObject] interface PhysicalPointerChangeCB' class='idl'>
<dt>void handleEvent(in PhysicalPointerChange physicalPointerChange)</dt>
<dd>
This function is called whenever the implementation determines that a physical pointer has
@@ -2115,8 +2094,8 @@
</dl>
</section>
<section>
- <h3>InputErrorCallback</h3>
- <dl title='[Callback=FunctionOnly, NoInterfaceObject] interface InputErrorCallback' class='idl'>
+ <h3>InputErrorCB</h3>
+ <dl title='[Callback=FunctionOnly, NoInterfaceObject] interface InputErrorCB' class='idl'>
<dt>void handleEvent(in InputChangeError error)</dt>
<dd>
This function MUST be called whenever the implementation is unable to monitor
@@ -2191,11 +2170,11 @@
<p class='note'>These interfaces MAY be general interfaces for use throughout all APIs. They are included here for now for completion.</p>
<section>
- <h2><a>SuccessCallback</a> interface</h2>
+ <h2><a>SuccessCB</a> interface</h2>
<!-- interface intro here -->
- <dl title='[Callback=FunctionOnly, NoInterfaceObject] interface SuccessCallback' class='idl'>
+ <dl title='[Callback=FunctionOnly, NoInterfaceObject] interface SuccessCB' class='idl'>
<dt>
void onSuccess ()
</dt>
@@ -2216,11 +2195,11 @@
</section>
<section>
- <h2><a>ErrorCallback</a> interface</h2>
+ <h2><a>ErrorCB</a> interface</h2>
<!-- interface intro here -->
- <dl title='[Callback=FunctionOnly, NoInterfaceObject] interface ErrorCallback' class='idl'>
+ <dl title='[Callback=FunctionOnly, NoInterfaceObject] interface ErrorCB' class='idl'>
<dt>
void onError ()
</dt>
@@ -2241,11 +2220,11 @@
</section>
<section>
- <h2><a>PendingOperation</a> interface</h2>
+ <h2><a>PendingOp</a> interface</h2>
<!-- interface intro here -->
- <dl title='[NoInterfaceObject] interface PendingOperation' class='idl'>
+ <dl title='[NoInterfaceObject] interface PendingOp' class='idl'>
<dt>
void cancel ()
</dt>
Received on Wednesday, 2 December 2009 16:37:45 UTC