@@ -142,15 +142,47 @@ public interface IPublicAPI
142
142
List < PluginPair > GetAllPlugins ( ) ;
143
143
144
144
/// <summary>
145
- /// Register a callback for Global Keyboard Event
146
- /// </summary>
147
- /// <param name="callback"></param>
145
+ /// Registers a callback function for global keyboard events.
146
+ /// </summary>
147
+ /// <param name="callback">
148
+ /// The callback function to invoke when a global keyboard event occurs.
149
+ /// <para>
150
+ /// Parameters:
151
+ /// <list type="number">
152
+ /// <item><description>int: The type of <see cref="KeyEvent"/> (key down, key up, etc.)</description></item>
153
+ /// <item><description>int: The virtual key code of the pressed/released key</description></item>
154
+ /// <item><description><see cref="SpecialKeyState"/>: The state of modifier keys (Ctrl, Alt, Shift, etc.)</description></item>
155
+ /// </list>
156
+ /// </para>
157
+ /// <para>
158
+ /// Returns: <c>true</c> to allow normal system processing of the key event,
159
+ /// or <c>false</c> to intercept and prevent default handling.
160
+ /// </para>
161
+ /// </param>
162
+ /// <remarks>
163
+ /// This callback will be invoked for all keyboard events system-wide.
164
+ /// Use with caution as intercepting system keys may affect normal system operation.
165
+ /// </remarks>
148
166
public void RegisterGlobalKeyboardCallback ( Func < int , int , SpecialKeyState , bool > callback ) ;
149
-
167
+
150
168
/// <summary>
151
169
/// Remove a callback for Global Keyboard Event
152
170
/// </summary>
153
- /// <param name="callback"></param>
171
+ /// <param name="callback">
172
+ /// The callback function to invoke when a global keyboard event occurs.
173
+ /// <para>
174
+ /// Parameters:
175
+ /// <list type="number">
176
+ /// <item><description>int: The type of <see cref="KeyEvent"/> (key down, key up, etc.)</description></item>
177
+ /// <item><description>int: The virtual key code of the pressed/released key</description></item>
178
+ /// <item><description><see cref="SpecialKeyState"/>: The state of modifier keys (Ctrl, Alt, Shift, etc.)</description></item>
179
+ /// </list>
180
+ /// </para>
181
+ /// <para>
182
+ /// Returns: <c>true</c> to allow normal system processing of the key event,
183
+ /// or <c>false</c> to intercept and prevent default handling.
184
+ /// </para>
185
+ /// </param>
154
186
public void RemoveGlobalKeyboardCallback ( Func < int , int , SpecialKeyState , bool > callback ) ;
155
187
156
188
/// <summary>
0 commit comments