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/region.h"
21 // ----------------------------------------------------------------------------
22 // wxWindow class for Motif - see also wxWindowBase
23 // ----------------------------------------------------------------------------
25 class wxWindow
: public wxWindowBase
27 friend class WXDLLEXPORT wxDC
;
28 friend class WXDLLEXPORT wxWindowDC
;
31 wxWindow() { Init(); }
33 wxWindow(wxWindow
*parent
,
35 const wxPoint
& pos
= wxDefaultPosition
,
36 const wxSize
& size
= wxDefaultSize
,
38 const wxString
& name
= wxPanelNameStr
)
41 Create(parent
, id
, pos
, size
, style
, name
);
46 bool Create(wxWindow
*parent
,
48 const wxPoint
& pos
= wxDefaultPosition
,
49 const wxSize
& size
= wxDefaultSize
,
51 const wxString
& name
= wxPanelNameStr
);
53 // implement base class pure virtuals
54 virtual void SetTitle( const wxString
& title
);
55 virtual wxString
GetTitle() const;
60 virtual bool Show( bool show
= TRUE
);
61 virtual bool Enable( bool enable
= TRUE
);
63 virtual void SetFocus();
65 virtual void WarpPointer(int x
, int y
);
67 virtual void Refresh( bool eraseBackground
= TRUE
,
68 const wxRect
*rect
= (const wxRect
*) NULL
);
71 virtual bool SetBackgroundColour( const wxColour
&colour
);
72 virtual bool SetForegroundColour( const wxColour
&colour
);
74 virtual bool SetCursor( const wxCursor
&cursor
);
75 virtual bool SetFont( const wxFont
&font
);
77 virtual int GetCharHeight() const;
78 virtual int GetCharWidth() const;
79 virtual void GetTextExtent(const wxString
& string
,
81 int *descent
= (int *) NULL
,
82 int *externalLeading
= (int *) NULL
,
83 const wxFont
*theFont
= (const wxFont
*) NULL
)
86 virtual void SetScrollbar( int orient
, int pos
, int thumbVisible
,
87 int range
, bool refresh
= TRUE
);
88 virtual void SetScrollPos( int orient
, int pos
, bool refresh
= TRUE
);
89 virtual int GetScrollPos( int orient
) const;
90 virtual int GetScrollThumb( int orient
) const;
91 virtual int GetScrollRange( int orient
) const;
92 virtual void ScrollWindow( int dx
, int dy
,
93 const wxRect
* rect
= (wxRect
*) NULL
);
95 #if wxUSE_DRAG_AND_DROP
96 virtual void SetDropTarget( wxDropTarget
*dropTarget
);
97 #endif // wxUSE_DRAG_AND_DROP
99 // Accept files for dragging
100 virtual void DragAcceptFiles(bool accept
);
102 // Get the unique identifier of a window
103 virtual WXWidget
GetHandle() const { return GetMainWidget(); }
105 // implementation from now on
106 // --------------------------
111 // Get main widget for this window, e.g. a text widget
112 virtual WXWidget
GetMainWidget() const;
113 // Get the widget that corresponds to the label (for font setting, label setting etc.)
114 virtual WXWidget
GetLabelWidget() const;
115 // Get the client widget for this window (something we can create other
117 virtual WXWidget
GetClientWidget() const;
118 // Get the top widget for this window, e.g. the scrolled widget parent of a
119 // multi-line text widget. Top means, top in the window hierarchy that
120 // implements this window.
121 virtual WXWidget
GetTopWidget() const;
123 // Get the underlying X window and display
124 WXWindow
GetXWindow() const;
125 WXDisplay
*GetXDisplay() const;
127 // called from Motif callbacks - and should only be called from there
129 void SetButton1(bool pressed
) { m_button1Pressed
= pressed
; }
130 void SetButton2(bool pressed
) { m_button2Pressed
= pressed
; }
131 void SetButton3(bool pressed
) { m_button3Pressed
= pressed
; }
133 void SetLastClick(int button
, long timestamp
)
134 { m_lastButton
= button
; m_lastTS
= timestamp
; }
136 int GetLastClickedButton() const { return m_lastButton
; }
137 long GetLastClickTime() const { return m_lastTS
; }
139 // Gives window a chance to do something in response to a size message, e.g.
140 // arrange status bar, toolbar etc.
141 virtual bool PreResize();
143 // Generates a paint event
144 virtual void DoPaint();
146 // update rectangle/region manipulation
147 // (for wxWindowDC and Motif callbacks only)
148 // -----------------------------------------
150 // read/write access to the update rect list
151 const wxRectList
& GetUpdateRects() const { return m_updateRects
; }
153 // Adds a recangle to the updates list
154 void AddUpdateRect(int x
, int y
, int w
, int h
)
155 { m_updateRects
.Append(new wxRect(x
, y
, w
, h
)); }
157 // Empties the m_updateRects list
158 void ClearUpdateRects();
160 void ClearUpdateRegion() { m_updateRegion
.Clear(); }
161 void SetUpdateRegion(const wxRegion
& region
) { m_updateRegion
= region
; }
163 // sets the fore/background colour for the given widget
164 static void DoChangeForegroundColour(WXWidget widget
, wxColour
& foregroundColour
);
165 static void DoChangeBackgroundColour(WXWidget widget
, wxColour
& backgroundColour
, bool changeArmColour
= FALSE
);
167 // For implementation purposes - sometimes decorations make the client area
169 virtual wxPoint
GetClientAreaOrigin() const;
172 // event handlers (not virtual by design)
173 void OnIdle(wxIdleEvent
& event
);
175 wxWindow
*GetChild(int number
) const
176 { return GetChildren().Item(number
)->GetData(); }
178 // Responds to colour changes: passes event on to children.
179 void OnSysColourChanged(wxSysColourChangedEvent
& event
);
183 void SetMainWidget(WXWidget w
) { m_mainWidget
= w
; }
185 bool CanAddEventHandler() const { return m_canAddEventHandler
; }
186 void SetCanAddEventHandler(bool flag
) { m_canAddEventHandler
= flag
; }
188 // See src/motif/window.cpp, near the top, for an explanation
189 // why this is necessary
190 void CanvasSetSizeIntr(int x
, int y
, int width
, int height
,
191 int sizeFlags
, bool fromCtor
);
192 void DoSetSizeIntr(int x
, int y
,
193 int width
, int height
,
194 int sizeFlags
, bool fromCtor
);
196 // for DoMoveWindowIntr flags
205 void DoMoveWindowIntr(int x
, int y
, int width
, int height
,
208 WXPixmap
GetBackingPixmap() const { return m_backingPixmap
; }
209 void SetBackingPixmap(WXPixmap pixmap
) { m_backingPixmap
= pixmap
; }
210 int GetPixmapWidth() const { return m_pixmapWidth
; }
211 int GetPixmapHeight() const { return m_pixmapHeight
; }
212 void SetPixmapWidth(int w
) { m_pixmapWidth
= w
; }
213 void SetPixmapHeight(int h
) { m_pixmapHeight
= h
; }
216 virtual void ChangeFont(bool keepOriginalSize
= TRUE
); // Change to the current font (often overridden)
218 // Change background and foreground colour using current background colour
219 // setting (Motif generates foreground based on background)
220 virtual void ChangeBackgroundColour();
221 // Change foreground colour using current foreground colour setting
222 virtual void ChangeForegroundColour();
225 // Adds the widget to the hash table and adds event handlers.
226 bool AttachWidget(wxWindow
* parent
, WXWidget mainWidget
,
227 WXWidget formWidget
, int x
, int y
, int width
, int height
);
228 bool DetachWidget(WXWidget widget
);
230 // How to implement accelerators. If we find a key event, translate to
231 // wxWindows wxKeyEvent form. Find a widget for the window. Now find a
232 // wxWindow for the widget. If there isn't one, go up the widget hierarchy
233 // trying to find one. Once one is found, call ProcessAccelerator for the
234 // window. If it returns TRUE (processed the event), skip the X event,
235 // otherwise carry on up the wxWindows window hierarchy calling
236 // ProcessAccelerator. If all return FALSE, process the X event as normal.
237 // Eventually we can implement OnCharHook the same way, but concentrate on
238 // accelerators for now. ProcessAccelerator must look at the current
239 // accelerator table, and try to find what menu id or window (beneath it)
240 // has this ID. Then construct an appropriate command
241 // event and send it.
243 virtual bool ProcessAccelerator(wxKeyEvent
& event
);
246 // unmanage and destroy an X widget f it's !NULL (passing NULL is ok)
247 void UnmanageAndDestroy(WXWidget widget
);
249 // map or unmap an X widget (passing NULL is ok), returns TRUE if widget was
251 bool MapOrUnmap(WXWidget widget
, bool map
);
256 // create/destroy window scrollbars
257 void CreateScrollbar(wxOrientation orientation
);
258 void DestroyScrollbar(wxOrientation orientation
);
260 // get either hor or vert scrollbar widget
261 WXWidget
GetScrollbar(wxOrientation orient
) const
262 { return orient
== wxHORIZONTAL
? m_hScrollBar
: m_vScrollBar
; }
264 // set the scroll pos
265 void SetInternalScrollPos(wxOrientation orient
, int pos
)
267 if ( orient
== wxHORIZONTAL
)
273 // Motif-specific flags
274 // --------------------
276 bool m_needsRefresh
:1; // repaint backing store?
277 bool m_canAddEventHandler
:1; // ???
278 bool m_button1Pressed
:1;
279 bool m_button2Pressed
:1;
280 bool m_button3Pressed
:1;
282 // For double-click detection
283 long m_lastTS
; // last timestamp
284 int m_lastButton
; // last pressed button
286 // List of wxRects representing damaged region
287 wxRectList m_updateRects
;
290 WXWidget m_mainWidget
;
291 WXWidget m_hScrollBar
;
292 WXWidget m_vScrollBar
;
293 WXWidget m_borderWidget
;
294 WXWidget m_scrolledWindow
;
295 WXWidget m_drawingArea
;
299 WXPixmap m_backingPixmap
;
305 // Store the last scroll pos, since in wxWin the pos isn't set automatically
310 // implement the base class pure virtuals
311 virtual void DoClientToScreen( int *x
, int *y
) const;
312 virtual void DoScreenToClient( int *x
, int *y
) const;
313 virtual void DoGetPosition( int *x
, int *y
) const;
314 virtual void DoGetSize( int *width
, int *height
) const;
315 virtual void DoGetClientSize( int *width
, int *height
) const;
316 virtual void DoSetSize(int x
, int y
,
317 int width
, int height
,
318 int sizeFlags
= wxSIZE_AUTO
);
319 virtual void DoSetClientSize(int width
, int height
);
320 virtual void DoMoveWindow(int x
, int y
, int width
, int height
);
321 virtual bool DoPopupMenu(wxMenu
*menu
, int x
, int y
);
322 virtual void DoCaptureMouse();
323 virtual void DoReleaseMouse();
326 virtual void DoSetToolTip( wxToolTip
*tip
);
327 #endif // wxUSE_TOOLTIPS
330 // common part of all ctors
333 DECLARE_DYNAMIC_CLASS(wxWindow
)
334 DECLARE_NO_COPY_CLASS(wxWindow
)
335 DECLARE_EVENT_TABLE()
338 // ----------------------------------------------------------------------------
339 // A little class to switch off `size optimization' while an instance of the
340 // object exists: this may be useful to temporarily disable the optimisation
341 // which consists to do nothing when the new size is equal to the old size -
342 // although quite useful usually to avoid flicker, sometimes it leads to
343 // undesired effects.
345 // Usage: create an instance of this class on the stack to disable the size
346 // optimisation, it will be reenabled as soon as the object goes out from scope.
347 // ----------------------------------------------------------------------------
349 class WXDLLEXPORT wxNoOptimize
352 wxNoOptimize() { ms_count
++; }
353 ~wxNoOptimize() { ms_count
--; }
355 static bool CanOptimize() { return ms_count
== 0; }