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 // ----------------------------------------------------------------------------
20 // A list of rectangles type used by wxWindow
21 // ----------------------------------------------------------------------------
23 WX_DECLARE_LIST(wxRect
, wxRectList
);
25 // ----------------------------------------------------------------------------
26 // wxWindow class for Motif - see also wxWindowBase
27 // ----------------------------------------------------------------------------
29 class wxWindow
: public wxWindowBase
31 DECLARE_DYNAMIC_CLASS(wxWindow
)
33 friend class WXDLLEXPORT wxDC
;
34 friend class WXDLLEXPORT wxWindowDC
;
37 wxWindow() { Init(); }
39 wxWindow(wxWindow
*parent
,
41 const wxPoint
& pos
= wxDefaultPosition
,
42 const wxSize
& size
= wxDefaultSize
,
44 const wxString
& name
= wxPanelNameStr
)
47 Create(parent
, id
, pos
, size
, style
, name
);
52 bool Create(wxWindow
*parent
,
54 const wxPoint
& pos
= wxDefaultPosition
,
55 const wxSize
& size
= wxDefaultSize
,
57 const wxString
& name
= wxPanelNameStr
);
59 // implement base class pure virtuals
60 virtual void SetTitle( const wxString
& title
);
61 virtual wxString
GetTitle() const;
66 virtual bool Show( bool show
= TRUE
);
67 virtual bool Enable( bool enable
= TRUE
);
69 virtual void SetFocus();
71 virtual void WarpPointer(int x
, int y
);
72 virtual void CaptureMouse();
73 virtual void ReleaseMouse();
75 virtual void Refresh( bool eraseBackground
= TRUE
,
76 const wxRect
*rect
= (const wxRect
*) NULL
);
79 virtual bool SetBackgroundColour( const wxColour
&colour
);
80 virtual bool SetForegroundColour( const wxColour
&colour
);
82 virtual bool SetCursor( const wxCursor
&cursor
);
83 virtual bool SetFont( const wxFont
&font
);
85 virtual int GetCharHeight() const;
86 virtual int GetCharWidth() const;
87 virtual void GetTextExtent(const wxString
& string
,
89 int *descent
= (int *) NULL
,
90 int *externalLeading
= (int *) NULL
,
91 const wxFont
*theFont
= (const wxFont
*) NULL
)
94 virtual bool PopupMenu( wxMenu
*menu
, int x
, int y
);
96 virtual void SetScrollbar( int orient
, int pos
, int thumbVisible
,
97 int range
, bool refresh
= TRUE
);
98 virtual void SetScrollPos( int orient
, int pos
, bool refresh
= TRUE
);
99 virtual int GetScrollPos( int orient
) const;
100 virtual int GetScrollThumb( int orient
) const;
101 virtual int GetScrollRange( int orient
) const;
102 virtual void ScrollWindow( int dx
, int dy
,
103 const wxRect
* rect
= (wxRect
*) NULL
);
105 virtual void SetSizeHints(int minW
, int minH
,
108 #if wxUSE_DRAG_AND_DROP
109 virtual void SetDropTarget( wxDropTarget
*dropTarget
);
110 #endif // wxUSE_DRAG_AND_DROP
112 // Accept files for dragging
113 virtual void DragAcceptFiles(bool accept
);
115 // Get the unique identifier of a window
116 virtual WXWidget
GetHandle() const { return GetMainWidget(); }
118 // implementation from now on
119 // --------------------------
124 // Get main widget for this window, e.g. a text widget
125 virtual WXWidget
GetMainWidget() const;
126 // Get the widget that corresponds to the label (for font setting, label setting etc.)
127 virtual WXWidget
GetLabelWidget() const;
128 // Get the client widget for this window (something we can create other
130 virtual WXWidget
GetClientWidget() const;
131 // Get the top widget for this window, e.g. the scrolled widget parent of a
132 // multi-line text widget. Top means, top in the window hierarchy that
133 // implements this window.
134 virtual WXWidget
GetTopWidget() const;
136 // Get the underlying X window and display
137 WXWindow
GetXWindow() const;
138 WXDisplay
*GetXDisplay() const;
140 // called from Motif callbacks - and should only be called from there
142 void SetButton1(bool pressed
) { m_button1Pressed
= pressed
; }
143 void SetButton2(bool pressed
) { m_button2Pressed
= pressed
; }
144 void SetButton3(bool pressed
) { m_button3Pressed
= pressed
; }
146 void SetLastClick(int button
, long timestamp
)
147 { m_lastButton
= button
; m_lastTS
= timestamp
; }
149 int GetLastClickedButton() const { return m_lastButton
; }
150 long GetLastClickTime() const { return m_lastTS
; }
152 // Gives window a chance to do something in response to a size message, e.g.
153 // arrange status bar, toolbar etc.
154 virtual bool PreResize();
156 // Generates a paint event
157 virtual void DoPaint();
159 // update rectangle/region manipulation
160 // (for wxWindowDC and Motif callbacks only)
161 // -----------------------------------------
163 // read/write access to the update rect list
164 const wxRectList
& GetUpdateRects() const { return m_updateRects
; }
166 // Adds a recangle to the updates list
167 void AddUpdateRect(int x
, int y
, int w
, int h
)
168 { m_updateRects
.Append(new wxRect(x
, y
, w
, h
)); }
170 // Empties the m_updateRects list
171 void ClearUpdateRects();
173 void ClearUpdateRegion() { m_updateRegion
.Clear(); }
174 void SetUpdateRegion(const wxRegion
& region
) { m_updateRegion
= region
; }
177 // event handlers (not virtual by design)
178 void OnIdle(wxIdleEvent
& event
);
180 // For implementation purposes - sometimes decorations make the client area
182 virtual wxPoint
GetClientAreaOrigin() const;
184 // Makes an adjustment to the window position (for example, a frame that has
185 // a toolbar that it manages itself).
186 virtual void AdjustForParentClientOrigin(int& x
, int& y
, int sizeFlags
);
188 wxWindow
*GetChild(int number
) const
189 { return GetChildren().Item(number
)->GetData(); }
191 // Responds to colour changes: passes event on to children.
192 void OnSysColourChanged(wxSysColourChangedEvent
& event
);
196 // CanvasXXXSiize functions
197 void CanvasGetSize(int* width
, int* height
) const; // If have drawing area
198 void CanvasGetClientSize(int *width
, int *height
) const;
199 void CanvasGetPosition(int *x
, int *y
) const; // If have drawing area
200 void CanvasSetClientSize(int width
, int size
);
201 void CanvasSetSize(int x
, int y
, int width
, int height
, int sizeFlags
= wxSIZE_AUTO
);
203 void SetMainWidget(WXWidget w
) { m_mainWidget
= w
; }
205 bool CanAddEventHandler() const { return m_canAddEventHandler
; }
206 void SetCanAddEventHandler(bool flag
) { m_canAddEventHandler
= flag
; }
208 WXPixmap
GetBackingPixmap() const { return m_backingPixmap
; }
209 int GetPixmapWidth() const { return m_pixmapWidth
; }
210 int GetPixmapHeight() const { return m_pixmapHeight
; }
213 virtual void ChangeFont(bool keepOriginalSize
= TRUE
); // Change to the current font (often overridden)
214 virtual void DoChangeForegroundColour(WXWidget widget
, wxColour
& foregroundColour
);
215 virtual void DoChangeBackgroundColour(WXWidget widget
, wxColour
& backgroundColour
, bool changeArmColour
= FALSE
);
217 // Change background and foreground colour using current background colour
218 // setting (Motif generates foreground based on background)
219 virtual void ChangeBackgroundColour();
220 // Change foreground colour using current foreground colour setting
221 virtual void ChangeForegroundColour();
223 // Adds the widget to the hash table and adds event handlers.
224 bool AttachWidget(wxWindow
* parent
, WXWidget mainWidget
,
225 WXWidget formWidget
, int x
, int y
, int width
, int height
);
226 bool DetachWidget(WXWidget widget
);
228 // How to implement accelerators. If we find a key event, translate to
229 // wxWindows wxKeyEvent form. Find a widget for the window. Now find a
230 // wxWindow for the widget. If there isn't one, go up the widget hierarchy
231 // trying to find one. Once one is found, call ProcessAccelerator for the
232 // window. If it returns TRUE (processed the event), skip the X event,
233 // otherwise carry on up the wxWindows window hierarchy calling
234 // ProcessAccelerator. If all return FALSE, process the X event as normal.
235 // Eventually we can implement OnCharHook the same way, but concentrate on
236 // accelerators for now. ProcessAccelerator must look at the current
237 // accelerator table, and try to find what menu id or window (beneath it)
238 // has this ID. Then construct an appropriate command
239 // event and send it.
240 virtual bool ProcessAccelerator(wxKeyEvent
& event
);
242 // unmanage and destroy an X widget f it's !NULL (passing NULL is ok)
243 void UnmanageAndDestroy(WXWidget widget
);
245 // map or unmap an X widget (passing NULL is ok), returns TRUE if widget was
247 bool MapOrUnmap(WXWidget widget
, bool map
);
252 // create/destroy window scrollbars
253 void CreateScrollbar(wxOrientation orientation
);
254 void DestroyScrollbar(wxOrientation orientation
);
256 // get either hor or vert scrollbar widget
257 WXWidget
GetScrollbar(wxOrientation orient
) const
258 { return orient
== wxHORIZONTAL
? m_hScrollBar
: m_vScrollBar
; }
260 // set the scroll pos
261 void SetInternalScrollPos(wxOrientation orient
, int pos
)
263 if ( orient
== wxHORIZONTAL
)
269 // Motif-specific flags
270 // --------------------
272 bool m_needsRefresh
:1; // repaint backing store?
273 bool m_canAddEventHandler
:1; // ???
274 bool m_button1Pressed
:1;
275 bool m_button2Pressed
:1;
276 bool m_button3Pressed
:1;
278 // For double-click detection
279 long m_lastTS
; // last timestamp
280 int m_lastButton
; // last pressed button
282 // List of wxRects representing damaged region
283 wxRectList m_updateRects
;
286 WXWidget m_mainWidget
;
287 WXWidget m_hScrollBar
;
288 WXWidget m_vScrollBar
;
289 WXWidget m_borderWidget
;
290 WXWidget m_scrolledWindow
;
291 WXWidget m_drawingArea
;
295 WXPixmap m_backingPixmap
;
301 // Store the last scroll pos, since in wxWin the pos isn't set automatically
306 // implement the base class pure virtuals
307 virtual void DoClientToScreen( int *x
, int *y
) const;
308 virtual void DoScreenToClient( int *x
, int *y
) const;
309 virtual void DoGetPosition( int *x
, int *y
) const;
310 virtual void DoGetSize( int *width
, int *height
) const;
311 virtual void DoGetClientSize( int *width
, int *height
) const;
312 virtual void DoSetSize(int x
, int y
,
313 int width
, int height
,
314 int sizeFlags
= wxSIZE_AUTO
);
315 virtual void DoSetClientSize(int width
, int height
);
318 virtual void DoSetToolTip( wxToolTip
*tip
);
319 #endif // wxUSE_TOOLTIPS
322 // common part of all ctors
325 DECLARE_NO_COPY_CLASS(wxWindow
);
326 DECLARE_EVENT_TABLE()
329 // ----------------------------------------------------------------------------
330 // A little class to switch off `size optimization' while an instance of the
331 // object exists: this may be useful to temporarily disable the optimisation
332 // which consists to do nothing when the new size is equal to the old size -
333 // although quite useful usually to avoid flicker, sometimes it leads to
334 // undesired effects.
336 // Usage: create an instance of this class on the stack to disable the size
337 // optimisation, it will be reenabled as soon as the object goes out from scope.
338 // ----------------------------------------------------------------------------
340 class WXDLLEXPORT wxNoOptimize
343 wxNoOptimize() { ms_count
++; }
344 ~wxNoOptimize() { ms_count
--; }
346 static bool CanOptimize() { return ms_count
== 0; }