Skip to content
This repository was archived by the owner on Jan 13, 2024. It is now read-only.

Commit 034971b

Browse files
committed
Update README.md
1 parent 5f9999f commit 034971b

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,34 @@ This is a fork of UFO's plugin package updated for VS2015
1010
5. Build (building will copy the dll to the `Notepad++/plugins` folder)
1111
6. Start Notepad++ and activate your plugin from the plugins menu
1212

13+
14+
## Overall plugin architecture
15+
16+
Plugins can interact with Notepad++ or the underlying Scintilla engine. The plugin pack provides two classes to make this interaction easier. This is `NotepadPlusPlusGateway` and `ScintillaGateWay` which are thin layers making interaction more pleasant (and testable!).
17+
18+
If you are interested in low-level access you can use the `Win32` api also included in the plugin pack.
19+
20+
The architecture of the plugin is.
21+
22+
23+
+-----------+ +-----------+
24+
| scintilla | | Notepad++ |
25+
+-----------+ +-----------+
26+
^ ^
27+
| |
28+
+--------+--------+----+------------+
29+
| | |
30+
+------------------+ +----------------+ +-----------+
31+
| scintillaGateway | | NotepadGateway | | Win32 |
32+
+------------------+ +----------------+ +-----------+
33+
^ ^ ^
34+
| | |
35+
+-----------------+---+----------------+
36+
|
37+
+-----------+
38+
| plugin |
39+
+-----------+
40+
1341
## Content information
1442
This package contains two folders:
1543

0 commit comments

Comments
 (0)