From f38c02c44304e40b1a406c8ce21173a0568a99a0 Mon Sep 17 00:00:00 2001
From: Neil <nyamatongwe@gmail.com>
Date: Sun, 29 Sep 2013 08:25:23 +1000
Subject: Improved information about notifications, particularly on GTK+.

---
 doc/ScintillaDoc.html | 27 ++++++++++++++++-----------
 1 file changed, 16 insertions(+), 11 deletions(-)

(limited to 'doc/ScintillaDoc.html')

diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html
index f408dafad..d2be3b3e1 100644
--- a/doc/ScintillaDoc.html
+++ b/doc/ScintillaDoc.html
@@ -82,7 +82,7 @@
 
     <h1>Scintilla Documentation</h1>
 
-    <p>Last edited 26 September 2013 NH</p>
+    <p>Last edited 29 September 2013 NH</p>
 
     <p>There is <a class="jump" href="Design.html">an overview of the internal design of
     Scintilla</a>.<br />
@@ -6438,13 +6438,16 @@ implemented and thus which methods may be called.</p>
     <h2 id="Notifications">Notifications</h2>
 
     <p>Notifications are sent (fired) from the Scintilla control to its container when an event has
-    occurred that may interest the container. Notifications are sent using the
-    <code>WM_NOTIFY</code> message on Windows and the "notify" signal on GTK+.
-    On Cocoa, a delegate implementing the <code>ScintillaNotificationProtocol</code>
+    occurred that may interest the container.</p>
+    <p>Notifications are sent using the
+    <code>WM_NOTIFY</code> message on Windows.</p>
+    <p>On GTK+, the "sci-notify" signal is sent and the signal handler should have the signature
+    <code>handler(GtkWidget *, gint, gpointer notification, gpointer  userData)</code>.</p>
+    <p>On Cocoa, a delegate implementing the <code>ScintillaNotificationProtocol</code>
     may be set to receive notifications or the <code>ScintillaView</code> class may be subclassed and the
     <code>notification:</code> method overridden. Overriding <code>notification:</code> allows the
-    subclass to control whether default handling is performed.
-    The container is
+    subclass to control whether default handling is performed.</p>
+    <p>The container is
     passed a <code>SCNotification</code> structure containing information about the event.</p>
 <pre id="SCNotification">
 struct NotifyHeader {   // This matches the Win32 NMHDR structure
@@ -6530,11 +6533,13 @@ struct SCNotification {
     </code>
 
     <p>The following additional notifications are sent using the <code>WM_COMMAND</code> message on
-    Windows and the "Command" signal on GTK+.
-    On Cocoa, a delegate implementing the
-    <code>ScintillaNotificationProtocol</code> with a <code>command:idFrom:</code> method may be set.
+    Windows.
     This emulates the Windows Edit control. Only the lower
     16 bits of the control's ID is passed in these notifications.</p>
+    <p>On GTK+, the "command" signal is sent and the signal handler should have the signature
+    <code>handler(GtkWidget *, gint wParam, gpointer lParam, gpointer userData)</code>.</p>
+    <p>On Cocoa, a delegate implementing the
+    <code>ScintillaNotificationProtocol</code> with a <code>command:idFrom:</code> method may be set.</p>
     <code><a class="message" href="#SCEN_CHANGE">SCEN_CHANGE</a><br />
      <a class="message" href="#SCEN_SETFOCUS">SCEN_SETFOCUS</a><br />
      <a class="message" href="#SCEN_KILLFOCUS">SCEN_KILLFOCUS</a><br />
@@ -6977,7 +6982,7 @@ href="#SCI_POSITIONFROMLINE">SCI_POSITIONFROMLINE</a>(lineNumber);
     <p><b id="SCEN_CHANGE">SCEN_CHANGE</b><br />
      <code>SCEN_CHANGE</code> (768) is fired when the text (not the style) of the document changes.
     This notification is sent using the <code>WM_COMMAND</code> message on Windows and the
-    "Command" signal on GTK+ as this is the behaviour of the standard Edit control
+    "command" signal on GTK+ as this is the behaviour of the standard Edit control
     (<code>SCEN_CHANGE</code> has the same value as the Windows Edit control
     <code>EN_CHANGE</code>). No other information is sent. If you need more detailed information
     use <a class="message" href="#SCN_MODIFIED"><code>SCN_MODIFIED</code></a>. You can filter the
@@ -7006,7 +7011,7 @@ href="#SCI_POSITIONFROMLINE">SCI_POSITIONFROMLINE</a>(lineNumber);
      <b id="SCEN_KILLFOCUS">SCEN_KILLFOCUS</b><br />
      <code>SCEN_SETFOCUS</code> (512) is fired when Scintilla receives focus and
     <code>SCEN_KILLFOCUS</code> (256) when it loses focus. These notifications are sent using the
-    <code>WM_COMMAND</code> message on Windows and the "Command" signal on GTK+ as this is the
+    <code>WM_COMMAND</code> message on Windows and the "command" signal on GTK+ as this is the
     behaviour of the standard Edit control. Unfortunately, these codes do not match the Windows Edit
     notification codes <code>EN_SETFOCUS</code> (256) and <code>EN_KILLFOCUS</code> (512). It is
     now too late to change the Scintilla codes as clients depend on the current values.</p>
-- 
cgit v1.2.3