forked from dail8859/LuaScript
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcallbacks.md.html
More file actions
162 lines (133 loc) · 6.51 KB
/
Copy pathcallbacks.md.html
File metadata and controls
162 lines (133 loc) · 6.51 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>LuaScript Reference</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
<div id="container">
<div id="product">
<div id="product_logo"></div>
<div id="product_name"><big><b></b></big></div>
<div id="product_description"></div>
</div> <!-- id="product" -->
<div id="main">
<!-- Menu -->
<div id="navigation">
<br/>
<h1>LuaScript <sub>v0.12</sub></h1>
<ul>
<li><a href="../index.html">Index</a></li>
</ul>
<h2>Topics</h2>
<ul class="">
<li><strong>Callbacks</strong></li>
<li><a href="../topics/externalpluginsupport.md.html">External Plugin Support</a></li>
</ul>
<h2>Classes</h2>
<ul class="nowrap">
<li><a href="../classes/Editor.html">Editor</a></li>
<li><a href="../classes/Match.html">Match</a></li>
<li><a href="../classes/Styler.html">Styler</a></li>
<li><a href="../classes/Notepad.html">Notepad</a></li>
</ul>
<h2>Examples</h2>
<ul class="nowrap">
<li><a href="../examples/bookmark.lua.html">bookmark.lua</a></li>
<li><a href="../examples/highlightoccurrences.lua.html">highlightoccurrences.lua</a></li>
<li><a href="../examples/luaautoindent.lua.html">luaautoindent.lua</a></li>
<li><a href="../examples/luasyntaxchecker.lua.html">luasyntaxchecker.lua</a></li>
<li><a href="../examples/randomizelines.lua.html">randomizelines.lua</a></li>
<li><a href="../examples/selectionaddnext.lua.html">selectionaddnext.lua</a></li>
<li><a href="../examples/sessionmanager.lua.html">sessionmanager.lua</a></li>
<li><a href="../examples/stylecsv.lua.html">stylecsv.lua</a></li>
<li><a href="../examples/stylecustom.lua.html">stylecustom.lua</a></li>
<li><a href="../examples/visualstudiolinecopy.lua.html">visualstudiolinecopy.lua</a></li>
</ul>
</div>
<div id="content">
<h1>Callbacks</h1>
<p>Scripts can register Lua functions as a callback when certain events take place. Each event type can have multiple callbacks registered.</p>
<p>Scintilla related callbacks:</p>
<ul>
<li><code>OnStyle(styler)</code></li>
<li><code>OnChar(character)</code></li>
<li><code>OnSavePointReached()</code></li>
<li><code>OnSavePointLeft()</code></li>
<li><code>OnModifyAttemptRO()</code></li>
<li><code>OnDoubleClick(position, line, modifiers)</code></li>
<li><code>OnUpdateUI(flags)</code></li>
<li><code>OnModification(modType, position, length, text, linesAdded)</code></li>
<li><code>OnMarginClick(position, margin, modifiers)</code></li>
<li><code>OnNeedShown(position, length)</code></li>
<li><code>OnPainted()</code></li>
<li><code>OnUserListSelection(listType, position, text)</code></li>
<li><code>OnDwellStart(position, x, y)</code></li>
<li><code>OnDwellEnd(position, x, y)</code></li>
<li><code>OnZoom()</code></li>
<li><code>OnHotSpotClick(position, modifiers)</code></li>
<li><code>OnHotSpotDoubleClick(position, modifiers)</code></li>
<li><code>OnHotSpotReleaseClick(position, modifiers)</code></li>
<li><code>OnIndicatorClick(position, modifiers)</code></li>
<li><code>OnIndicatorRelease(position, modifiers)</code></li>
<li><code>OnCallTipClick(flag)</code></li>
<li><code>OnAutoCSelection(position, text)</code></li>
<li><code>OnAutoCCancelled()</code></li>
<li><code>OnAutoCCharDeleted()</code></li>
<li><code>OnFocusIn()</code></li>
<li><code>OnFocusOut()</code></li>
</ul>
<p>Notepad++ related callbacks:</p>
<ul>
<li><code>OnReady()</code></li>
<li><code>OnToolBarModification()</code></li>
<li><code>OnFileBeforeLoad()</code></li>
<li><code>OnFileLoadFailed()</code></li>
<li><code>OnBeforeOpen(filename, bufferid)</code></li>
<li><code>OnOpen(filename, bufferid)</code></li>
<li><code>OnBeforeSave(filename, bufferid)</code></li>
<li><code>OnSave(filename, bufferid)</code></li>
<li><code>OnBeforeClose(filename, bufferid)</code></li>
<li><code>OnClose()</code></li>
<li><code>OnSwitchFile(filename, bufferid)</code></li>
<li><code>OnLangChange()</code></li>
<li><code>OnReadOnlyChanged(filename, bufferid, status)</code></li>
<li><code>OnDocOrderChanged(filename, bufferid, index)</code></li>
<li><code>OnSnapshotDirtyFileLoaded(filename, bufferid)</code></li>
<li><code>OnFileBeforeRename(filename, bufferid)</code></li>
<li><code>OnFileRenameCancel(filename, bufferid)</code></li>
<li><code>OnFileRenamed(filename, bufferid)</code></li>
<li><code>OnFileBeforeDelete(filename, bufferid)</code></li>
<li><code>OnFileDeleteFailed(filename, bufferid)</code></li>
<li><code>OnFileDeleted()</code></li>
<li><code>OnBeforeShutdown()</code></li>
<li><code>OnCancelShutdown()</code></li>
<li><code>OnShutdown()</code></li>
</ul>
<p>The Notepad++ object allows adding, removing, and clearing callback functions for the events. </p>
<ul>
<li><code>npp.AddEventHandler(event, function)</code></li>
<li><code>npp.RemoveEventHandler(event, function)</code></li>
<li><code>npp.RemoveAllEventHandlers(event)</code></li>
</ul>
<p>To register for an event, first define your function that accepts the parameters (if any). You can then add the callback to the appropriate event. Although callbacks are not required to return a value, in order to ensure forwards compatibility it should return <code>false</code>. For example:</p>
<pre>
<span class="keyword">function</span> printchar(ch)
<span class="global">print</span>(<span class="string">"You typed "</span> .. ch)
<span class="keyword">return</span> <span class="keyword">false</span>
<span class="keyword">end</span>
npp.AddEventHandler(<span class="string">"OnChar"</span>, printchar)
</pre>
<p>Take care not to register the same callback twice. To be safe you can attempt to remove it before adding it.</p>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
<footer>
<a href="https://github.com/dail8859/LuaScript"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://camo.githubusercontent.com/a6677b08c955af8400f44c6298f40e7d19cc5b2d/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f677261795f3664366436642e706e67" alt="Fork me on GitHub" data-canonical-src="https://s3.amazonaws.com/github/ribbons/forkme_right_gray_6d6d6d.png"></a>
</footer>
</body>
</html>