]> git.saurik.com Git - wxWidgets.git/blame - include/wx/gtk1/window.h
Document that wxDC::FloodFill() is not implemented under wxOSX.
[wxWidgets.git] / include / wx / gtk1 / window.h
CommitLineData
c801d85f 1/////////////////////////////////////////////////////////////////////////////
8ef94bfc 2// Name: wx/gtk1/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
c801d85f
KB
10#ifndef __GTKWINDOWH__
11#define __GTKWINDOWH__
12
55489584 13typedef struct _GtkTooltips GtkTooltips;
29e461a2
PC
14#ifdef HAVE_XIM
15typedef struct _GdkIC GdkIC;
16typedef struct _GdkICAttr GdkICAttr;
17#endif
55489584 18
6ca41e57 19//-----------------------------------------------------------------------------
fd0eed64 20// callback definition for inserting a window (internal)
6ca41e57
RR
21//-----------------------------------------------------------------------------
22
b5dbe15d 23class WXDLLIMPEXP_FWD_CORE wxWindowGTK;
1e6feb95 24typedef void (*wxInsertChildFunction)( wxWindowGTK*, wxWindowGTK* );
6ca41e57 25
c801d85f 26//-----------------------------------------------------------------------------
1e6feb95 27// wxWindowGTK
c801d85f
KB
28//-----------------------------------------------------------------------------
29
20123d49 30class WXDLLIMPEXP_CORE wxWindowGTK : public wxWindowBase
c801d85f 31{
aed8df38 32public:
bfc6fde4
VZ
33 // creating the window
34 // -------------------
1e6feb95
VZ
35 wxWindowGTK();
36 wxWindowGTK(wxWindow *parent,
37 wxWindowID id,
38 const wxPoint& pos = wxDefaultPosition,
39 const wxSize& size = wxDefaultSize,
40 long style = 0,
41 const wxString& name = wxPanelNameStr);
f03fc89f
VZ
42 bool Create(wxWindow *parent,
43 wxWindowID id,
44 const wxPoint& pos = wxDefaultPosition,
45 const wxSize& size = wxDefaultSize,
46 long style = 0,
47 const wxString& name = wxPanelNameStr);
1e6feb95 48 virtual ~wxWindowGTK();
cd0183ca 49
f03fc89f
VZ
50 // implement base class (pure) virtual methods
51 // -------------------------------------------
a264ece2 52
4292eeb4 53 virtual void SetLabel(const wxString& WXUNUSED(label)) { }
5bc3865f 54 virtual wxString GetLabel() const { return wxEmptyString; }
2ea5111b 55
bfc6fde4 56 virtual bool Destroy();
bfc6fde4 57
f03fc89f
VZ
58 virtual void Raise();
59 virtual void Lower();
ff8bfdbb 60
5bc3865f 61 virtual bool Show( bool show = true );
47a8a4d5 62 virtual void DoEnable( bool enable );
ff8bfdbb 63
015dca24
MR
64 virtual void SetWindowStyleFlag( long style );
65
f03fc89f 66 virtual bool IsRetained() const;
2f2aa628 67
bfc6fde4 68 virtual void SetFocus();
f03fc89f 69 virtual bool AcceptsFocus() const;
ff8bfdbb 70
fdb7dadb 71 virtual bool Reparent( wxWindowBase *newParent );
ff8bfdbb 72
f03fc89f 73 virtual void WarpPointer(int x, int y);
b1170810 74
5bc3865f 75 virtual void Refresh( bool eraseBackground = true,
f03fc89f 76 const wxRect *rect = (const wxRect *) NULL );
beab25bd 77 virtual void Update();
596f1d11 78 virtual void ClearBackground();
bfc6fde4 79
f03fc89f
VZ
80 virtual bool SetBackgroundColour( const wxColour &colour );
81 virtual bool SetForegroundColour( const wxColour &colour );
82 virtual bool SetCursor( const wxCursor &cursor );
83 virtual bool SetFont( const wxFont &font );
cd0183ca 84
c7382f91 85 virtual bool SetBackgroundStyle(wxBackgroundStyle style) ;
f26623c8 86
bfc6fde4
VZ
87 virtual int GetCharHeight() const;
88 virtual int GetCharWidth() const;
8bbe427f 89
f03fc89f 90 virtual void SetScrollbar( int orient, int pos, int thumbVisible,
5bc3865f
WS
91 int range, bool refresh = true );
92 virtual void SetScrollPos( int orient, int pos, bool refresh = true );
f03fc89f
VZ
93 virtual int GetScrollPos( int orient ) const;
94 virtual int GetScrollThumb( int orient ) const;
95 virtual int GetScrollRange( int orient ) const;
96 virtual void ScrollWindow( int dx, int dy,
d3b9f782 97 const wxRect* rect = NULL );
8bbe427f 98
f03fc89f
VZ
99#if wxUSE_DRAG_AND_DROP
100 virtual void SetDropTarget( wxDropTarget *dropTarget );
101#endif // wxUSE_DRAG_AND_DROP
f26623c8 102
2e992e06
VZ
103 virtual bool IsDoubleBuffered() const { return false; }
104
08f53168
PC
105 GdkWindow* GTKGetDrawingWindow() const;
106
f03fc89f
VZ
107 // implementation
108 // --------------
c801d85f 109
d7c24517
VZ
110 virtual WXWidget GetHandle() const { return m_widget; }
111
beab25bd
RR
112 // I don't want users to override what's done in idle so everything that
113 // has to be done in idle time in order for wxGTK to work is done in
114 // OnInternalIdle
bfc6fde4 115 virtual void OnInternalIdle();
ff8bfdbb 116
4c51a665 117 // Internal representation of Update()
010afced 118 void GtkUpdate();
f26623c8 119
beab25bd
RR
120 // For compatibility across platforms (not in event table)
121 void OnIdle(wxIdleEvent& WXUNUSED(event)) {}
20e85460 122
beab25bd 123 // Used by all window classes in the widget creation process.
1e6feb95 124 bool PreCreation( wxWindowGTK *parent, const wxPoint &pos, const wxSize &size );
bfc6fde4 125 void PostCreation();
ff8bfdbb 126
beab25bd
RR
127 // Internal addition of child windows. differs from class
128 // to class not by using virtual functions but by using
129 // the m_insertCallback.
1e6feb95 130 void DoAddChild(wxWindowGTK *child);
f26623c8 131
beab25bd
RR
132 // This methods sends wxPaintEvents to the window. It reads the
133 // update region, breaks it up into rects and sends an event
134 // for each rect. It is also responsible for background erase
135 // events and NC paint events. It is called from "draw" and
136 // "expose" handlers as well as from ::Update()
137 void GtkSendPaintEvents();
138
139 // The methods below are required because many native widgets
140 // are composed of several subwidgets and setting a style for
141 // the widget means setting it for all subwidgets as well.
90e572f1 142 // also, it is not clear which native widget is the top
beab25bd
RR
143 // widget where (most of) the input goes. even tooltips have
144 // to be applied to all subwidgets.
bfc6fde4
VZ
145 virtual GtkWidget* GetConnectWidget();
146 virtual bool IsOwnGtkWindow( GdkWindow *window );
147 void ConnectWidget( GtkWidget *widget );
8bbe427f 148
ff8bfdbb 149#if wxUSE_TOOLTIPS
74ce55e9 150 virtual void ApplyToolTip( GtkTooltips *tips, const wxChar *tip );
ff8bfdbb 151#endif // wxUSE_TOOLTIPS
301cd871 152
87a3ebe9
VZ
153 // Call after modifing the value of m_hAdjust or m_vAdjust to bring the
154 // scrolbar in sync (this does not generate any wx events)
155 void GtkUpdateScrollbar(int orient);
156
90e572f1 157 // Called from GTK signal handlers. it indicates that
d13b34d3 158 // the layout functions have to be called later on
739730ca 159 // (i.e. in idle time, implemented in OnInternalIdle() ).
5bc3865f 160 void GtkUpdateSize() { m_sizeSet = false; }
94633ad9 161
3ae4c570
VZ
162 // fix up the mouse event coords, used by wxListBox only so far
163 virtual void FixUpMouseEvent(GtkWidget * WXUNUSED(widget),
164 wxCoord& WXUNUSED(x),
165 wxCoord& WXUNUSED(y)) { }
166
d1f2ac45 167 // is this window transparent for the mouse events (as wxStaticBox is)?
5bc3865f 168 virtual bool IsTransparentForMouse() const { return false; }
d1f2ac45 169
2b4f3c9f 170 // is this a radiobutton (used by radiobutton code itself only)?
5bc3865f 171 virtual bool IsRadioButton() const { return false; }
2b4f3c9f 172
f03fc89f
VZ
173 // position and size of the window
174 int m_x, m_y;
175 int m_width, m_height;
5b8a521e 176 int m_oldClientWidth,m_oldClientHeight;
bcf1fa6b 177
76fcf0f2
RR
178 // see the docs in src/gtk/window.cpp
179 GtkWidget *m_widget; // mostly the widget seen by the rest of GTK
77ffb593 180 GtkWidget *m_wxwindow; // mostly the client area as per wxWidgets
94633ad9 181
76fcf0f2
RR
182 // this widget will be queried for GTK's focus events
183 GtkWidget *m_focusWidget;
f03fc89f 184
60e4975c 185#ifdef HAVE_XIM
77ffb593 186 // XIM support for wxWidgets
63081513
RR
187 GdkIC *m_ic;
188 GdkICAttr *m_icattr;
60e4975c 189#endif // HAVE_XIM
3379ed37 190
3bcc8d15 191 // The area to be cleared (and not just refreshed)
331a0b6b 192 // We cannot make this distinction under GTK 2.0.
3bcc8d15
RR
193 wxRegion m_clearRegion;
194
76fcf0f2 195 // scrolling stuff
bfc6fde4 196 GtkAdjustment *m_hAdjust,*m_vAdjust;
739730ca
RR
197 float m_oldHorizontalPos;
198 float m_oldVerticalPos;
199
f03fc89f 200 // extra (wxGTK-specific) flags
76fcf0f2
RR
201 bool m_needParent:1; // ! wxFrame, wxDialog, wxNotebookPage ?
202 bool m_noExpose:1; // wxGLCanvas has its own redrawing
203 bool m_nativeSizeEvent:1; // wxGLCanvas sends wxSizeEvent upon "alloc_size"
f03fc89f 204 bool m_hasScrolling:1;
f03fc89f
VZ
205 bool m_hasVMT:1;
206 bool m_sizeSet:1;
207 bool m_resizing:1;
6cad4f1b
VZ
208 bool m_acceptsFocus:1; // true if not static
209 bool m_hasFocus:1; // true if == FindFocus()
210 bool m_isScrolling:1; // dragging scrollbar thumb?
5bc3865f 211 bool m_clipPaintRegion:1; // true after ScrollWindow()
c7382f91
JS
212 bool m_needsStyleChange:1; // May not be able to change
213 // background style until OnIdle
7af6f327 214
d7c24517
VZ
215 // C++ has no virtual methods in the constrcutor of any class but we need
216 // different methods of inserting a child window into a wxFrame,
217 // wxMDIFrame, wxNotebook etc. this is the callback that will get used.
f03fc89f 218 wxInsertChildFunction m_insertCallback;
68995f26 219
f03fc89f 220 // implement the base class pure virtuals
6de70470
VZ
221 virtual void DoGetTextExtent(const wxString& string,
222 int *x, int *y,
223 int *descent = NULL,
224 int *externalLeading = NULL,
225 const wxFont *theFont = NULL) const;
226
227#if wxUSE_MENUS_NATIVE
228 virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
229#endif // wxUSE_MENUS_NATIVE
230
dabc0cd5
VZ
231 virtual void DoClientToScreen( int *x, int *y ) const;
232 virtual void DoScreenToClient( int *x, int *y ) const;
f03fc89f
VZ
233 virtual void DoGetPosition( int *x, int *y ) const;
234 virtual void DoGetSize( int *width, int *height ) const;
235 virtual void DoGetClientSize( int *width, int *height ) const;
bfc6fde4
VZ
236 virtual void DoSetSize(int x, int y,
237 int width, int height,
238 int sizeFlags = wxSIZE_AUTO);
bfc6fde4 239 virtual void DoSetClientSize(int width, int height);
9d9b7755 240 virtual void DoMoveWindow(int x, int y, int width, int height);
aed8df38 241
94633ad9
VZ
242 virtual void DoCaptureMouse();
243 virtual void DoReleaseMouse();
f26623c8 244
f03fc89f
VZ
245#if wxUSE_TOOLTIPS
246 virtual void DoSetToolTip( wxToolTip *tip );
247#endif // wxUSE_TOOLTIPS
248
3ae4c570
VZ
249protected:
250 // common part of all ctors (not virtual because called from ctor)
f03fc89f 251 void Init();
f26623c8 252
f40fdaa3
VS
253 // Called by ApplyWidgetStyle (which is called by SetFont() and
254 // SetXXXColour etc to apply style changed to native widgets) to create
5edef14e
VS
255 // modified GTK style with non-standard attributes. If forceStyle=true,
256 // creates empty GtkRcStyle if there are no modifications, otherwise
257 // returns NULL in such case.
258 GtkRcStyle *CreateWidgetStyle(bool forceStyle = false);
f40fdaa3
VS
259
260 // Overridden in many GTK widgets who have to handle subwidgets
5edef14e 261 virtual void ApplyWidgetStyle(bool forceStyle = false);
f26623c8 262
5bc3865f 263 // helper function to ease native widgets wrapping, called by
7074ce35
VS
264 // ApplyWidgetStyle -- override this, not ApplyWidgetStyle
265 virtual void DoApplyWidgetStyle(GtkRcStyle *style);
f03fc89f 266
68dda785 267private:
1e6feb95 268 DECLARE_DYNAMIC_CLASS(wxWindowGTK)
c0c133e1 269 wxDECLARE_NO_COPY_CLASS(wxWindowGTK);
c801d85f
KB
270};
271
20123d49 272extern WXDLLIMPEXP_CORE wxWindow *wxFindFocusedChild(wxWindowGTK *win);
3379ed37 273
c801d85f 274#endif // __GTKWINDOWH__