diff options
author | Wuzzy <almikes@aol.com> | 2016-11-07 21:17:39 +0100 |
---|---|---|
committer | Wuzzy <almikes@aol.com> | 2016-11-07 21:17:39 +0100 |
commit | d5736bda723e2995e6f70a7511337e6afc4a3f93 (patch) | |
tree | 890d9c8676351b65115d6c459f3f13bd3cfc90db /API.md | |
parent | 71a96d8f228cfe28588b92f2e7365f0d525271ce (diff) |
Add and document entry widgets boundary box
Diffstat (limited to 'API.md')
-rw-r--r-- | API.md | 17 |
1 files changed, 14 insertions, 3 deletions
@@ -146,9 +146,20 @@ following predefined convenience functions: if you expect your entries to differ wildly in layouts. When building your formspec, you have to respect the size limitations. -The documentation system uses a size of `12,9` and you should place -all your formspec elements at positions not lower than `0.25,0.5` to -avoid overlapping. +The documentation system uses a size of 12×9 and you must make sure +all entry widgets are inside a boundary box. The remaining space is +reserved for widgets of the Documentation System and should not be used +to avoid overlapping. +Read from the following variables to calculate the final formspec coordinates: + +* `doc.FORMSPEC.WIDTH`: Width of Documentation System formspec +* `doc.FORMSPEC.HEIGHT`: Height of Documentation System formspec +* `doc.FORMSPEC.ENTRY_START_X`: Leftmost X point of bounding box +* `doc.FORMSPEC.ENTRY_START_Y`: Topmost Y point of bounding box +* `doc.FORMSPEC.ENTRY_END_X`: Rightmost X point of bounding box +* `doc.FORMSPEC.ENTRY_END_Y`: Bottom Y point of bounding box +* `doc.FORMSPEC.ENTRY_WIDTH`: Width of the entry widgets bounding box +* `doc.FORMSPEC.ENTRY_HEIGHT`: Height of the entry widgets bounding box #### Return value Always `nil`. |