]> git.saurik.com Git - wxWidgets.git/blame - include/wx/gtk/window.h
Applied patch which allows you to detach a stream
[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
6ca41e57 21//-----------------------------------------------------------------------------
fd0eed64 22// callback definition for inserting a window (internal)
6ca41e57
RR
23//-----------------------------------------------------------------------------
24
20123d49 25class WXDLLIMPEXP_CORE wxWindowGTK;
1e6feb95 26typedef void (*wxInsertChildFunction)( wxWindowGTK*, wxWindowGTK* );
6ca41e57 27
c801d85f 28//-----------------------------------------------------------------------------
1e6feb95 29// wxWindowGTK
c801d85f
KB
30//-----------------------------------------------------------------------------
31
20123d49 32class WXDLLIMPEXP_CORE wxWindowGTK : public wxWindowBase
c801d85f 33{
aed8df38 34public:
bfc6fde4
VZ
35 // creating the window
36 // -------------------
1e6feb95
VZ
37 wxWindowGTK();
38 wxWindowGTK(wxWindow *parent,
39 wxWindowID id,
40 const wxPoint& pos = wxDefaultPosition,
41 const wxSize& size = wxDefaultSize,
42 long style = 0,
43 const wxString& name = wxPanelNameStr);
f03fc89f
VZ
44 bool Create(wxWindow *parent,
45 wxWindowID id,
46 const wxPoint& pos = wxDefaultPosition,
47 const wxSize& size = wxDefaultSize,
48 long style = 0,
49 const wxString& name = wxPanelNameStr);
1e6feb95 50 virtual ~wxWindowGTK();
cd0183ca 51
f03fc89f
VZ
52 // implement base class (pure) virtual methods
53 // -------------------------------------------
a264ece2 54
4292eeb4 55 virtual void SetLabel(const wxString& WXUNUSED(label)) { }
5bc3865f 56 virtual wxString GetLabel() const { return wxEmptyString; }
2ea5111b 57
bfc6fde4 58 virtual bool Destroy();
bfc6fde4 59
f03fc89f
VZ
60 virtual void Raise();
61 virtual void Lower();
ff8bfdbb 62
5bc3865f
WS
63 virtual bool Show( bool show = true );
64 virtual bool Enable( bool enable = true );
ff8bfdbb 65
015dca24
MR
66 virtual void SetWindowStyleFlag( long style );
67
f03fc89f 68 virtual bool IsRetained() const;
2f2aa628 69
bfc6fde4 70 virtual void SetFocus();
f03fc89f 71 virtual bool AcceptsFocus() const;
ff8bfdbb 72
fdb7dadb 73 virtual bool Reparent( wxWindowBase *newParent );
ff8bfdbb 74
f03fc89f 75 virtual void WarpPointer(int x, int y);
b1170810 76
5bc3865f 77 virtual void Refresh( bool eraseBackground = true,
f03fc89f 78 const wxRect *rect = (const wxRect *) NULL );
beab25bd 79 virtual void Update();
596f1d11 80 virtual void ClearBackground();
bfc6fde4 81
f03fc89f
VZ
82 virtual bool SetBackgroundColour( const wxColour &colour );
83 virtual bool SetForegroundColour( const wxColour &colour );
84 virtual bool SetCursor( const wxCursor &cursor );
85 virtual bool SetFont( const wxFont &font );
cd0183ca 86
c7382f91 87 virtual bool SetBackgroundStyle(wxBackgroundStyle style) ;
f26623c8 88
bfc6fde4
VZ
89 virtual int GetCharHeight() const;
90 virtual int GetCharWidth() const;
f03fc89f
VZ
91 virtual void GetTextExtent(const wxString& string,
92 int *x, int *y,
93 int *descent = (int *) NULL,
94 int *externalLeading = (int *) NULL,
95 const wxFont *theFont = (const wxFont *) NULL)
96 const;
aed8df38 97
f03fc89f 98 virtual void SetScrollbar( int orient, int pos, int thumbVisible,
5bc3865f
WS
99 int range, bool refresh = true );
100 virtual void SetScrollPos( int orient, int pos, bool refresh = true );
f03fc89f
VZ
101 virtual int GetScrollPos( int orient ) const;
102 virtual int GetScrollThumb( int orient ) const;
103 virtual int GetScrollRange( int orient ) const;
104 virtual void ScrollWindow( int dx, int dy,
105 const wxRect* rect = (wxRect *) NULL );
0c131a5a
VZ
106 virtual bool ScrollLines(int lines);
107 virtual bool ScrollPages(int pages);
8bbe427f 108
f03fc89f
VZ
109#if wxUSE_DRAG_AND_DROP
110 virtual void SetDropTarget( wxDropTarget *dropTarget );
111#endif // wxUSE_DRAG_AND_DROP
f26623c8 112
a589495e
VS
113 virtual void AddChild( wxWindowBase *child );
114 virtual void RemoveChild( wxWindowBase *child );
8bbe427f 115
978af864
VZ
116 virtual void SetLayoutDirection(wxLayoutDirection dir);
117 virtual wxLayoutDirection GetLayoutDirection() const;
118
8e1a5bf9
VZ
119 // currently wxGTK2-only
120 void SetDoubleBuffered(bool on);
121
f03fc89f
VZ
122 // implementation
123 // --------------
c801d85f 124
d7c24517
VZ
125 virtual WXWidget GetHandle() const { return m_widget; }
126
ef5c70f9
VZ
127 // many important things are done here, this function must be called
128 // regularly
bfc6fde4 129 virtual void OnInternalIdle();
ff8bfdbb 130
010afced
RR
131 // Internal represention of Update()
132 void GtkUpdate();
f26623c8 133
beab25bd
RR
134 // For compatibility across platforms (not in event table)
135 void OnIdle(wxIdleEvent& WXUNUSED(event)) {}
20e85460 136
fdca68a6 137 // wxGTK-specific: called recursively by Enable,
90e572f1 138 // to give widgets an opportunity to correct their colours after they
fdca68a6 139 // have been changed by Enable
beab25bd 140 virtual void OnParentEnable( bool WXUNUSED(enable) ) {}
fdca68a6 141
beab25bd 142 // Used by all window classes in the widget creation process.
1e6feb95 143 bool PreCreation( wxWindowGTK *parent, const wxPoint &pos, const wxSize &size );
bfc6fde4 144 void PostCreation();
ff8bfdbb 145
beab25bd
RR
146 // Internal addition of child windows. differs from class
147 // to class not by using virtual functions but by using
148 // the m_insertCallback.
1e6feb95 149 void DoAddChild(wxWindowGTK *child);
f26623c8 150
beab25bd
RR
151 // This methods sends wxPaintEvents to the window. It reads the
152 // update region, breaks it up into rects and sends an event
153 // for each rect. It is also responsible for background erase
154 // events and NC paint events. It is called from "draw" and
155 // "expose" handlers as well as from ::Update()
156 void GtkSendPaintEvents();
157
158 // The methods below are required because many native widgets
159 // are composed of several subwidgets and setting a style for
160 // the widget means setting it for all subwidgets as well.
90e572f1 161 // also, it is not clear which native widget is the top
beab25bd
RR
162 // widget where (most of) the input goes. even tooltips have
163 // to be applied to all subwidgets.
bfc6fde4 164 virtual GtkWidget* GetConnectWidget();
bfc6fde4 165 void ConnectWidget( GtkWidget *widget );
8bbe427f 166
5478f221
VZ
167 // Called from several event handlers, if it returns true or false, the
168 // same value should be immediately returned by the handler without doing
169 // anything else. If it returns -1, the handler should continue as usual
170 int GTKCallbackCommonPrologue(struct _GdkEventAny *event) const;
ef5c70f9 171
97687291
VZ
172 // override this if some events should never be consumed by wxWidgets but
173 // but have to be left for the native control
174 //
175 // base version just does GetEventHandler()->ProcessEvent()
176 virtual bool GTKProcessEvent(wxEvent& event) const;
177
978af864
VZ
178 // Map GTK widget direction of the given widget to/from wxLayoutDirection
179 static wxLayoutDirection GTKGetLayout(GtkWidget *widget);
180 static void GTKSetLayout(GtkWidget *widget, wxLayoutDirection dir);
181
cb3db090 182protected:
2e1f5012
VZ
183 // Override GTKWidgetNeedsMnemonic and return true if your
184 // needs to set its mnemonic widget, such as for a
185 // GtkLabel for wxStaticText, then do the actual
186 // setting of the widget inside GTKWidgetDoSetMnemonic
187 virtual bool GTKWidgetNeedsMnemonic() const;
188 virtual void GTKWidgetDoSetMnemonic(GtkWidget* w);
189
ef5c70f9
VZ
190 // Get the GdkWindows making part of this window: usually there will be
191 // only one of them in which case it should be returned directly by this
192 // function. If there is more than one GdkWindow (can be the case for
193 // composite widgets), return NULL and fill in the provided array
194 //
195 // This is not pure virtual for backwards compatibility but almost
196 // certainly must be overridden in any wxControl-derived class!
197 virtual GdkWindow *GTKGetWindow(wxArrayGdkWindows& windows) const;
198
199 // Check if the given window makes part of this widget
200 bool GTKIsOwnWindow(GdkWindow *window) const;
201
202 // Set the focus to this window if its setting was delayed because the
203 // widget hadn't been realized when SetFocus() was called
204 //
205 // Return true if focus was set to us, false if nothing was done
206 bool GTKSetDelayedFocusIfNeeded();
207
cb3db090 208public:
2b5f62a0
VZ
209 // Returns the default context which usually is anti-aliased
210 PangoContext *GtkGetPangoDefaultContext();
2b5f62a0 211
ff8bfdbb 212#if wxUSE_TOOLTIPS
74ce55e9 213 virtual void ApplyToolTip( GtkTooltips *tips, const wxChar *tip );
ff8bfdbb 214#endif // wxUSE_TOOLTIPS
301cd871 215
90e572f1 216 // Called from GTK signal handlers. it indicates that
739730ca
RR
217 // the layouting functions have to be called later on
218 // (i.e. in idle time, implemented in OnInternalIdle() ).
5bc3865f 219 void GtkUpdateSize() { m_sizeSet = false; }
f46ad98f
RR
220
221
222 // Called when a window should delay showing itself
223 // until idle time. This partly mimmicks defered
224 // sizing under MSW.
225 void GtkShowOnIdle() { m_showOnIdle = true; }
7317857d
RR
226
227 // This is called from the various OnInternalIdle methods
228 bool GtkShowFromOnIdle();
94633ad9 229
3ae4c570
VZ
230 // fix up the mouse event coords, used by wxListBox only so far
231 virtual void FixUpMouseEvent(GtkWidget * WXUNUSED(widget),
232 wxCoord& WXUNUSED(x),
233 wxCoord& WXUNUSED(y)) { }
234
d1f2ac45 235 // is this window transparent for the mouse events (as wxStaticBox is)?
5bc3865f 236 virtual bool IsTransparentForMouse() const { return false; }
d1f2ac45 237
2b4f3c9f 238 // is this a radiobutton (used by radiobutton code itself only)?
5bc3865f 239 virtual bool IsRadioButton() const { return false; }
2b4f3c9f 240
add7cadd
PC
241 // Common scroll event handling code for wxWindow and wxScrollBar
242 wxEventType GetScrollEventType(GtkRange* range);
243
a01ed326
PC
244 void BlockScrollEvent();
245 void UnblockScrollEvent();
246
f03fc89f
VZ
247 // position and size of the window
248 int m_x, m_y;
249 int m_width, m_height;
5b8a521e 250 int m_oldClientWidth,m_oldClientHeight;
bcf1fa6b 251
76fcf0f2
RR
252 // see the docs in src/gtk/window.cpp
253 GtkWidget *m_widget; // mostly the widget seen by the rest of GTK
77ffb593 254 GtkWidget *m_wxwindow; // mostly the client area as per wxWidgets
94633ad9 255
76fcf0f2
RR
256 // this widget will be queried for GTK's focus events
257 GtkWidget *m_focusWidget;
f03fc89f 258
a3c15d89 259 wxGtkIMData *m_imData;
3bcc8d15 260
22c9b211
VZ
261
262 // indices for the arrays below
263 enum ScrollDir { ScrollDir_Horz, ScrollDir_Vert, ScrollDir_Max };
264
add7cadd 265 // horizontal/vertical scroll bar
22c9b211
VZ
266 GtkRange* m_scrollBar[ScrollDir_Max];
267
add7cadd 268 // horizontal/vertical scroll position
22c9b211
VZ
269 double m_scrollPos[ScrollDir_Max];
270
271 // if true, don't notify about adjustment change (without resetting the
272 // flag, so this has to be done manually)
273 bool m_blockValueChanged[ScrollDir_Max];
274
275 // return the scroll direction index corresponding to the given orientation
276 // (which is wxVERTICAL or wxHORIZONTAL)
277 static ScrollDir ScrollDirFromOrient(int orient)
278 {
279 return orient == wxVERTICAL ? ScrollDir_Vert : ScrollDir_Horz;
280 }
281
282 // return the orientation for the given scrolling direction
283 static int OrientFromScrollDir(ScrollDir dir)
284 {
285 return dir == ScrollDir_Horz ? wxHORIZONTAL : wxVERTICAL;
286 }
287
288 // find the direction of the given scrollbar (must be one of ours)
289 ScrollDir ScrollDirFromRange(GtkRange *range) const;
290
739730ca 291
f03fc89f 292 // extra (wxGTK-specific) flags
76fcf0f2
RR
293 bool m_needParent:1; // ! wxFrame, wxDialog, wxNotebookPage ?
294 bool m_noExpose:1; // wxGLCanvas has its own redrawing
295 bool m_nativeSizeEvent:1; // wxGLCanvas sends wxSizeEvent upon "alloc_size"
f03fc89f 296 bool m_hasScrolling:1;
f03fc89f
VZ
297 bool m_hasVMT:1;
298 bool m_sizeSet:1;
299 bool m_resizing:1;
6cad4f1b
VZ
300 bool m_acceptsFocus:1; // true if not static
301 bool m_hasFocus:1; // true if == FindFocus()
302 bool m_isScrolling:1; // dragging scrollbar thumb?
5bc3865f 303 bool m_clipPaintRegion:1; // true after ScrollWindow()
a589495e
VS
304 bool m_dirtyTabOrder:1; // tab order changed, GTK focus
305 // chain needs update
c7382f91
JS
306 bool m_needsStyleChange:1; // May not be able to change
307 // background style until OnIdle
add7cadd
PC
308 bool m_mouseButtonDown:1;
309 bool m_blockScrollEvent:1;
f46ad98f
RR
310
311 bool m_showOnIdle:1; // postpone showing the window until idle
7af6f327 312
d7c24517
VZ
313 // C++ has no virtual methods in the constrcutor of any class but we need
314 // different methods of inserting a child window into a wxFrame,
315 // wxMDIFrame, wxNotebook etc. this is the callback that will get used.
f03fc89f 316 wxInsertChildFunction m_insertCallback;
68995f26 317
6f02a879 318protected:
f03fc89f 319 // implement the base class pure virtuals
dabc0cd5
VZ
320 virtual void DoClientToScreen( int *x, int *y ) const;
321 virtual void DoScreenToClient( int *x, int *y ) const;
f03fc89f
VZ
322 virtual void DoGetPosition( int *x, int *y ) const;
323 virtual void DoGetSize( int *width, int *height ) const;
324 virtual void DoGetClientSize( int *width, int *height ) const;
bfc6fde4
VZ
325 virtual void DoSetSize(int x, int y,
326 int width, int height,
327 int sizeFlags = wxSIZE_AUTO);
bfc6fde4 328 virtual void DoSetClientSize(int width, int height);
9d9b7755 329 virtual void DoMoveWindow(int x, int y, int width, int height);
aed8df38 330
6f02a879
VZ
331#if wxUSE_MENUS_NATIVE
332 virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
333#endif // wxUSE_MENUS_NATIVE
334
94633ad9
VZ
335 virtual void DoCaptureMouse();
336 virtual void DoReleaseMouse();
f26623c8 337
f03fc89f
VZ
338#if wxUSE_TOOLTIPS
339 virtual void DoSetToolTip( wxToolTip *tip );
340#endif // wxUSE_TOOLTIPS
341
3ae4c570 342 // common part of all ctors (not virtual because called from ctor)
f03fc89f 343 void Init();
f26623c8 344
a589495e
VS
345 virtual void DoMoveInTabOrder(wxWindow *win, MoveKind move);
346
347 // Copies m_children tab order to GTK focus chain:
348 void RealizeTabOrder();
f26623c8 349
f40fdaa3
VS
350 // Called by ApplyWidgetStyle (which is called by SetFont() and
351 // SetXXXColour etc to apply style changed to native widgets) to create
5edef14e
VS
352 // modified GTK style with non-standard attributes. If forceStyle=true,
353 // creates empty GtkRcStyle if there are no modifications, otherwise
354 // returns NULL in such case.
355 GtkRcStyle *CreateWidgetStyle(bool forceStyle = false);
f40fdaa3
VS
356
357 // Overridden in many GTK widgets who have to handle subwidgets
5edef14e 358 virtual void ApplyWidgetStyle(bool forceStyle = false);
f26623c8 359
5bc3865f 360 // helper function to ease native widgets wrapping, called by
7074ce35
VS
361 // ApplyWidgetStyle -- override this, not ApplyWidgetStyle
362 virtual void DoApplyWidgetStyle(GtkRcStyle *style);
f03fc89f 363
6493aaca
VZ
364 // sets the border of a given GtkScrolledWindow from a wx style
365 static void GtkScrolledWindowSetBorder(GtkWidget* w, int style);
366
ef5c70f9
VZ
367 // set the current cursor for all GdkWindows making part of this widget
368 // (see GTKGetWindow)
2f262021 369 //
ef5c70f9
VZ
370 // should be called from OnInternalIdle() if it's overridden
371 void GTKUpdateCursor();
372
68dda785 373private:
22c9b211
VZ
374 enum ScrollUnit { ScrollUnit_Line, ScrollUnit_Page, ScrollUnit_Max };
375
376 // common part of ScrollLines() and ScrollPages() and could be used, in the
377 // future, for horizontal scrolling as well
378 //
379 // return true if we scrolled, false otherwise (on error or simply if we
380 // are already at the end)
381 bool DoScrollByUnits(ScrollDir dir, ScrollUnit unit, int units);
382
383
1e6feb95 384 DECLARE_DYNAMIC_CLASS(wxWindowGTK)
1a0d517e 385 DECLARE_NO_COPY_CLASS(wxWindowGTK)
c801d85f
KB
386};
387
20123d49 388extern WXDLLIMPEXP_CORE wxWindow *wxFindFocusedChild(wxWindowGTK *win);
3379ed37 389
ef5c70f9 390#endif // _WX_GTK_WINDOW_H_