Return handles of notepad, editor1, editor2

[vinsworldcom]

There are no methods to return the handles for the notepad, editor1 and editor2 instances, but they do exist.

PythonScript/PythonScript/src/NotepadPlusWrapper.h

Lines 842 to 845 in aba7bcd

	private:
	NotepadPlusWrapper(); // default constructor disabled
	HWND m_nppHandle;

PythonScript/PythonScript/src/PythonHandler.h

Lines 71 to 81 in aba7bcd

	protected:
	void consume(std::shared_ptr<RunScriptArgs> args);
	boost::shared_ptr<ScintillaWrapper> createScintillaWrapper();
	boost::shared_ptr<NotepadPlusWrapper> createNotepadPlusWrapper();
	virtual void queueComplete();
	// Handles
	HWND m_nppHandle;
	HWND m_scintilla1Handle;
	HWND m_scintilla2Handle;

Thought would be like:

notepad.hwnd()
editor1.hwnd()
editor2.hwnd()

to return the handles.

Cheers.

[chcg]

@vinsworldcom What would you like to use it for?

[vinsworldcom]

Some scripts import ctypes and some of those Win32 APIs require the handle (HWND) of the application or parent window. We can get them programmatically and that's how I do it now - with a PythonScript to cycle through EnumWindows, but since they are available in the plugin, it would be nice for the plugin to just expose them through accessors. NppExec does this with:

$(NPP_HWND)  :  Notepad++'s main window handle
$(SCI_HWND1)  :  primary Scintilla's window handle (main view)
$(SCI_HWND2)  :  secondary Scintilla's window handle (second view)
$(CON_HWND)  :  NppExec's Console window handle (RichEdit control)

Cheers.

[alankilborn]

@chcg

If you run this search on the Community, you'll see some of the usefulness: https://community.notepad-plus-plus.org/search?term=FindWindow

[vinsworldcom]

@chcg @alankilborn:

Is the notepad.hwnd() as simple as:

diff --git a/PythonScript/src/NotepadPlusWrapper.cpp b/PythonScript/src/NotepadPlusWrapper.cpp
index f7c0bd7..a02b5a5 100644
--- a/PythonScript/src/NotepadPlusWrapper.cpp
+++ b/PythonScript/src/NotepadPlusWrapper.cpp
@@ -1006,6 +1006,11 @@ void NotepadPlusWrapper::setEditorBorderEdge(bool withEditorBorderEdgeOrNot)
        callNotepad(NPPM_SETEDITORBORDEREDGE, 0, withEditorBorderEdgeOrNot);
 }

+intptr_t NotepadPlusWrapper::hwnd()
+{
+       return m_nppHandle;
+}
+
 intptr_t NotepadPlusWrapper::getNbUserLang()
 {
        return callNotepad(NPPM_GETNBUSERLANG);
diff --git a/PythonScript/src/NotepadPlusWrapper.h b/PythonScript/src/NotepadPlusWrapper.h
index 10683cb..177d6b1 100644
--- a/PythonScript/src/NotepadPlusWrapper.h
+++ b/PythonScript/src/NotepadPlusWrapper.h
@@ -776,6 +776,8 @@ public:

        void setEditorBorderEdge(bool withEditorBorderEdgeOrNot);

+       intptr_t hwnd();
+
        intptr_t getNbUserLang();

        intptr_t encodeSci(int view);

I'm having issues getting Github Actions to build it for me and when it does, it doesn't generate an artifact like the AppVeyor does - and I don't have an AppVeyor account. No luck building PythonScript locally to test either.

Cheers.

[Ekopalypse]

What do you think about using properties instead of functions?

diff --git a/PythonScript/src/NotepadPlusWrapper.cpp b/PythonScript/src/NotepadPlusWrapper.cpp
index f7c0bd7..5ba5f5a 100644
--- a/PythonScript/src/NotepadPlusWrapper.cpp
+++ b/PythonScript/src/NotepadPlusWrapper.cpp
@@ -23,7 +23,9 @@ NotepadPlusWrapper::NotepadPlusWrapper(HINSTANCE hInst, HWND nppHandle)
          m_hInst(hInst),
          m_notificationsEnabled(false),
          m_callbackMutex(::CreateMutex(NULL, FALSE, NULL))
-{ }
+{ ^M
+       hwnd = (intptr_t)nppHandle;^M
+}^M

 NotepadPlusWrapper::~NotepadPlusWrapper()
 {
diff --git a/PythonScript/src/NotepadPlusWrapper.h b/PythonScript/src/NotepadPlusWrapper.h
index 10683cb..9ab350a 100644
--- a/PythonScript/src/NotepadPlusWrapper.h
+++ b/PythonScript/src/NotepadPlusWrapper.h
@@ -668,6 +668,8 @@ public:
        void setStatusBar(StatusBarSection section, const char *text);

        intptr_t getPluginMenuHandle();
+       ^M
+       intptr_t hwnd;^M

        void activateIndex(int view, int index);

diff --git a/PythonScript/src/NotepadPython.cpp b/PythonScript/src/NotepadPython.cpp
index 28e2916..a4c53a4 100644
--- a/PythonScript/src/NotepadPython.cpp
+++ b/PythonScript/src/NotepadPython.cpp
@@ -21,6 +21,7 @@ void export_notepad()
        boost::python::register_exception_translator<InvalidValueProvidedException>(&translateInvalidValueProvidedException);

        boost::python::class_<NotepadPlusWrapper, boost::shared_ptr<NotepadPlusWrapper>, boost::noncopyable>("Notepad", boost::python::no_init)
+               .add_property("hwnd", &NotepadPlusWrapper::hwnd)^M
                .def("new", &NotepadPlusWrapper::newDocument, "Create a new document")
                .def("new", &NotepadPlusWrapper::newDocumentWithFilename, "Create a new document with the given filename")
                .def("save", &NotepadPlusWrapper::save, "Save the current file")
diff --git a/PythonScript/src/ScintillaPython.cpp b/PythonScript/src/ScintillaPython.cpp
index 5230a41..7259218 100644
--- a/PythonScript/src/ScintillaPython.cpp
+++ b/PythonScript/src/ScintillaPython.cpp
@@ -28,6 +28,7 @@ BOOST_PYTHON_MODULE(Npp)
        boost::python::register_exception_translator<NotAllowedInCallbackException>(&translateNotAllowedInCallbackException);

        boost::python::class_<ScintillaWrapper, boost::shared_ptr<ScintillaWrapper>, boost::noncopyable >("Editor", boost::python::no_init)
+               .add_property("hwnd", &ScintillaWrapper::hwnd)^M
                .def("write", &ScintillaWrapper::AddText, "Add text to the document at current position (alias for addText).")
                .def("callbackSync", &ScintillaWrapper::addSyncCallback, boost::python::args("callable", "listOfNotifications"), "Registers a callback to a Python function when a Scintilla event occurs. See also callback() to register an asynchronous callback. Callbacks are called synchronously with the event, so try not to perform too much work in the event handler.\nCertain operations cannot be performed in a synchronous callback.  setDocPointer, searchInTarget or findText calls are examples.  Scintilla doesn't allow recursively modifying the text, so you can't modify the text in a SCINTILLANOTIFICATION.MODIFIED callback - use a standard Asynchronous callback to do this.\ne.g. editor.callbackSync(my_function, [SCINTILLANOTIFICATION.CHARADDED])")
                .def("callback", &ScintillaWrapper::addAsyncCallback, boost::python::args("callable", "listOfNotifications"), "Registers a callback to call a Python function synchronously when a Scintilla event occurs. Events are queued up, and run in the order they arrive, one after the other, but asynchronously with the main GUI. See editor.callbackSync() to register a synchronous callback. e.g. editor.callback(my_function, [SCINTILLANOTIFICATION.CHARADDED])")
diff --git a/PythonScript/src/ScintillaWrapper.cpp b/PythonScript/src/ScintillaWrapper.cpp
index ade3903..80f85ea 100644
--- a/PythonScript/src/ScintillaWrapper.cpp
+++ b/PythonScript/src/ScintillaWrapper.cpp
@@ -33,6 +33,7 @@ ScintillaWrapper::ScintillaWrapper(const HWND handle, const HWND notepadHandle)
          m_notificationsEnabled(false),
          m_callbackMutex(::CreateMutex(NULL, FALSE, NULL))
 {
+       hwnd = (intptr_t)handle;^M
 }

 ScintillaWrapper::~ScintillaWrapper()
diff --git a/PythonScript/src/ScintillaWrapper.h b/PythonScript/src/ScintillaWrapper.h
index 8a19576..dec3169 100644
--- a/PythonScript/src/ScintillaWrapper.h
+++ b/PythonScript/src/ScintillaWrapper.h
@@ -58,6 +58,7 @@ public:
        explicit ScintillaWrapper(HWND handle, HWND notepadHandle);
        virtual ~ScintillaWrapper();

+       intptr_t hwnd;^M
        void setHandle(const HWND handle) { m_handle = handle; };
        HWND getHandle() { return m_handle; };
        void invalidateHandle() { m_handle = NULL; };

[vinsworldcom]

@Ekopalypse I just want to see them available - the scripting way I (borrowed from @alankilborn ) do it now is like your way - as properties. I think that would be just fine!

Cheers.

[Ekopalypse]

Unfortunately there is still a small issue

I was hoping that boost::python could do some magic itself, but ...
i will try it tomorrow :-)

[vinsworldcom]

@Ekopalypse to be honest, I didn't even think to implement editor.hwnd as in the current view. So long as:

• notepad.hwnd
• editor1.hwnd
• editor2.hwnd

all work, I'd consider it a success!

Cheers.

[Ekopalypse]

@chcg, Would you mind if I revert the console hwnd PR to look just like the others?

The current changes
master...Ekopalypse:PythonScript:temp

[chcg]

@Ekopalypse The way to make all the handles available via properties is fine for me. So reverting the change done for the console is ok. Would you please provide a PR with your changes. Thanks for taking care of this topic.

[alankilborn]

I'm pleased that @Ekopalypse is taking this on!