Merge pull request #58 from jorix/3580-Docs_ZoomBox

ZoomBox: missing API documentation. p=jorix, r=fredj (closes #3580)
This commit is contained in:
Frédéric Junod
2011-11-20 23:56:25 -08:00
2 changed files with 11 additions and 2 deletions

View File

@@ -94,7 +94,7 @@ OpenLayers.Control.Navigation = OpenLayers.Class(OpenLayers.Control, {
* You should probably set handleRightClicks to true if you use this
* with MOD_CTRL, to disable the context menu for machines which use
* CTRL-Click as a right click.
* Default: <OpenLayers.Handler.MOD_SHIFT
* Default: <OpenLayers.Handler.MOD_SHIFT>
*/
zoomBoxKeyMask: OpenLayers.Handler.MOD_SHIFT,

View File

@@ -31,7 +31,16 @@ OpenLayers.Control.ZoomBox = OpenLayers.Class(OpenLayers.Control, {
out: false,
/**
* Property: alwaysZoom
* APIProperty: keyMask
* {Integer} Zoom only occurs if the keyMask matches the combination of
* keys down. Use bitwise operators and one or more of the
* <OpenLayers.Handler> constants to construct a keyMask. Leave null if
* not used mask. Default is null.
*/
keyMask: null,
/**
* APIProperty: alwaysZoom
* {Boolean} Always zoom in/out, when box drawed
*/
alwaysZoom: false,