]> git.saurik.com Git - wxWidgets.git/blob - include/wx/motif/window.h
Insert() patch from John Labenski
[wxWidgets.git] / include / wx / motif / window.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: window.h
3 // Purpose: wxWindow class
4 // Author: Julian Smart
5 // Modified by:
6 // Created: 17/09/98
7 // RCS-ID: $Id$
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _WX_WINDOW_H_
13 #define _WX_WINDOW_H_
14
15 #ifdef __GNUG__
16 #pragma interface "window.h"
17 #endif
18
19 #include "wx/region.h"
20
21 // ----------------------------------------------------------------------------
22 // wxWindow class for Motif - see also wxWindowBase
23 // ----------------------------------------------------------------------------
24
25 class wxWindow : public wxWindowBase
26 {
27 friend class WXDLLEXPORT wxDC;
28 friend class WXDLLEXPORT wxWindowDC;
29
30 public:
31 wxWindow() { Init(); }
32
33 wxWindow(wxWindow *parent,
34 wxWindowID id,
35 const wxPoint& pos = wxDefaultPosition,
36 const wxSize& size = wxDefaultSize,
37 long style = 0,
38 const wxString& name = wxPanelNameStr)
39 {
40 Init();
41 Create(parent, id, pos, size, style, name);
42 }
43
44 virtual ~wxWindow();
45
46 bool Create(wxWindow *parent,
47 wxWindowID id,
48 const wxPoint& pos = wxDefaultPosition,
49 const wxSize& size = wxDefaultSize,
50 long style = 0,
51 const wxString& name = wxPanelNameStr);
52
53 // implement base class pure virtuals
54 virtual void SetTitle( const wxString& title);
55 virtual wxString GetTitle() const;
56
57 virtual void Raise();
58 virtual void Lower();
59
60 virtual bool Show( bool show = TRUE );
61 virtual bool Enable( bool enable = TRUE );
62
63 virtual void SetFocus();
64
65 virtual void WarpPointer(int x, int y);
66
67 virtual void Refresh( bool eraseBackground = TRUE,
68 const wxRect *rect = (const wxRect *) NULL );
69 virtual void Clear();
70
71 virtual bool SetBackgroundColour( const wxColour &colour );
72 virtual bool SetForegroundColour( const wxColour &colour );
73
74 virtual bool SetCursor( const wxCursor &cursor );
75 virtual bool SetFont( const wxFont &font );
76
77 virtual int GetCharHeight() const;
78 virtual int GetCharWidth() const;
79 virtual void GetTextExtent(const wxString& string,
80 int *x, int *y,
81 int *descent = (int *) NULL,
82 int *externalLeading = (int *) NULL,
83 const wxFont *theFont = (const wxFont *) NULL)
84 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 = (wxRect *) NULL );
94
95 #if wxUSE_DRAG_AND_DROP
96 virtual void SetDropTarget( wxDropTarget *dropTarget );
97 #endif // wxUSE_DRAG_AND_DROP
98
99 // Accept files for dragging
100 virtual void DragAcceptFiles(bool accept);
101
102 // Get the unique identifier of a window
103 virtual WXWidget GetHandle() const { return GetMainWidget(); }
104
105 // implementation from now on
106 // --------------------------
107
108 // accessors
109 // ---------
110
111 // Get main widget for this window, e.g. a text widget
112 virtual WXWidget GetMainWidget() const;
113 // Get the widget that corresponds to the label (for font setting,
114 // label setting etc.)
115 virtual WXWidget GetLabelWidget() const;
116 // Get the client widget for this window (something we can create other
117 // windows on)
118 virtual WXWidget GetClientWidget() const;
119 // Get the top widget for this window, e.g. the scrolled widget parent of a
120 // multi-line text widget. Top means, top in the window hierarchy that
121 // implements this window.
122 virtual WXWidget GetTopWidget() const;
123
124 // Get the underlying X window and display
125 WXWindow GetXWindow() const;
126 WXDisplay *GetXDisplay() const;
127
128 void SetLastClick(int button, long timestamp)
129 { m_lastButton = button; m_lastTS = timestamp; }
130
131 int GetLastClickedButton() const { return m_lastButton; }
132 long GetLastClickTime() const { return m_lastTS; }
133
134 // Gives window a chance to do something in response to a size message,
135 // e.g. arrange status bar, toolbar etc.
136 virtual bool PreResize();
137
138 // Generates a paint event
139 virtual void DoPaint();
140
141 // update rectangle/region manipulation
142 // (for wxWindowDC and Motif callbacks only)
143 // -----------------------------------------
144
145 // read/write access to the update rect list
146 const wxRectList& GetUpdateRects() const { return m_updateRects; }
147
148 // Adds a recangle to the updates list
149 void AddUpdateRect(int x, int y, int w, int h)
150 { m_updateRects.Append(new wxRect(x, y, w, h)); }
151
152 // Empties the m_updateRects list
153 void ClearUpdateRects();
154
155 void ClearUpdateRegion() { m_updateRegion.Clear(); }
156 void SetUpdateRegion(const wxRegion& region) { m_updateRegion = region; }
157
158 // For implementation purposes - sometimes decorations make the client area
159 // smaller
160 virtual wxPoint GetClientAreaOrigin() const;
161
162 protected:
163 // event handlers (not virtual by design)
164 void OnIdle(wxIdleEvent& event);
165
166 // Responds to colour changes: passes event on to children.
167 void OnSysColourChanged(wxSysColourChangedEvent& event);
168
169 // Motif-specific
170
171 void SetMainWidget(WXWidget w) { m_mainWidget = w; }
172
173 // See src/motif/window.cpp, near the top, for an explanation
174 // why this is necessary
175 void CanvasSetSizeIntr(int x, int y, int width, int height,
176 int sizeFlags, bool fromCtor);
177 void DoSetSizeIntr(int x, int y,
178 int width, int height,
179 int sizeFlags, bool fromCtor);
180
181 // for DoMoveWindowIntr flags
182 enum
183 {
184 wxMOVE_X = 1,
185 wxMOVE_Y = 2,
186 wxMOVE_WIDTH = 4,
187 wxMOVE_HEIGHT = 8
188 };
189
190 void DoMoveWindowIntr(int x, int y, int width, int height,
191 int flags);
192 public:
193 WXPixmap GetBackingPixmap() const { return m_backingPixmap; }
194 void SetBackingPixmap(WXPixmap pixmap) { m_backingPixmap = pixmap; }
195 int GetPixmapWidth() const { return m_pixmapWidth; }
196 int GetPixmapHeight() const { return m_pixmapHeight; }
197 void SetPixmapWidth(int w) { m_pixmapWidth = w; }
198 void SetPixmapHeight(int h) { m_pixmapHeight = h; }
199
200 // Change properties
201 // Change to the current font (often overridden)
202 virtual void ChangeFont(bool keepOriginalSize = TRUE);
203
204 // Change background and foreground colour using current background colour
205 // setting (Motif generates foreground based on background)
206 virtual void ChangeBackgroundColour();
207 // Change foreground colour using current foreground colour setting
208 virtual void ChangeForegroundColour();
209
210 protected:
211 // Adds the widget to the hash table and adds event handlers.
212 bool AttachWidget(wxWindow* parent, WXWidget mainWidget,
213 WXWidget formWidget, int x, int y, int width, int height);
214 bool DetachWidget(WXWidget widget);
215
216 // How to implement accelerators. If we find a key event, translate to
217 // wxWindows wxKeyEvent form. Find a widget for the window. Now find a
218 // wxWindow for the widget. If there isn't one, go up the widget hierarchy
219 // trying to find one. Once one is found, call ProcessAccelerator for the
220 // window. If it returns TRUE (processed the event), skip the X event,
221 // otherwise carry on up the wxWindows window hierarchy calling
222 // ProcessAccelerator. If all return FALSE, process the X event as normal.
223 // Eventually we can implement OnCharHook the same way, but concentrate on
224 // accelerators for now. ProcessAccelerator must look at the current
225 // accelerator table, and try to find what menu id or window (beneath it)
226 // has this ID. Then construct an appropriate command
227 // event and send it.
228 public:
229 virtual bool ProcessAccelerator(wxKeyEvent& event);
230
231 protected:
232 // unmanage and destroy an X widget f it's !NULL (passing NULL is ok)
233 void UnmanageAndDestroy(WXWidget widget);
234
235 // map or unmap an X widget (passing NULL is ok),
236 // returns TRUE if widget was mapped/unmapped
237 bool MapOrUnmap(WXWidget widget, bool map);
238
239 // scrolling stuff
240 // ---------------
241
242 // create/destroy window scrollbars
243 void CreateScrollbar(wxOrientation orientation);
244 void DestroyScrollbar(wxOrientation orientation);
245
246 // get either hor or vert scrollbar widget
247 WXWidget GetScrollbar(wxOrientation orient) const
248 { return orient == wxHORIZONTAL ? m_hScrollBar : m_vScrollBar; }
249
250 // set the scroll pos
251 void SetInternalScrollPos(wxOrientation orient, int pos)
252 {
253 if ( orient == wxHORIZONTAL )
254 m_scrollPosX = pos;
255 else
256 m_scrollPosY = pos;
257 }
258
259 // Motif-specific flags
260 // --------------------
261
262 bool m_needsRefresh:1; // repaint backing store?
263
264 // For double-click detection
265 long m_lastTS; // last timestamp
266 unsigned m_lastButton:2; // last pressed button
267
268 // List of wxRects representing damaged region
269 wxRectList m_updateRects;
270
271 protected:
272 WXWidget m_mainWidget;
273 WXWidget m_hScrollBar;
274 WXWidget m_vScrollBar;
275 WXWidget m_borderWidget;
276 WXWidget m_scrolledWindow;
277 WXWidget m_drawingArea;
278 bool m_winCaptured:1;
279 WXPixmap m_backingPixmap;
280 int m_pixmapWidth;
281 int m_pixmapHeight;
282 int m_pixmapOffsetX;
283 int m_pixmapOffsetY;
284
285 // Store the last scroll pos, since in wxWin the pos isn't set
286 // automatically by system
287 int m_scrollPosX;
288 int m_scrollPosY;
289
290 // implement the base class pure virtuals
291 virtual void DoClientToScreen( int *x, int *y ) const;
292 virtual void DoScreenToClient( int *x, int *y ) const;
293 virtual void DoGetPosition( int *x, int *y ) const;
294 virtual void DoGetSize( int *width, int *height ) const;
295 virtual void DoGetClientSize( int *width, int *height ) const;
296 virtual void DoSetSize(int x, int y,
297 int width, int height,
298 int sizeFlags = wxSIZE_AUTO);
299 virtual void DoSetClientSize(int width, int height);
300 virtual void DoMoveWindow(int x, int y, int width, int height);
301 virtual bool DoPopupMenu(wxMenu *menu, int x, int y);
302 virtual void DoCaptureMouse();
303 virtual void DoReleaseMouse();
304
305 #if wxUSE_TOOLTIPS
306 virtual void DoSetToolTip( wxToolTip *tip );
307 #endif // wxUSE_TOOLTIPS
308
309 private:
310 // common part of all ctors
311 void Init();
312
313 DECLARE_DYNAMIC_CLASS(wxWindow)
314 DECLARE_NO_COPY_CLASS(wxWindow)
315 DECLARE_EVENT_TABLE()
316 };
317
318 // ----------------------------------------------------------------------------
319 // A little class to switch off `size optimization' while an instance of the
320 // object exists: this may be useful to temporarily disable the optimisation
321 // which consists to do nothing when the new size is equal to the old size -
322 // although quite useful usually to avoid flicker, sometimes it leads to
323 // undesired effects.
324 //
325 // Usage: create an instance of this class on the stack to disable the size
326 // optimisation, it will be reenabled as soon as the object goes out
327 // from scope.
328 // ----------------------------------------------------------------------------
329
330 class WXDLLEXPORT wxNoOptimize
331 {
332 public:
333 wxNoOptimize() { ms_count++; }
334 ~wxNoOptimize() { ms_count--; }
335
336 static bool CanOptimize() { return ms_count == 0; }
337
338 protected:
339 static int ms_count;
340 };
341
342 #endif
343 // _WX_WINDOW_H_