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