]> git.saurik.com Git - wxWidgets.git/blob - include/wx/msw/window.h
Fixed new lintian warnings.
[wxWidgets.git] / include / wx / msw / window.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/msw/window.h
3 // Purpose: wxWindow class
4 // Author: Julian Smart
5 // Modified by: Vadim Zeitlin on 13.05.99: complete refont of message handling,
6 // elimination of Default(), ...
7 // Created: 01/02/97
8 // RCS-ID: $Id$
9 // Copyright: (c) Julian Smart and Markus Holzem
10 // Licence: wxWindows licence
11 /////////////////////////////////////////////////////////////////////////////
12
13 #ifndef _WX_WINDOW_H_
14 #define _WX_WINDOW_H_
15
16 // ---------------------------------------------------------------------------
17 // headers
18 // ---------------------------------------------------------------------------
19
20 #ifdef __GNUG__
21 #pragma interface "window.h"
22 #endif
23
24 // [at least] some version of Windows send extra mouse move messages after
25 // a mouse click or a key press - to temporarily fix this problem, set the
26 // define below to 1
27 //
28 // a better solution should be found later...
29 #define wxUSE_MOUSEEVENT_HACK 0
30
31 // ---------------------------------------------------------------------------
32 // constants
33 // ---------------------------------------------------------------------------
34
35 // FIXME does anybody use those? they're unused by wxWindows...
36 enum
37 {
38 wxKEY_SHIFT = 1,
39 wxKEY_CTRL = 2
40 };
41
42 // ---------------------------------------------------------------------------
43 // wxWindow declaration for MSW
44 // ---------------------------------------------------------------------------
45
46 class WXDLLEXPORT wxWindowMSW : public wxWindowBase
47 {
48 public:
49 wxWindowMSW() { Init(); }
50
51 wxWindowMSW(wxWindow *parent,
52 wxWindowID id,
53 const wxPoint& pos = wxDefaultPosition,
54 const wxSize& size = wxDefaultSize,
55 long style = 0,
56 const wxString& name = wxPanelNameStr)
57 {
58 Init();
59 Create(parent, id, pos, size, style, name);
60 }
61
62 virtual ~wxWindowMSW();
63
64 bool Create(wxWindow *parent,
65 wxWindowID id,
66 const wxPoint& pos = wxDefaultPosition,
67 const wxSize& size = wxDefaultSize,
68 long style = 0,
69 const wxString& name = wxPanelNameStr);
70
71 // implement base class pure virtuals
72 virtual void SetTitle( const wxString& title);
73 virtual wxString GetTitle() const;
74
75 virtual void Raise();
76 virtual void Lower();
77
78 virtual bool Show( bool show = TRUE );
79 virtual bool Enable( bool enable = TRUE );
80
81 virtual void SetFocus();
82
83 virtual bool Reparent(wxWindowBase *newParent);
84
85 virtual void WarpPointer(int x, int y);
86 virtual void CaptureMouse();
87 virtual void ReleaseMouse();
88
89 virtual void Refresh( bool eraseBackground = TRUE,
90 const wxRect *rect = (const wxRect *) NULL );
91 virtual void Update();
92 virtual void Clear();
93 virtual void Freeze();
94 virtual void Thaw();
95
96 virtual bool SetCursor( const wxCursor &cursor );
97 virtual bool SetFont( const wxFont &font );
98
99 virtual int GetCharHeight() const;
100 virtual int GetCharWidth() const;
101 virtual void GetTextExtent(const wxString& string,
102 int *x, int *y,
103 int *descent = (int *) NULL,
104 int *externalLeading = (int *) NULL,
105 const wxFont *theFont = (const wxFont *) NULL)
106 const;
107
108 #if wxUSE_MENUS_NATIVE
109 virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
110 #endif // wxUSE_MENUS_NATIVE
111
112 virtual void SetScrollbar( int orient, int pos, int thumbVisible,
113 int range, bool refresh = TRUE );
114 virtual void SetScrollPos( int orient, int pos, bool refresh = TRUE );
115 virtual int GetScrollPos( int orient ) const;
116 virtual int GetScrollThumb( int orient ) const;
117 virtual int GetScrollRange( int orient ) const;
118 virtual void ScrollWindow( int dx, int dy,
119 const wxRect* rect = (wxRect *) NULL );
120
121 virtual bool ScrollLines(int lines);
122 virtual bool ScrollPages(int pages);
123
124 #if wxUSE_DRAG_AND_DROP
125 virtual void SetDropTarget( wxDropTarget *dropTarget );
126 #endif // wxUSE_DRAG_AND_DROP
127
128 // Accept files for dragging
129 virtual void DragAcceptFiles(bool accept);
130
131 #if WXWIN_COMPATIBILITY
132 // Set/get scroll attributes
133 virtual void SetScrollRange(int orient, int range, bool refresh = TRUE);
134 virtual void SetScrollPage(int orient, int page, bool refresh = TRUE);
135 virtual int OldGetScrollRange(int orient) const;
136 virtual int GetScrollPage(int orient) const;
137
138 // event handlers
139 // Handle a control command
140 virtual void OnCommand(wxWindow& win, wxCommandEvent& event);
141
142 // Override to define new behaviour for default action (e.g. double
143 // clicking on a listbox)
144 virtual void OnDefaultAction(wxControl * WXUNUSED(initiatingItem)) { }
145 #endif // WXWIN_COMPATIBILITY
146
147 #if wxUSE_CARET && WXWIN_COMPATIBILITY
148 // caret manipulation (old MSW only functions, see wxCaret class for the
149 // new API)
150 void CreateCaret(int w, int h);
151 void CreateCaret(const wxBitmap *bitmap);
152 void DestroyCaret();
153 void ShowCaret(bool show);
154 void SetCaretPos(int x, int y);
155 void GetCaretPos(int *x, int *y) const;
156 #endif // wxUSE_CARET
157
158 #ifndef __WXUNIVERSAL__
159 // Native resource loading (implemented in src/msw/nativdlg.cpp)
160 // FIXME: should they really be all virtual?
161 virtual bool LoadNativeDialog(wxWindow* parent, wxWindowID& id);
162 virtual bool LoadNativeDialog(wxWindow* parent, const wxString& name);
163 wxWindow* GetWindowChild1(wxWindowID id);
164 wxWindow* GetWindowChild(wxWindowID id);
165 #endif // __WXUNIVERSAL__
166
167 // a MSW only function which sends a size event to the window using its
168 // current size - this has an effect of refreshing the window layout
169 /*
170 FUNCTION IS NOW A MEMBER OF wxFrame - gt
171 void SendSizeEvent();
172 */
173
174 // implementation from now on
175 // --------------------------
176
177 // simple accessors
178 // ----------------
179
180 WXHWND GetHWND() const { return m_hWnd; }
181 void SetHWND(WXHWND hWnd) { m_hWnd = hWnd; }
182 virtual WXWidget GetHandle() const { return GetHWND(); }
183
184 bool GetUseCtl3D() const { return m_useCtl3D; }
185 bool GetTransparentBackground() const { return m_backgroundTransparent; }
186 void SetTransparent(bool t = TRUE) { m_backgroundTransparent = t; }
187
188 // event handlers
189 // --------------
190
191 void OnSetFocus(wxFocusEvent& event);
192 void OnEraseBackground(wxEraseEvent& event);
193 void OnIdle(wxIdleEvent& event);
194 void OnPaint(wxPaintEvent& event);
195
196 public:
197 // For implementation purposes - sometimes decorations make the client area
198 // smaller
199 virtual wxPoint GetClientAreaOrigin() const;
200
201 // Windows subclassing
202 void SubclassWin(WXHWND hWnd);
203 void UnsubclassWin();
204
205 WXFARPROC MSWGetOldWndProc() const { return m_oldWndProc; }
206 void MSWSetOldWndProc(WXFARPROC proc) { m_oldWndProc = proc; }
207
208 wxWindow *FindItem(long id) const;
209 wxWindow *FindItemByHWND(WXHWND hWnd, bool controlOnly = FALSE) const;
210
211 // Make a Windows extended style from the given wxWindows window style
212 static WXDWORD MakeExtendedStyle(long style,
213 bool eliminateBorders = FALSE);
214 // Determine whether 3D effects are wanted
215 WXDWORD Determine3DEffects(WXDWORD defaultBorderStyle, bool *want3D) const;
216
217 // MSW only: TRUE if this control is part of the main control
218 virtual bool ContainsHWND(WXHWND WXUNUSED(hWnd)) const { return FALSE; };
219
220 // returns TRUE if the window has been created
221 bool MSWCreate(int id,
222 wxWindow *parent,
223 const wxChar *wclass,
224 wxWindow *wx_win,
225 const wxChar *title,
226 int x, int y, int width, int height,
227 WXDWORD style,
228 const wxChar *dialog_template = NULL,
229 WXDWORD exendedStyle = 0);
230 virtual bool MSWCommand(WXUINT param, WXWORD id);
231
232 #if WXWIN_COMPATIBILITY
233 wxObject *GetChild(int number) const;
234 virtual void MSWDeviceToLogical(float *x, float *y) const;
235 #endif // WXWIN_COMPATIBILITY
236
237 #ifndef __WXUNIVERSAL__
238 // Create an appropriate wxWindow from a HWND
239 virtual wxWindow* CreateWindowFromHWND(wxWindow* parent, WXHWND hWnd);
240
241 // Make sure the window style reflects the HWND style (roughly)
242 virtual void AdoptAttributesFromHWND();
243 #endif // __WXUNIVERSAL__
244
245 // Setup background and foreground colours correctly
246 virtual void SetupColours();
247
248 // ------------------------------------------------------------------------
249 // helpers for message handlers: these perform the same function as the
250 // message crackers from <windowsx.h> - they unpack WPARAM and LPARAM into
251 // the correct parameters
252 // ------------------------------------------------------------------------
253
254 void UnpackCommand(WXWPARAM wParam, WXLPARAM lParam,
255 WXWORD *id, WXHWND *hwnd, WXWORD *cmd);
256 void UnpackActivate(WXWPARAM wParam, WXLPARAM lParam,
257 WXWORD *state, WXWORD *minimized, WXHWND *hwnd);
258 void UnpackScroll(WXWPARAM wParam, WXLPARAM lParam,
259 WXWORD *code, WXWORD *pos, WXHWND *hwnd);
260 void UnpackCtlColor(WXWPARAM wParam, WXLPARAM lParam,
261 WXWORD *nCtlColor, WXHDC *hdc, WXHWND *hwnd);
262 void UnpackMenuSelect(WXWPARAM wParam, WXLPARAM lParam,
263 WXWORD *item, WXWORD *flags, WXHMENU *hmenu);
264
265 // ------------------------------------------------------------------------
266 // internal handlers for MSW messages: all handlers return a boolean value:
267 // TRUE means that the handler processed the event and FALSE that it didn't
268 // ------------------------------------------------------------------------
269
270 // there are several cases where we have virtual functions for Windows
271 // message processing: this is because these messages often require to be
272 // processed in a different manner in the derived classes. For all other
273 // messages, however, we do *not* have corresponding MSWOnXXX() function
274 // and if the derived class wants to process them, it should override
275 // MSWWindowProc() directly.
276
277 // scroll event (both horizontal and vertical)
278 virtual bool MSWOnScroll(int orientation, WXWORD nSBCode,
279 WXWORD pos, WXHWND control);
280
281 // child control notifications
282 #ifdef __WIN95__
283 virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
284 #endif // __WIN95__
285
286 // owner-drawn controls need to process these messages
287 virtual bool MSWOnDrawItem(int id, WXDRAWITEMSTRUCT *item);
288 virtual bool MSWOnMeasureItem(int id, WXMEASUREITEMSTRUCT *item);
289
290 // the rest are not virtual
291 bool HandleCreate(WXLPCREATESTRUCT cs, bool *mayCreate);
292 bool HandleInitDialog(WXHWND hWndFocus);
293 bool HandleDestroy();
294
295 bool HandlePaint();
296 bool HandleEraseBkgnd(WXHDC pDC);
297
298 bool HandleMinimize();
299 bool HandleMaximize();
300 bool HandleSize(int x, int y, WXUINT flag);
301 bool HandleGetMinMaxInfo(void *mmInfo);
302
303 bool HandleShow(bool show, int status);
304 bool HandleActivate(int flag, bool minimized, WXHWND activate);
305
306 bool HandleCommand(WXWORD id, WXWORD cmd, WXHWND control);
307 bool HandleSysCommand(WXWPARAM wParam, WXLPARAM lParam);
308
309 bool HandleCtlColor(WXHBRUSH *hBrush,
310 WXHDC hdc,
311 WXHWND hWnd,
312 WXUINT nCtlColor,
313 WXUINT message,
314 WXWPARAM wParam,
315 WXLPARAM lParam);
316
317 bool HandlePaletteChanged(WXHWND hWndPalChange);
318 bool HandleQueryNewPalette();
319 bool HandleSysColorChange();
320
321 bool HandleQueryEndSession(long logOff, bool *mayEnd);
322 bool HandleEndSession(bool endSession, long logOff);
323
324 bool HandleSetFocus(WXHWND wnd);
325 bool HandleKillFocus(WXHWND wnd);
326
327 bool HandleDropFiles(WXWPARAM wParam);
328
329 bool HandleMouseEvent(WXUINT msg, int x, int y, WXUINT flags);
330 bool HandleMouseMove(int x, int y, WXUINT flags);
331 bool HandleMouseWheel(WXWPARAM wParam, WXLPARAM lParam);
332
333 bool HandleChar(WXWPARAM wParam, WXLPARAM lParam, bool isASCII = FALSE);
334 bool HandleKeyDown(WXWPARAM wParam, WXLPARAM lParam);
335 bool HandleKeyUp(WXWPARAM wParam, WXLPARAM lParam);
336
337 bool HandleQueryDragIcon(WXHICON *hIcon);
338
339 bool HandleSetCursor(WXHWND hWnd, short nHitTest, int mouseMsg);
340
341 // Window procedure
342 virtual long MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
343
344 // Calls an appropriate default window procedure
345 virtual long MSWDefWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
346
347 // message processing helpers
348
349 // return FALSE if the message shouldn't be translated/preprocessed but
350 // dispatched normally
351 virtual bool MSWShouldPreProcessMessage(WXMSG* pMsg);
352
353 // return TRUE if the message was preprocessed and shouldn't be dispatched
354 virtual bool MSWProcessMessage(WXMSG* pMsg);
355
356 // return TRUE if the message was translated and shouldn't be dispatched
357 virtual bool MSWTranslateMessage(WXMSG* pMsg);
358
359 // called when the window is about to be destroyed
360 virtual void MSWDestroyWindow();
361
362 // Detach "Window" menu from menu bar so it doesn't get deleted
363 void MSWDetachWindowMenu();
364
365 // this function should return the brush to paint the window background
366 // with or 0 for the default brush
367 virtual WXHBRUSH OnCtlColor(WXHDC hDC,
368 WXHWND hWnd,
369 WXUINT nCtlColor,
370 WXUINT message,
371 WXWPARAM wParam,
372 WXLPARAM lParam);
373
374 #if WXWIN_COMPATIBILITY
375 void SetShowing(bool show) { (void)Show(show); }
376 bool IsUserEnabled() const { return IsEnabled(); }
377 #endif // WXWIN_COMPATIBILITY
378
379 // Responds to colour changes: passes event on to children.
380 void OnSysColourChanged(wxSysColourChangedEvent& event);
381
382 // initialize various fields of wxMouseEvent (common part of MSWOnMouseXXX)
383 void InitMouseEvent(wxMouseEvent& event, int x, int y, WXUINT flags);
384
385 // check if mouse is in the window
386 bool IsMouseInWindow() const;
387
388 protected:
389 // the window handle
390 WXHWND m_hWnd;
391
392 // the old window proc (we subclass all windows)
393 WXFARPROC m_oldWndProc;
394
395 // additional (MSW specific) flags
396 bool m_useCtl3D:1; // Using CTL3D for this control
397 bool m_backgroundTransparent:1;
398 bool m_mouseInWindow:1;
399 bool m_doubleClickAllowed:1;
400
401 // the size of one page for scrolling
402 int m_xThumbSize;
403 int m_yThumbSize;
404
405 #if wxUSE_MOUSEEVENT_HACK
406 // the coordinates of the last mouse event and the type of it
407 long m_lastMouseX,
408 m_lastMouseY;
409 int m_lastMouseEvent;
410 #endif // wxUSE_MOUSEEVENT_HACK
411
412 WXHMENU m_hMenu; // Menu, if any
413
414 // the return value of WM_GETDLGCODE handler
415 long m_lDlgCode;
416
417 // implement the base class pure virtuals
418 virtual void DoClientToScreen( int *x, int *y ) const;
419 virtual void DoScreenToClient( int *x, int *y ) const;
420 virtual void DoGetPosition( int *x, int *y ) const;
421 virtual void DoGetSize( int *width, int *height ) const;
422 virtual void DoGetClientSize( int *width, int *height ) const;
423 virtual void DoSetSize(int x, int y,
424 int width, int height,
425 int sizeFlags = wxSIZE_AUTO);
426 virtual void DoSetClientSize(int width, int height);
427
428 // move the window to the specified location and resize it: this is called
429 // from both DoSetSize() and DoSetClientSize() and would usually just call
430 // ::MoveWindow() except for composite controls which will want to arrange
431 // themselves inside the given rectangle
432 virtual void DoMoveWindow(int x, int y, int width, int height);
433
434 #if wxUSE_TOOLTIPS
435 virtual void DoSetToolTip( wxToolTip *tip );
436 #endif // wxUSE_TOOLTIPS
437
438 // the helper functions used by HandleChar/KeyXXX methods
439 wxKeyEvent CreateKeyEvent(wxEventType evType, int id, WXLPARAM lp) const;
440
441 private:
442 // common part of all ctors
443 void Init();
444
445 // the (non-virtual) handlers for the events
446 bool HandleMove(int x, int y);
447 bool HandleJoystickEvent(WXUINT msg, int x, int y, WXUINT flags);
448
449 #ifdef __WIN95__
450 bool HandleNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
451 #endif // __WIN95__
452
453 DECLARE_DYNAMIC_CLASS(wxWindowMSW)
454 DECLARE_NO_COPY_CLASS(wxWindowMSW)
455 DECLARE_EVENT_TABLE()
456 };
457
458 // ---------------------------------------------------------------------------
459 // global functions
460 // ---------------------------------------------------------------------------
461
462 // kbd code translation
463 WXDLLEXPORT int wxCharCodeMSWToWX(int keySym);
464 WXDLLEXPORT int wxCharCodeWXToMSW(int id, bool *IsVirtual);
465
466 #endif
467 // _WX_WINDOW_H_