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