All Identifiers

Handles editor events and notifications from Notepad++

Initializes and (on shutdown) destroys the main instance of this plugin

Standard flag for main parent after its children are initialized.

See DMN_FIRST

See DMN_FIRST

See DMN_FIRST

Display a string of additional information in the title bar

Default docking on left

Default docking on top

Display an icon in the title bar (currently not supported)

Sets nFuncs to the size of this plugin's TNppPlugin.FuncArray member and returns a pointer to it

Always returns true

Handles Win32 window messages, and some editor notifications as well

BOOL NPPM_ADDSCNMODIFIEDFLAGS(0, unsigned long scnMotifiedFlags2Add)
Add the necessary flags so that your plugin will receive additional SCN_MODIFIED notifications.

BOOL NPPM_ADDTOOLBARICON_DEPRECATED(UINT pluginCmdID, toolbarIcons* iconHandles)
Add an icon to the toolbar.

BOOL NPPM_ALLOCATECMDID(int numberRequested, int* startNumber)
Allocate a consecutive number of menu item IDs for a plugin.

BOOL NPPM_ALLOCATEMARKER(int numberRequested, int* startNumber)
Allocate a consecutive number of marker IDs for a plugin.

BOOL NPPM_ALLOCATESUPPORTED_DEPRECATED(0, 0)
Get the status of support for the NPPM_ALLOCATECMDID API.

HWND NPPM_CREATESCINTILLAHANDLE(0, HWND hParent)
Get a handle to the active Scintilla control.

int NPPM_DECODESCI(int inView, 0)
Change the document encoding of the given view to ANSI.

BOOL NPPM_DESTROYSCINTILLAHANDLE_DEPRECATED(0, HWND hScintilla)
Does nothing and always returns true.

HWND NPPM_DMMGETPLUGINHWNDBYNAME(const wchar_t* windowName, const wchar_t* moduleName)
Retrieve the handle of the docked dialog corresponding to the given windowName and moduleName.

BOOL NPPM_DMMREGASDCKDLG(0, tTbData* pData)
Register a plugin dialog with the Docking Manager.

BOOL NPPM_DMMUPDATEDISPINFO(0, HWND hDlg)
Redraw the title bar of a dialog that was previously registered with NPPM_DMMREGASDCKDLG.

BOOL NPPM_DOCLISTDISABLEEXTCOLUMN(0, BOOL disableOrNot)
Disable or enable the file extension column of the Document List.

BOOL NPPM_DOOPEN(0, const wchar_t* fullPathName2Open)
Open the file with the given fullPathName2Open.

BOOL NPPM_GETAPPDATAPLUGINSALLOWED(0, 0)
Check to see if loading plugins from "%APPDATA%\..\Local\Notepad++\plugins" is allowed.

int NPPM_GETBUFFERENCODING(UINT_PTR bufferID, 0)
Get the encoding of the document with the given bufferID.

UINT_PTR NPPM_GETBUFFERIDFROMPOS(int index, int inView)
Get the buffer ID of the document in the given view with the given index.

UINT_PTR NPPM_GETCURRENTBUFFERID(0, 0)
Get the active document's buffer ID.

Returns the caret's current position column.

int NPPM_GETCURRENTDOCINDEX(0, int inView)
Get the index of the document currently open in the given view.

Returns the caret's current position line.

MacroStatus NPPM_GETCURRENTMACROSTATUS(0, 0)
Get the current TMacroStatus.

BOOL NPPM_GETCURRENTSCINTILLA(0, int* iScintillaView)
Get the index of the currently active Scintilla view.

See NPPM_GETCURRENTLINESTR

int NPPM_GETEDITORDEFAULTBACKGROUNDCOLOR(0, 0)
Get the editor's current default background color.

THEMEAPI NPPM_GETENABLETHEMETEXTUREFUNC(0, 0)
Get the function address of ::EnableThemeDialogTexture().

See NPPM_GETCURRENTLINESTR

See NPPM_GETCURRENTLINESTR

int NPPM_GETFULLPATHFROMBUFFERID(UINT_PTR bufferID, wchar_t* fullFilePath)
Get the full file path of the document with the given bufferID.

int NPPM_GETLANGUAGENAME(int langType, wchar_t* langName)
Get the name of the programming language associated with the given langType.

HMENU NPPM_GETMENUHANDLE(int menuChoice, 0)
Get a handle to the menu indicated by menuChoice.

int NPPM_GETNATIVELANGFILENAME(size_t strLen, char* nativeLangFileName)
Get the name of the currently active XML localization file.

int NPPM_GETNBSESSIONFILES (BOOL* pbIsValidXML, wchar_t* sessionFileName)
Get the number of files listed in the session file with the given sessionFileName.

See NPPM_GETCURRENTLINESTR

int NPPM_GETNPPSETTINGSDIRPATH(size_t strLen, wchar_t *settingsDirPath)
Get the Notepad++ application settings directory path.

See NPPM_GETOPENFILENAMES_DEPRECATED

BOOL NPPM_GETOPENFILENAMESPRIMARY_DEPRECATED(wchar_t** fileNames, int nbFileNames)
Get the full path names of all files currently open in the main view.

BOOL NPPM_GETOPENFILENAMESSECOND_DEPRECATED(wchar_t** fileNames, int nbFileNames)
Get the full path names of all files currently open in the sub-view.

int NPPM_GETPLUGINHOMEPATH(size_t strLen, wchar_t* pluginRootPath)
Get the root path of all the installed Notepad++ plugins.

int NPPM_GETPOSFROMBUFFERID(UINT_PTR bufferID, int priorityView)
Get the position of the document with bufferID, searching in priorityView first.

int NPPM_GETSETTINGSONCLOUDPATH(size_t strLen, wchar_t* settingsOnCloudPath)
Get the user's cloud settings file path.

int NPPM_GETTABCOLORID (int view, int tabIndex)
Get the color ID of the tab in the given view with the given tab index.

winVer NPPM_GETWINDOWSVERSION(0, 0)
Get the host PC's (Windows) OS version.

BOOL NPPM_HIDESTATUSBAR(0, BOOL hideOrNot)
Hide (or show) the status bar.

BOOL NPPM_HIDETOOLBAR(0, BOOL hideOrNot)
Hide (or show) the toolbar.

BOOL NPPM_ISDARKMODEENABLED(0, 0)
Get the current status (ON or OFF) of the dark mode setting.

BOOL NPPM_ISMENUHIDDEN(0, 0)
Get the visibility (hidden or visible) of the menu bar.

BOOL NPPM_ISTABBARHIDDEN(0, 0)
Get the visibility (hidden or visible) of the tab bar.

BOOL NPPM_LAUNCHFINDINFILESDLG(wchar_t* dir2Search, wchar_t* filter)
Launch the "Find in Files" dialog and set the "Find in" directory and filters with the given arguments.

BOOL NPPM_MAKECURRENTBUFFERDIRTY(0, 0)
Make the current document dirty, i.e., set the current buffer state to "modified".

HWND NPPM_MODELESSDIALOG(int action, HWND hDlg)
Register (or unregister) the plugin dialog with the given handle.

BOOL NPPM_RELOADBUFFERID(UINT_PTR bufferID, BOOL alert)
Reload the document with the given bufferID.

BOOL NPPM_REMOVESHORTCUTBYCMDID(int pluginCmdID, 0)
Remove a shortcut that was mapped to the plugin command with the given ID.

BOOL NPPM_SAVECURRENTFILE(0, 0)
Save the currently active document.

wchar_t* NPPM_SAVECURRENTSESSION(0, wchar_t* sessionFileName)
Save all files currently open in Notepad++ to an XML session file.

wchar_t* NPPM_SAVESESSION(0, sessionInfo* si)
Save a given set of file paths to a new session file.

BOOL NPPM_SETBUFFERFORMAT(UINT_PTR bufferID, int format)
Set the EOL format of the document with the given bufferID.

BOOL NPPM_SETCURRENTLANGTYPE(0, int langType)
Set the TNppLang associated with the current document.

BOOL NPPM_SETEXTERNALLEXERAUTOINDENTMODE(const wchar_t* languageName, ExternalLexerAutoIndentMode autoIndentMode)
Set the TExternalLexerAutoIndentMode of the external lexer identified by languageName.

BOOL NPPM_SETMENUITEMCHECK(UINT pluginCmdID, BOOL doCheck)
Set or remove the checkmark on a plugin menu item and highlight or unhighlight its toolbar icon (if any).

BOOL NPPM_SETSTATUSBAR(int whichPart, wchar_t* str2set)
Change the text in a field of the status bar.

BOOL NPPM_SHOWDOCLIST(0, BOOL toShowOrNot)
Show or hide the Document List panel.

BOOL NPPM_TRIGGERTABBARCONTEXTMENU(int inView, int index2Activate)
Switch to the document in the given view with the given index2Activate, then open the context menu in it.

To notify plugins that a buffer has been activated (i.e., put into the foreground)

To notify plugins that the command line argument -pluginMessage="YOUR_PLUGIN_ARGUMENT" is available

Added in 8.4.2

To notify plugins that the document order has changed

To notify plugins that a file is about to be closed

To notify plugins that a file is about to be loaded

Note

Plugins can use this notification to filter SCN_MODIFIED.

To notify plugins that a file is about to be renamed

To notify plugins that a file was just closed

To notify plugins that a file deletion has failed

To notify plugins that a file was just opened

To notify plugins that a file has been renamed

To notify plugins that the programming language of the current document was just changed

To notify plugins that the readonly status of the current document has changed

To notify plugins that a plugin command shortcut was remapped

To notify plugins that a dirty file snapshot was loaded on startup

To notify plugins that the toolbar icon set selection has changed

Note

The TNotifyHeader.IdFrom field will be set to the new TToolBarStatusType value.

Added in 8.8.2

Type alias for TScintillaMessageFnc