]>
git.gir.st - VimFx.git/blob - docs/hints.html
1 <!DOCTYPE html
> <html> <head> <title>hints.coffee
</title> <meta http-equiv=
"content-type" content=
"text/html; charset=UTF-8"> <link rel=
"stylesheet" media=
"all" href=
"docco.css" /> </head> <body> <div id=
"container"> <div id=
"background"></div> <div id=
"jump_to"> Jump To
… <div id=
"jump_wrapper"> <div id=
"jump_page"> <a class=
"source" href=
"bootstrap.html"> bootstrap.coffee
</a> <a class=
"source" href=
"chrome.html"> chrome.coffee
</a> <a class=
"source" href=
"console.html"> console.coffee
</a> <a class=
"source" href=
"unload.html"> unload.coffee
</a> <a class=
"source" href=
"window-utils.html"> window-utils.coffee
</a> <a class=
"source" href=
"button.html"> button.coffee
</a> <a class=
"source" href=
"commands.html"> commands.coffee
</a> <a class=
"source" href=
"events.html"> events.coffee
</a> <a class=
"source" href=
"help.html"> help.coffee
</a> <a class=
"source" href=
"hints.html"> hints.coffee
</a> <a class=
"source" href=
"marker.html"> marker.coffee
</a> <a class=
"source" href=
"prefs.html"> prefs.coffee
</a> <a class=
"source" href=
"utils.html"> utils.coffee
</a> <a class=
"source" href=
"vim.html"> vim.coffee
</a> </div> </div> </div> <table cellpadding=
"0" cellspacing=
"0"> <thead> <tr> <th class=
"docs"> <h1> hints.coffee
</h1> </th> <th class=
"code"> </th> </tr> </thead> <tbody> <tr id=
"section-1"> <td class=
"docs"> <div class=
"pilwrap"> <a class=
"pilcrow" href=
"#section-1">¶</a> </div> </td> <td class=
"code"> <div class=
"highlight"><pre><span class=
"nv">CONTAINER_ID =
</span><span class=
"s">'VimFxHintMarkerContainer
'</span>
3 <span class=
"p">{
</span> <span class=
"nv">interfaces:
</span><span class=
"nx">Ci
</span> <span class=
"p">}
</span> <span class=
"o">=
</span> <span class=
"nx">Components
</span>
4 <span class=
"nv">HTMLDocument =
</span><span class=
"nx">Ci
</span><span class=
"p">.
</span><span class=
"nx">nsIDOMHTMLDocument
</span>
5 <span class=
"p">{
</span> <span class=
"nx">Marker
</span> <span class=
"p">}
</span> <span class=
"o">=
</span> <span class=
"nx">require
</span> <span class=
"s">'marker
'</span>
7 <span class=
"nv">getHintsContainer =
</span><span class=
"nf">(document) -
></span>
8 <span class=
"nb">document
</span><span class=
"p">.
</span><span class=
"nx">getElementById
</span> <span class=
"nx">CONTAINER_ID
</span>
10 <span class=
"nv">createHintsContainer =
</span><span class=
"nf">(document) -
></span>
11 <span class=
"nv">container =
</span><span class=
"nb">document
</span><span class=
"p">.
</span><span class=
"nx">createElement
</span> <span class=
"s">'div
'</span>
12 <span class=
"nv">container.id =
</span><span class=
"nx">CONTAINER_ID
</span>
13 <span class=
"nv">container.className =
</span><span class=
"s">'VimFxReset
'</span>
14 <span class=
"k">return
</span> <span class=
"nx">container
</span>
16 <span class=
"nv">injectHints =
</span><span class=
"nf">(document) -
></span>
17 <span class=
"nx">removeHints
</span> <span class=
"nb">document
</span>
19 <span class=
"k">if
</span> <span class=
"nb">document
</span> <span class=
"k">instanceof
</span> <span class=
"nx">HTMLDocument
</span>
20 <span class=
"nv">markers =
</span><span class=
"nx">Marker
</span><span class=
"p">.
</span><span class=
"nx">createMarkers
</span> <span class=
"nb">document
</span>
22 <span class=
"nv">container =
</span><span class=
"nx">createHintsContainer
</span> <span class=
"nb">document
</span>
24 <span class=
"nv">fragment =
</span><span class=
"nb">document
</span><span class=
"p">.
</span><span class=
"nx">createDocumentFragment
</span><span class=
"p">()
</span>
25 <span class=
"k">for
</span> <span class=
"nx">marker
</span> <span class=
"k">in
</span> <span class=
"nx">markers
</span>
26 <span class=
"nx">fragment
</span><span class=
"p">.
</span><span class=
"nx">appendChild
</span> <span class=
"nx">marker
</span><span class=
"p">.
</span><span class=
"nx">markerElement
</span>
28 <span class=
"nx">container
</span><span class=
"p">.
</span><span class=
"nx">appendChild
</span> <span class=
"nx">fragment
</span>
30 <span class=
"nb">document
</span><span class=
"p">.
</span><span class=
"nx">body
</span><span class=
"p">.
</span><span class=
"nx">appendChild
</span> <span class=
"nx">container
</span>
32 <span class=
"k">return
</span> <span class=
"nx">markers
</span>
34 <span class=
"nv">removeHints =
</span><span class=
"nf">(document, markers) -
></span>
35 <span class=
"k">if
</span> <span class=
"nv">container =
</span><span class=
"nx">getHintsContainer
</span> <span class=
"nb">document
</span>
36 <span class=
"nb">document
</span><span class=
"p">.
</span><span class=
"nx">body
</span><span class=
"p">.
</span><span class=
"nx">removeChild
</span> <span class=
"nx">container
</span>
38 <span class=
"nv">handleHintChar =
</span><span class=
"nf">(markers, char) -
></span>
40 <span class=
"nv">exports.injectHints =
</span><span class=
"nx">injectHints
</span>
41 <span class=
"nv">exports.removeHints =
</span><span class=
"nx">removeHints
</span>
42 <span class=
"nv">exports.handleHintChar =
</span><span class=
"nx">handleHintChar
</span>
44 </pre></div> </td> </tr> </tbody> </table> </div> </body> </html>