/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ /* * This file is part of the LibreOffice project. * * This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. * * This file incorporates work covered by the following license notice: * * Licensed to the Apache Software Foundation (ASF) under one or more * contributor license agreements. See the NOTICE file distributed * with this work for additional information regarding copyright * ownership. The ASF licenses this file to you under the Apache * License, Version 2.0 (the "License"); you may not use this file * except in compliance with the License. You may obtain a copy of * the License at http://www.apache.org/licenses/LICENSE-2.0 . */ #ifndef INCLUDED_VCL_INC_UNX_GTK_GTKFRAME_HXX #define INCLUDED_VCL_INC_UNX_GTK_GTKFRAME_HXX #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include class GtkSalGraphics; class GtkSalDisplay; typedef sal_uIntPtr GdkNativeWindow; #define GDK_WINDOW_XWINDOW(o) GDK_WINDOW_XID(o) #define gdk_set_sm_client_id(i) gdk_x11_set_sm_client_id(i) #define gdk_window_foreign_new_for_display(a,b) gdk_x11_window_foreign_new_for_display(a,b) class GtkDropTarget; class GtkDragSource; class GtkDnDTransferable; class GtkSalMenu; class GtkSalFrame final : public SalFrame , public NativeWindowHandleProvider { struct IMHandler { // Not all GTK Input Methods swallow key release // events. Since they swallow the key press events and we // are left with the key release events, we need to // manually swallow those. To do this, we keep a list of // the previous 10 key press events in each GtkSalFrame // and when we get a key release that matches one of the // key press events in our list, we swallow it. struct PreviousKeyPress { GdkWindow *window; gint8 send_event; guint32 time; guint state; guint keyval; guint16 hardware_keycode; guint8 group; PreviousKeyPress (GdkEventKey *event) : window (nullptr), send_event (0), time (0), state (0), keyval (0), hardware_keycode (0), group (0) { if (event) { window = event->window; send_event = event->send_event; time = event->time; state = event->state; keyval = event->keyval; hardware_keycode = event->hardware_keycode; group = event->group; } } PreviousKeyPress( const PreviousKeyPress& rPrev ) : window( rPrev.window ), send_event( rPrev.send_event ), time( rPrev.time ), state( rPrev.state ), keyval( rPrev.keyval ), hardware_keycode( rPrev.hardware_keycode ), group( rPrev.group ) {} bool operator== (GdkEventKey const *event) const { return (event != nullptr) && (event->window == window) && (event->send_event == send_event) // ignore non-Gdk state bits, e.g., these used by IBus && ((event->state & GDK_MODIFIER_MASK) == (state & GDK_MODIFIER_MASK)) && (event->keyval == keyval) && (event->hardware_keycode == hardware_keycode) && (event->group == group) && (event->time - time < 300) ; } }; GtkSalFrame* m_pFrame; std::list< PreviousKeyPress > m_aPrevKeyPresses; int m_nPrevKeyPresses; // avoid using size() GtkIMContext* m_pIMContext; bool m_bFocused; bool m_bPreeditJustChanged; SalExtTextInputEvent m_aInputEvent; std::vector< ExtTextInputAttr > m_aInputFlags; IMHandler( GtkSalFrame* ); ~IMHandler(); void createIMContext(); void deleteIMContext(); void updateIMSpotLocation(); void endExtTextInput( EndExtTextInputFlags nFlags ); bool handleKeyEvent( GdkEventKey* pEvent ); void focusChanged( bool bFocusIn ); void doCallEndExtTextInput(); void sendEmptyCommit(); static void signalIMCommit( GtkIMContext*, gchar*, gpointer ); static gboolean signalIMDeleteSurrounding( GtkIMContext*, gint, gint, gpointer ); static void signalIMPreeditChanged( GtkIMContext*, gpointer ); static void signalIMPreeditEnd( GtkIMContext*, gpointer ); static void signalIMPreeditStart( GtkIMContext*, gpointer ); static gboolean signalIMRetrieveSurrounding( GtkIMContext*, gpointer ); }; friend struct IMHandler; friend class GtkSalObjectWidgetClip; SalX11Screen m_nXScreen; GtkWidget* m_pWindow; GtkHeaderBar* m_pHeaderBar; GtkGrid* m_pTopLevelGrid; GtkEventBox* m_pEventBox; GtkFixed* m_pFixedContainer; GdkWindow* m_pForeignParent; GdkNativeWindow m_aForeignParentWindow; GdkWindow* m_pForeignTopLevel; GdkNativeWindow m_aForeignTopLevelWindow; SalFrameStyleFlags m_nStyle; GtkSalFrame* m_pParent; std::list< GtkSalFrame* > m_aChildren; GdkWindowState m_nState; SystemEnvData m_aSystemData; std::unique_ptr m_pGraphics; bool m_bGraphics; ModKeyFlags m_nKeyModifiers; GdkCursor *m_pCurrentCursor; PointerStyle m_ePointerStyle; ScreenSaverInhibitor m_ScreenSaverInhibitor; bool m_bFullscreen; bool m_bSpanMonitorsWhenFullscreen; bool m_bDefaultPos; bool m_bDefaultSize; bool m_bTooltipBlocked; OUString m_sWMClass; std::unique_ptr m_pIMHandler; Size m_aMaxSize; Size m_aMinSize; tools::Rectangle m_aRestorePosSize; OUString m_aTooltip; tools::Rectangle m_aHelpArea; tools::Rectangle m_aFloatRect; FloatWinPopupFlags m_nFloatFlags; bool m_bFloatPositioned; long m_nWidthRequest; long m_nHeightRequest; cairo_region_t* m_pRegion; GtkDropTarget* m_pDropTarget; GtkDragSource* m_pDragSource; bool m_bGeometryIsProvisional; bool m_bIconSetWhileUnmapped; GtkSalMenu* m_pSalMenu; #if ENABLE_DBUS && ENABLE_GIO private: friend void ensure_dbus_setup(GdkWindow* gdkWindow, GtkSalFrame* pSalFrame); friend void on_registrar_available (GDBusConnection*, const gchar*, const gchar*, gpointer); friend void on_registrar_unavailable (GDBusConnection*, const gchar*, gpointer); #endif guint m_nWatcherId; void Init( SalFrame* pParent, SalFrameStyleFlags nStyle ); void Init( SystemParentData* pSysData ); void InitCommon(); void InvalidateGraphics(); // signals static gboolean signalButton( GtkWidget*, GdkEventButton*, gpointer ); static void signalStyleUpdated(GtkWidget*, gpointer); static gboolean signalDraw( GtkWidget*, cairo_t *cr, gpointer ); static void signalRealize(GtkWidget*, gpointer frame); static void sizeAllocated(GtkWidget*, GdkRectangle *pAllocation, gpointer frame); static gboolean signalTooltipQuery(GtkWidget*, gint x, gint y, gboolean keyboard_mode, GtkTooltip *tooltip, gpointer frame); static gboolean signalDragMotion(GtkWidget *widget, GdkDragContext *context, gint x, gint y, guint time, gpointer frame); static gboolean signalDragDrop(GtkWidget* widget, GdkDragContext *context, gint x, gint y, guint time, gpointer frame); static void signalDragDropReceived(GtkWidget *widget, GdkDragContext *context, gint x, gint y, GtkSelectionData *data, guint ttype, guint time, gpointer frame); static void signalDragLeave(GtkWidget *widget, GdkDragContext *context, guint time, gpointer frame); static gboolean signalDragFailed(GtkWidget *widget, GdkDragContext *context, GtkDragResult result, gpointer frame); static void signalDragDelete(GtkWidget *widget, GdkDragContext *context, gpointer frame); static void signalDragEnd(GtkWidget *widget, GdkDragContext *context, gpointer frame); static void signalDragDataGet(GtkWidget* widget, GdkDragContext* context, GtkSelectionData *data, guint info, guint time, gpointer frame); static void gestureSwipe(GtkGestureSwipe* gesture, gdouble velocity_x, gdouble velocity_y, gpointer frame); static void gestureLongPress(GtkGestureLongPress* gesture, gdouble x, gdouble y, gpointer frame); static gboolean signalFocus( GtkWidget*, GdkEventFocus*, gpointer ); static void signalSetFocus( GtkWindow* pWindow, GtkWidget* pWidget, gpointer frame ); static gboolean signalMap( GtkWidget*, GdkEvent*, gpointer ); static gboolean signalUnmap( GtkWidget*, GdkEvent*, gpointer ); static gboolean signalConfigure( GtkWidget*, GdkEventConfigure*, gpointer ); static gboolean signalMotion( GtkWidget*, GdkEventMotion*, gpointer ); static gboolean signalKey( GtkWidget*, GdkEventKey*, gpointer ); static gboolean signalDelete( GtkWidget*, GdkEvent*, gpointer ); static gboolean signalWindowState( GtkWidget*, GdkEvent*, gpointer ); static gboolean signalScroll( GtkWidget*, GdkEvent*, gpointer ); static gboolean signalCrossing( GtkWidget*, GdkEventCrossing*, gpointer ); static gboolean signalVisibility( GtkWidget*, GdkEventVisibility*, gpointer ); static void signalDestroy( GtkWidget*, gpointer ); void Center(); void SetDefaultSize(); bool doKeyCallback( guint state, guint keyval, guint16 hardware_keycode, guint8 group, sal_Unicode aOrigCode, bool bDown, bool bSendRelease ); static GdkNativeWindow findTopLevelSystemWindow( GdkNativeWindow aWindow ); static int m_nFloats; bool isFloatGrabWindow() const { return (m_nStyle & SalFrameStyleFlags::FLOAT) && // only a float can be floatgrab !(m_nStyle & SalFrameStyleFlags::TOOLTIP) && // tool tips are not !(m_nStyle & SalFrameStyleFlags::OWNERDRAWDECORATION); // toolbars are also not } bool isChild( bool bPlug = true, bool bSysChild = true ) { SalFrameStyleFlags nMask = SalFrameStyleFlags::NONE; if( bPlug ) nMask |= SalFrameStyleFlags::PLUG; if( bSysChild ) nMask |= SalFrameStyleFlags::SYSTEMCHILD; return bool(m_nStyle & nMask); } //call gtk_window_resize void window_resize(long nWidth, long nHeight); //call gtk_widget_set_size_request void widget_set_size_request(long nWidth, long nHeight); void resizeWindow( long nWidth, long nHeight ); void moveWindow( long nX, long nY ); Size calcDefaultSize(); void setMinMaxSize(); void AllocateFrame(); void TriggerPaintEvent(); void updateWMClass(); enum class SetType { RetainSize, Fullscreen, UnFullscreen }; void SetScreen( unsigned int nNewScreen, SetType eType, tools::Rectangle const *pSize = nullptr ); void SetIcon(const char* pIcon); public: cairo_surface_t* m_pSurface; basegfx::B2IVector m_aFrameSize; DamageHandler m_aDamageHandler; std::vector m_aPendingScrollEvents; Idle m_aSmoothScrollIdle; int m_nGrabLevel; bool m_bSalObjectSetPosSize; GtkSalFrame( SalFrame* pParent, SalFrameStyleFlags nStyle ); GtkSalFrame( SystemParentData* pSysData ); guint m_nMenuExportId; guint m_nActionGroupExportId; guint m_nHudAwarenessId; std::vector m_aMouseSignalIds; void grabPointer(bool bGrab, bool bKeyboardAlso, bool bOwnerEvents); static GtkSalDisplay* getDisplay(); static GdkDisplay* getGdkDisplay(); GtkWidget* getWindow() const { return m_pWindow; } GtkFixed* getFixedContainer() const { return m_pFixedContainer; } GtkEventBox* getEventBox() const { return m_pEventBox; } GtkWidget* getMouseEventWidget() const; GtkGrid* getTopLevelGridWidget() const { return m_pTopLevelGrid; } const SalX11Screen& getXScreenNumber() const { return m_nXScreen; } int GetDisplayScreen() const { return maGeometry.nDisplayScreenNumber; } void updateScreenNumber(); cairo_t* getCairoContext() const; void damaged(sal_Int32 nExtentsLeft, sal_Int32 nExtentsTop, sal_Int32 nExtentsRight, sal_Int32 nExtentsBottom) const; void registerDropTarget(GtkDropTarget* pDropTarget) { assert(!m_pDropTarget); m_pDropTarget = pDropTarget; } void deregisterDropTarget(GtkDropTarget const * pDropTarget) { assert(m_pDropTarget == pDropTarget); (void)pDropTarget; m_pDropTarget = nullptr; } void registerDragSource(GtkDragSource* pDragSource) { assert(!m_pDragSource); m_pDragSource = pDragSource; } void deregisterDragSource(GtkDragSource const * pDragSource) { assert(m_pDragSource == pDragSource); (void)pDragSource; m_pDragSource = nullptr; } void startDrag(gint nButton, gint nDragOriginX, gint nDragOriginY, GdkDragAction sourceActions, GtkTargetList* pTargetList); void closePopup(); void addGrabLevel(); void removeGrabLevel(); void nopaint_container_resize_children(GtkContainer*); void LaunchAsyncScroll(GdkEvent const * pEvent); DECL_LINK(AsyncScroll, Timer *, void); virtual ~GtkSalFrame() override; // SalGraphics or NULL, but two Graphics for all SalFrames // must be returned virtual SalGraphics* AcquireGraphics() override; virtual void ReleaseGraphics( SalGraphics* pGraphics ) override; // Event must be destroyed, when Frame is destroyed // When Event is called, SalInstance::Yield() must be returned virtual bool PostEvent(std::unique_ptr pData) override; virtual void SetTitle( const OUString& rTitle ) override; virtual void SetIcon( sal_uInt16 nIcon ) override; virtual void SetMenu( SalMenu *pSalMenu ) override; SalMenu* GetMenu(); virtual void DrawMenuBar() override; void EnsureAppMenuWatch(); virtual void SetExtendedFrameStyle( SalExtStyle nExtStyle ) override; // Before the window is visible, a resize event // must be sent with the correct size virtual void Show( bool bVisible, bool bNoActivate = false ) override; // Set ClientSize and Center the Window to the desktop // and send/post a resize message virtual void SetMinClientSize( long nWidth, long nHeight ) override; virtual void SetMaxClientSize( long nWidth, long nHeight ) override; virtual void SetPosSize( long nX, long nY, long nWidth, long nHeight, sal_uInt16 nFlags ) override; virtual void GetClientSize( long& rWidth, long& rHeight ) override; virtual void GetWorkArea( tools::Rectangle& rRect ) override; virtual SalFrame* GetParent() const override; virtual void SetWindowState( const SalFrameState* pState ) override; virtual bool GetWindowState( SalFrameState* pState ) override; virtual void ShowFullScreen( bool bFullScreen, sal_Int32 nDisplay ) override; // Enable/Disable ScreenSaver, SystemAgents, ... virtual void StartPresentation( bool bStart ) override; // Show Window over all other Windows virtual void SetAlwaysOnTop( bool bOnTop ) override; // Window to top and grab focus virtual void ToTop( SalFrameToTop nFlags ) override; // this function can call with the same // pointer style virtual void SetPointer( PointerStyle ePointerStyle ) override; virtual void CaptureMouse( bool bMouse ) override; virtual void GrabFocus() override; virtual void SetPointerPos( long nX, long nY ) override; // flush output buffer using SalFrame::Flush; virtual void Flush() override; // flush output buffer, wait till outstanding operations are done virtual void SetInputContext( SalInputContext* pContext ) override; virtual void EndExtTextInput( EndExtTextInputFlags nFlags ) override; virtual OUString GetKeyName( sal_uInt16 nKeyCode ) override; virtual bool MapUnicodeToKeyCode( sal_Unicode aUnicode, LanguageType aLangType, vcl::KeyCode& rKeyCode ) override; // returns the input language used for the last key stroke // may be LANGUAGE_DONTKNOW if not supported by the OS virtual LanguageType GetInputLanguage() override; virtual void UpdateSettings( AllSettings& rSettings ) override; virtual void Beep() override; // returns system data (most prominent: window handle) virtual const SystemEnvData* GetSystemData() const override; // get current modifier and button mask virtual SalPointerState GetPointerState() override; virtual KeyIndicatorState GetIndicatorState() override; virtual void SimulateKeyPress( sal_uInt16 nKeyCode ) override; // set new parent window virtual void SetParent( SalFrame* pNewParent ) override; // reparent window to act as a plugin; implementation // may choose to use a new system window internally // return false to indicate failure virtual bool SetPluginParent( SystemParentData* pNewParent ) override; virtual void SetScreenNumber( unsigned int ) override; virtual void SetApplicationID( const OUString &rWMClass ) override; // shaped system windows // set clip region to none (-> rectangular windows, normal state) virtual void ResetClipRegion() override; // start setting the clipregion consisting of nRects rectangles virtual void BeginSetClipRegion( sal_uInt32 nRects ) override; // add a rectangle to the clip region virtual void UnionClipRegion( long nX, long nY, long nWidth, long nHeight ) override; // done setting up the clipregion virtual void EndSetClipRegion() override; virtual void PositionByToolkit(const tools::Rectangle& rRect, FloatWinPopupFlags nFlags) override; virtual void SetModal(bool bModal) override; virtual bool GetModal() const override; void HideTooltip(); void BlockTooltip(); void UnblockTooltip(); virtual bool ShowTooltip(const OUString& rHelpText, const tools::Rectangle& rHelpArea) override; virtual void* ShowPopover(const OUString& rHelpText, vcl::Window* pParent, const tools::Rectangle& rHelpArea, QuickHelpFlags nFlags) override; virtual bool UpdatePopover(void* nId, const OUString& rHelpText, vcl::Window* pParent, const tools::Rectangle& rHelpArea) override; virtual bool HidePopover(void* nId) override; virtual weld::Window* GetFrameWeld() const override; static GtkSalFrame *getFromWindow( GtkWidget *pWindow ); sal_uIntPtr GetNativeWindowHandle(GtkWidget *pWidget); virtual sal_uIntPtr GetNativeWindowHandle() override; //Call the usual SalFrame Callback, but catch uno exceptions and delegate //to GtkSalData to rethrow them after the gsignal is processed when its safe //to do so again in our own code after the g_main_context_iteration call //which triggers the gsignals. bool CallCallbackExc(SalEvent nEvent, const void* pEvent) const; static void KeyCodeToGdkKey(const vcl::KeyCode& rKeyCode, guint* pGdkKeyCode, GdkModifierType *pGdkModifiers); static guint32 GetLastInputEventTime(); static void UpdateLastInputEventTime(guint32 nUserInputTime); static sal_uInt16 GetMouseModCode(guint nState); static sal_uInt16 GetKeyCode(guint nKeyVal); static guint GetKeyValFor(GdkKeymap* pKeyMap, guint16 hardware_keycode, guint8 group); static sal_uInt16 GetKeyModCode(guint nState); static GdkEvent* makeFakeKeyPress(GtkWidget* pWidget); static SalWheelMouseEvent GetWheelEvent(GdkEventScroll& rEvent); static gboolean NativeWidgetHelpPressed(GtkAccelGroup*, GObject*, guint, GdkModifierType, gpointer pFrame); static OUString GetPreeditDetails(GtkIMContext* pIMContext, std::vector& rInputFlags, sal_Int32& rCursorPos, sal_uInt8& rCursorFlags); }; #define OOO_TYPE_FIXED ooo_fixed_get_type() extern "C" { GType ooo_fixed_get_type(); AtkObject* ooo_fixed_get_accessible(GtkWidget *obj); } // extern "C" #if !GTK_CHECK_VERSION(3, 20, 0) enum GdkDragCancelReason { GDK_DRAG_CANCEL_NO_TARGET, GDK_DRAG_CANCEL_USER_CANCELLED, GDK_DRAG_CANCEL_ERROR }; #endif #if !GTK_CHECK_VERSION(3, 22, 0) enum GdkAnchorHints { GDK_ANCHOR_FLIP_X = 1 << 0, GDK_ANCHOR_FLIP_Y = 1 << 1, GDK_ANCHOR_SLIDE_X = 1 << 2, GDK_ANCHOR_SLIDE_Y = 1 << 3, GDK_ANCHOR_RESIZE_X = 1 << 4, GDK_ANCHOR_RESIZE_Y = 1 << 5, GDK_ANCHOR_FLIP = GDK_ANCHOR_FLIP_X | GDK_ANCHOR_FLIP_Y, GDK_ANCHOR_SLIDE = GDK_ANCHOR_SLIDE_X | GDK_ANCHOR_SLIDE_Y, GDK_ANCHOR_RESIZE = GDK_ANCHOR_RESIZE_X | GDK_ANCHOR_RESIZE_Y }; #endif #endif // INCLUDED_VCL_INC_UNX_GTK_GTKFRAME_HXX /* vim:set shiftwidth=4 softtabstop=4 expandtab: */