1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxWindow class
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
16 #pragma interface "window.h"
19 #include "wx/gdicmn.h"
21 #include "wx/cursor.h"
24 #include "wx/validate.h"
26 #include "wx/string.h"
28 #include "wx/region.h"
35 * Base class for frame, panel, canvas, panel items, dialog box.
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).
47 class WXDLLEXPORT wxWindow
;
48 class WXDLLEXPORT wxEvent
;
49 class WXDLLEXPORT wxCommandEvent
;
50 class WXDLLEXPORT wxKeyEvent
;
51 class WXDLLEXPORT wxControl
;
52 class WXDLLEXPORT wxCursor
;
53 class WXDLLEXPORT wxColourMap
;
54 class WXDLLEXPORT wxFont
;
55 class WXDLLEXPORT wxMenu
;
56 class WXDLLEXPORT wxRectangle
;
57 class WXDLLEXPORT wxBitmap
;
58 class WXDLLEXPORT wxSizer
;
59 class WXDLLEXPORT wxList
;
60 class WXDLLEXPORT wxLayoutConstraints
;
61 class WXDLLEXPORT wxMouseEvent
;
62 class WXDLLEXPORT wxButton
;
63 class WXDLLEXPORT wxColour
;
64 class WXDLLEXPORT wxBrush
;
65 class WXDLLEXPORT wxPen
;
66 class WXDLLEXPORT wxIcon
;
67 class WXDLLEXPORT wxDC
;
68 class WXDLLEXPORT wxValidator
;
70 #if wxUSE_DRAG_AND_DROP
71 class WXDLLEXPORT wxDropTarget
;
74 #if wxUSE_WX_RESOURCES
75 class WXDLLEXPORT wxResourceTable
;
76 class WXDLLEXPORT wxItemResource
;
79 WXDLLEXPORT_DATA(extern const char*) wxPanelNameStr
;
81 WXDLLEXPORT_DATA(extern const wxSize
) wxDefaultSize
;
82 WXDLLEXPORT_DATA(extern const wxPoint
) wxDefaultPosition
;
84 class WXDLLEXPORT wxWindow
: public wxEvtHandler
86 DECLARE_ABSTRACT_CLASS(wxWindow
)
88 friend class WXDLLEXPORT wxDC
;
89 friend class WXDLLEXPORT wxWindowDC
;
93 inline wxWindow(wxWindow
*parent
, wxWindowID id
,
94 const wxPoint
& pos
= wxDefaultPosition
,
95 const wxSize
& size
= wxDefaultSize
,
97 const wxString
& name
= wxPanelNameStr
)
99 m_children
= new wxList
;
100 Create(parent
, id
, pos
, size
, style
, name
);
105 bool Create(wxWindow
*parent
, wxWindowID id
,
106 const wxPoint
& pos
= wxDefaultPosition
,
107 const wxSize
& size
= wxDefaultSize
,
109 const wxString
& name
= wxPanelNameStr
);
111 // Fit the window around the items
114 // Show or hide the window
115 virtual bool Show(bool show
);
117 // Is the window shown?
118 virtual bool IsShown() const;
120 // Raise the window to the top of the Z order
121 virtual void Raise();
123 // Lower the window to the bottom of the Z order
124 virtual void Lower();
126 // Is the window enabled?
127 virtual bool IsEnabled() const;
130 inline bool Enabled() const { return IsEnabled(); }
132 // Dialog support: override these and call
133 // base class members to add functionality
134 // that can't be done using validators.
136 // Transfer values to controls. If returns FALSE,
137 // it's an application error (pops up a dialog)
138 virtual bool TransferDataToWindow();
140 // Transfer values from controls. If returns FALSE,
141 // transfer failed: don't quit
142 virtual bool TransferDataFromWindow();
144 // Validate controls. If returns FALSE,
145 // validation failed: don't quit
146 virtual bool Validate();
148 // Return code for dialogs
149 inline void SetReturnCode(int retCode
);
150 inline int GetReturnCode();
153 virtual void SetCursor(const wxCursor
& cursor
);
154 inline virtual wxCursor
*GetCursor() const { return (wxCursor
*)& m_windowCursor
; };
156 // Get the window with the focus
157 static wxWindow
*FindFocus();
159 // Get character size
160 virtual int GetCharHeight() const;
161 virtual int GetCharWidth() const;
163 // Get overall window size
164 virtual void GetSize(int *width
, int *height
) const;
166 // Get window position, relative to parent (or screen if no parent)
167 virtual void GetPosition(int *x
, int *y
) const;
169 // Get client (application-useable) size
170 virtual void GetClientSize(int *width
, int *height
) const;
172 // Set overall size and position
173 virtual void SetSize(int x
, int y
, int width
, int height
, int sizeFlags
= wxSIZE_AUTO
);
174 inline virtual void SetSize(int width
, int height
) { SetSize(-1, -1, width
, height
, wxSIZE_USE_EXISTING
); }
175 inline virtual void Move(int x
, int y
) { SetSize(x
, y
, -1, -1, wxSIZE_USE_EXISTING
); }
178 virtual void SetClientSize(int width
, int size
);
180 // Convert client to screen coordinates
181 virtual void ClientToScreen(int *x
, int *y
) const;
183 // Convert screen to client coordinates
184 virtual void ScreenToClient(int *x
, int *y
) const;
186 // Set the focus to this window
187 virtual void SetFocus();
189 // Capture/release mouse
190 virtual void CaptureMouse();
191 virtual void ReleaseMouse();
193 // Enable or disable the window
194 virtual void Enable(bool enable
);
196 #if wxUSE_DRAG_AND_DROP
197 // Associate a drop target with this window (if the window already had a drop
198 // target, it's deleted!) and return the current drop target (may be NULL).
199 void SetDropTarget(wxDropTarget
*pDropTarget
);
200 wxDropTarget
*GetDropTarget() const { return m_pDropTarget
; }
203 // Accept files for dragging
204 virtual void DragAcceptFiles(bool accept
);
206 // Update region access
207 virtual wxRegion
GetUpdateRegion() const;
208 virtual bool IsExposed(int x
, int y
, int w
, int h
) const;
209 virtual bool IsExposed(const wxPoint
& pt
) const;
210 virtual bool IsExposed(const wxRect
& rect
) const;
212 // Set/get the window title
213 virtual inline void SetTitle(const wxString
& WXUNUSED(title
)) {};
214 inline virtual wxString
GetTitle() const { return wxString(""); };
215 // Most windows have the concept of a label; for frames, this is the
216 // title; for items, this is the label or button text.
217 inline virtual wxString
GetLabel() const { return GetTitle(); }
219 // Set/get the window name (used for resource setting in X)
220 inline virtual wxString
GetName() const;
221 inline virtual void SetName(const wxString
& name
);
224 virtual void Centre(int direction
) ;
225 inline void Center(int direction
= wxHORIZONTAL
) { Centre(direction
); }
228 virtual bool PopupMenu(wxMenu
*menu
, int x
, int y
);
230 // Send the window a refresh event
231 virtual void Refresh(bool eraseBack
= TRUE
, const wxRectangle
*rect
= NULL
);
233 // New functions that will replace the above.
234 virtual void SetScrollbar(int orient
, int pos
, int thumbVisible
,
235 int range
, bool refresh
= TRUE
);
237 virtual void SetScrollPos(int orient
, int pos
, bool refresh
= TRUE
);
238 virtual int GetScrollPos(int orient
) const;
239 virtual int GetScrollRange(int orient
) const;
240 virtual int GetScrollThumb(int orient
) const;
242 virtual void ScrollWindow(int dx
, int dy
, const wxRectangle
*rect
= NULL
);
244 // Caret manipulation
245 virtual void CreateCaret(int w
, int h
);
246 virtual void CreateCaret(const wxBitmap
*bitmap
);
247 virtual void DestroyCaret();
248 virtual void ShowCaret(bool show
);
249 virtual void SetCaretPos(int x
, int y
);
250 virtual void GetCaretPos(int *x
, int *y
) const;
252 // Tell window how much it can be sized
253 virtual void SetSizeHints(int minW
= -1, int minH
= -1, int maxW
= -1, int maxH
= -1, int incW
= -1, int incH
= -1);
255 // Set/get the window's identifier
256 inline int GetId() const;
257 inline void SetId(int id
);
259 virtual void SetAcceleratorTable(const wxAcceleratorTable
& accel
);
260 inline virtual wxAcceleratorTable
& GetAcceleratorTable() const { return (wxAcceleratorTable
&) m_acceleratorTable
; }
262 // Make the window modal (all other windows unresponsive)
263 virtual void MakeModal(bool modal
);
265 // Get the private handle (platform-dependent)
266 inline void *GetHandle() const;
268 // Set/get the window's relatives
269 inline wxWindow
*GetParent() const;
270 inline void SetParent(wxWindow
*p
) ;
271 inline wxWindow
*GetGrandParent() const;
272 inline wxList
*GetChildren() const;
274 // Set/get the window's font
275 virtual void SetFont(const wxFont
& f
);
276 inline virtual wxFont
*GetFont() const;
278 // Set/get the window's validator
279 void SetValidator(const wxValidator
& validator
);
280 inline wxValidator
*GetValidator() const;
282 // Set/get the window's style
283 inline void SetWindowStyleFlag(long flag
);
284 inline long GetWindowStyleFlag() const;
286 // Handle a control command
287 virtual void OnCommand(wxWindow
& win
, wxCommandEvent
& event
);
289 // Set/get event handler
290 inline void SetEventHandler(wxEvtHandler
*handler
);
291 inline wxEvtHandler
*GetEventHandler() const;
293 // Push/pop event handler (i.e. allow a chain of event handlers
295 void PushEventHandler(wxEvtHandler
*handler
) ;
296 wxEvtHandler
*PopEventHandler(bool deleteHandler
= FALSE
) ;
298 // Close the window by calling OnClose, posting a deletion
299 virtual bool Close(bool force
= FALSE
);
301 // Destroy the window (delayed, if a managed window)
302 virtual bool Destroy() ;
304 // Mode for telling default OnSize members to
305 // call Layout(), if not using Sizers, just top-down constraints
306 inline void SetAutoLayout(bool a
);
307 inline bool GetAutoLayout() const;
309 // Set/get constraints
310 inline wxLayoutConstraints
*GetConstraints() const;
311 void SetConstraints(wxLayoutConstraints
*c
);
313 // Set/get window background colour
314 inline virtual void SetBackgroundColour(const wxColour
& col
);
315 inline virtual wxColour
GetBackgroundColour() const;
317 // Set/get window foreground colour
318 inline virtual void SetForegroundColour(const wxColour
& col
);
319 inline virtual wxColour
GetForegroundColour() const;
321 // Set/get window default background colour (for children to inherit).
322 // NOTE: these may be removed in later revisions.
323 inline virtual void SetDefaultBackgroundColour(const wxColour
& col
);
324 inline virtual wxColour
GetDefaultBackgroundColour(void) const;
326 // Set/get window default foreground colour (for children to inherit)
327 inline virtual void SetDefaultForegroundColour(const wxColour
& col
);
328 inline virtual wxColour
GetDefaultForegroundColour(void) const;
330 // Get the default button, if there is one
331 inline virtual wxButton
*GetDefaultItem() const;
332 inline virtual void SetDefaultItem(wxButton
*but
);
334 // Override to define new behaviour for default action (e.g. double clicking
336 virtual void OnDefaultAction(wxControl
*initiatingItem
);
339 #if wxUSE_WX_RESOURCES
340 virtual bool LoadFromResource(wxWindow
*parent
, const wxString
& resourceName
, const wxResourceTable
*table
= NULL
);
341 virtual wxControl
*CreateItem(const wxItemResource
*childResource
, const wxResourceTable
*table
= NULL
);
344 virtual void GetTextExtent(const wxString
& string
, int *x
, int *y
,
346 int *externalLeading
= NULL
,
347 const wxFont
*theFont
= NULL
, bool use16
= FALSE
) const;
349 // Is the window retained?
350 inline bool IsRetained() const;
352 // Warp the pointer the given position
353 virtual void WarpPointer(int x_pos
, int y_pos
) ;
356 virtual void Clear();
358 // Find a window by id or name
359 virtual wxWindow
*FindWindow(long id
);
360 virtual wxWindow
*FindWindow(const wxString
& name
);
362 // Constraint operations
364 void SetSizer(wxSizer
*sizer
); // Adds sizer child to this window
365 inline wxSizer
*GetSizer() const ;
366 inline wxWindow
*GetSizerParent() const ;
367 inline void SetSizerParent(wxWindow
*win
);
369 // Do Update UI processing for controls
370 void UpdateWindowUI();
372 void OnEraseBackground(wxEraseEvent
& event
);
373 void OnChar(wxKeyEvent
& event
);
374 void OnPaint(wxPaintEvent
& event
);
375 void OnIdle(wxIdleEvent
& event
);
377 // Does this window want to accept keyboard focus?
378 virtual bool AcceptsFocus() const;
380 virtual void PrepareDC( wxDC
&dc
) {};
384 ////////////////////////////////////////////////////////////////////////
387 // For implementation purposes - sometimes decorations make the client area
389 virtual wxPoint
GetClientAreaOrigin() const;
391 // Makes an adjustment to the window position (for example, a frame that has
392 // a toolbar that it manages itself).
393 virtual void AdjustForParentClientOrigin(int& x
, int& y
, int sizeFlags
);
395 // Executes the default message
396 virtual long Default();
398 /* TODO: you may need something like this
399 // Determine whether 3D effects are wanted
400 virtual WXDWORD Determine3DEffects(WXDWORD defaultBorderStyle, bool *want3D);
403 virtual void AddChild(wxWindow
*child
); // Adds reference to the child object
404 virtual void RemoveChild(wxWindow
*child
); // Removes reference to child
405 // (but doesn't delete the child object)
406 virtual void DestroyChildren(); // Removes and destroys all children
408 inline bool IsBeingDeleted() const { return FALSE
; } // TODO: Should probably eliminate this
410 // Constraint implementation
411 void UnsetConstraints(wxLayoutConstraints
*c
);
412 inline wxList
*GetConstraintsInvolvedIn() const ;
413 // Back-pointer to other windows we're involved with, so if we delete
414 // this window, we must delete any constraints we're involved with.
415 void AddConstraintReference(wxWindow
*otherWin
);
416 void RemoveConstraintReference(wxWindow
*otherWin
);
417 void DeleteRelatedConstraints();
419 virtual void ResetConstraints();
420 virtual void SetConstraintSizes(bool recurse
= TRUE
);
421 virtual bool LayoutPhase1(int *noChanges
);
422 virtual bool LayoutPhase2(int *noChanges
);
423 virtual bool DoPhase(int);
424 // Transforms from sizer coordinate space to actual
425 // parent coordinate space
426 virtual void TransformSizerToActual(int *x
, int *y
) const ;
428 // Set size with transformation to actual coordinates if nec.
429 virtual void SizerSetSize(int x
, int y
, int w
, int h
);
430 virtual void SizerMove(int x
, int y
);
432 // Only set/get the size/position of the constraint (if any)
433 virtual void SetSizeConstraint(int x
, int y
, int w
, int h
);
434 virtual void MoveConstraint(int x
, int y
);
435 virtual void GetSizeConstraint(int *w
, int *h
) const ;
436 virtual void GetClientSizeConstraint(int *w
, int *h
) const ;
437 virtual void GetPositionConstraint(int *x
, int *y
) const ;
439 wxObject
*GetChild(int number
) const ;
441 // Generates a new id for controls
442 static int NewControlId();
444 // Responds to colour changes: passes event on to children.
445 void OnSysColourChanged(wxSysColourChangedEvent
& event
);
447 // Transfers data to any child controls
448 void OnInitDialog(wxInitDialogEvent
& event
);
450 // Sends an OnInitDialog event, which in turns transfers data to
451 // to the window via validators.
452 virtual void InitDialog();
456 void CanvasGetSize(int* width
, int* height
) const; // If have drawing area
457 void CanvasGetClientSize(int *width
, int *height
) const;
458 void CanvasGetPosition(int *x
, int *y
) const; // If have drawing area
459 void CanvasSetClientSize(int width
, int size
);
460 void CanvasSetSize(int x
, int y
, int width
, int height
, int sizeFlags
= wxSIZE_AUTO
);
462 // Gives window a chance to do something in response to a size
463 // message, e.g. arrange status bar, toolbar etc.
464 virtual bool PreResize() { return TRUE
; }
466 // Get main widget for this window, e.g. a text widget
467 virtual WXWidget
GetMainWidget() const;
468 // Get the client widget for this window (something we can
469 // create other windows on)
470 virtual WXWidget
GetClientWidget() const;
471 // Get the top widget for this window, e.g. the scrolled widget parent
472 // of a multi-line text widget. Top means, top in the window hierarchy
473 // that implements this window.
474 virtual WXWidget
GetTopWidget() const;
475 virtual void SetMainWidget(WXWidget w
) { m_mainWidget
= w
; }
476 bool CanAddEventHandler() const { return m_canAddEventHandler
; }
477 void SetCanAddEventHandler(bool flag
) { m_canAddEventHandler
= flag
; }
479 // Get the underlying X window and display
480 virtual WXWindow
GetXWindow() const;
481 virtual WXDisplay
*GetXDisplay() const;
483 virtual WXPixmap
GetBackingPixmap() const { return m_backingPixmap
; }
484 inline int GetPixmapWidth() const { return m_pixmapWidth
; }
485 inline int GetPixmapHeight() const { return m_pixmapHeight
; }
486 virtual WXRegion
GetPaintRegion() const { return m_paintRegion
; }
489 virtual void ChangeColour(WXWidget widget
);
490 virtual void ChangeFont(WXWidget widget
);
492 // Adds the widget to the hash table and adds event handlers.
493 bool AttachWidget (wxWindow
* parent
, WXWidget mainWidget
,
494 WXWidget formWidget
, int x
, int y
, int width
, int height
);
495 bool DetachWidget(WXWidget widget
);
497 // Generates a paint event
498 virtual void DoPaint();
500 ////////////////////////////////////////////////////////////////////////
504 long m_windowStyle
; // Store the window's style
505 wxEvtHandler
* m_windowEventHandler
; // Usually is 'this'
506 wxLayoutConstraints
* m_constraints
; // Constraints for this window
507 wxList
* m_constraintsInvolvedIn
; // List of constraints we're involved in
508 wxSizer
* m_windowSizer
; // Window's top-level sizer (if any)
509 wxWindow
* m_sizerParent
; // Window's parent sizer (if any)
510 bool m_autoLayout
; // Whether to call Layout() in OnSize
511 wxWindow
* m_windowParent
; // Each window always knows its parent
512 wxValidator
* m_windowValidator
;
523 wxFont m_windowFont
; // Window's font
524 wxCursor m_windowCursor
; // Window's cursor
525 wxString m_windowName
; // Window name
527 wxButton
* m_defaultItem
;
529 wxColour m_backgroundColour
;
530 wxColour m_foregroundColour
;
531 wxColour m_defaultBackgroundColour
;
532 wxColour m_defaultForegroundColour
;
533 wxAcceleratorTable m_acceleratorTable
;
535 #if wxUSE_DRAG_AND_DROP
536 wxDropTarget
*m_pDropTarget
; // the current drop target or NULL
537 #endif //USE_DRAG_AND_DROP
540 wxRegion m_updateRegion
;
541 wxList
* m_children
; // Window's children
546 bool m_canAddEventHandler
;
547 bool m_button1Pressed
;
548 bool m_button2Pressed
;
549 bool m_button3Pressed
;
550 // For double-click detection
551 long m_lastTS
; // last timestamp
552 int m_lastButton
; // last pressed button
553 wxList m_updateRects
; // List of wxRectangles representing damaged region
555 WXRegion m_paintRegion
; // Clip region generated by expose event
557 WXWidget m_mainWidget
;
558 WXWidget m_hScrollBar
;
559 WXWidget m_vScrollBar
;
560 WXWidget m_borderWidget
;
561 WXWidget m_scrolledWindow
;
562 WXWidget m_drawingArea
;
566 bool m_hScrollingEnabled
;
567 bool m_vScrollingEnabled
;
568 WXPixmap m_backingPixmap
;
574 DECLARE_EVENT_TABLE()
577 ////////////////////////////////////////////////////////////////////////
580 inline void *wxWindow::GetHandle() const { return (void *)NULL
; }
581 inline int wxWindow::GetId() const { return m_windowId
; }
582 inline void wxWindow::SetId(int id
) { m_windowId
= id
; }
583 inline wxWindow
*wxWindow::GetParent() const { return m_windowParent
; }
584 inline void wxWindow::SetParent(wxWindow
*p
) { m_windowParent
= p
; }
585 inline wxWindow
*wxWindow::GetGrandParent() const { return (m_windowParent
? m_windowParent
->m_windowParent
: (wxWindow
*) NULL
); }
586 inline wxList
*wxWindow::GetChildren() const { return m_children
; }
587 inline wxFont
*wxWindow::GetFont() const { return (wxFont
*) & m_windowFont
; }
588 inline wxString
wxWindow::GetName() const { return m_windowName
; }
589 inline void wxWindow::SetName(const wxString
& name
) { m_windowName
= name
; }
590 inline long wxWindow::GetWindowStyleFlag() const { return m_windowStyle
; }
591 inline void wxWindow::SetWindowStyleFlag(long flag
) { m_windowStyle
= flag
; }
592 inline void wxWindow::SetEventHandler(wxEvtHandler
*handler
) { m_windowEventHandler
= handler
; }
593 inline wxEvtHandler
*wxWindow::GetEventHandler() const { return m_windowEventHandler
; }
594 inline void wxWindow::SetAutoLayout(bool a
) { m_autoLayout
= a
; }
595 inline bool wxWindow::GetAutoLayout() const { return m_autoLayout
; }
596 inline wxLayoutConstraints
*wxWindow::GetConstraints() const { return m_constraints
; }
597 inline void wxWindow::SetBackgroundColour(const wxColour
& col
) { m_backgroundColour
= col
; };
598 inline wxColour
wxWindow::GetBackgroundColour() const { return m_backgroundColour
; };
599 inline void wxWindow::SetForegroundColour(const wxColour
& col
) { m_foregroundColour
= col
; };
600 inline wxColour
wxWindow::GetForegroundColour() const { return m_foregroundColour
; };
601 inline void wxWindow::SetDefaultForegroundColour(const wxColour
& col
) { m_defaultForegroundColour
= col
; };
602 inline wxColour
wxWindow::GetDefaultForegroundColour(void) const { return m_defaultForegroundColour
; };
603 inline void wxWindow::SetDefaultBackgroundColour(const wxColour
& col
) { m_defaultBackgroundColour
= col
; };
604 inline wxColour
wxWindow::GetDefaultBackgroundColour(void) const { return m_defaultBackgroundColour
; };
606 inline wxButton
*wxWindow::GetDefaultItem() const { return m_defaultItem
; }
607 inline void wxWindow::SetDefaultItem(wxButton
*but
) { m_defaultItem
= but
; }
608 inline bool wxWindow::IsRetained() const { return ((m_windowStyle
& wxRETAINED
) == wxRETAINED
); }
610 inline wxList
*wxWindow::GetConstraintsInvolvedIn() const { return m_constraintsInvolvedIn
; }
611 inline wxSizer
*wxWindow::GetSizer() const { return m_windowSizer
; }
612 inline wxWindow
*wxWindow::GetSizerParent() const { return m_sizerParent
; }
613 inline void wxWindow::SetSizerParent(wxWindow
*win
) { m_sizerParent
= win
; }
614 inline wxValidator
*wxWindow::GetValidator() const { return m_windowValidator
; }
615 inline void wxWindow::SetReturnCode(int retCode
) { m_returnCode
= retCode
; }
616 inline int wxWindow::GetReturnCode() { return m_returnCode
; }
618 // Get the active window.
619 wxWindow
* WXDLLEXPORT
wxGetActiveWindow();
621 WXDLLEXPORT_DATA(extern wxList
) wxTopLevelWindows
;