1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxWindow class
8 // Copyright: (c) AUTHOR
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
16 #pragma interface "window.h"
19 // ---------------------------------------------------------------------------
20 // forward declarations
21 // ---------------------------------------------------------------------------
23 class WXDLLEXPORT wxButton
;
24 class WXDLLEXPORT wxScrollBar
;
26 // ---------------------------------------------------------------------------
28 // ---------------------------------------------------------------------------
30 // FIXME does anybody use those? they're unused by wxWindows...
37 class WXDLLEXPORT wxWindow
: public wxWindowBase
39 DECLARE_DYNAMIC_CLASS(wxWindow
);
42 friend class wxPaintDC
;
45 typedef struct MacWindowData
47 SInt16 m_macWindowBackgroundTheme
;
48 WindowRef m_macWindow
;
49 ControlHandle m_macRootControl
;
50 wxWindow
* m_macFocus
;
54 wxWindow() { Init(); }
56 wxWindow(wxWindow
*parent
,
58 const wxPoint
& pos
= wxDefaultPosition
,
59 const wxSize
& size
= wxDefaultSize
,
61 const wxString
& name
= wxPanelNameStr
)
64 Create(parent
, id
, pos
, size
, style
, name
);
69 bool Create(wxWindow
*parent
,
71 const wxPoint
& pos
= wxDefaultPosition
,
72 const wxSize
& size
= wxDefaultSize
,
74 const wxString
& name
= wxPanelNameStr
);
77 // implement base class pure virtuals
78 virtual void SetTitle( const wxString
& title
);
79 virtual wxString
GetTitle() const;
84 virtual bool Show( bool show
= TRUE
);
85 virtual bool Enable( bool enable
= TRUE
);
87 virtual void SetFocus();
89 virtual bool Reparent( wxWindow
*newParent
);
91 virtual void WarpPointer(int x
, int y
);
92 virtual void CaptureMouse();
93 virtual void ReleaseMouse();
95 virtual void Refresh( bool eraseBackground
= TRUE
,
96 const wxRect
*rect
= (const wxRect
*) NULL
);
99 virtual bool SetCursor( const wxCursor
&cursor
);
100 virtual bool SetFont( const wxFont
&font
);
102 virtual int GetCharHeight() const;
103 virtual int GetCharWidth() const;
104 virtual void GetTextExtent(const wxString
& string
,
106 int *descent
= (int *) NULL
,
107 int *externalLeading
= (int *) NULL
,
108 const wxFont
*theFont
= (const wxFont
*) NULL
)
111 virtual bool DoPopupMenu( wxMenu
*menu
, int x
, int y
);
113 virtual void SetScrollbar( int orient
, int pos
, int thumbVisible
,
114 int range
, bool refresh
= TRUE
);
115 virtual void SetScrollPos( int orient
, int pos
, bool refresh
= TRUE
);
116 virtual int GetScrollPos( int orient
) const;
117 virtual int GetScrollThumb( int orient
) const;
118 virtual int GetScrollRange( int orient
) const;
119 virtual void ScrollWindow( int dx
, int dy
,
120 const wxRect
* rect
= (wxRect
*) NULL
);
122 #if wxUSE_DRAG_AND_DROP
123 virtual void SetDropTarget( wxDropTarget
*dropTarget
);
124 #endif // wxUSE_DRAG_AND_DROP
126 // Accept files for dragging
127 virtual void DragAcceptFiles(bool accept
);
129 #if WXWIN_COMPATIBILITY
130 // Set/get scroll attributes
131 virtual void SetScrollRange(int orient
, int range
, bool refresh
= TRUE
);
132 virtual void SetScrollPage(int orient
, int page
, bool refresh
= TRUE
);
133 virtual int OldGetScrollRange(int orient
) const;
134 virtual int GetScrollPage(int orient
) const;
137 // Handle a control command
138 virtual void OnCommand(wxWindow
& win
, wxCommandEvent
& event
);
140 // Override to define new behaviour for default action (e.g. double
141 // clicking on a listbox)
142 virtual void OnDefaultAction(wxControl
* WXUNUSED(initiatingItem
)) { }
143 #endif // WXWIN_COMPATIBILITY
145 #if wxUSE_CARET && WXWIN_COMPATIBILITY
146 // caret manipulation (old MSW only functions, see wxCaret class for the
148 void CreateCaret(int w
, int h
);
149 void CreateCaret(const wxBitmap
*bitmap
);
151 void ShowCaret(bool show
);
152 void SetCaretPos(int x
, int y
);
153 void GetCaretPos(int *x
, int *y
) const;
154 #endif // wxUSE_CARET
156 // Native resource loading (implemented in src/msw/nativdlg.cpp)
157 // FIXME: should they really be all virtual?
158 virtual bool LoadNativeDialog(wxWindow
* parent
, wxWindowID
& id
);
159 virtual bool LoadNativeDialog(wxWindow
* parent
, const wxString
& name
);
160 wxWindow
* GetWindowChild1(wxWindowID id
);
161 wxWindow
* GetWindowChild(wxWindowID id
);
163 // implementation from now on
164 // --------------------------
166 void MacClientToRootWindow( int *x
, int *y
) const ;
167 void MacRootWindowToClient( int *x
, int *y
) const ;
173 // WXHWND GetHWND() const { return m_hWnd; }
174 // void SetHWND(WXHWND hWnd) { m_hWnd = hWnd; }
175 virtual WXWidget
GetHandle() const { return (WXWidget
) NULL
; }
177 bool GetUseCtl3D() const { return m_useCtl3D
; }
178 bool GetTransparentBackground() const { return m_backgroundTransparent
; }
179 void SetTransparent(bool t
= TRUE
) { m_backgroundTransparent
= t
; }
183 void OnEraseBackground(wxEraseEvent
& event
);
184 void OnIdle(wxIdleEvent
& event
);
187 // For implementation purposes - sometimes decorations make the client area
189 virtual wxPoint
GetClientAreaOrigin() const;
191 // Makes an adjustment to the window position (for example, a frame that has
192 // a toolbar that it manages itself).
193 virtual void AdjustForParentClientOrigin(int& x
, int& y
, int sizeFlags
);
195 wxWindow
*FindItem(long id
) const;
196 wxWindow
*FindItemByHWND(WXHWND hWnd
, bool controlOnly
= FALSE
) const;
198 // Make a Windows extended style from the given wxWindows window style
199 static WXDWORD
MakeExtendedStyle(long style
,
200 bool eliminateBorders
= TRUE
);
201 // Determine whether 3D effects are wanted
202 WXDWORD
Determine3DEffects(WXDWORD defaultBorderStyle
, bool *want3D
) const;
204 // MSW only: TRUE if this control is part of the main control
205 virtual bool ContainsHWND(WXHWND
WXUNUSED(hWnd
)) const { return FALSE
; };
207 #if WXWIN_COMPATIBILITY
208 wxObject
*GetChild(int number
) const;
209 virtual void MSWDeviceToLogical(float *x
, float *y
) const;
210 #endif // WXWIN_COMPATIBILITY
212 // Create an appropriate wxWindow from a HWND
213 virtual wxWindow
* CreateWindowFromHWND(wxWindow
* parent
, WXHWND hWnd
);
215 // Make sure the window style reflects the HWND style (roughly)
216 virtual void AdoptAttributesFromHWND();
218 // Setup background and foreground colours correctly
219 virtual void SetupColours();
222 #if WXWIN_COMPATIBILITY
223 void SetShowing(bool show
) { (void)Show(show
); }
224 bool IsUserEnabled() const { return IsEnabled(); }
225 #endif // WXWIN_COMPATIBILITY
227 // Responds to colour changes: passes event on to children.
228 void OnSysColourChanged(wxSysColourChangedEvent
& event
);
231 static bool MacGetWindowFromPoint( const wxPoint
&point
, wxWindow
** outWin
) ;
232 virtual void MacActivate( EventRecord
*ev
, bool inIsActivating
) ;
233 virtual void MacUpdate( EventRecord
*ev
) ;
234 virtual void MacUpdateImmediately() ;
235 virtual void MacRedraw( RgnHandle updatergn
, long time
) ;
236 virtual void MacMouseDown( EventRecord
*ev
, short windowPart
) ;
237 virtual void MacMouseUp( EventRecord
*ev
, short windowPart
) ;
238 virtual void MacMouseMoved( EventRecord
*ev
, short windowPart
) ;
239 virtual void MacKeyDown( EventRecord
*ev
) ;
240 virtual bool MacCanFocus() const { return true ; }
242 virtual void MacFireMouseEvent( EventRecord
*ev
) ;
243 virtual bool MacDispatchMouseEvent(wxMouseEvent
& event
) ;
244 virtual void MacEraseBackground( Rect
*rect
) ;
245 WindowRef
GetMacRootWindow() const ;
247 virtual ControlHandle
MacGetContainerForEmbedding() ;
248 virtual void MacSuperChangedPosition() ;
250 bool MacSetupFocusPort() ;
251 bool MacSetupDrawingPort() ;
252 bool MacSetupFocusClientPort() ;
253 bool MacSetupDrawingClientPort() ;
255 virtual bool MacSetPortFocusParams( const Point
& localOrigin
, const Rect
& clipRect
, WindowRef window
, wxWindow
* rootwin
) ;
256 virtual bool MacSetPortDrawingParams( const Point
& localOrigin
, const Rect
& clipRect
, WindowRef window
, wxWindow
* rootwin
) ;
258 virtual void MacGetPortParams(Point
* localOrigin
, Rect
* clipRect
, WindowRef
*window
, wxWindow
** rootwin
) ;
259 virtual void MacGetPortClientParams(Point
* localOrigin
, Rect
* clipRect
, WindowRef
*window
, wxWindow
** rootwin
) ;
260 MacWindowData
* MacGetWindowData() { return m_macWindowData
; }
261 static WindowRef
MacGetWindowInUpdate() { return s_macWindowInUpdate
; }
262 static wxWindow
* s_lastMouseWindow
;
264 virtual bool MacGetWindowFromPointSub( const wxPoint
&point
, wxWindow
** outWin
) ;
267 MacWindowData
* m_macWindowData
;
268 static WindowRef s_macWindowInUpdate
;
275 wxScrollBar
* m_hScrollBar
;
276 wxScrollBar
* m_vScrollBar
;
279 void MacCreateScrollBars( long style
) ;
280 void MacRepositionScrollBars() ;
282 // additional (MSW specific) flags
283 bool m_useCtl3D
:1; // Using CTL3D for this control
284 bool m_backgroundTransparent
:1;
285 bool m_mouseInWindow
:1;
286 bool m_doubleClickAllowed
:1;
287 bool m_winCaptured
:1;
289 // the size of one page for scrolling
293 // WXHMENU m_hMenu; // Menu, if any
295 // implement the base class pure virtuals
296 virtual void DoClientToScreen( int *x
, int *y
) const;
297 virtual void DoScreenToClient( int *x
, int *y
) const;
298 virtual void DoGetPosition( int *x
, int *y
) const;
299 virtual void DoGetSize( int *width
, int *height
) const;
300 virtual void DoGetClientSize( int *width
, int *height
) const;
301 virtual void DoSetSize(int x
, int y
,
302 int width
, int height
,
303 int sizeFlags
= wxSIZE_AUTO
);
304 virtual void DoSetClientSize(int width
, int height
);
306 // get the size which best suits the window: e.g., for a static text it
307 // will be the width and height of the text
308 virtual wxSize
DoGetBestSize();
310 // move the window to the specified location and resize it: this is called
311 // from both DoSetSize() and DoSetClientSize() and would usually just call
312 // ::MoveWindow() except for composite controls which will want to arrange
313 // themselves inside the given rectangle
314 virtual void DoMoveWindow(int x
, int y
, int width
, int height
);
317 virtual void DoSetToolTip( wxToolTip
*tip
);
318 #endif // wxUSE_TOOLTIPS
321 // common part of all ctors
324 DECLARE_NO_COPY_CLASS(wxWindow
);
325 DECLARE_EVENT_TABLE()
328 // associate mac windows with wx counterparts
330 wxWindow
* wxFindWinFromMacWindow( WindowRef inWindow
) ;
331 void wxAssociateWinWithMacWindow(WindowRef inWindow
, wxWindow
*win
) ;
332 void wxRemoveMacWindowAssociation(wxWindow
*win
) ;
334 class wxMacFocusHelper
337 wxMacFocusHelper( wxWindow
* theWindow
) ;
338 ~wxMacFocusHelper() ;
339 bool Ok() { return m_ok
; }
342 GrafPtr m_formerPort
;
343 GrafPtr m_currentPort
;
347 class wxMacDrawingHelper
350 wxMacDrawingHelper( wxWindow
* theWindow
) ;
351 ~wxMacDrawingHelper() ;
352 bool Ok() { return m_ok
; }
355 GrafPtr m_formerPort
;
356 GrafPtr m_currentPort
;
357 PenState m_savedPenState
;
361 class wxMacFocusClientHelper
364 wxMacFocusClientHelper( wxWindow
* theWindow
) ;
365 ~wxMacFocusClientHelper() ;
366 bool Ok() { return m_ok
; }
369 GrafPtr m_formerPort
;
370 GrafPtr m_currentPort
;
374 class wxMacDrawingClientHelper
377 wxMacDrawingClientHelper( wxWindow
* theWindow
) ;
378 ~wxMacDrawingClientHelper() ;
379 bool Ok() { return m_ok
; }
382 GrafPtr m_formerPort
;
383 GrafPtr m_currentPort
;
384 PenState m_savedPenState
;