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