]> git.saurik.com Git - wxWidgets.git/blame - include/wx/gtk/window.h
don't draw borders for bitmap buttons with wxBORDER_NONE style
[wxWidgets.git] / include / wx / gtk / window.h
CommitLineData
c801d85f 1/////////////////////////////////////////////////////////////////////////////
1e6feb95 2// Name: wx/gtk/window.h
c801d85f
KB
3// Purpose:
4// Author: Robert Roebling
58614078
RR
5// Id: $Id$
6// Copyright: (c) 1998 Robert Roebling
65571936 7// Licence: wxWindows licence
c801d85f
KB
8/////////////////////////////////////////////////////////////////////////////
9
ef5c70f9
VZ
10#ifndef _WX_GTK_WINDOW_H_
11#define _WX_GTK_WINDOW_H_
12
13#include "wx/dynarray.h"
c801d85f 14
a3c15d89
VS
15// helper structure that holds class that holds GtkIMContext object and
16// some additional data needed for key events processing
17struct wxGtkIMData;
18
ef5c70f9
VZ
19WX_DEFINE_EXPORTED_ARRAY_PTR(GdkWindow *, wxArrayGdkWindows);
20
c801d85f 21//-----------------------------------------------------------------------------
1e6feb95 22// wxWindowGTK
c801d85f
KB
23//-----------------------------------------------------------------------------
24
20123d49 25class WXDLLIMPEXP_CORE wxWindowGTK : public wxWindowBase
c801d85f 26{
aed8df38 27public:
bfc6fde4
VZ
28 // creating the window
29 // -------------------
1e6feb95
VZ
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);
f03fc89f
VZ
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);
1e6feb95 43 virtual ~wxWindowGTK();
cd0183ca 44
f03fc89f
VZ
45 // implement base class (pure) virtual methods
46 // -------------------------------------------
a264ece2 47
4292eeb4 48 virtual void SetLabel(const wxString& WXUNUSED(label)) { }
5bc3865f 49 virtual wxString GetLabel() const { return wxEmptyString; }
2ea5111b 50
bfc6fde4 51 virtual bool Destroy();
bfc6fde4 52
f03fc89f
VZ
53 virtual void Raise();
54 virtual void Lower();
ff8bfdbb 55
5bc3865f 56 virtual bool Show( bool show = true );
ff8bfdbb 57
015dca24
MR
58 virtual void SetWindowStyleFlag( long style );
59
f03fc89f 60 virtual bool IsRetained() const;
2f2aa628 61
bfc6fde4 62 virtual void SetFocus();
cca410b3 63
00ff24c8 64 // hint from wx to native GTK+ tab traversal code
80332672 65 virtual void SetCanFocus(bool canFocus);
ff8bfdbb 66
fdb7dadb 67 virtual bool Reparent( wxWindowBase *newParent );
ff8bfdbb 68
f03fc89f 69 virtual void WarpPointer(int x, int y);
b1170810 70
5bc3865f 71 virtual void Refresh( bool eraseBackground = true,
f03fc89f 72 const wxRect *rect = (const wxRect *) NULL );
beab25bd 73 virtual void Update();
596f1d11 74 virtual void ClearBackground();
bfc6fde4 75
f03fc89f
VZ
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 );
cd0183ca 80
c7382f91 81 virtual bool SetBackgroundStyle(wxBackgroundStyle style) ;
f26623c8 82
bfc6fde4
VZ
83 virtual int GetCharHeight() const;
84 virtual int GetCharWidth() const;
aed8df38 85
f03fc89f 86 virtual void SetScrollbar( int orient, int pos, int thumbVisible,
5bc3865f
WS
87 int range, bool refresh = true );
88 virtual void SetScrollPos( int orient, int pos, bool refresh = true );
f03fc89f
VZ
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,
d3b9f782 93 const wxRect* rect = NULL );
0c131a5a
VZ
94 virtual bool ScrollLines(int lines);
95 virtual bool ScrollPages(int pages);
8bbe427f 96
f03fc89f
VZ
97#if wxUSE_DRAG_AND_DROP
98 virtual void SetDropTarget( wxDropTarget *dropTarget );
99#endif // wxUSE_DRAG_AND_DROP
f26623c8 100
a589495e
VS
101 virtual void AddChild( wxWindowBase *child );
102 virtual void RemoveChild( wxWindowBase *child );
8bbe427f 103
978af864
VZ
104 virtual void SetLayoutDirection(wxLayoutDirection dir);
105 virtual wxLayoutDirection GetLayoutDirection() const;
fe92a9d6
RR
106 virtual wxCoord AdjustForLayoutDirection(wxCoord x,
107 wxCoord width,
108 wxCoord widthTotal) const;
978af864 109
657b4fd4
RD
110 virtual bool DoIsExposed( int x, int y ) const;
111 virtual bool DoIsExposed( int x, int y, int w, int h ) const;
847dfdb4 112
8e1a5bf9
VZ
113 // currently wxGTK2-only
114 void SetDoubleBuffered(bool on);
2e992e06 115 virtual bool IsDoubleBuffered() const;
8e1a5bf9 116
f03fc89f
VZ
117 // implementation
118 // --------------
c801d85f 119
d7c24517
VZ
120 virtual WXWidget GetHandle() const { return m_widget; }
121
ef5c70f9
VZ
122 // many important things are done here, this function must be called
123 // regularly
bfc6fde4 124 virtual void OnInternalIdle();
ff8bfdbb 125
beab25bd
RR
126 // For compatibility across platforms (not in event table)
127 void OnIdle(wxIdleEvent& WXUNUSED(event)) {}
20e85460 128
beab25bd 129 // Used by all window classes in the widget creation process.
1e6feb95 130 bool PreCreation( wxWindowGTK *parent, const wxPoint &pos, const wxSize &size );
bfc6fde4 131 void PostCreation();
ff8bfdbb 132
48200154 133 // Internal addition of child windows
1e6feb95 134 void DoAddChild(wxWindowGTK *child);
f26623c8 135
beab25bd
RR
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.
90e572f1 146 // also, it is not clear which native widget is the top
beab25bd
RR
147 // widget where (most of) the input goes. even tooltips have
148 // to be applied to all subwidgets.
bfc6fde4 149 virtual GtkWidget* GetConnectWidget();
bfc6fde4 150 void ConnectWidget( GtkWidget *widget );
8bbe427f 151
5478f221
VZ
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;
ef5c70f9 156
02bad830
VZ
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
97687291
VZ
163 // override this if some events should never be consumed by wxWidgets but
164 // but have to be left for the native control
165 //
004867db 166 // base version just calls HandleWindowEvent()
97687291
VZ
167 virtual bool GTKProcessEvent(wxEvent& event) const;
168
978af864
VZ
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
e8375af8
VZ
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
004867db 178 // This is called when capture is taken from the window. It will
7738af59
VZ
179 // fire off capture lost events.
180 void GTKReleaseMouseAndNotify();
181
08f53168
PC
182 GdkWindow* GTKGetDrawingWindow() const;
183
bd2e08d0
VS
184 bool GTKHandleFocusIn();
185 bool GTKHandleFocusOut();
186 void GTKHandleFocusOutNoDeferring();
187 static void GTKHandleDeferredFocusOut();
188
cb3db090 189protected:
bd2e08d0
VS
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
2e1f5012 195 // Override GTKWidgetNeedsMnemonic and return true if your
28e88942 196 // needs to set its mnemonic widget, such as for a
2e1f5012
VZ
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
ef5c70f9
VZ
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
cb3db090 214public:
2b5f62a0 215 // Returns the default context which usually is anti-aliased
496e7ec6 216 PangoContext *GTKGetPangoDefaultContext();
2b5f62a0 217
ff8bfdbb 218#if wxUSE_TOOLTIPS
6e5f6c7c 219 // applies tooltip to the widget (tip must be UTF-8 encoded)
7fc8b9a4 220 virtual void GTKApplyToolTip( GtkTooltips *tips, const gchar *tip );
ff8bfdbb 221#endif // wxUSE_TOOLTIPS
301cd871 222
f46ad98f 223 // Called when a window should delay showing itself
71ead4bf
RR
224 // until idle time used in Reparent().
225 void GTKShowOnIdle() { m_showOnIdle = true; }
28e88942 226
7317857d 227 // This is called from the various OnInternalIdle methods
71ead4bf 228 bool GTKShowFromOnIdle();
3ae4c570 229
d1f2ac45 230 // is this window transparent for the mouse events (as wxStaticBox is)?
71ead4bf 231 virtual bool GTKIsTransparentForMouse() const { return false; }
d1f2ac45 232
add7cadd 233 // Common scroll event handling code for wxWindow and wxScrollBar
71ead4bf 234 wxEventType GTKGetScrollEventType(GtkRange* range);
add7cadd 235
f03fc89f
VZ
236 // position and size of the window
237 int m_x, m_y;
238 int m_width, m_height;
5b8a521e 239 int m_oldClientWidth,m_oldClientHeight;
bcf1fa6b 240
76fcf0f2
RR
241 // see the docs in src/gtk/window.cpp
242 GtkWidget *m_widget; // mostly the widget seen by the rest of GTK
77ffb593 243 GtkWidget *m_wxwindow; // mostly the client area as per wxWidgets
94633ad9 244
da1bd25f
RR
245 // return true if the window is of a standard (i.e. not wxWidgets') class
246 bool IsOfStandardClass() const { return m_wxwindow == NULL; }
cca410b3 247
76fcf0f2
RR
248 // this widget will be queried for GTK's focus events
249 GtkWidget *m_focusWidget;
004867db 250
36a845fe
RR
251 void GTKDisableFocusOutEvent();
252 void GTKEnableFocusOutEvent();
f03fc89f 253
a3c15d89 254 wxGtkIMData *m_imData;
3bcc8d15 255
22c9b211
VZ
256
257 // indices for the arrays below
258 enum ScrollDir { ScrollDir_Horz, ScrollDir_Vert, ScrollDir_Max };
259
add7cadd 260 // horizontal/vertical scroll bar
22c9b211
VZ
261 GtkRange* m_scrollBar[ScrollDir_Max];
262
add7cadd 263 // horizontal/vertical scroll position
22c9b211
VZ
264 double m_scrollPos[ScrollDir_Max];
265
22c9b211
VZ
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
f03fc89f 282 // extra (wxGTK-specific) flags
76fcf0f2
RR
283 bool m_noExpose:1; // wxGLCanvas has its own redrawing
284 bool m_nativeSizeEvent:1; // wxGLCanvas sends wxSizeEvent upon "alloc_size"
02bad830 285 bool m_hasVMT:1; // set after PostCreation() is called
6cad4f1b 286 bool m_isScrolling:1; // dragging scrollbar thumb?
5bc3865f 287 bool m_clipPaintRegion:1; // true after ScrollWindow()
bcb614b3 288 wxRegion m_nativeUpdateRegion; // not transformed for RTL
a589495e
VS
289 bool m_dirtyTabOrder:1; // tab order changed, GTK focus
290 // chain needs update
c7382f91
JS
291 bool m_needsStyleChange:1; // May not be able to change
292 // background style until OnIdle
add7cadd 293 bool m_mouseButtonDown:1;
28e88942 294
f46ad98f 295 bool m_showOnIdle:1; // postpone showing the window until idle
7af6f327 296
c821db16 297protected:
f03fc89f 298 // implement the base class pure virtuals
6de70470
VZ
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;
dabc0cd5
VZ
304 virtual void DoClientToScreen( int *x, int *y ) const;
305 virtual void DoScreenToClient( int *x, int *y ) const;
f03fc89f
VZ
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;
bfc6fde4
VZ
309 virtual void DoSetSize(int x, int y,
310 int width, int height,
311 int sizeFlags = wxSIZE_AUTO);
bfc6fde4 312 virtual void DoSetClientSize(int width, int height);
9d9b7755 313 virtual void DoMoveWindow(int x, int y, int width, int height);
c821db16 314 virtual void DoEnable(bool enable);
aed8df38 315
6f02a879
VZ
316#if wxUSE_MENUS_NATIVE
317 virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
318#endif // wxUSE_MENUS_NATIVE
319
94633ad9
VZ
320 virtual void DoCaptureMouse();
321 virtual void DoReleaseMouse();
f26623c8 322
5f346ddc
VS
323 virtual void DoFreeze();
324 virtual void DoThaw();
325
326 static void GTKFreezeWidget(GtkWidget *w);
327 static void GTKThawWidget(GtkWidget *w);
328
f03fc89f
VZ
329#if wxUSE_TOOLTIPS
330 virtual void DoSetToolTip( wxToolTip *tip );
331#endif // wxUSE_TOOLTIPS
332
3ae4c570 333 // common part of all ctors (not virtual because called from ctor)
f03fc89f 334 void Init();
f26623c8 335
915bd4e4 336 virtual void DoMoveInTabOrder(wxWindow *win, WindowOrder move);
5644933f
VZ
337 virtual bool DoNavigateIn(int flags);
338
a589495e
VS
339
340 // Copies m_children tab order to GTK focus chain:
341 void RealizeTabOrder();
f26623c8 342
f40fdaa3
VS
343 // Called by ApplyWidgetStyle (which is called by SetFont() and
344 // SetXXXColour etc to apply style changed to native widgets) to create
5edef14e
VS
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.
496e7ec6 348 GtkRcStyle *GTKCreateWidgetStyle(bool forceStyle = false);
f40fdaa3
VS
349
350 // Overridden in many GTK widgets who have to handle subwidgets
496e7ec6 351 virtual void GTKApplyWidgetStyle(bool forceStyle = false);
f26623c8 352
5bc3865f 353 // helper function to ease native widgets wrapping, called by
7074ce35
VS
354 // ApplyWidgetStyle -- override this, not ApplyWidgetStyle
355 virtual void DoApplyWidgetStyle(GtkRcStyle *style);
f03fc89f 356
6493aaca 357 // sets the border of a given GtkScrolledWindow from a wx style
496e7ec6 358 static void GTKScrolledWindowSetBorder(GtkWidget* w, int style);
6493aaca 359
ef5c70f9
VZ
360 // set the current cursor for all GdkWindows making part of this widget
361 // (see GTKGetWindow)
2f262021 362 //
ef5c70f9
VZ
363 // should be called from OnInternalIdle() if it's overridden
364 void GTKUpdateCursor();
365
82008f15
PC
366 void ConstrainSize();
367
68dda785 368private:
22c9b211
VZ
369 enum ScrollUnit { ScrollUnit_Line, ScrollUnit_Page, ScrollUnit_Max };
370
371 // common part of ScrollLines() and ScrollPages() and could be used, in the
372 // future, for horizontal scrolling as well
373 //
374 // return true if we scrolled, false otherwise (on error or simply if we
375 // are already at the end)
376 bool DoScrollByUnits(ScrollDir dir, ScrollUnit unit, int units);
48200154 377 virtual void AddChildGTK(wxWindowGTK* child);
22c9b211
VZ
378
379
1e6feb95 380 DECLARE_DYNAMIC_CLASS(wxWindowGTK)
c0c133e1 381 wxDECLARE_NO_COPY_CLASS(wxWindowGTK);
c801d85f
KB
382};
383
ef5c70f9 384#endif // _WX_GTK_WINDOW_H_