1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
|
/* -*- 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 <cairo.h>
#include <gdk/gdk.h>
#include <gdk/gdkx.h>
#include <gtk/gtk.h>
#if GTK_CHECK_VERSION(3,0,0)
# include <gtk/gtkx.h>
#endif
#include <gdk/gdkkeysyms.h>
#include <salframe.hxx>
#include <vcl/sysdata.hxx>
#include <unx/nativewindowhandleprovider.hxx>
#include <unx/saltype.h>
#include <unx/screensaverinhibitor.hxx>
#include "tools/link.hxx"
#include <com/sun/star/awt/XTopWindow.hpp>
#include <com/sun/star/datatransfer/DataFlavor.hpp>
#include <com/sun/star/datatransfer/dnd/XDragSource.hpp>
#include <com/sun/star/datatransfer/dnd/XDropTarget.hpp>
#include <list>
#include <vector>
#include <config_dbus.h>
#include <config_gio.h>
#include "headless/svpgdi.hxx"
class GtkSalGraphics;
class GtkSalDisplay;
#if GTK_CHECK_VERSION(3,0,0)
typedef ::Window 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;
#endif
#if !(GLIB_MAJOR_VERSION > 2 || GLIB_MINOR_VERSION >= 26)
typedef void GDBusConnection;
#endif
class GtkSalFrame : 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 *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;
SalX11Screen m_nXScreen;
GtkWidget* m_pWindow;
#if GTK_CHECK_VERSION(3,0,0)
GtkGrid* m_pTopLevelGrid;
#endif
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;
GtkSalGraphics *m_pGraphics;
bool m_bGraphics;
ModKeyFlags m_nKeyModifiers;
GdkCursor *m_pCurrentCursor;
GdkVisibilityState m_nVisibility;
PointerStyle m_ePointerStyle;
ScreenSaverInhibitor m_ScreenSaverInhibitor;
int m_nWorkArea;
bool m_bFullscreen;
bool m_bSpanMonitorsWhenFullscreen;
bool m_bDefaultPos;
bool m_bDefaultSize;
bool m_bSendModChangeOnRelease;
bool m_bWindowIsGtkPlug;
OUString m_aTitle;
OUString m_sWMClass;
IMHandler* m_pIMHandler;
Size m_aMaxSize;
Size m_aMinSize;
tools::Rectangle m_aRestorePosSize;
#if GTK_CHECK_VERSION(3,0,0)
OUString m_aTooltip;
tools::Rectangle m_aHelpArea;
long m_nWidthRequest;
long m_nHeightRequest;
cairo_region_t* m_pRegion;
GtkDropTarget* m_pDropTarget;
GtkDragSource* m_pDragSource;
bool m_bInDrag;
GtkDnDTransferable* m_pFormatConversionRequest;
#else
GdkRegion* m_pRegion;
bool m_bSetFocusOnMap;
#endif
SalMenu* 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 );
#if GTK_CHECK_VERSION(3,0,0)
static void signalStyleUpdated(GtkWidget*, gpointer);
#else
static void signalStyleSet(GtkWidget*, GtkStyle* pPrevious, gpointer);
#endif
#if GTK_CHECK_VERSION(3,0,0)
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);
#if GTK_CHECK_VERSION(3,14,0)
static void gestureSwipe(GtkGestureSwipe* gesture, gdouble velocity_x, gdouble velocity_y, gpointer frame);
static void gestureLongPress(GtkGestureLongPress* gesture, gpointer frame);
#endif
#else
static gboolean signalExpose( GtkWidget*, GdkEventExpose*, gpointer );
void askForXEmbedFocus( sal_Int32 nTimecode );
void grabKeyboard(bool bGrab);
#endif
static gboolean signalFocus( GtkWidget*, GdkEventFocus*, gpointer );
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*, GdkEventScroll*, gpointer );
static gboolean signalCrossing( GtkWidget*, GdkEventCrossing*, gpointer );
static gboolean signalVisibility( GtkWidget*, GdkEventVisibility*, gpointer );
static void signalDestroy( GtkWidget*, gpointer );
void Center();
void SetDefaultSize();
void doKeyCallback( guint state,
guint keyval,
guint16 hardware_keycode,
guint8 group,
guint32 time,
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 createNewWindow( ::Window aParent, bool bXEmbed, SalX11Screen nXScreen );
void AllocateFrame();
void TriggerPaintEvent();
void updateWMClass();
enum class SetType { RetainSize, Fullscreen, UnFullscreen };
void SetScreen( unsigned int nNewScreen, SetType eType, tools::Rectangle *pSize = nullptr );
public:
#if GTK_CHECK_VERSION(3,0,0)
cairo_surface_t* m_pSurface;
basegfx::B2IVector m_aFrameSize;
DamageHandler m_aDamageHandler;
int m_nGrabLevel;
bool m_bSalObjectSetPosSize;
#endif
GtkSalFrame( SalFrame* pParent, SalFrameStyleFlags nStyle );
GtkSalFrame( SystemParentData* pSysData );
guint m_nMenuExportId;
guint m_nAppMenuExportId;
guint m_nActionGroupExportId;
guint m_nAppActionGroupExportId;
guint m_nHudAwarenessId;
std::vector<gulong> m_aMouseSignalIds;
// dispatches an event, returns true if dispatched
// and false else; if true was returned the event should
// be swallowed
bool Dispatch( const XEvent* pEvent );
void grabPointer(bool bGrab, bool bOwnerEvents = false);
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;
#if GTK_CHECK_VERSION(3,0,0)
GtkGrid* getTopLevelGridWidget() const { return m_pTopLevelGrid; }
#endif
GdkWindow* getForeignParent() const { return m_pForeignParent; }
GdkNativeWindow getForeignParentWindow() const { return m_aForeignParentWindow; }
GdkWindow* getForeignTopLevel() const { return m_pForeignTopLevel; }
GdkNativeWindow getForeignTopLevelWindow() const { return m_aForeignTopLevelWindow; }
const SalX11Screen& getXScreenNumber() const { return m_nXScreen; }
int GetDisplayScreen() const { return maGeometry.nDisplayScreenNumber; }
void updateScreenNumber();
#if GTK_CHECK_VERSION(3,0,0)
// only for gtk3 ...
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* pDropTarget)
{
assert(m_pDropTarget == pDropTarget); (void)pDropTarget;
m_pDropTarget = nullptr;
}
void registerDragSource(GtkDragSource* pDragSource)
{
assert(!m_pDragSource);
m_pDragSource = pDragSource;
}
void deregisterDragSource(GtkDragSource* pDragSource)
{
assert(m_pDragSource == pDragSource); (void)pDragSource;
m_pDragSource = nullptr;
}
void SetFormatConversionRequest(GtkDnDTransferable *pRequest)
{
m_pFormatConversionRequest = pRequest;
}
void startDrag(gint nButton, gint nDragOriginX, gint nDragOriginY,
GdkDragAction sourceActions, GtkTargetList* pTargetList);
void closePopup();
void addGrabLevel();
void removeGrabLevel();
void nopaint_container_resize_children(GtkContainer*);
#endif
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(ImplSVEvent* 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 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_uLong 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;
#if GTK_CHECK_VERSION(3,0,0)
virtual void SetModal(bool bModal) override;
virtual bool ShowTooltip(const OUString& rHelpText, const tools::Rectangle& rHelpArea) override;
virtual sal_uIntPtr ShowPopover(const OUString& rHelpText, const tools::Rectangle& rHelpArea, QuickHelpFlags nFlags) override;
virtual bool UpdatePopover(sal_uIntPtr nId, const OUString& rHelpText, const tools::Rectangle& rHelpArea) override;
virtual bool HidePopover(sal_uIntPtr nId) override;
#endif
static GtkSalFrame *getFromWindow( GtkWindow *pWindow );
sal_uIntPtr GetNativeWindowHandle(GtkWidget *pWidget);
virtual sal_uIntPtr GetNativeWindowHandle() override;
//Call the usual SalFrame Callback, but catch uno exceptions and delegate
//to GtkData 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.
long 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);
};
#define OOO_TYPE_FIXED ooo_fixed_get_type()
extern "C" {
GType ooo_fixed_get_type();
AtkObject* ooo_fixed_get_accessible(GtkWidget *obj);
} // extern "C"
#endif // INCLUDED_VCL_INC_UNX_GTK_GTKFRAME_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|