Add WindowBase::setIMEPreeditPosition

SFML · Apr 5, 2023 · e04bcbb · e04bcbb
1 parent f371a99
commit e04bcbb
Show file tree

Hide file tree

Showing 16 changed files with 142 additions and 1 deletion.
diff --git a/include/SFML/Window/WindowBase.hpp b/include/SFML/Window/WindowBase.hpp
@@ -390,6 +390,23 @@ class SFML_WINDOW_API WindowBase
     ////////////////////////////////////////////////////////////
     bool hasFocus() const;
 
+    ////////////////////////////////////////////////////////////
+    /// \brief Set the position where the IME preedit popup
+    ///        should show up
+    ///
+    /// The position specified is relative to the left-top
+    /// corner of the window area.
+    ///
+    /// It is implementation-specific what happens when negative
+    /// values are used. X11 handles them as you would expect,
+    /// but Windows sometimes resets the position to the top-left
+    /// of the screen.
+    ///
+    /// \param position Left-top corner of the preedit popup
+    ///
+    ////////////////////////////////////////////////////////////
+    void setImePreeditPosition(const Vector2i& position);
+
     ////////////////////////////////////////////////////////////
     /// \brief Get the OS-specific handle of the window
     ///

diff --git a/src/SFML/Window/Android/WindowImplAndroid.cpp b/src/SFML/Window/Android/WindowImplAndroid.cpp
@@ -211,6 +211,13 @@ bool WindowImplAndroid::hasFocus() const
 }
 
 
+////////////////////////////////////////////////////////////
+void WindowImplAndroid::setImePreeditPosition(const Vector2i& /* position */)
+{
+    // Not applicable
+}
+
+
 ////////////////////////////////////////////////////////////
 void WindowImplAndroid::forwardEvent(const Event& event)
 {

diff --git a/src/SFML/Window/Android/WindowImplAndroid.hpp b/src/SFML/Window/Android/WindowImplAndroid.hpp
@@ -181,6 +181,15 @@ class WindowImplAndroid : public WindowImpl
     ////////////////////////////////////////////////////////////
     bool hasFocus() const override;
 
+    ////////////////////////////////////////////////////////////
+    /// \brief Set the position where the IME preedit window
+    ///        should show up
+    ///
+    /// \param position Left-top corner of the preedit window
+    ///
+    ////////////////////////////////////////////////////////////
+    void setImePreeditPosition(const Vector2i& position) override;
+
     static void               forwardEvent(const Event& event);
     static WindowImplAndroid* singleInstance;
 

diff --git a/src/SFML/Window/CMakeLists.txt b/src/SFML/Window/CMakeLists.txt
@@ -331,7 +331,7 @@ if(SFML_OS_LINUX)
     sfml_find_package(UDev INCLUDE "UDEV_INCLUDE_DIR" LINK "UDEV_LIBRARIES")
     target_link_libraries(sfml-window PRIVATE UDev dl)
 elseif(SFML_OS_WINDOWS)
-    target_link_libraries(sfml-window PRIVATE winmm gdi32)
+    target_link_libraries(sfml-window PRIVATE winmm gdi32 imm32)
 elseif(SFML_OS_FREEBSD)
     target_link_libraries(sfml-window PRIVATE usbhid)
 elseif(SFML_OS_MACOSX)

diff --git a/src/SFML/Window/DRM/WindowImplDRM.cpp b/src/SFML/Window/DRM/WindowImplDRM.cpp
@@ -145,6 +145,13 @@ bool WindowImplDRM::hasFocus() const
     return true;
 }
 
+
+////////////////////////////////////////////////////////////
+void WindowImplDRM::setImePreeditPosition(const Vector2i& /* position */)
+{
+    // Not applicable
+}
+
 void WindowImplDRM::processEvents()
 {
     sf::Event ev;

diff --git a/src/SFML/Window/DRM/WindowImplDRM.hpp b/src/SFML/Window/DRM/WindowImplDRM.hpp
@@ -176,6 +176,15 @@ class WindowImplDRM : public WindowImpl
     ////////////////////////////////////////////////////////////
     bool hasFocus() const override;
 
+    ////////////////////////////////////////////////////////////
+    /// \brief Set the position where the IME preedit window
+    ///        should show up
+    ///
+    /// \param position Left-top corner of the preedit window
+    ///
+    ////////////////////////////////////////////////////////////
+    void setImePreeditPosition(const Vector2i& position) override;
+
 protected:
     ////////////////////////////////////////////////////////////
     /// \brief Process incoming events from the operating system

diff --git a/src/SFML/Window/OSX/WindowImplCocoa.hpp b/src/SFML/Window/OSX/WindowImplCocoa.hpp
@@ -351,6 +351,15 @@ class WindowImplCocoa : public WindowImpl
     ////////////////////////////////////////////////////////////
     bool hasFocus() const override;
 
+    ////////////////////////////////////////////////////////////
+    /// \brief Set the position where the IME preedit window
+    ///        should show up
+    ///
+    /// \param position Left-top corner of the preedit window
+    ///
+    ////////////////////////////////////////////////////////////
+    void setImePreeditPosition(const Vector2i& position) override;
+
 protected:
     ////////////////////////////////////////////////////////////
     /// \brief Process incoming events from the operating system

diff --git a/src/SFML/Window/OSX/WindowImplCocoa.mm b/src/SFML/Window/OSX/WindowImplCocoa.mm
@@ -523,4 +523,11 @@ void showMouseCursor()
 }
 
 
+////////////////////////////////////////////////////////////
+void WindowImplCocoa::setImePreeditPosition(const Vector2i& /* position */)
+{
+    // TODO: To implement
+}
+
+
 } // namespace sf::priv
diff --git a/src/SFML/Window/Unix/WindowImplX11.cpp b/src/SFML/Window/Unix/WindowImplX11.cpp
@@ -1213,6 +1213,16 @@ void WindowImplX11::grabFocus()
 }
 
 
+////////////////////////////////////////////////////////////
+void WindowImplX11::setImePreeditPosition(const Vector2i& position)
+{
+    const XPoint        xpos{static_cast<short>(position.x), static_cast<short>(position.y)};
+    const XVaNestedList preeditAttr = XVaCreateNestedList(0, XNSpotLocation, &xpos, NULL);
+    XSetICValues(m_inputContext, XNPreeditAttributes, preeditAttr, NULL);
+    XFree(preeditAttr);
+}
+
+
 ////////////////////////////////////////////////////////////
 void WindowImplX11::setVideoMode(const VideoMode& mode)
 {

diff --git a/src/SFML/Window/Unix/WindowImplX11.hpp b/src/SFML/Window/Unix/WindowImplX11.hpp
@@ -183,6 +183,15 @@ class WindowImplX11 : public WindowImpl
     ////////////////////////////////////////////////////////////
     bool hasFocus() const override;
 
+    ////////////////////////////////////////////////////////////
+    /// \brief Set the position where the IME preedit window
+    ///        should show up
+    ///
+    /// \param position Left-top corner of the preedit window
+    ///
+    ////////////////////////////////////////////////////////////
+    void setImePreeditPosition(const Vector2i& position) override;
+
 protected:
     ////////////////////////////////////////////////////////////
     /// \brief Process incoming events from the operating system

diff --git a/src/SFML/Window/Win32/WindowImplWin32.cpp b/src/SFML/Window/Win32/WindowImplWin32.cpp
@@ -460,6 +460,21 @@ bool WindowImplWin32::hasFocus() const
 }
 
 
+////////////////////////////////////////////////////////////
+void WindowImplWin32::setImePreeditPosition(const Vector2i& position)
+{
+    if (HIMC himc = ImmGetContext(m_handle); himc != nullptr)
+    {
+        COMPOSITIONFORM cf;
+        cf.ptCurrentPos.x = static_cast<LONG>(position.x);
+        cf.ptCurrentPos.y = static_cast<LONG>(position.y);
+        cf.dwStyle        = CFS_FORCE_POSITION; // Don't let the IME adjust the position
+        ImmSetCompositionWindow(himc, &cf);
+        ImmReleaseContext(m_handle, himc);
+    }
+}
+
+
 ////////////////////////////////////////////////////////////
 void WindowImplWin32::registerWindowClass()
 {

diff --git a/src/SFML/Window/Win32/WindowImplWin32.hpp b/src/SFML/Window/Win32/WindowImplWin32.hpp
@@ -182,6 +182,15 @@ class WindowImplWin32 : public WindowImpl
     ////////////////////////////////////////////////////////////
     bool hasFocus() const override;
 
+    ////////////////////////////////////////////////////////////
+    /// \brief Set the position where the IME preedit window
+    ///        should show up
+    ///
+    /// \param position Left-top corner of the preedit window
+    ///
+    ////////////////////////////////////////////////////////////
+    void setImePreeditPosition(const Vector2i& position) override;
+
 protected:
     ////////////////////////////////////////////////////////////
     /// \brief Process incoming events from the operating system

diff --git a/src/SFML/Window/WindowBase.cpp b/src/SFML/Window/WindowBase.cpp
@@ -297,6 +297,14 @@ bool WindowBase::hasFocus() const
 }
 
 
+////////////////////////////////////////////////////////////
+void WindowBase::setImePreeditPosition(const Vector2i& position)
+{
+    if (m_impl)
+        m_impl->setImePreeditPosition(position);
+}
+
+
 ////////////////////////////////////////////////////////////
 WindowHandle WindowBase::getSystemHandle() const
 {

diff --git a/src/SFML/Window/WindowImpl.hpp b/src/SFML/Window/WindowImpl.hpp
@@ -238,6 +238,15 @@ class WindowImpl
     ////////////////////////////////////////////////////////////
     virtual bool hasFocus() const = 0;
 
+    ////////////////////////////////////////////////////////////
+    /// \brief Set the position where the IME preedit window
+    ///        should show up
+    ///
+    /// \param position Left-top corner of the preedit window
+    ///
+    ////////////////////////////////////////////////////////////
+    virtual void setImePreeditPosition(const Vector2i& position) = 0;
+
     ////////////////////////////////////////////////////////////
     /// \brief Create a Vulkan rendering surface
     ///

diff --git a/src/SFML/Window/iOS/WindowImplUIKit.hpp b/src/SFML/Window/iOS/WindowImplUIKit.hpp
@@ -177,6 +177,15 @@ class WindowImplUIKit : public WindowImpl
     ////////////////////////////////////////////////////////////
     bool hasFocus() const override;
 
+    ////////////////////////////////////////////////////////////
+    /// \brief Set the position where the IME preedit window
+    ///        should show up
+    ///
+    /// \param position Left-top corner of the preedit window
+    ///
+    ////////////////////////////////////////////////////////////
+    void setImePreeditPosition(const Vector2i& position) override;
+
 public:
     ////////////////////////////////////////////////////////////
     /// \brief Notify an event

diff --git a/src/SFML/Window/iOS/WindowImplUIKit.mm b/src/SFML/Window/iOS/WindowImplUIKit.mm
@@ -208,6 +208,13 @@
 }
 
 
+////////////////////////////////////////////////////////////
+void WindowImplUIKit::setImePreeditPosition(const Vector2i& /* position */)
+{
+    // Not applicable
+}
+
+
 ////////////////////////////////////////////////////////////
 void WindowImplUIKit::forwardEvent(Event event)
 {