1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/gtk/window.h
4 // Author: Robert Roebling
6 // Copyright: (c) 1998 Robert Roebling
7 // Licence: wxWindows licence
8 /////////////////////////////////////////////////////////////////////////////
10 #ifndef _WX_GTK_WINDOW_H_
11 #define _WX_GTK_WINDOW_H_
13 #include "wx/dynarray.h"
15 // helper structure that holds class that holds GtkIMContext object and
16 // some additional data needed for key events processing
19 WX_DEFINE_EXPORTED_ARRAY_PTR(GdkWindow
*, wxArrayGdkWindows
);
21 //-----------------------------------------------------------------------------
23 //-----------------------------------------------------------------------------
25 class WXDLLIMPEXP_CORE wxWindowGTK
: public wxWindowBase
28 // creating the window
29 // -------------------
31 wxWindowGTK(wxWindow
*parent
,
33 const wxPoint
& pos
= wxDefaultPosition
,
34 const wxSize
& size
= wxDefaultSize
,
36 const wxString
& name
= wxPanelNameStr
);
37 bool Create(wxWindow
*parent
,
39 const wxPoint
& pos
= wxDefaultPosition
,
40 const wxSize
& size
= wxDefaultSize
,
42 const wxString
& name
= wxPanelNameStr
);
43 virtual ~wxWindowGTK();
45 // implement base class (pure) virtual methods
46 // -------------------------------------------
48 virtual bool Destroy();
53 virtual bool Show( bool show
= true );
55 virtual void SetWindowStyleFlag( long style
);
57 virtual bool IsRetained() const;
59 virtual void SetFocus();
61 // hint from wx to native GTK+ tab traversal code
62 virtual void SetCanFocus(bool canFocus
);
64 virtual bool Reparent( wxWindowBase
*newParent
);
66 virtual void WarpPointer(int x
, int y
);
68 virtual void Refresh( bool eraseBackground
= true,
69 const wxRect
*rect
= (const wxRect
*) NULL
);
70 virtual void Update();
71 virtual void ClearBackground();
73 virtual bool SetBackgroundColour( const wxColour
&colour
);
74 virtual bool SetForegroundColour( const wxColour
&colour
);
75 virtual bool SetCursor( const wxCursor
&cursor
);
76 virtual bool SetFont( const wxFont
&font
);
78 virtual bool SetBackgroundStyle(wxBackgroundStyle style
) ;
80 virtual int GetCharHeight() const;
81 virtual int GetCharWidth() const;
83 virtual void SetScrollbar( int orient
, int pos
, int thumbVisible
,
84 int range
, bool refresh
= true );
85 virtual void SetScrollPos( int orient
, int pos
, bool refresh
= true );
86 virtual int GetScrollPos( int orient
) const;
87 virtual int GetScrollThumb( int orient
) const;
88 virtual int GetScrollRange( int orient
) const;
89 virtual void ScrollWindow( int dx
, int dy
,
90 const wxRect
* rect
= NULL
);
91 virtual bool ScrollLines(int lines
);
92 virtual bool ScrollPages(int pages
);
94 #if wxUSE_DRAG_AND_DROP
95 virtual void SetDropTarget( wxDropTarget
*dropTarget
);
96 #endif // wxUSE_DRAG_AND_DROP
98 virtual void AddChild( wxWindowBase
*child
);
99 virtual void RemoveChild( wxWindowBase
*child
);
101 virtual void SetLayoutDirection(wxLayoutDirection dir
);
102 virtual wxLayoutDirection
GetLayoutDirection() const;
103 virtual wxCoord
AdjustForLayoutDirection(wxCoord x
,
105 wxCoord widthTotal
) const;
107 virtual bool DoIsExposed( int x
, int y
) const;
108 virtual bool DoIsExposed( int x
, int y
, int w
, int h
) const;
110 // currently wxGTK2-only
111 void SetDoubleBuffered(bool on
);
112 virtual bool IsDoubleBuffered() const;
114 // SetLabel(), which does nothing in wxWindow
115 virtual void SetLabel(const wxString
& label
) { m_gtkLabel
= label
; }
116 virtual wxString
GetLabel() const { return m_gtkLabel
; }
121 virtual WXWidget
GetHandle() const { return m_widget
; }
123 // many important things are done here, this function must be called
125 virtual void OnInternalIdle();
127 // For compatibility across platforms (not in event table)
128 void OnIdle(wxIdleEvent
& WXUNUSED(event
)) {}
130 // Used by all window classes in the widget creation process.
131 bool PreCreation( wxWindowGTK
*parent
, const wxPoint
&pos
, const wxSize
&size
);
134 // Internal addition of child windows
135 void DoAddChild(wxWindowGTK
*child
);
137 // This methods sends wxPaintEvents to the window. It reads the
138 // update region, breaks it up into rects and sends an event
139 // for each rect. It is also responsible for background erase
140 // events and NC paint events. It is called from "draw" and
141 // "expose" handlers as well as from ::Update()
142 void GtkSendPaintEvents();
144 // The methods below are required because many native widgets
145 // are composed of several subwidgets and setting a style for
146 // the widget means setting it for all subwidgets as well.
147 // also, it is not clear which native widget is the top
148 // widget where (most of) the input goes. even tooltips have
149 // to be applied to all subwidgets.
150 virtual GtkWidget
* GetConnectWidget();
151 void ConnectWidget( GtkWidget
*widget
);
153 // Called from several event handlers, if it returns true or false, the
154 // same value should be immediately returned by the handler without doing
155 // anything else. If it returns -1, the handler should continue as usual
156 int GTKCallbackCommonPrologue(struct _GdkEventAny
*event
) const;
158 // Simplified form of GTKCallbackCommonPrologue() which can be used from
159 // GTK callbacks without return value to check if the event should be
160 // ignored: if this returns true, the event shouldn't be handled
161 bool GTKShouldIgnoreEvent() const;
164 // override this if some events should never be consumed by wxWidgets but
165 // but have to be left for the native control
167 // base version just calls HandleWindowEvent()
168 virtual bool GTKProcessEvent(wxEvent
& event
) const;
170 // Map GTK widget direction of the given widget to/from wxLayoutDirection
171 static wxLayoutDirection
GTKGetLayout(GtkWidget
*widget
);
172 static void GTKSetLayout(GtkWidget
*widget
, wxLayoutDirection dir
);
174 // return true if this window must have a non-NULL parent, false if it can
175 // be created without parent (normally only top level windows but in wxGTK
176 // there is also the exception of wxMenuBar)
177 virtual bool GTKNeedsParent() const { return !IsTopLevel(); }
179 // This is called when capture is taken from the window. It will
180 // fire off capture lost events.
181 void GTKReleaseMouseAndNotify();
183 GdkWindow
* GTKGetDrawingWindow() const;
185 bool GTKHandleFocusIn();
186 bool GTKHandleFocusOut();
187 void GTKHandleFocusOutNoDeferring();
188 static void GTKHandleDeferredFocusOut();
190 // Called when m_widget becomes realized. Derived classes must call the
191 // base class method if they override it.
192 virtual void GTKHandleRealized();
195 // for controls composed of multiple GTK widgets, return true to eliminate
196 // spurious focus events if the focus changes between GTK+ children within
198 virtual bool GTKNeedsToFilterSameWindowFocus() const { return false; }
200 // Override GTKWidgetNeedsMnemonic and return true if your
201 // needs to set its mnemonic widget, such as for a
202 // GtkLabel for wxStaticText, then do the actual
203 // setting of the widget inside GTKWidgetDoSetMnemonic
204 virtual bool GTKWidgetNeedsMnemonic() const;
205 virtual void GTKWidgetDoSetMnemonic(GtkWidget
* w
);
207 // Get the GdkWindows making part of this window: usually there will be
208 // only one of them in which case it should be returned directly by this
209 // function. If there is more than one GdkWindow (can be the case for
210 // composite widgets), return NULL and fill in the provided array
212 // This is not pure virtual for backwards compatibility but almost
213 // certainly must be overridden in any wxControl-derived class!
214 virtual GdkWindow
*GTKGetWindow(wxArrayGdkWindows
& windows
) const;
216 // Check if the given window makes part of this widget
217 bool GTKIsOwnWindow(GdkWindow
*window
) const;
220 // Returns the default context which usually is anti-aliased
221 PangoContext
*GTKGetPangoDefaultContext();
224 // applies tooltip to the widget (tip must be UTF-8 encoded)
225 virtual void GTKApplyToolTip(const char* tip
);
226 #endif // wxUSE_TOOLTIPS
228 // Called when a window should delay showing itself
229 // until idle time used in Reparent().
230 void GTKShowOnIdle() { m_showOnIdle
= true; }
232 // This is called from the various OnInternalIdle methods
233 bool GTKShowFromOnIdle();
235 // is this window transparent for the mouse events (as wxStaticBox is)?
236 virtual bool GTKIsTransparentForMouse() const { return false; }
238 // Common scroll event handling code for wxWindow and wxScrollBar
239 wxEventType
GTKGetScrollEventType(GtkRange
* range
);
241 // position and size of the window
243 int m_width
, m_height
;
244 int m_oldClientWidth
,m_oldClientHeight
;
246 // see the docs in src/gtk/window.cpp
247 GtkWidget
*m_widget
; // mostly the widget seen by the rest of GTK
248 GtkWidget
*m_wxwindow
; // mostly the client area as per wxWidgets
250 // label for use with GetLabelSetLabel
253 // return true if the window is of a standard (i.e. not wxWidgets') class
254 bool IsOfStandardClass() const { return m_wxwindow
== NULL
; }
256 // this widget will be queried for GTK's focus events
257 GtkWidget
*m_focusWidget
;
259 void GTKDisableFocusOutEvent();
260 void GTKEnableFocusOutEvent();
262 wxGtkIMData
*m_imData
;
265 // indices for the arrays below
266 enum ScrollDir
{ ScrollDir_Horz
, ScrollDir_Vert
, ScrollDir_Max
};
268 // horizontal/vertical scroll bar
269 GtkRange
* m_scrollBar
[ScrollDir_Max
];
271 // horizontal/vertical scroll position
272 double m_scrollPos
[ScrollDir_Max
];
274 // return the scroll direction index corresponding to the given orientation
275 // (which is wxVERTICAL or wxHORIZONTAL)
276 static ScrollDir
ScrollDirFromOrient(int orient
)
278 return orient
== wxVERTICAL
? ScrollDir_Vert
: ScrollDir_Horz
;
281 // return the orientation for the given scrolling direction
282 static int OrientFromScrollDir(ScrollDir dir
)
284 return dir
== ScrollDir_Horz
? wxHORIZONTAL
: wxVERTICAL
;
287 // find the direction of the given scrollbar (must be one of ours)
288 ScrollDir
ScrollDirFromRange(GtkRange
*range
) const;
290 // set the current cursor for all GdkWindows making part of this widget
291 // (see GTKGetWindow)
292 void GTKUpdateCursor(bool update_self
= true, bool recurse
= true);
294 // extra (wxGTK-specific) flags
295 bool m_noExpose
:1; // wxGLCanvas has its own redrawing
296 bool m_nativeSizeEvent
:1; // wxGLCanvas sends wxSizeEvent upon "alloc_size"
297 bool m_hasVMT
:1; // set after PostCreation() is called
298 bool m_isScrolling
:1; // dragging scrollbar thumb?
299 bool m_clipPaintRegion
:1; // true after ScrollWindow()
300 wxRegion m_nativeUpdateRegion
; // not transformed for RTL
301 bool m_dirtyTabOrder
:1; // tab order changed, GTK focus
302 // chain needs update
303 bool m_needsStyleChange
:1; // May not be able to change
304 // background style until OnIdle
305 bool m_mouseButtonDown
:1;
307 bool m_showOnIdle
:1; // postpone showing the window until idle
310 // implement the base class pure virtuals
311 virtual void DoGetTextExtent(const wxString
& string
,
314 int *externalLeading
= NULL
,
315 const wxFont
*font
= NULL
) const;
316 virtual void DoClientToScreen( int *x
, int *y
) const;
317 virtual void DoScreenToClient( int *x
, int *y
) const;
318 virtual void DoGetPosition( int *x
, int *y
) const;
319 virtual void DoGetSize( int *width
, int *height
) const;
320 virtual void DoGetClientSize( int *width
, int *height
) const;
321 virtual void DoSetSize(int x
, int y
,
322 int width
, int height
,
323 int sizeFlags
= wxSIZE_AUTO
);
324 virtual void DoSetClientSize(int width
, int height
);
325 virtual wxSize
DoGetBorderSize() const;
326 virtual void DoMoveWindow(int x
, int y
, int width
, int height
);
327 virtual void DoEnable(bool enable
);
329 #if wxUSE_MENUS_NATIVE
330 virtual bool DoPopupMenu( wxMenu
*menu
, int x
, int y
);
331 #endif // wxUSE_MENUS_NATIVE
333 virtual void DoCaptureMouse();
334 virtual void DoReleaseMouse();
336 virtual void DoFreeze();
337 virtual void DoThaw();
339 void GTKFreezeWidget(GtkWidget
*w
);
340 void GTKThawWidget(GtkWidget
*w
);
343 virtual void DoSetToolTip( wxToolTip
*tip
);
344 #endif // wxUSE_TOOLTIPS
346 // common part of all ctors (not virtual because called from ctor)
349 virtual void DoMoveInTabOrder(wxWindow
*win
, WindowOrder move
);
350 virtual bool DoNavigateIn(int flags
);
353 // Copies m_children tab order to GTK focus chain:
354 void RealizeTabOrder();
356 // Called by ApplyWidgetStyle (which is called by SetFont() and
357 // SetXXXColour etc to apply style changed to native widgets) to create
358 // modified GTK style with non-standard attributes. If forceStyle=true,
359 // creates empty GtkRcStyle if there are no modifications, otherwise
360 // returns NULL in such case.
361 GtkRcStyle
*GTKCreateWidgetStyle(bool forceStyle
= false);
363 // Overridden in many GTK widgets who have to handle subwidgets
364 virtual void GTKApplyWidgetStyle(bool forceStyle
= false);
366 // helper function to ease native widgets wrapping, called by
367 // ApplyWidgetStyle -- override this, not ApplyWidgetStyle
368 virtual void DoApplyWidgetStyle(GtkRcStyle
*style
);
370 // sets the border of a given GtkScrolledWindow from a wx style
371 static void GTKScrolledWindowSetBorder(GtkWidget
* w
, int style
);
373 // Connect the given function to the specified signal on m_widget.
375 // This is just a wrapper for g_signal_connect() and returns the handler id
377 unsigned long GTKConnectWidget(const char *signal
, void (*callback
)());
379 // Return true from here if PostCreation() should connect to size_request
380 // signal: this is done by default but doesn't work for some native
381 // controls which override this function to return false
382 virtual bool GTKShouldConnectSizeRequest() const { return !IsTopLevel(); }
384 void ConstrainSize();
387 enum ScrollUnit
{ ScrollUnit_Line
, ScrollUnit_Page
, ScrollUnit_Max
};
389 // common part of ScrollLines() and ScrollPages() and could be used, in the
390 // future, for horizontal scrolling as well
392 // return true if we scrolled, false otherwise (on error or simply if we
393 // are already at the end)
394 bool DoScrollByUnits(ScrollDir dir
, ScrollUnit unit
, int units
);
395 virtual void AddChildGTK(wxWindowGTK
* child
);
398 DECLARE_DYNAMIC_CLASS(wxWindowGTK
)
399 wxDECLARE_NO_COPY_CLASS(wxWindowGTK
);
402 #endif // _WX_GTK_WINDOW_H_