]> git.saurik.com Git - wxWidgets.git/blame - include/wx/msw/window.h
synched Clear() and SetBackgroundColour()
[wxWidgets.git] / include / wx / msw / window.h
CommitLineData
2bda0e17
KB
1/////////////////////////////////////////////////////////////////////////////
2// Name: window.h
3// Purpose: wxWindow class
4// Author: Julian Smart
5// Modified by:
6// Created: 01/02/97
7// RCS-ID: $Id$
8// Copyright: (c) Julian Smart and Markus Holzem
9f3362c4 9// Licence: wxWindows licence
2bda0e17
KB
10/////////////////////////////////////////////////////////////////////////////
11
bbcdf8bc
JS
12#ifndef _WX_WINDOW_H_
13#define _WX_WINDOW_H_
2bda0e17
KB
14
15#ifdef __GNUG__
16#pragma interface "window.h"
17#endif
18
19#include "wx/gdicmn.h"
20#include "wx/icon.h"
21#include "wx/cursor.h"
22#include "wx/pen.h"
23#include "wx/font.h"
24#include "wx/validate.h"
25#include "wx/event.h"
26#include "wx/string.h"
27#include "wx/list.h"
81d66cf3 28#include "wx/region.h"
14b72bf5 29#include "wx/msw/accel.h"
2bda0e17
KB
30
31#define wxKEY_SHIFT 1
32#define wxKEY_CTRL 2
33
34/*
35 * Base class for frame, panel, canvas, panel items, dialog box.
36 *
37 */
38
39/*
40 * Event handler: windows have themselves as their event handlers
41 * by default, but their event handlers could be set to another
42 * object entirely. This separation can reduce the amount of
43 * derivation required, and allow alteration of a window's functionality
44 * (e.g. by a resource editor that temporarily switches event handlers).
45 */
46
47class WXDLLEXPORT wxWindow;
48class WXDLLEXPORT wxEvent;
49class WXDLLEXPORT wxCommandEvent;
50class WXDLLEXPORT wxKeyEvent;
51class WXDLLEXPORT wxControl;
52class WXDLLEXPORT wxCursor;
53class WXDLLEXPORT wxColourMap;
54class WXDLLEXPORT wxFont;
55class WXDLLEXPORT wxMenu;
1b826605 56class WXDLLEXPORT wxRect;
2bda0e17
KB
57class WXDLLEXPORT wxBitmap;
58class WXDLLEXPORT wxSizer;
59class WXDLLEXPORT wxList;
60class WXDLLEXPORT wxLayoutConstraints;
61class WXDLLEXPORT wxMouseEvent;
62class WXDLLEXPORT wxButton;
63class WXDLLEXPORT wxColour;
64class WXDLLEXPORT wxBrush;
65class WXDLLEXPORT wxPen;
66class WXDLLEXPORT wxIcon;
67class WXDLLEXPORT wxDC;
68class WXDLLEXPORT wxValidator;
9f3362c4 69class WXDLLEXPORT wxToolTip;
2bda0e17 70
47d67540 71#if wxUSE_DRAG_AND_DROP
b823f5a1 72class WXDLLEXPORT wxDropTarget;
2bda0e17
KB
73#endif
74
47d67540 75#if wxUSE_WX_RESOURCES
2bda0e17
KB
76class WXDLLEXPORT wxResourceTable;
77class WXDLLEXPORT wxItemResource;
78#endif
79
80WXDLLEXPORT_DATA(extern const char*) wxPanelNameStr;
81
82WXDLLEXPORT_DATA(extern const wxSize) wxDefaultSize;
83WXDLLEXPORT_DATA(extern const wxPoint) wxDefaultPosition;
84
1e6d9499
JS
85//-----------------------------------------------------------------------------
86// wxClientData
87//-----------------------------------------------------------------------------
88
89class wxClientData
90{
91public:
92 wxClientData() { }
93 virtual ~wxClientData() { }
94};
95
96//-----------------------------------------------------------------------------
97// wxStringClientData
98//-----------------------------------------------------------------------------
99
100class wxStringClientData: public wxClientData
101{
102public:
103 wxStringClientData() { }
104 wxStringClientData( wxString &data ) { m_data = data; }
105 void SetData( wxString &data ) { m_data = data; }
106 wxString GetData() const { return m_data; }
9f3362c4 107
1e6d9499
JS
108private:
109 wxString m_data;
110};
111
3f1af920
JS
112// Clash with Windows headers
113#ifdef GetCharWidth
114#undef GetCharWidth
115#endif
116
117#ifdef FindWindow
118#undef FindWindow
119#endif
120
fd3f686c 121class WXDLLEXPORT wxWindow : public wxEvtHandler
2bda0e17
KB
122{
123 DECLARE_ABSTRACT_CLASS(wxWindow)
124
2bda0e17
KB
125 friend class wxDC;
126 friend class wxPaintDC;
127
128public:
fd3f686c
VZ
129 wxWindow();
130 wxWindow(wxWindow *parent, wxWindowID id,
2bda0e17
KB
131 const wxPoint& pos = wxDefaultPosition,
132 const wxSize& size = wxDefaultSize,
debe6624 133 long style = 0,
2bda0e17
KB
134 const wxString& name = wxPanelNameStr)
135 {
cf65ad8d 136 Init();
2bda0e17
KB
137 Create(parent, id, pos, size, style, name);
138 }
139
fd3f686c 140 virtual ~wxWindow();
2bda0e17 141
debe6624 142 bool Create(wxWindow *parent, wxWindowID id,
2bda0e17
KB
143 const wxPoint& pos = wxDefaultPosition,
144 const wxSize& size = wxDefaultSize,
debe6624 145 long style = 0,
2bda0e17
KB
146 const wxString& name = wxPanelNameStr);
147
148 // Fit the window around the items
fd3f686c 149 virtual void Fit();
2bda0e17
KB
150
151 // Show or hide the window
debe6624 152 virtual bool Show(bool show);
2bda0e17
KB
153
154 // Is the window shown?
fd3f686c 155 virtual bool IsShown() const;
2bda0e17
KB
156
157 // Raise the window to the top of the Z order
fd3f686c 158 virtual void Raise();
2bda0e17
KB
159
160 // Lower the window to the bottom of the Z order
fd3f686c 161 virtual void Lower();
2bda0e17
KB
162
163 // Is the window enabled?
fd3f686c 164 virtual bool IsEnabled() const;
2bda0e17
KB
165
166 // For compatibility
fd3f686c 167 inline bool Enabled() const { return IsEnabled(); }
2bda0e17
KB
168
169 // Dialog support: override these and call
170 // base class members to add functionality
171 // that can't be done using validators.
172
173 // Transfer values to controls. If returns FALSE,
174 // it's an application error (pops up a dialog)
fd3f686c 175 virtual bool TransferDataToWindow();
2bda0e17
KB
176
177 // Transfer values from controls. If returns FALSE,
178 // transfer failed: don't quit
fd3f686c 179 virtual bool TransferDataFromWindow();
2bda0e17
KB
180
181 // Validate controls. If returns FALSE,
182 // validation failed: don't quit
fd3f686c 183 virtual bool Validate();
2bda0e17
KB
184
185 // Return code for dialogs
186 inline void SetReturnCode(int retCode);
fd3f686c 187 inline int GetReturnCode();
2bda0e17
KB
188
189 // Set the cursor
190 virtual void SetCursor(const wxCursor& cursor);
c0ed460c 191 inline virtual wxCursor& GetCursor() const { return (wxCursor& ) m_windowCursor; };
2bda0e17
KB
192
193 // Get the window with the focus
fd3f686c 194 static wxWindow *FindFocus();
2bda0e17
KB
195
196 // Get character size
fd3f686c
VZ
197 virtual int GetCharHeight() const;
198 virtual int GetCharWidth() const;
2bda0e17
KB
199
200 // Get overall window size
201 virtual void GetSize(int *width, int *height) const;
7b218dfa 202 wxSize GetSize() const { int w, h; GetSize(& w, & h); return wxSize(w, h); }
2bda0e17
KB
203
204 // Get window position, relative to parent (or screen if no parent)
205 virtual void GetPosition(int *x, int *y) const;
7b218dfa
VZ
206 wxPoint GetPosition() const
207 { int x, y; GetPosition(&x, &y); return wxPoint(x, y); }
208
209 // Get size and position
210 wxRect GetRect() const
211 { int x, y, w, h; GetPosition(& x, & y); GetSize(& w, & h); return wxRect(x, y, w, h); }
2bda0e17
KB
212
213 // Get client (application-useable) size
214 virtual void GetClientSize(int *width, int *height) const;
7b218dfa 215 wxSize GetClientSize() const { int w, h; GetClientSize(& w, & h); return wxSize(w, h); }
2bda0e17
KB
216
217 // Set overall size and position
7b218dfa 218 // generic function, may be overriden in derived classes
debe6624 219 virtual void SetSize(int x, int y, int width, int height, int sizeFlags = wxSIZE_AUTO);
7b218dfa
VZ
220
221 void SetSize(const wxRect& rect, int sizeFlags = wxSIZE_AUTO)
4fabb575 222 { SetSize(rect.x, rect.y, rect.width, rect.height, sizeFlags); }
4fabb575 223
7b218dfa
VZ
224 // set size only
225 void SetSize(int width, int height)
226 { SetSize(-1, -1, width, height, wxSIZE_USE_EXISTING); }
227 void SetSize(const wxSize& size)
228 { SetSize(-1, -1, size.x, size.y, wxSIZE_USE_EXISTING); }
229
230 // set position only
4fabb575 231 virtual void Move(int x, int y) { SetSize(x, y, -1, -1, wxSIZE_USE_EXISTING); }
7b218dfa 232 void Move(const wxPoint& pt) { SetSize(pt.x, pt.y, -1, -1, wxSIZE_USE_EXISTING); }
2bda0e17
KB
233
234 // Set client size
4fabb575 235 virtual void SetClientSize(int width, int height);
7b218dfa 236 void SetClientSize(const wxSize& sz) { SetClientSize(sz.x, sz.y); }
2bda0e17
KB
237
238 // Convert client to screen coordinates
239 virtual void ClientToScreen(int *x, int *y) const;
7b218dfa 240 wxPoint ClientToScreen(const wxPoint& pt) const
4fabb575 241 { int x = pt.x; int y = pt.y; ClientToScreen(& x, & y); return wxPoint(x, y); }
2bda0e17
KB
242
243 // Convert screen to client coordinates
244 virtual void ScreenToClient(int *x, int *y) const;
7b218dfa 245 wxPoint ScreenToClient(const wxPoint& pt) const
4fabb575 246 { int x = pt.x; int y = pt.y; ScreenToClient(& x, & y); return wxPoint(x, y); }
2bda0e17
KB
247
248 // Set the focus to this window
fd3f686c 249 virtual void SetFocus();
2bda0e17
KB
250
251 // Capture/release mouse
fd3f686c
VZ
252 virtual void CaptureMouse();
253 virtual void ReleaseMouse();
2bda0e17
KB
254
255 // Enable or disable the window
debe6624 256 virtual void Enable(bool enable);
2bda0e17 257
47d67540 258#if wxUSE_DRAG_AND_DROP
2bda0e17
KB
259 // Associate a drop target with this window (if the window already had a drop
260 // target, it's deleted!) and return the current drop target (may be NULL).
261 void SetDropTarget(wxDropTarget *pDropTarget);
262 wxDropTarget *GetDropTarget() const { return m_pDropTarget; }
263#endif
264
9f3362c4
VZ
265 // tooltips
266 // create a tooltip with this text
267 void SetToolTip(const wxString &tip);
268 // pointer may be NULL to remove the tooltip
269 void SetToolTip(wxToolTip *tooltip);
270 // get the current tooltip (may return NULL if none)
271 wxToolTip* GetToolTip() const { return m_tooltip; }
272
2bda0e17 273 // Accept files for dragging
debe6624 274 virtual void DragAcceptFiles(bool accept);
2bda0e17 275
81d66cf3
JS
276 // Update region access
277 virtual wxRegion GetUpdateRegion() const;
278 virtual bool IsExposed(int x, int y, int w, int h) const;
279 virtual bool IsExposed(const wxPoint& pt) const;
280 virtual bool IsExposed(const wxRect& rect) const;
281
2bda0e17
KB
282 // Set/get the window title
283 virtual inline void SetTitle(const wxString& WXUNUSED(title)) {};
fd3f686c 284 inline virtual wxString GetTitle() const { return wxString(""); };
2bda0e17
KB
285 // Most windows have the concept of a label; for frames, this is the
286 // title; for items, this is the label or button text.
fd3f686c 287 inline virtual wxString GetLabel() const { return GetTitle(); }
2bda0e17
KB
288
289 // Set/get the window name (used for resource setting in X)
fd3f686c 290 inline virtual wxString GetName() const;
2bda0e17
KB
291 inline virtual void SetName(const wxString& name);
292
293 // Centre the window
debe6624
JS
294 virtual void Centre(int direction) ;
295 inline void Center(int direction = wxHORIZONTAL) { Centre(direction); }
2bda0e17
KB
296
297 // Popup a menu
debe6624 298 virtual bool PopupMenu(wxMenu *menu, int x, int y);
2bda0e17
KB
299
300 // Send the window a refresh event
1b826605 301 virtual void Refresh(bool eraseBack = TRUE, const wxRect *rect = NULL);
2bda0e17
KB
302
303#if WXWIN_COMPATIBILITY
304 // Set/get scroll attributes
debe6624
JS
305 virtual void SetScrollRange(int orient, int range, bool refresh = TRUE);
306 virtual void SetScrollPage(int orient, int page, bool refresh = TRUE);
307 virtual int OldGetScrollRange(int orient) const;
308 virtual int GetScrollPage(int orient) const;
2bda0e17
KB
309#endif
310
311 // New functions that will replace the above.
debe6624
JS
312 virtual void SetScrollbar(int orient, int pos, int thumbVisible,
313 int range, bool refresh = TRUE);
2bda0e17 314
debe6624
JS
315 virtual void SetScrollPos(int orient, int pos, bool refresh = TRUE);
316 virtual int GetScrollPos(int orient) const;
317 virtual int GetScrollRange(int orient) const;
318 virtual int GetScrollThumb(int orient) const;
2bda0e17 319
1b826605 320 virtual void ScrollWindow(int dx, int dy, const wxRect *rect = NULL);
2bda0e17
KB
321
322 // Caret manipulation
debe6624 323 virtual void CreateCaret(int w, int h);
2bda0e17 324 virtual void CreateCaret(const wxBitmap *bitmap);
fd3f686c 325 virtual void DestroyCaret();
debe6624
JS
326 virtual void ShowCaret(bool show);
327 virtual void SetCaretPos(int x, int y);
2bda0e17
KB
328 virtual void GetCaretPos(int *x, int *y) const;
329
330 // Tell window how much it can be sized
debe6624 331 virtual void SetSizeHints(int minW = -1, int minH = -1, int maxW = -1, int maxH = -1, int incW = -1, int incH = -1);
2bda0e17
KB
332
333 // Set/get the window's identifier
334 inline int GetId() const;
debe6624 335 inline void SetId(int id);
2bda0e17
KB
336
337 // Make the window modal (all other windows unresponsive)
debe6624 338 virtual void MakeModal(bool modal);
2bda0e17
KB
339
340 // Get the private handle (platform-dependent)
fd3f686c 341 inline void *GetHandle() const;
2bda0e17
KB
342
343 // Set/get the window's relatives
fd3f686c 344 inline wxWindow *GetParent() const;
2bda0e17 345 inline void SetParent(wxWindow *p) ;
fd3f686c 346 inline wxWindow *GetGrandParent() const;
c0ed460c 347 inline wxList& GetChildren() const;
4fabb575
JS
348 // Set this window to be the child of 'parent'.
349 // Returns FALSE it's not possible (some systems
350 // won't allow it)
351 virtual bool Reparent(wxWindow *parent);
2bda0e17
KB
352
353 // Set/get the window's font
354 virtual void SetFont(const wxFont& f);
c0ed460c 355 inline virtual wxFont& GetFont() const;
2bda0e17
KB
356
357 // Set/get the window's validator
358 void SetValidator(const wxValidator& validator);
fd3f686c 359 inline wxValidator *GetValidator() const;
2bda0e17
KB
360
361 // Set/get the window's style
debe6624 362 inline void SetWindowStyleFlag(long flag);
fd3f686c 363 inline long GetWindowStyleFlag() const;
2bda0e17
KB
364
365 // Set/get double-clickability
366 // TODO: we probably wish to get rid of this, and
367 // always allow double clicks.
debe6624 368 inline void SetDoubleClick(bool flag);
fd3f686c 369 inline bool GetDoubleClick() const;
debe6624 370 inline void AllowDoubleClick(bool value) { SetDoubleClick(value); }
2bda0e17 371
02e8b2f9 372 // Handle a control command
2bda0e17
KB
373 virtual void OnCommand(wxWindow& win, wxCommandEvent& event);
374
375 // Set/get event handler
376 inline void SetEventHandler(wxEvtHandler *handler);
fd3f686c 377 inline wxEvtHandler *GetEventHandler() const;
2bda0e17
KB
378
379 // Push/pop event handler (i.e. allow a chain of event handlers
380 // be searched)
381 void PushEventHandler(wxEvtHandler *handler) ;
382 wxEvtHandler *PopEventHandler(bool deleteHandler = FALSE) ;
9f3362c4 383
2bda0e17 384 // Close the window by calling OnClose, posting a deletion
debe6624 385 virtual bool Close(bool force = FALSE);
2bda0e17
KB
386
387 // Destroy the window (delayed, if a managed window)
fd3f686c 388 virtual bool Destroy() ;
2bda0e17
KB
389
390 // Mode for telling default OnSize members to
391 // call Layout(), if not using Sizers, just top-down constraints
debe6624 392 inline void SetAutoLayout(bool a);
fd3f686c 393 inline bool GetAutoLayout() const;
2bda0e17
KB
394
395 // Set/get constraints
fd3f686c 396 inline wxLayoutConstraints *GetConstraints() const;
2bda0e17
KB
397 void SetConstraints(wxLayoutConstraints *c);
398
399 // Set/get window background colour
400 inline virtual void SetBackgroundColour(const wxColour& col);
fd3f686c 401 inline virtual wxColour GetBackgroundColour() const;
2bda0e17
KB
402
403 // Set/get window foreground colour
404 inline virtual void SetForegroundColour(const wxColour& col);
fd3f686c 405 inline virtual wxColour GetForegroundColour() const;
2bda0e17 406
2bda0e17
KB
407 // For backward compatibility
408 inline virtual void SetButtonFont(const wxFont& font) { SetFont(font); }
409 inline virtual void SetLabelFont(const wxFont& font) { SetFont(font); }
c0ed460c
JS
410 inline virtual wxFont& GetLabelFont() const { return GetFont(); };
411 inline virtual wxFont& GetButtonFont() const { return GetFont(); };
2bda0e17
KB
412
413 // Get the default button, if there is one
fd3f686c 414 inline virtual wxButton *GetDefaultItem() const;
2bda0e17
KB
415 inline virtual void SetDefaultItem(wxButton *but);
416
14b72bf5 417 virtual void SetAcceleratorTable(const wxAcceleratorTable& accel);
46ccb510 418 inline virtual wxAcceleratorTable& GetAcceleratorTable() const { return (wxAcceleratorTable&) m_acceleratorTable; }
14b72bf5 419
2bda0e17
KB
420 // Override to define new behaviour for default action (e.g. double clicking
421 // on a listbox)
422 virtual void OnDefaultAction(wxControl *initiatingItem);
423
424 // Resource loading
47d67540 425#if wxUSE_WX_RESOURCES
2bda0e17 426 virtual bool LoadFromResource(wxWindow *parent, const wxString& resourceName, const wxResourceTable *table = NULL);
fd71308f 427 virtual wxControl *CreateItem(const wxItemResource* childResource, const wxItemResource* parentResource, const wxResourceTable *table = NULL);
2bda0e17
KB
428#endif
429
430 // Native resource loading
debe6624 431 virtual bool LoadNativeDialog(wxWindow* parent, wxWindowID& id);
2bda0e17 432 virtual bool LoadNativeDialog(wxWindow* parent, const wxString& name);
debe6624
JS
433 virtual wxWindow* GetWindowChild1(wxWindowID& id);
434 virtual wxWindow* GetWindowChild(wxWindowID& id);
2bda0e17
KB
435
436 virtual void GetTextExtent(const wxString& string, int *x, int *y,
437 int *descent = NULL,
438 int *externalLeading = NULL,
debe6624 439 const wxFont *theFont = NULL, bool use16 = FALSE) const;
2bda0e17
KB
440
441 // Is the window retained?
fd3f686c 442 inline bool IsRetained() const;
2bda0e17 443
2bda0e17 444 // Warp the pointer the given position
debe6624 445 virtual void WarpPointer(int x_pos, int y_pos) ;
2bda0e17
KB
446
447 // Clear the window
fd3f686c 448 virtual void Clear();
2bda0e17
KB
449
450 // Find a window by id or name
debe6624 451 virtual wxWindow *FindWindow(long id);
2bda0e17
KB
452 virtual wxWindow *FindWindow(const wxString& name);
453
454 // Constraint operations
fd3f686c 455 bool Layout();
2bda0e17 456 void SetSizer(wxSizer *sizer); // Adds sizer child to this window
fd3f686c
VZ
457 inline wxSizer *GetSizer() const ;
458 inline wxWindow *GetSizerParent() const ;
2bda0e17
KB
459 inline void SetSizerParent(wxWindow *win);
460
461 // Do Update UI processing for controls
fd3f686c 462 void UpdateWindowUI();
2bda0e17 463
2bda0e17
KB
464 void OnEraseBackground(wxEraseEvent& event);
465 void OnChar(wxKeyEvent& event);
2bda0e17
KB
466 void OnIdle(wxIdleEvent& event);
467
52476186
VZ
468 // Does this window want to accept keyboard focus?
469 virtual bool AcceptsFocus() const;
470
57c208c5 471 virtual void PrepareDC( wxDC& WXUNUSED(dc) ) {};
2bda0e17
KB
472public:
473 ////////////////////////////////////////////////////////////////////////
474 //// IMPLEMENTATION
9f3362c4 475
81d66cf3
JS
476 // For implementation purposes - sometimes decorations make the client area
477 // smaller
478 virtual wxPoint GetClientAreaOrigin() const;
479
480 // Makes an adjustment to the window position (for example, a frame that has
481 // a toolbar that it manages itself).
482 virtual void AdjustForParentClientOrigin(int& x, int& y, int sizeFlags);
483
2bda0e17
KB
484 // Windows subclassing
485 void SubclassWin(WXHWND hWnd);
fd3f686c
VZ
486 void UnsubclassWin();
487 virtual long Default();
debe6624 488 virtual bool MSWCommand(WXUINT param, WXWORD id);
fd3f686c
VZ
489
490 // returns TRUE if the event was processed
491 virtual bool MSWNotify(WXWPARAM wParam, WXLPARAM lParam, WXLPARAM *result);
492
debe6624
JS
493 virtual wxWindow *FindItem(int id) const;
494 virtual wxWindow *FindItemByHWND(WXHWND hWnd, bool controlOnly = FALSE) const ;
495 virtual void PreDelete(WXHDC dc); // Allows system cleanup
2bda0e17 496 // TO DO: how many of these need to be virtual?
fd3f686c 497 virtual WXHWND GetHWND() const ;
2bda0e17
KB
498 virtual void SetHWND(WXHWND hWnd);
499
500 // Make a Windows extended style from the given wxWindows window style
501 virtual WXDWORD MakeExtendedStyle(long style, bool eliminateBorders = TRUE);
502 // Determine whether 3D effects are wanted
503 virtual WXDWORD Determine3DEffects(WXDWORD defaultBorderStyle, bool *want3D);
504
505 virtual void AddChild(wxWindow *child); // Adds reference to the child object
506 virtual void RemoveChild(wxWindow *child); // Removes reference to child
507 // (but doesn't delete the child object)
fd3f686c 508 virtual void DestroyChildren(); // Removes and destroys all children
2bda0e17 509
fd3f686c 510 inline bool IsBeingDeleted();
2bda0e17
KB
511
512 // MSW only: TRUE if this control is part of the main control
513 virtual bool ContainsHWND(WXHWND WXUNUSED(hWnd)) const { return FALSE; };
514
515 // Constraint implementation
516 void UnsetConstraints(wxLayoutConstraints *c);
fd3f686c 517 inline wxList *GetConstraintsInvolvedIn() const ;
2bda0e17
KB
518 // Back-pointer to other windows we're involved with, so if we delete
519 // this window, we must delete any constraints we're involved with.
520 void AddConstraintReference(wxWindow *otherWin);
521 void RemoveConstraintReference(wxWindow *otherWin);
fd3f686c 522 void DeleteRelatedConstraints();
2bda0e17 523
fd3f686c 524 virtual void ResetConstraints();
debe6624 525 virtual void SetConstraintSizes(bool recurse = TRUE);
2bda0e17
KB
526 virtual bool LayoutPhase1(int *noChanges);
527 virtual bool LayoutPhase2(int *noChanges);
debe6624 528 virtual bool DoPhase(int);
2bda0e17
KB
529 // Transforms from sizer coordinate space to actual
530 // parent coordinate space
531 virtual void TransformSizerToActual(int *x, int *y) const ;
532
533 // Set size with transformation to actual coordinates if nec.
debe6624
JS
534 virtual void SizerSetSize(int x, int y, int w, int h);
535 virtual void SizerMove(int x, int y);
2bda0e17
KB
536
537 // Only set/get the size/position of the constraint (if any)
debe6624
JS
538 virtual void SetSizeConstraint(int x, int y, int w, int h);
539 virtual void MoveConstraint(int x, int y);
2bda0e17
KB
540 virtual void GetSizeConstraint(int *w, int *h) const ;
541 virtual void GetClientSizeConstraint(int *w, int *h) const ;
542 virtual void GetPositionConstraint(int *x, int *y) const ;
543
fd71308f
JS
544 // Dialog units translations. Implemented in wincmn.cpp.
545 wxPoint ConvertPixelsToDialog(const wxPoint& pt) ;
546 wxPoint ConvertDialogToPixels(const wxPoint& pt) ;
547 inline wxSize ConvertPixelsToDialog(const wxSize& sz)
548 { wxPoint pt(ConvertPixelsToDialog(wxPoint(sz.x, sz.y))); return wxSize(pt.x, pt.y); }
549 inline wxSize ConvertDialogToPixels(const wxSize& sz)
550 { wxPoint pt(ConvertDialogToPixels(wxPoint(sz.x, sz.y))); return wxSize(pt.x, pt.y); }
551
debe6624 552 wxObject *GetChild(int number) const ;
2bda0e17 553
debe6624
JS
554 void MSWCreate(int id, wxWindow *parent, const char *wclass, wxWindow *wx_win, const char *title,
555 int x, int y, int width, int height,
556 WXDWORD style, const char *dialog_template = NULL,
557 WXDWORD exendedStyle = 0);
2bda0e17
KB
558
559 // Actually defined in wx_canvs.cc since requires wxCanvas declaration
560 virtual void MSWDeviceToLogical(float *x, float *y) const ;
561
562 // Create an appropriate wxWindow from a HWND
563 virtual wxWindow* CreateWindowFromHWND(wxWindow* parent, WXHWND hWnd);
564
565 // Make sure the window style reflects the HWND style (roughly)
fd3f686c 566 virtual void AdoptAttributesFromHWND();
2bda0e17
KB
567
568 // Setup background and foreground colours correctly
fd3f686c 569 virtual void SetupColours();
2bda0e17 570
a02eb1d2
VZ
571 // Saves the last message information before calling base version
572 virtual bool ProcessEvent(wxEvent& event);
573
2bda0e17
KB
574 // Handlers
575 virtual void MSWOnCreate(WXLPCREATESTRUCT cs);
fd3f686c
VZ
576 virtual bool MSWOnPaint();
577 virtual WXHICON MSWOnQueryDragIcon() { return 0; }
debe6624 578 virtual void MSWOnSize(int x, int y, WXUINT flag);
2bda0e17 579 virtual void MSWOnWindowPosChanging(void *lpPos);
debe6624
JS
580 virtual void MSWOnHScroll(WXWORD nSBCode, WXWORD pos, WXHWND control);
581 virtual void MSWOnVScroll(WXWORD nSBCode, WXWORD pos, WXHWND control);
582 virtual bool MSWOnCommand(WXWORD id, WXWORD cmd, WXHWND control);
2bda0e17 583 virtual long MSWOnSysCommand(WXWPARAM wParam, WXLPARAM lParam);
fd3f686c 584 virtual long MSWOnNotify(WXWPARAM wParam, WXLPARAM lParam);
debe6624
JS
585 virtual WXHBRUSH MSWOnCtlColor(WXHDC dc, WXHWND pWnd, WXUINT nCtlColor,
586 WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
587 virtual bool MSWOnColorChange(WXHWND hWnd, WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
f7bd2698
JS
588 virtual long MSWOnPaletteChanged(WXHWND hWndPalChange);
589 virtual long MSWOnQueryNewPalette();
debe6624
JS
590 virtual bool MSWOnEraseBkgnd(WXHDC pDC);
591 virtual void MSWOnMenuHighlight(WXWORD item, WXWORD flags, WXHMENU sysmenu);
592 virtual void MSWOnInitMenuPopup(WXHMENU menu, int pos, bool isSystem);
fd3f686c 593 virtual bool MSWOnClose();
387a3b02
JS
594 // Return TRUE to end session, FALSE to veto end session.
595 virtual bool MSWOnQueryEndSession(long logOff);
596 virtual bool MSWOnEndSession(bool endSession, long logOff);
fd3f686c 597 virtual bool MSWOnDestroy();
debe6624
JS
598 virtual bool MSWOnSetFocus(WXHWND wnd);
599 virtual bool MSWOnKillFocus(WXHWND wnd);
600 virtual void MSWOnDropFiles(WXWPARAM wParam);
2bda0e17
KB
601 virtual bool MSWOnInitDialog(WXHWND hWndFocus);
602 virtual void MSWOnShow(bool show, int status);
603
604 // TODO: rationalise these functions into 1 or 2 which take the
605 // event type as argument.
debe6624
JS
606 virtual void MSWOnLButtonDown(int x, int y, WXUINT flags);
607 virtual void MSWOnLButtonUp(int x, int y, WXUINT flags);
608 virtual void MSWOnLButtonDClick(int x, int y, WXUINT flags);
2bda0e17 609
debe6624
JS
610 virtual void MSWOnMButtonDown(int x, int y, WXUINT flags);
611 virtual void MSWOnMButtonUp(int x, int y, WXUINT flags);
612 virtual void MSWOnMButtonDClick(int x, int y, WXUINT flags);
2bda0e17 613
debe6624
JS
614 virtual void MSWOnRButtonDown(int x, int y, WXUINT flags);
615 virtual void MSWOnRButtonUp(int x, int y, WXUINT flags);
616 virtual void MSWOnRButtonDClick(int x, int y, WXUINT flags);
2bda0e17 617
debe6624
JS
618 virtual void MSWOnMouseMove(int x, int y, WXUINT flags);
619 virtual void MSWOnMouseEnter(int x, int y, WXUINT flags);
620 virtual void MSWOnMouseLeave(int x, int y, WXUINT flags);
2bda0e17 621
debe6624 622 virtual void MSWOnChar(WXWORD wParam, WXLPARAM lParam, bool isASCII = FALSE);
4ce81a75
JS
623 virtual void MSWOnKeyDown(WXWORD wParam, WXLPARAM lParam, bool isASCII = FALSE);
624 virtual void MSWOnKeyUp(WXWORD wParam, WXLPARAM lParam, bool isASCII = FALSE);
2bda0e17 625
debe6624
JS
626 virtual bool MSWOnActivate(int flag, bool minimized, WXHWND activate);
627 virtual long MSWOnMDIActivate(long flag, WXHWND activate, WXHWND deactivate);
2bda0e17 628
debe6624
JS
629 virtual bool MSWOnDrawItem(int id, WXDRAWITEMSTRUCT *item);
630 virtual bool MSWOnMeasureItem(int id, WXMEASUREITEMSTRUCT *item);
2bda0e17 631
debe6624
JS
632 virtual void MSWOnJoyDown(int joystick, int x, int y, WXUINT flags);
633 virtual void MSWOnJoyUp(int joystick, int x, int y, WXUINT flags);
634 virtual void MSWOnJoyMove(int joystick, int x, int y, WXUINT flags);
635 virtual void MSWOnJoyZMove(int joystick, int z, WXUINT flags);
2bda0e17 636
52476186
VZ
637 virtual long MSWGetDlgCode();
638
2bda0e17
KB
639 // Window procedure
640 virtual long MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
641
642 // Calls an appropriate default window procedure
643 virtual long MSWDefWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
644 virtual bool MSWProcessMessage(WXMSG* pMsg);
57a7b7c1 645 virtual bool MSWTranslateMessage(WXMSG* pMsg);
fd3f686c 646 virtual void MSWDestroyWindow();
2bda0e17
KB
647
648 // Detach "Window" menu from menu bar so it doesn't get deleted
fd3f686c 649 void MSWDetachWindowMenu();
9f3362c4 650
2bda0e17 651 inline WXFARPROC MSWGetOldWndProc() const;
debe6624 652 inline void MSWSetOldWndProc(WXFARPROC proc);
2bda0e17
KB
653
654 // Define for each class of dialog and control
debe6624 655 virtual WXHBRUSH OnCtlColor(WXHDC pDC, WXHWND pWnd, WXUINT nCtlColor,
9f3362c4 656 WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
2bda0e17 657
debe6624 658 inline void SetShowing(bool show);
fd3f686c
VZ
659 inline bool IsUserEnabled() const;
660 inline bool GetUseCtl3D() const ;
661 inline bool GetTransparentBackground() const ;
2bda0e17
KB
662
663 // Responds to colour changes: passes event on to children.
664 void OnSysColourChanged(wxSysColourChangedEvent& event);
665
666 // Transfers data to any child controls
667 void OnInitDialog(wxInitDialogEvent& event);
668
669 // Sends an OnInitDialog event, which in turns transfers data to
670 // to the window via validators.
fd3f686c 671 virtual void InitDialog();
2bda0e17
KB
672
673 ////////////////////////////////////////////////////////////////////////
674 //// PROTECTED DATA
675protected:
14b72bf5 676 wxAcceleratorTable m_acceleratorTable;
2bda0e17 677 int m_windowId;
9f3362c4
VZ
678 long m_windowStyle; // Store the window's style
679 wxEvtHandler * m_windowEventHandler; // Usually is 'this'
2bda0e17
KB
680 wxLayoutConstraints * m_constraints; // Constraints for this window
681 wxList * m_constraintsInvolvedIn; // List of constraints we're involved in
682 wxSizer * m_windowSizer; // Window's top-level sizer (if any)
683 wxWindow * m_sizerParent; // Window's parent sizer (if any)
684 bool m_autoLayout; // Whether to call Layout() in OnSize
685 wxWindow * m_windowParent; // Each window always knows its parent
686 wxValidator * m_windowValidator;
687 // Old window proc, for subclassed controls
688 WXFARPROC m_oldWndProc;
689 bool m_useCtl3D; // Using CTL3D for this control
690
9f3362c4 691 bool m_inOnSize; // Protection against OnSize reentry
bbcdf8bc 692#ifndef _WX_WIN32__
2bda0e17
KB
693 // Pointer to global memory, for EDIT controls that need
694 // special treatment to reduce USER area consumption.
695 WXHGLOBAL m_globalHandle;
696#endif
697
698 bool m_winEnabled;
699 int m_minSizeX;
700 int m_minSizeY;
701 int m_maxSizeX;
702 int m_maxSizeY;
703
704 // Caret data
705 int m_caretWidth;
706 int m_caretHeight;
707 bool m_caretEnabled;
708 bool m_caretShown;
2bda0e17
KB
709 wxFont m_windowFont; // Window's font
710 bool m_isShown;
711 bool m_doubleClickAllowed ;
712 wxCursor m_windowCursor; // Window's cursor
713 bool m_winCaptured;
714 wxString m_windowName; // Window name
715
47d67540 716#if wxUSE_EXTENDED_STATICS
2bda0e17
KB
717 wxList m_staticItems;
718#endif
719
720 wxButton * m_defaultItem;
2bda0e17 721 wxColour m_backgroundColour ;
2bda0e17 722 wxColour m_foregroundColour ;
2bda0e17
KB
723 bool m_backgroundTransparent;
724
2bda0e17
KB
725 int m_xThumbSize;
726 int m_yThumbSize;
727
728 float m_lastXPos;
729 float m_lastYPos;
730 int m_lastEvent;
731
732 bool m_mouseInWindow;
733
47d67540 734#if wxUSE_DRAG_AND_DROP
2bda0e17
KB
735 wxDropTarget *m_pDropTarget; // the current drop target or NULL
736#endif //USE_DRAG_AND_DROP
737
738public:
9f3362c4 739 WXHWND m_hWnd; // MS Windows window handle
2bda0e17
KB
740 WXUINT m_lastMsg;
741 WXWPARAM m_lastWParam;
742 WXLPARAM m_lastLParam;
81d66cf3
JS
743
744 wxRegion m_updateRegion;
745/*
1b826605 746 wxRect m_updateRect; // Bounding box for screen damage area
2bda0e17
KB
747#ifdef __WIN32__
748 WXHRGN m_updateRgn; // NT allows access to the rectangle list
749#endif
81d66cf3
JS
750*/
751
57a7b7c1 752// WXHANDLE m_acceleratorTable;
2bda0e17
KB
753 WXHMENU m_hMenu; // Menu, if any
754 wxList * m_children; // Window's children
755 int m_returnCode;
756 bool m_isBeingDeleted; // Fudge because can't access parent
757 // when being deleted
758
fd3f686c
VZ
759private:
760 // common part of all ctors
761 void Init();
762
9f3362c4
VZ
763 // the associated tooltip (may be NULL if none)
764 wxToolTip *m_tooltip;
765
fd3f686c 766 DECLARE_EVENT_TABLE()
2bda0e17
KB
767};
768
769////////////////////////////////////////////////////////////////////////
770//// INLINES
771
fd3f686c 772inline void *wxWindow::GetHandle() const { return (void *)GetHWND(); }
2bda0e17 773inline int wxWindow::GetId() const { return m_windowId; }
debe6624 774inline void wxWindow::SetId(int id) { m_windowId = id; }
fd3f686c 775inline wxWindow *wxWindow::GetParent() const { return m_windowParent; }
2bda0e17 776inline void wxWindow::SetParent(wxWindow *p) { m_windowParent = p; }
57c208c5 777inline wxWindow *wxWindow::GetGrandParent() const { return (m_windowParent ? m_windowParent->m_windowParent : (wxWindow*) NULL); }
c0ed460c
JS
778inline wxList& wxWindow::GetChildren() const { return (wxList&) *m_children; }
779inline wxFont& wxWindow::GetFont() const { return (wxFont&) m_windowFont; }
fd3f686c 780inline wxString wxWindow::GetName() const { return m_windowName; }
2bda0e17 781inline void wxWindow::SetName(const wxString& name) { m_windowName = name; }
fd3f686c 782inline long wxWindow::GetWindowStyleFlag() const { return m_windowStyle; }
debe6624
JS
783inline void wxWindow::SetWindowStyleFlag(long flag) { m_windowStyle = flag; }
784inline void wxWindow::SetDoubleClick(bool flag) { m_doubleClickAllowed = flag; }
fd3f686c 785inline bool wxWindow::GetDoubleClick() const { return m_doubleClickAllowed; }
2bda0e17 786inline void wxWindow::SetEventHandler(wxEvtHandler *handler) { m_windowEventHandler = handler; }
fd3f686c 787inline wxEvtHandler *wxWindow::GetEventHandler() const { return m_windowEventHandler; }
debe6624 788inline void wxWindow::SetAutoLayout(bool a) { m_autoLayout = a; }
fd3f686c
VZ
789inline bool wxWindow::GetAutoLayout() const { return m_autoLayout; }
790inline wxLayoutConstraints *wxWindow::GetConstraints() const { return m_constraints; }
2bda0e17 791inline void wxWindow::SetBackgroundColour(const wxColour& col) { m_backgroundColour = col; };
fd3f686c 792inline wxColour wxWindow::GetBackgroundColour() const { return m_backgroundColour; };
2bda0e17 793inline void wxWindow::SetForegroundColour(const wxColour& col) { m_foregroundColour = col; };
fd3f686c 794inline wxColour wxWindow::GetForegroundColour() const { return m_foregroundColour; };
2bda0e17 795
fd3f686c 796inline wxButton *wxWindow::GetDefaultItem() const { return m_defaultItem; }
2bda0e17 797inline void wxWindow::SetDefaultItem(wxButton *but) { m_defaultItem = but; }
fd3f686c 798inline bool wxWindow::IsRetained() const { return ((m_windowStyle & wxRETAINED) == wxRETAINED); }
debe6624 799
debe6624 800inline void wxWindow::SetShowing(bool show) { m_isShown = show; }
fd3f686c
VZ
801inline wxList *wxWindow::GetConstraintsInvolvedIn() const { return m_constraintsInvolvedIn; }
802inline wxSizer *wxWindow::GetSizer() const { return m_windowSizer; }
803inline wxWindow *wxWindow::GetSizerParent() const { return m_sizerParent; }
2bda0e17
KB
804inline void wxWindow::SetSizerParent(wxWindow *win) { m_sizerParent = win; }
805inline WXFARPROC wxWindow::MSWGetOldWndProc() const { return m_oldWndProc; }
debe6624 806inline void wxWindow::MSWSetOldWndProc(WXFARPROC proc) { m_oldWndProc = proc; }
fd3f686c
VZ
807inline wxValidator *wxWindow::GetValidator() const { return m_windowValidator; }
808inline bool wxWindow::IsUserEnabled() const { return m_winEnabled; }
809inline bool wxWindow::GetUseCtl3D() const { return m_useCtl3D; }
810inline bool wxWindow::GetTransparentBackground() const { return m_backgroundTransparent; }
2bda0e17 811inline void wxWindow::SetReturnCode(int retCode) { m_returnCode = retCode; }
fd3f686c
VZ
812inline int wxWindow::GetReturnCode() { return m_returnCode; }
813inline bool wxWindow::IsBeingDeleted() { return m_isBeingDeleted; }
2bda0e17
KB
814
815// Window specific (so far)
fd3f686c 816WXDLLEXPORT wxWindow* wxGetActiveWindow();
2bda0e17 817
2bda0e17
KB
818WXDLLEXPORT_DATA(extern wxList) wxTopLevelWindows;
819
184b5d99
JS
820WXDLLEXPORT int wxCharCodeMSWToWX(int keySym);
821WXDLLEXPORT int wxCharCodeWXToMSW(int id, bool *IsVirtual);
2bda0e17
KB
822
823// Allocates control ids
fd3f686c 824WXDLLEXPORT int NewControlId();
2bda0e17
KB
825
826#endif
bbcdf8bc 827 // _WX_WINDOW_H_