]>
Commit | Line | Data |
---|---|---|
1 | /////////////////////////////////////////////////////////////////////////////// | |
2 | // Name: wx/window.h | |
3 | // Purpose: wxWindowBase class - the interface of wxWindow | |
4 | // Author: Vadim Zeitlin | |
5 | // Modified by: Ron Lee | |
6 | // Created: 01/02/97 | |
7 | // RCS-ID: $Id$ | |
8 | // Copyright: (c) wxWidgets team | |
9 | // Licence: wxWindows licence | |
10 | /////////////////////////////////////////////////////////////////////////////// | |
11 | ||
12 | #ifndef _WX_WINDOW_H_BASE_ | |
13 | #define _WX_WINDOW_H_BASE_ | |
14 | ||
15 | #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) | |
16 | #pragma interface "windowbase.h" | |
17 | #endif | |
18 | ||
19 | // ---------------------------------------------------------------------------- | |
20 | // headers which we must include here | |
21 | // ---------------------------------------------------------------------------- | |
22 | ||
23 | #include "wx/event.h" // the base class | |
24 | ||
25 | #include "wx/list.h" // defines wxWindowList | |
26 | ||
27 | #include "wx/cursor.h" // we have member variables of these classes | |
28 | #include "wx/font.h" // so we can't do without them | |
29 | #include "wx/colour.h" | |
30 | #include "wx/region.h" | |
31 | #include "wx/utils.h" | |
32 | ||
33 | #include "wx/validate.h" // for wxDefaultValidator (always include it) | |
34 | ||
35 | #if wxUSE_PALETTE | |
36 | #include "wx/palette.h" | |
37 | #endif // wxUSE_PALETTE | |
38 | ||
39 | #if wxUSE_ACCEL | |
40 | #include "wx/accel.h" | |
41 | #endif // wxUSE_ACCEL | |
42 | ||
43 | #if wxUSE_ACCESSIBILITY | |
44 | #include "wx/access.h" | |
45 | #endif | |
46 | ||
47 | // when building wxUniv/Foo we don't want the code for native menu use to be | |
48 | // compiled in - it should only be used when building real wxFoo | |
49 | #ifdef __WXUNIVERSAL__ | |
50 | #define wxUSE_MENUS_NATIVE 0 | |
51 | #else // __WXMSW__ | |
52 | #define wxUSE_MENUS_NATIVE wxUSE_MENUS | |
53 | #endif // __WXUNIVERSAL__/__WXMSW__ | |
54 | ||
55 | // ---------------------------------------------------------------------------- | |
56 | // forward declarations | |
57 | // ---------------------------------------------------------------------------- | |
58 | ||
59 | class WXDLLEXPORT wxCaret; | |
60 | class WXDLLEXPORT wxControl; | |
61 | class WXDLLEXPORT wxCursor; | |
62 | class WXDLLEXPORT wxDC; | |
63 | class WXDLLEXPORT wxDropTarget; | |
64 | class WXDLLEXPORT wxItemResource; | |
65 | class WXDLLEXPORT wxLayoutConstraints; | |
66 | class WXDLLEXPORT wxResourceTable; | |
67 | class WXDLLEXPORT wxSizer; | |
68 | class WXDLLEXPORT wxToolTip; | |
69 | class WXDLLEXPORT wxWindowBase; | |
70 | class WXDLLEXPORT wxWindow; | |
71 | ||
72 | #if wxUSE_ACCESSIBILITY | |
73 | class WXDLLEXPORT wxAccessible; | |
74 | #endif | |
75 | ||
76 | // ---------------------------------------------------------------------------- | |
77 | // helper stuff used by wxWindow | |
78 | // ---------------------------------------------------------------------------- | |
79 | ||
80 | // struct containing all the visual attributes of a control | |
81 | struct WXDLLEXPORT wxVisualAttributes | |
82 | { | |
83 | // the font used for control label/text inside it | |
84 | wxFont font; | |
85 | ||
86 | // the foreground colour | |
87 | wxColour colFg; | |
88 | ||
89 | // the background colour, may be wxNullColour if the controls background | |
90 | // colour is not solid | |
91 | wxColour colBg; | |
92 | }; | |
93 | ||
94 | // different window variants, on platforms like eg mac uses different | |
95 | // rendering sizes | |
96 | enum wxWindowVariant | |
97 | { | |
98 | wxWINDOW_VARIANT_NORMAL, // Normal size | |
99 | wxWINDOW_VARIANT_SMALL, // Smaller size (about 25 % smaller than normal) | |
100 | wxWINDOW_VARIANT_MINI, // Mini size (about 33 % smaller than normal) | |
101 | wxWINDOW_VARIANT_LARGE, // Large size (about 25 % larger than normal) | |
102 | wxWINDOW_VARIANT_MAX | |
103 | }; | |
104 | ||
105 | // ---------------------------------------------------------------------------- | |
106 | // (pseudo)template list classes | |
107 | // ---------------------------------------------------------------------------- | |
108 | ||
109 | WX_DECLARE_LIST_3(wxWindow, wxWindowBase, wxWindowList, wxWindowListNode, class WXDLLEXPORT); | |
110 | ||
111 | // ---------------------------------------------------------------------------- | |
112 | // global variables | |
113 | // ---------------------------------------------------------------------------- | |
114 | ||
115 | WXDLLEXPORT_DATA(extern wxWindowList) wxTopLevelWindows; | |
116 | ||
117 | // ---------------------------------------------------------------------------- | |
118 | // wxWindowBase is the base class for all GUI controls/widgets, this is the public | |
119 | // interface of this class. | |
120 | // | |
121 | // Event handler: windows have themselves as their event handlers by default, | |
122 | // but their event handlers could be set to another object entirely. This | |
123 | // separation can reduce the amount of derivation required, and allow | |
124 | // alteration of a window's functionality (e.g. by a resource editor that | |
125 | // temporarily switches event handlers). | |
126 | // ---------------------------------------------------------------------------- | |
127 | ||
128 | class WXDLLEXPORT wxWindowBase : public wxEvtHandler | |
129 | { | |
130 | public: | |
131 | // creating the window | |
132 | // ------------------- | |
133 | ||
134 | // default ctor, initializes everything which can be initialized before | |
135 | // Create() | |
136 | wxWindowBase() ; | |
137 | ||
138 | // pseudo ctor (can't be virtual, called from ctor) | |
139 | bool CreateBase(wxWindowBase *parent, | |
140 | wxWindowID winid, | |
141 | const wxPoint& pos = wxDefaultPosition, | |
142 | const wxSize& size = wxDefaultSize, | |
143 | long style = 0, | |
144 | const wxValidator& validator = wxDefaultValidator, | |
145 | const wxString& name = wxPanelNameStr); | |
146 | ||
147 | virtual ~wxWindowBase(); | |
148 | ||
149 | // deleting the window | |
150 | // ------------------- | |
151 | ||
152 | // ask the window to close itself, return true if the event handler | |
153 | // honoured our request | |
154 | bool Close( bool force = false ); | |
155 | ||
156 | // the following functions delete the C++ objects (the window itself | |
157 | // or its children) as well as the GUI windows and normally should | |
158 | // never be used directly | |
159 | ||
160 | // delete window unconditionally (dangerous!), returns true if ok | |
161 | virtual bool Destroy(); | |
162 | // delete all children of this window, returns true if ok | |
163 | bool DestroyChildren(); | |
164 | ||
165 | // is the window being deleted? | |
166 | bool IsBeingDeleted() const { return m_isBeingDeleted; } | |
167 | ||
168 | // window attributes | |
169 | // ----------------- | |
170 | ||
171 | // NB: in future versions of wxWidgets Set/GetTitle() will only work | |
172 | // with the top level windows (such as dialogs and frames) and | |
173 | // Set/GetLabel() only with the other ones (i.e. all controls). | |
174 | ||
175 | // the title (or label, see below) of the window: the text which the | |
176 | // window shows | |
177 | virtual void SetTitle( const wxString& WXUNUSED(title) ) {} | |
178 | virtual wxString GetTitle() const { return wxEmptyString; } | |
179 | ||
180 | // label is just the same as the title (but for, e.g., buttons it | |
181 | // makes more sense to speak about labels) | |
182 | virtual void SetLabel(const wxString& label) { SetTitle(label); } | |
183 | virtual wxString GetLabel() const { return GetTitle(); } | |
184 | ||
185 | // the window name is used for ressource setting in X, it is not the | |
186 | // same as the window title/label | |
187 | virtual void SetName( const wxString &name ) { m_windowName = name; } | |
188 | virtual wxString GetName() const { return m_windowName; } | |
189 | ||
190 | // sets the window variant, calls internally DoSetVariant if variant has changed | |
191 | void SetWindowVariant( wxWindowVariant variant ) ; | |
192 | wxWindowVariant GetWindowVariant() const { return m_windowVariant ; } | |
193 | ||
194 | ||
195 | // window id uniquely identifies the window among its siblings unless | |
196 | // it is -1 which means "don't care" | |
197 | void SetId( wxWindowID winid ) { m_windowId = winid; } | |
198 | wxWindowID GetId() const { return m_windowId; } | |
199 | ||
200 | // generate a control id for the controls which were not given one by | |
201 | // user | |
202 | static int NewControlId() { return --ms_lastControlId; } | |
203 | // get the id of the control following the one with the given | |
204 | // (autogenerated) id | |
205 | static int NextControlId(int winid) { return winid - 1; } | |
206 | // get the id of the control preceding the one with the given | |
207 | // (autogenerated) id | |
208 | static int PrevControlId(int winid) { return winid + 1; } | |
209 | ||
210 | // moving/resizing | |
211 | // --------------- | |
212 | ||
213 | // set the window size and/or position | |
214 | void SetSize( int x, int y, int width, int height, | |
215 | int sizeFlags = wxSIZE_AUTO ) | |
216 | { DoSetSize(x, y, width, height, sizeFlags); } | |
217 | ||
218 | void SetSize( int width, int height ) | |
219 | { DoSetSize( -1, -1, width, height, wxSIZE_USE_EXISTING ); } | |
220 | ||
221 | void SetSize( const wxSize& size ) | |
222 | { SetSize( size.x, size.y); } | |
223 | ||
224 | void SetSize(const wxRect& rect, int sizeFlags = wxSIZE_AUTO) | |
225 | { DoSetSize(rect.x, rect.y, rect.width, rect.height, sizeFlags); } | |
226 | ||
227 | void Move(int x, int y, int flags = wxSIZE_USE_EXISTING) | |
228 | { DoSetSize(x, y, -1, -1, flags); } | |
229 | ||
230 | void Move(const wxPoint& pt, int flags = wxSIZE_USE_EXISTING) | |
231 | { Move(pt.x, pt.y, flags); } | |
232 | ||
233 | // Z-order | |
234 | virtual void Raise() = 0; | |
235 | virtual void Lower() = 0; | |
236 | ||
237 | // client size is the size of area available for subwindows | |
238 | void SetClientSize( int width, int height ) | |
239 | { DoSetClientSize(width, height); } | |
240 | ||
241 | void SetClientSize( const wxSize& size ) | |
242 | { DoSetClientSize(size.x, size.y); } | |
243 | ||
244 | void SetClientSize(const wxRect& rect) | |
245 | { SetClientSize( rect.width, rect.height ); } | |
246 | ||
247 | // get the window position and/or size (pointers may be NULL) | |
248 | void GetPosition( int *x, int *y ) const { DoGetPosition(x, y); } | |
249 | wxPoint GetPosition() const | |
250 | { | |
251 | int w, h; | |
252 | DoGetPosition(&w, &h); | |
253 | ||
254 | return wxPoint(w, h); | |
255 | } | |
256 | ||
257 | void SetPosition( const wxPoint& pt ) { Move( pt ) ; } | |
258 | ||
259 | void GetSize( int *w, int *h ) const { DoGetSize(w, h); } | |
260 | wxSize GetSize() const | |
261 | { | |
262 | int w, h; | |
263 | DoGetSize(& w, & h); | |
264 | return wxSize(w, h); | |
265 | } | |
266 | ||
267 | wxRect GetRect() const | |
268 | { | |
269 | int x, y, w, h; | |
270 | GetPosition(& x, & y); | |
271 | GetSize(& w, & h); | |
272 | ||
273 | return wxRect(x, y, w, h); | |
274 | } | |
275 | ||
276 | void GetClientSize( int *w, int *h ) const { DoGetClientSize(w, h); } | |
277 | wxSize GetClientSize() const | |
278 | { | |
279 | int w, h; | |
280 | DoGetClientSize(& w, & h); | |
281 | ||
282 | return wxSize(w, h); | |
283 | } | |
284 | ||
285 | // get the origin of the client area of the window relative to the | |
286 | // window top left corner (the client area may be shifted because of | |
287 | // the borders, scrollbars, other decorations...) | |
288 | virtual wxPoint GetClientAreaOrigin() const; | |
289 | ||
290 | // get the client rectangle in window (i.e. client) coordinates | |
291 | wxRect GetClientRect() const | |
292 | { | |
293 | return wxRect(GetClientAreaOrigin(), GetClientSize()); | |
294 | } | |
295 | ||
296 | // get the size best suited for the window (in fact, minimal | |
297 | // acceptable size using which it will still look "nice" in | |
298 | // most situations) | |
299 | wxSize GetBestSize() const | |
300 | { | |
301 | if (m_bestSizeCache.IsFullySpecified()) | |
302 | return m_bestSizeCache; | |
303 | return DoGetBestSize(); | |
304 | } | |
305 | void GetBestSize(int *w, int *h) const | |
306 | { | |
307 | wxSize s = GetBestSize(); | |
308 | if ( w ) | |
309 | *w = s.x; | |
310 | if ( h ) | |
311 | *h = s.y; | |
312 | } | |
313 | ||
314 | // reset the cached best size value so it will be recalculated the | |
315 | // next time it is needed. | |
316 | void InvalidateBestSize() { m_bestSizeCache = wxDefaultSize; } | |
317 | void CacheBestSize(const wxSize& size) const | |
318 | { wxConstCast(this, wxWindowBase)->m_bestSizeCache = size; } | |
319 | ||
320 | // There are times (and windows) where 'Best' size and 'Min' size | |
321 | // are vastly out of sync. This should be remedied somehow, but in | |
322 | // the meantime, this method will return the larger of BestSize | |
323 | // (the window's smallest legible size), and any user specified | |
324 | // MinSize hint. | |
325 | wxSize GetAdjustedBestSize() const | |
326 | { | |
327 | wxSize s( GetBestSize() ); | |
328 | return wxSize( wxMax( s.x, GetMinWidth() ), wxMax( s.y, GetMinHeight() ) ); | |
329 | } | |
330 | ||
331 | // This function will merge the window's best size into the window's | |
332 | // minimum size, giving priority to the min size components, and | |
333 | // returns the results. | |
334 | wxSize GetBestFittingSize() const; | |
335 | ||
336 | // A 'Smart' SetSize that will fill in default size values with 'best' | |
337 | // size. Sets the minsize to what was passed in. | |
338 | void SetBestFittingSize(const wxSize& size=wxDefaultSize); | |
339 | ||
340 | // the generic centre function - centers the window on parent by` | |
341 | // default or on screen if it doesn't have parent or | |
342 | // wxCENTER_ON_SCREEN flag is given | |
343 | void Centre( int direction = wxBOTH ); | |
344 | void Center( int direction = wxBOTH ) { Centre(direction); } | |
345 | ||
346 | // centre on screen (only works for top level windows) | |
347 | void CentreOnScreen(int dir = wxBOTH) { Centre(dir | wxCENTER_ON_SCREEN); } | |
348 | void CenterOnScreen(int dir = wxBOTH) { CentreOnScreen(dir); } | |
349 | ||
350 | // centre with respect to the the parent window | |
351 | void CentreOnParent(int dir = wxBOTH) { Centre(dir | wxCENTER_FRAME); } | |
352 | void CenterOnParent(int dir = wxBOTH) { CentreOnParent(dir); } | |
353 | ||
354 | // set window size to wrap around its children | |
355 | virtual void Fit(); | |
356 | ||
357 | // set virtual size to satisfy children | |
358 | virtual void FitInside(); | |
359 | ||
360 | // set min/max size of the window | |
361 | virtual void SetSizeHints( int minW, int minH, | |
362 | int maxW = -1, int maxH = -1, | |
363 | int incW = -1, int incH = -1 ); | |
364 | void SetSizeHints( const wxSize& minSize, | |
365 | const wxSize& maxSize=wxDefaultSize, | |
366 | const wxSize& incSize=wxDefaultSize) | |
367 | { | |
368 | SetSizeHints(minSize.x, minSize.y, | |
369 | maxSize.x, maxSize.y, | |
370 | incSize.x, incSize.y); | |
371 | } | |
372 | ||
373 | virtual void SetVirtualSizeHints( int minW, int minH, | |
374 | int maxW = -1, int maxH = -1 ); | |
375 | void SetVirtualSizeHints( const wxSize& minSize, | |
376 | const wxSize& maxSize=wxDefaultSize) | |
377 | { | |
378 | SetVirtualSizeHints(minSize.x, minSize.y, maxSize.x, maxSize.y); | |
379 | } | |
380 | ||
381 | virtual int GetMinWidth() const { return m_minWidth; } | |
382 | virtual int GetMinHeight() const { return m_minHeight; } | |
383 | int GetMaxWidth() const { return m_maxWidth; } | |
384 | int GetMaxHeight() const { return m_maxHeight; } | |
385 | ||
386 | // Override this method to control the values given to Sizers etc. | |
387 | virtual wxSize GetMaxSize() const { return wxSize( m_maxWidth, m_maxHeight ); } | |
388 | virtual wxSize GetMinSize() const { return wxSize( m_minWidth, m_minHeight ); } | |
389 | ||
390 | void SetMinSize(const wxSize& minSize) { SetSizeHints(minSize); } | |
391 | void SetMaxSize(const wxSize& maxSize) { SetSizeHints(GetMinSize(), maxSize); } | |
392 | ||
393 | // Methods for accessing the virtual size of a window. For most | |
394 | // windows this is just the client area of the window, but for | |
395 | // some like scrolled windows it is more or less independent of | |
396 | // the screen window size. You may override the DoXXXVirtual | |
397 | // methods below for classes where that is is the case. | |
398 | ||
399 | void SetVirtualSize( const wxSize &size ) { DoSetVirtualSize( size.x, size.y ); } | |
400 | void SetVirtualSize( int x, int y ) { DoSetVirtualSize( x, y ); } | |
401 | ||
402 | wxSize GetVirtualSize() const { return DoGetVirtualSize(); } | |
403 | void GetVirtualSize( int *x, int *y ) const | |
404 | { | |
405 | wxSize s( DoGetVirtualSize() ); | |
406 | ||
407 | if( x ) | |
408 | *x = s.GetWidth(); | |
409 | if( y ) | |
410 | *y = s.GetHeight(); | |
411 | } | |
412 | ||
413 | // Override these methods for windows that have a virtual size | |
414 | // independent of their client size. eg. the virtual area of a | |
415 | // wxScrolledWindow. Default is to alias VirtualSize to ClientSize. | |
416 | ||
417 | virtual void DoSetVirtualSize( int x, int y ); | |
418 | virtual wxSize DoGetVirtualSize() const; // { return m_virtualSize; } | |
419 | ||
420 | // Return the largest of ClientSize and BestSize (as determined | |
421 | // by a sizer, interior children, or other means) | |
422 | ||
423 | virtual wxSize GetBestVirtualSize() const | |
424 | { | |
425 | wxSize client( GetClientSize() ); | |
426 | wxSize best( GetBestSize() ); | |
427 | ||
428 | return wxSize( wxMax( client.x, best.x ), wxMax( client.y, best.y ) ); | |
429 | } | |
430 | ||
431 | // window state | |
432 | // ------------ | |
433 | ||
434 | // returns true if window was shown/hidden, false if the nothing was | |
435 | // done (window was already shown/hidden) | |
436 | virtual bool Show( bool show = true ); | |
437 | bool Hide() { return Show(false); } | |
438 | ||
439 | // returns true if window was enabled/disabled, false if nothing done | |
440 | virtual bool Enable( bool enable = true ); | |
441 | bool Disable() { return Enable(false); } | |
442 | ||
443 | bool IsShown() const { return m_isShown; } | |
444 | bool IsEnabled() const { return m_isEnabled; } | |
445 | ||
446 | // get/set window style (setting style won't update the window and so | |
447 | // is only useful for internal usage) | |
448 | virtual void SetWindowStyleFlag( long style ) { m_windowStyle = style; } | |
449 | virtual long GetWindowStyleFlag() const { return m_windowStyle; } | |
450 | ||
451 | // just some (somewhat shorter) synonims | |
452 | void SetWindowStyle( long style ) { SetWindowStyleFlag(style); } | |
453 | long GetWindowStyle() const { return GetWindowStyleFlag(); } | |
454 | ||
455 | bool HasFlag(int flag) const { return (m_windowStyle & flag) != 0; } | |
456 | virtual bool IsRetained() const { return HasFlag(wxRETAINED); } | |
457 | ||
458 | // extra style: the less often used style bits which can't be set with | |
459 | // SetWindowStyleFlag() | |
460 | virtual void SetExtraStyle(long exStyle) { m_exStyle = exStyle; } | |
461 | long GetExtraStyle() const { return m_exStyle; } | |
462 | ||
463 | // make the window modal (all other windows unresponsive) | |
464 | virtual void MakeModal(bool modal = true); | |
465 | ||
466 | ||
467 | // (primitive) theming support | |
468 | // --------------------------- | |
469 | ||
470 | virtual void SetThemeEnabled(bool enableTheme) { m_themeEnabled = enableTheme; } | |
471 | virtual bool GetThemeEnabled() const { return m_themeEnabled; } | |
472 | ||
473 | // Returns true if this class should have the background colour | |
474 | // changed to match the parent window's theme. For example when a | |
475 | // page is added to a notebook it and it's children may need to have | |
476 | // the colours adjusted depending on the current theme settings, but | |
477 | // not all windows/controls can do this without looking wrong. | |
478 | virtual void ApplyParentThemeBackground(const wxColour& WXUNUSED(bg)) | |
479 | { /* do nothing */ } | |
480 | ||
481 | ||
482 | // focus and keyboard handling | |
483 | // --------------------------- | |
484 | ||
485 | // set focus to this window | |
486 | virtual void SetFocus() = 0; | |
487 | ||
488 | // set focus to this window as the result of a keyboard action | |
489 | virtual void SetFocusFromKbd() { SetFocus(); } | |
490 | ||
491 | // return the window which currently has the focus or NULL | |
492 | static wxWindow *FindFocus() /* = 0: implement in derived classes */; | |
493 | ||
494 | // can this window have focus? | |
495 | virtual bool AcceptsFocus() const { return IsShown() && IsEnabled(); } | |
496 | ||
497 | // can this window be given focus by keyboard navigation? if not, the | |
498 | // only way to give it focus (provided it accepts it at all) is to | |
499 | // click it | |
500 | virtual bool AcceptsFocusFromKeyboard() const { return AcceptsFocus(); } | |
501 | ||
502 | // NB: these methods really don't belong here but with the current | |
503 | // class hierarchy there is no other place for them :-( | |
504 | ||
505 | // get the default child of this parent, i.e. the one which is | |
506 | // activated by pressing <Enter> | |
507 | virtual wxWindow *GetDefaultItem() const { return NULL; } | |
508 | ||
509 | // set this child as default, return the old default | |
510 | virtual wxWindow *SetDefaultItem(wxWindow * WXUNUSED(child)) | |
511 | { return NULL; } | |
512 | ||
513 | // set this child as temporary default | |
514 | virtual void SetTmpDefaultItem(wxWindow * WXUNUSED(win)) { } | |
515 | ||
516 | // navigates in the specified direction by sending a wxNavigationKeyEvent | |
517 | virtual bool Navigate(int flags = wxNavigationKeyEvent::IsForward); | |
518 | ||
519 | // move this window just before/after the specified one in tab order | |
520 | // (the other window must be our sibling!) | |
521 | void MoveBeforeInTabOrder(wxWindow *win) | |
522 | { DoMoveInTabOrder(win, MoveBefore); } | |
523 | void MoveAfterInTabOrder(wxWindow *win) | |
524 | { DoMoveInTabOrder(win, MoveAfter); } | |
525 | ||
526 | ||
527 | // parent/children relations | |
528 | // ------------------------- | |
529 | ||
530 | // get the list of children | |
531 | const wxWindowList& GetChildren() const { return m_children; } | |
532 | wxWindowList& GetChildren() { return m_children; } | |
533 | ||
534 | // needed just for extended runtime | |
535 | const wxWindowList& GetWindowChildren() const { return GetChildren() ; } | |
536 | ||
537 | // get the parent or the parent of the parent | |
538 | wxWindow *GetParent() const { return m_parent; } | |
539 | inline wxWindow *GetGrandParent() const; | |
540 | ||
541 | // is this window a top level one? | |
542 | virtual bool IsTopLevel() const; | |
543 | ||
544 | // it doesn't really change parent, use Reparent() instead | |
545 | void SetParent( wxWindowBase *parent ) { m_parent = (wxWindow *)parent; } | |
546 | // change the real parent of this window, return true if the parent | |
547 | // was changed, false otherwise (error or newParent == oldParent) | |
548 | virtual bool Reparent( wxWindowBase *newParent ); | |
549 | ||
550 | // implementation mostly | |
551 | virtual void AddChild( wxWindowBase *child ); | |
552 | virtual void RemoveChild( wxWindowBase *child ); | |
553 | ||
554 | // looking for windows | |
555 | // ------------------- | |
556 | ||
557 | // find window among the descendants of this one either by id or by | |
558 | // name (return NULL if not found) | |
559 | wxWindow *FindWindow( long winid ); | |
560 | wxWindow *FindWindow( const wxString& name ); | |
561 | ||
562 | // Find a window among any window (all return NULL if not found) | |
563 | static wxWindow *FindWindowById( long winid, const wxWindow *parent = NULL ); | |
564 | static wxWindow *FindWindowByName( const wxString& name, | |
565 | const wxWindow *parent = NULL ); | |
566 | static wxWindow *FindWindowByLabel( const wxString& label, | |
567 | const wxWindow *parent = NULL ); | |
568 | ||
569 | // event handler stuff | |
570 | // ------------------- | |
571 | ||
572 | // get the current event handler | |
573 | wxEvtHandler *GetEventHandler() const { return m_eventHandler; } | |
574 | ||
575 | // replace the event handler (allows to completely subclass the | |
576 | // window) | |
577 | void SetEventHandler( wxEvtHandler *handler ) { m_eventHandler = handler; } | |
578 | ||
579 | // push/pop event handler: allows to chain a custom event handler to | |
580 | // alreasy existing ones | |
581 | void PushEventHandler( wxEvtHandler *handler ); | |
582 | wxEvtHandler *PopEventHandler( bool deleteHandler = false ); | |
583 | ||
584 | // find the given handler in the event handler chain and remove (but | |
585 | // not delete) it from the event handler chain, return true if it was | |
586 | // found and false otherwise (this also results in an assert failure so | |
587 | // this function should only be called when the handler is supposed to | |
588 | // be there) | |
589 | bool RemoveEventHandler(wxEvtHandler *handler); | |
590 | ||
591 | // validators | |
592 | // ---------- | |
593 | ||
594 | #if wxUSE_VALIDATORS | |
595 | // a window may have an associated validator which is used to control | |
596 | // user input | |
597 | virtual void SetValidator( const wxValidator &validator ); | |
598 | virtual wxValidator *GetValidator() { return m_windowValidator; } | |
599 | #endif // wxUSE_VALIDATORS | |
600 | ||
601 | ||
602 | // dialog oriented functions | |
603 | // ------------------------- | |
604 | ||
605 | // validate the correctness of input, return true if ok | |
606 | virtual bool Validate(); | |
607 | ||
608 | // transfer data between internal and GUI representations | |
609 | virtual bool TransferDataToWindow(); | |
610 | virtual bool TransferDataFromWindow(); | |
611 | ||
612 | virtual void InitDialog(); | |
613 | ||
614 | #if wxUSE_ACCEL | |
615 | // accelerators | |
616 | // ------------ | |
617 | virtual void SetAcceleratorTable( const wxAcceleratorTable& accel ) | |
618 | { m_acceleratorTable = accel; } | |
619 | wxAcceleratorTable *GetAcceleratorTable() | |
620 | { return &m_acceleratorTable; } | |
621 | ||
622 | #endif // wxUSE_ACCEL | |
623 | ||
624 | #if wxUSE_HOTKEY | |
625 | // hot keys (system wide accelerators) | |
626 | // ----------------------------------- | |
627 | ||
628 | virtual bool RegisterHotKey(int hotkeyId, int modifiers, int keycode); | |
629 | virtual bool UnregisterHotKey(int hotkeyId); | |
630 | #endif // wxUSE_HOTKEY | |
631 | ||
632 | ||
633 | // dialog units translations | |
634 | // ------------------------- | |
635 | ||
636 | wxPoint ConvertPixelsToDialog( const wxPoint& pt ); | |
637 | wxPoint ConvertDialogToPixels( const wxPoint& pt ); | |
638 | wxSize ConvertPixelsToDialog( const wxSize& sz ) | |
639 | { | |
640 | wxPoint pt(ConvertPixelsToDialog(wxPoint(sz.x, sz.y))); | |
641 | ||
642 | return wxSize(pt.x, pt.y); | |
643 | } | |
644 | ||
645 | wxSize ConvertDialogToPixels( const wxSize& sz ) | |
646 | { | |
647 | wxPoint pt(ConvertDialogToPixels(wxPoint(sz.x, sz.y))); | |
648 | ||
649 | return wxSize(pt.x, pt.y); | |
650 | } | |
651 | ||
652 | // mouse functions | |
653 | // --------------- | |
654 | ||
655 | // move the mouse to the specified position | |
656 | virtual void WarpPointer(int x, int y) = 0; | |
657 | ||
658 | // start or end mouse capture, these functions maintain the stack of | |
659 | // windows having captured the mouse and after calling ReleaseMouse() | |
660 | // the mouse is not released but returns to the window which had had | |
661 | // captured it previously (if any) | |
662 | void CaptureMouse(); | |
663 | void ReleaseMouse(); | |
664 | ||
665 | // get the window which currently captures the mouse or NULL | |
666 | static wxWindow *GetCapture(); | |
667 | ||
668 | // does this window have the capture? | |
669 | virtual bool HasCapture() const | |
670 | { return (wxWindow *)this == GetCapture(); } | |
671 | ||
672 | // painting the window | |
673 | // ------------------- | |
674 | ||
675 | // mark the specified rectangle (or the whole window) as "dirty" so it | |
676 | // will be repainted | |
677 | virtual void Refresh( bool eraseBackground = true, | |
678 | const wxRect *rect = (const wxRect *) NULL ) = 0; | |
679 | ||
680 | // a less awkward wrapper for Refresh | |
681 | void RefreshRect(const wxRect& rect) { Refresh(true, &rect); } | |
682 | ||
683 | // repaint all invalid areas of the window immediately | |
684 | virtual void Update() { } | |
685 | ||
686 | // clear the window background | |
687 | virtual void ClearBackground(); | |
688 | ||
689 | // freeze the window: don't redraw it until it is thawed | |
690 | virtual void Freeze() { } | |
691 | ||
692 | // thaw the window: redraw it after it had been frozen | |
693 | virtual void Thaw() { } | |
694 | ||
695 | // adjust DC for drawing on this window | |
696 | virtual void PrepareDC( wxDC & WXUNUSED(dc) ) { } | |
697 | ||
698 | // the update region of the window contains the areas which must be | |
699 | // repainted by the program | |
700 | const wxRegion& GetUpdateRegion() const { return m_updateRegion; } | |
701 | wxRegion& GetUpdateRegion() { return m_updateRegion; } | |
702 | ||
703 | // get the update rectangleregion bounding box in client coords | |
704 | wxRect GetUpdateClientRect() const; | |
705 | ||
706 | // these functions verify whether the given point/rectangle belongs to | |
707 | // (or at least intersects with) the update region | |
708 | bool IsExposed( int x, int y ) const; | |
709 | bool IsExposed( int x, int y, int w, int h ) const; | |
710 | ||
711 | bool IsExposed( const wxPoint& pt ) const | |
712 | { return IsExposed(pt.x, pt.y); } | |
713 | bool IsExposed( const wxRect& rect ) const | |
714 | { return IsExposed(rect.x, rect.y, rect.width, rect.height); } | |
715 | ||
716 | // colours, fonts and cursors | |
717 | // -------------------------- | |
718 | ||
719 | // get the default attributes for the controls of this class: we | |
720 | // provide a virtual function which can be used to query the default | |
721 | // attributes of an existing control and a static function which can | |
722 | // be used even when no existing object of the given class is | |
723 | // available, but which won't return any styles specific to this | |
724 | // particular control, of course (e.g. "Ok" button might have | |
725 | // different -- bold for example -- font) | |
726 | virtual wxVisualAttributes GetDefaultAttributes() const | |
727 | { | |
728 | return GetClassDefaultAttributes(GetWindowVariant()); | |
729 | } | |
730 | ||
731 | static wxVisualAttributes | |
732 | GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL); | |
733 | ||
734 | // set/retrieve the window colours (system defaults are used by | |
735 | // default): SetXXX() functions return true if colour was changed, | |
736 | // SetDefaultXXX() reset the "m_inheritXXX" flag after setting the | |
737 | // value to prevent it from being inherited by our children | |
738 | virtual bool SetBackgroundColour(const wxColour& colour); | |
739 | void SetOwnBackgroundColour(const wxColour& colour) | |
740 | { | |
741 | if ( SetBackgroundColour(colour) ) | |
742 | m_inheritBgCol = false; | |
743 | } | |
744 | wxColour GetBackgroundColour() const; | |
745 | ||
746 | virtual bool SetForegroundColour(const wxColour& colour); | |
747 | void SetOwnForegroundColour(const wxColour& colour) | |
748 | { | |
749 | if ( SetForegroundColour(colour) ) | |
750 | m_inheritFgCol = false; | |
751 | } | |
752 | wxColour GetForegroundColour() const; | |
753 | ||
754 | // set/retrieve the font for the window (SetFont() returns true if the | |
755 | // font really changed) | |
756 | virtual bool SetFont(const wxFont& font) = 0; | |
757 | void SetOwnFont(const wxFont& font) | |
758 | { | |
759 | if ( SetFont(font) ) | |
760 | m_inheritFont = false; | |
761 | } | |
762 | wxFont GetFont() const; | |
763 | ||
764 | // set/retrieve the cursor for this window (SetCursor() returns true | |
765 | // if the cursor was really changed) | |
766 | virtual bool SetCursor( const wxCursor &cursor ); | |
767 | const wxCursor& GetCursor() const { return m_cursor; } | |
768 | ||
769 | #if wxUSE_CARET | |
770 | // associate a caret with the window | |
771 | void SetCaret(wxCaret *caret); | |
772 | // get the current caret (may be NULL) | |
773 | wxCaret *GetCaret() const { return m_caret; } | |
774 | #endif // wxUSE_CARET | |
775 | ||
776 | // get the (average) character size for the current font | |
777 | virtual int GetCharHeight() const = 0; | |
778 | virtual int GetCharWidth() const = 0; | |
779 | ||
780 | // get the width/height/... of the text using current or specified | |
781 | // font | |
782 | virtual void GetTextExtent(const wxString& string, | |
783 | int *x, int *y, | |
784 | int *descent = (int *) NULL, | |
785 | int *externalLeading = (int *) NULL, | |
786 | const wxFont *theFont = (const wxFont *) NULL) | |
787 | const = 0; | |
788 | ||
789 | // client <-> screen coords | |
790 | // ------------------------ | |
791 | ||
792 | // translate to/from screen/client coordinates (pointers may be NULL) | |
793 | void ClientToScreen( int *x, int *y ) const | |
794 | { DoClientToScreen(x, y); } | |
795 | void ScreenToClient( int *x, int *y ) const | |
796 | { DoScreenToClient(x, y); } | |
797 | ||
798 | // wxPoint interface to do the same thing | |
799 | wxPoint ClientToScreen(const wxPoint& pt) const | |
800 | { | |
801 | int x = pt.x, y = pt.y; | |
802 | DoClientToScreen(&x, &y); | |
803 | ||
804 | return wxPoint(x, y); | |
805 | } | |
806 | ||
807 | wxPoint ScreenToClient(const wxPoint& pt) const | |
808 | { | |
809 | int x = pt.x, y = pt.y; | |
810 | DoScreenToClient(&x, &y); | |
811 | ||
812 | return wxPoint(x, y); | |
813 | } | |
814 | ||
815 | // test where the given (in client coords) point lies | |
816 | wxHitTest HitTest(wxCoord x, wxCoord y) const | |
817 | { return DoHitTest(x, y); } | |
818 | ||
819 | wxHitTest HitTest(const wxPoint& pt) const | |
820 | { return DoHitTest(pt.x, pt.y); } | |
821 | ||
822 | // misc | |
823 | // ---- | |
824 | ||
825 | // get the window border style from the given flags: this is different from | |
826 | // simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to | |
827 | // translate wxBORDER_DEFAULT to something reasonable | |
828 | wxBorder GetBorder(long flags) const; | |
829 | ||
830 | // get border for the flags of this window | |
831 | wxBorder GetBorder() const { return GetBorder(GetWindowStyleFlag()); } | |
832 | ||
833 | // send wxUpdateUIEvents to this window, and children if recurse is true | |
834 | virtual void UpdateWindowUI(long flags = wxUPDATE_UI_NONE); | |
835 | ||
836 | // do the window-specific processing after processing the update event | |
837 | virtual void DoUpdateWindowUI(wxUpdateUIEvent& event) ; | |
838 | ||
839 | #if wxUSE_MENUS | |
840 | bool PopupMenu(wxMenu *menu, const wxPoint& pos = wxDefaultPosition) | |
841 | { return DoPopupMenu(menu, pos.x, pos.y); } | |
842 | bool PopupMenu(wxMenu *menu, int x, int y) | |
843 | { return DoPopupMenu(menu, x, y); } | |
844 | #endif // wxUSE_MENUS | |
845 | ||
846 | // scrollbars | |
847 | // ---------- | |
848 | ||
849 | // does the window have the scrollbar for this orientation? | |
850 | bool HasScrollbar(int orient) const | |
851 | { | |
852 | return (m_windowStyle & | |
853 | (orient == wxHORIZONTAL ? wxHSCROLL : wxVSCROLL)) != 0; | |
854 | } | |
855 | ||
856 | // configure the window scrollbars | |
857 | virtual void SetScrollbar( int orient, | |
858 | int pos, | |
859 | int thumbvisible, | |
860 | int range, | |
861 | bool refresh = true ) = 0; | |
862 | virtual void SetScrollPos( int orient, int pos, bool refresh = true ) = 0; | |
863 | virtual int GetScrollPos( int orient ) const = 0; | |
864 | virtual int GetScrollThumb( int orient ) const = 0; | |
865 | virtual int GetScrollRange( int orient ) const = 0; | |
866 | ||
867 | // scroll window to the specified position | |
868 | virtual void ScrollWindow( int dx, int dy, | |
869 | const wxRect* rect = (wxRect *) NULL ) = 0; | |
870 | ||
871 | // scrolls window by line/page: note that not all controls support this | |
872 | // | |
873 | // return true if the position changed, false otherwise | |
874 | virtual bool ScrollLines(int WXUNUSED(lines)) { return false; } | |
875 | virtual bool ScrollPages(int WXUNUSED(pages)) { return false; } | |
876 | ||
877 | // convenient wrappers for ScrollLines/Pages | |
878 | bool LineUp() { return ScrollLines(-1); } | |
879 | bool LineDown() { return ScrollLines(1); } | |
880 | bool PageUp() { return ScrollPages(-1); } | |
881 | bool PageDown() { return ScrollPages(1); } | |
882 | ||
883 | // context-sensitive help | |
884 | // ---------------------- | |
885 | ||
886 | // these are the convenience functions wrapping wxHelpProvider methods | |
887 | ||
888 | #if wxUSE_HELP | |
889 | // associate this help text with this window | |
890 | void SetHelpText(const wxString& text); | |
891 | // associate this help text with all windows with the same id as this | |
892 | // one | |
893 | void SetHelpTextForId(const wxString& text); | |
894 | // get the help string associated with this window (may be empty) | |
895 | wxString GetHelpText() const; | |
896 | #endif // wxUSE_HELP | |
897 | ||
898 | // tooltips | |
899 | // -------- | |
900 | ||
901 | #if wxUSE_TOOLTIPS | |
902 | // the easiest way to set a tooltip for a window is to use this method | |
903 | void SetToolTip( const wxString &tip ); | |
904 | // attach a tooltip to the window | |
905 | void SetToolTip( wxToolTip *tip ) { DoSetToolTip(tip); } | |
906 | // get the associated tooltip or NULL if none | |
907 | wxToolTip* GetToolTip() const { return m_tooltip; } | |
908 | wxString GetToolTipText() const ; | |
909 | #else | |
910 | // make it much easier to compile apps in an environment | |
911 | // that doesn't support tooltips, such as PocketPC | |
912 | inline void SetToolTip( const wxString & WXUNUSED(tip) ) {} | |
913 | #endif // wxUSE_TOOLTIPS | |
914 | ||
915 | // drag and drop | |
916 | // ------------- | |
917 | #if wxUSE_DRAG_AND_DROP | |
918 | // set/retrieve the drop target associated with this window (may be | |
919 | // NULL; it's owned by the window and will be deleted by it) | |
920 | virtual void SetDropTarget( wxDropTarget *dropTarget ) = 0; | |
921 | virtual wxDropTarget *GetDropTarget() const { return m_dropTarget; } | |
922 | #endif // wxUSE_DRAG_AND_DROP | |
923 | ||
924 | // constraints and sizers | |
925 | // ---------------------- | |
926 | #if wxUSE_CONSTRAINTS | |
927 | // set the constraints for this window or retrieve them (may be NULL) | |
928 | void SetConstraints( wxLayoutConstraints *constraints ); | |
929 | wxLayoutConstraints *GetConstraints() const { return m_constraints; } | |
930 | ||
931 | // implementation only | |
932 | void UnsetConstraints(wxLayoutConstraints *c); | |
933 | wxWindowList *GetConstraintsInvolvedIn() const | |
934 | { return m_constraintsInvolvedIn; } | |
935 | void AddConstraintReference(wxWindowBase *otherWin); | |
936 | void RemoveConstraintReference(wxWindowBase *otherWin); | |
937 | void DeleteRelatedConstraints(); | |
938 | void ResetConstraints(); | |
939 | ||
940 | // these methods may be overriden for special layout algorithms | |
941 | virtual void SetConstraintSizes(bool recurse = true); | |
942 | virtual bool LayoutPhase1(int *noChanges); | |
943 | virtual bool LayoutPhase2(int *noChanges); | |
944 | virtual bool DoPhase(int phase); | |
945 | ||
946 | // these methods are virtual but normally won't be overridden | |
947 | virtual void SetSizeConstraint(int x, int y, int w, int h); | |
948 | virtual void MoveConstraint(int x, int y); | |
949 | virtual void GetSizeConstraint(int *w, int *h) const ; | |
950 | virtual void GetClientSizeConstraint(int *w, int *h) const ; | |
951 | virtual void GetPositionConstraint(int *x, int *y) const ; | |
952 | ||
953 | #endif // wxUSE_CONSTRAINTS | |
954 | ||
955 | // when using constraints or sizers, it makes sense to update | |
956 | // children positions automatically whenever the window is resized | |
957 | // - this is done if autoLayout is on | |
958 | void SetAutoLayout( bool autoLayout ) { m_autoLayout = autoLayout; } | |
959 | bool GetAutoLayout() const { return m_autoLayout; } | |
960 | ||
961 | // lay out the window and its children | |
962 | virtual bool Layout(); | |
963 | ||
964 | // sizers | |
965 | void SetSizer(wxSizer *sizer, bool deleteOld = true ); | |
966 | void SetSizerAndFit( wxSizer *sizer, bool deleteOld = true ); | |
967 | ||
968 | wxSizer *GetSizer() const { return m_windowSizer; } | |
969 | ||
970 | // Track if this window is a member of a sizer | |
971 | void SetContainingSizer(wxSizer* sizer); | |
972 | wxSizer *GetContainingSizer() const { return m_containingSizer; } | |
973 | ||
974 | // accessibility | |
975 | // ---------------------- | |
976 | #if wxUSE_ACCESSIBILITY | |
977 | // Override to create a specific accessible object. | |
978 | virtual wxAccessible* CreateAccessible(); | |
979 | ||
980 | // Sets the accessible object. | |
981 | void SetAccessible(wxAccessible* accessible) ; | |
982 | ||
983 | // Returns the accessible object. | |
984 | wxAccessible* GetAccessible() { return m_accessible; }; | |
985 | ||
986 | // Returns the accessible object, creating if necessary. | |
987 | wxAccessible* GetOrCreateAccessible() ; | |
988 | #endif | |
989 | ||
990 | // implementation | |
991 | // -------------- | |
992 | ||
993 | // event handlers | |
994 | void OnSysColourChanged( wxSysColourChangedEvent& event ); | |
995 | void OnInitDialog( wxInitDialogEvent &event ); | |
996 | void OnMiddleClick( wxMouseEvent& event ); | |
997 | #if wxUSE_HELP | |
998 | void OnHelp(wxHelpEvent& event); | |
999 | #endif // wxUSE_HELP | |
1000 | ||
1001 | // virtual function for implementing internal idle | |
1002 | // behaviour | |
1003 | virtual void OnInternalIdle() {} | |
1004 | ||
1005 | // call internal idle recursively | |
1006 | // void ProcessInternalIdle() ; | |
1007 | ||
1008 | // get the handle of the window for the underlying window system: this | |
1009 | // is only used for wxWin itself or for user code which wants to call | |
1010 | // platform-specific APIs | |
1011 | virtual WXWidget GetHandle() const = 0; | |
1012 | ||
1013 | #if wxUSE_PALETTE | |
1014 | // Store the palette used by DCs in wxWindow so that the dcs can share | |
1015 | // a palette. And we can respond to palette messages. | |
1016 | wxPalette GetPalette() const { return m_palette; } | |
1017 | ||
1018 | // When palette is changed tell the DC to set the system palette to the | |
1019 | // new one. | |
1020 | void SetPalette(const wxPalette& pal); | |
1021 | ||
1022 | // return true if we have a specific palette | |
1023 | bool HasCustomPalette() const { return m_hasCustomPalette; } | |
1024 | ||
1025 | // return the first parent window with a custom palette or NULL | |
1026 | wxWindow *GetAncestorWithCustomPalette() const; | |
1027 | #endif // wxUSE_PALETTE | |
1028 | ||
1029 | // inherit the parents visual attributes if they had been explicitly set | |
1030 | // by the user (i.e. we don't inherit default attributes) and if we don't | |
1031 | // have our own explicitly set | |
1032 | virtual void InheritAttributes(); | |
1033 | ||
1034 | // returns false from here if this window doesn't want to inherit the | |
1035 | // parents colours even if InheritAttributes() would normally do it | |
1036 | // | |
1037 | // this just provides a simple way to customize InheritAttributes() | |
1038 | // behaviour in the most common case | |
1039 | virtual bool ShouldInheritColours() const { return false; } | |
1040 | ||
1041 | protected: | |
1042 | // event handling specific to wxWindow | |
1043 | virtual bool TryValidator(wxEvent& event); | |
1044 | virtual bool TryParent(wxEvent& event); | |
1045 | ||
1046 | // common part of MoveBefore/AfterInTabOrder() | |
1047 | enum MoveKind | |
1048 | { | |
1049 | MoveBefore, // insert before the given window | |
1050 | MoveAfter // insert after the given window | |
1051 | }; | |
1052 | virtual void DoMoveInTabOrder(wxWindow *win, MoveKind move); | |
1053 | ||
1054 | #if wxUSE_CONSTRAINTS | |
1055 | // satisfy the constraints for the windows but don't set the window sizes | |
1056 | void SatisfyConstraints(); | |
1057 | #endif // wxUSE_CONSTRAINTS | |
1058 | ||
1059 | // Send the wxWindowDestroyEvent | |
1060 | void SendDestroyEvent(); | |
1061 | ||
1062 | // the window id - a number which uniquely identifies a window among | |
1063 | // its siblings unless it is -1 | |
1064 | wxWindowID m_windowId; | |
1065 | ||
1066 | // the parent window of this window (or NULL) and the list of the children | |
1067 | // of this window | |
1068 | wxWindow *m_parent; | |
1069 | wxWindowList m_children; | |
1070 | ||
1071 | // the minimal allowed size for the window (no minimal size if variable(s) | |
1072 | // contain(s) -1) | |
1073 | int m_minWidth, | |
1074 | m_minHeight, | |
1075 | m_maxWidth, | |
1076 | m_maxHeight; | |
1077 | ||
1078 | // event handler for this window: usually is just 'this' but may be | |
1079 | // changed with SetEventHandler() | |
1080 | wxEvtHandler *m_eventHandler; | |
1081 | ||
1082 | #if wxUSE_VALIDATORS | |
1083 | // associated validator or NULL if none | |
1084 | wxValidator *m_windowValidator; | |
1085 | #endif // wxUSE_VALIDATORS | |
1086 | ||
1087 | #if wxUSE_DRAG_AND_DROP | |
1088 | wxDropTarget *m_dropTarget; | |
1089 | #endif // wxUSE_DRAG_AND_DROP | |
1090 | ||
1091 | // visual window attributes | |
1092 | wxCursor m_cursor; | |
1093 | wxFont m_font; // see m_hasFont | |
1094 | wxColour m_backgroundColour, // m_hasBgCol | |
1095 | m_foregroundColour; // m_hasFgCol | |
1096 | ||
1097 | #if wxUSE_CARET | |
1098 | wxCaret *m_caret; | |
1099 | #endif // wxUSE_CARET | |
1100 | ||
1101 | // the region which should be repainted in response to paint event | |
1102 | wxRegion m_updateRegion; | |
1103 | ||
1104 | #if wxUSE_ACCEL | |
1105 | // the accelerator table for the window which translates key strokes into | |
1106 | // command events | |
1107 | wxAcceleratorTable m_acceleratorTable; | |
1108 | #endif // wxUSE_ACCEL | |
1109 | ||
1110 | // the tooltip for this window (may be NULL) | |
1111 | #if wxUSE_TOOLTIPS | |
1112 | wxToolTip *m_tooltip; | |
1113 | #endif // wxUSE_TOOLTIPS | |
1114 | ||
1115 | // constraints and sizers | |
1116 | #if wxUSE_CONSTRAINTS | |
1117 | // the constraints for this window or NULL | |
1118 | wxLayoutConstraints *m_constraints; | |
1119 | ||
1120 | // constraints this window is involved in | |
1121 | wxWindowList *m_constraintsInvolvedIn; | |
1122 | #endif // wxUSE_CONSTRAINTS | |
1123 | ||
1124 | // this window's sizer | |
1125 | wxSizer *m_windowSizer; | |
1126 | ||
1127 | // The sizer this window is a member of, if any | |
1128 | wxSizer *m_containingSizer; | |
1129 | ||
1130 | // Layout() window automatically when its size changes? | |
1131 | bool m_autoLayout:1; | |
1132 | ||
1133 | // window state | |
1134 | bool m_isShown:1; | |
1135 | bool m_isEnabled:1; | |
1136 | bool m_isBeingDeleted:1; | |
1137 | ||
1138 | // was the window colours/font explicitly changed by user? | |
1139 | bool m_hasBgCol:1; | |
1140 | bool m_hasFgCol:1; | |
1141 | bool m_hasFont:1; | |
1142 | ||
1143 | // and should it be inherited by children? | |
1144 | bool m_inheritBgCol:1; | |
1145 | bool m_inheritFgCol:1; | |
1146 | bool m_inheritFont:1; | |
1147 | ||
1148 | // window attributes | |
1149 | long m_windowStyle, | |
1150 | m_exStyle; | |
1151 | wxString m_windowName; | |
1152 | bool m_themeEnabled; | |
1153 | ||
1154 | #if wxUSE_PALETTE | |
1155 | wxPalette m_palette; | |
1156 | bool m_hasCustomPalette; | |
1157 | #endif // wxUSE_PALETTE | |
1158 | ||
1159 | #if wxUSE_ACCESSIBILITY | |
1160 | wxAccessible* m_accessible; | |
1161 | #endif | |
1162 | ||
1163 | // Virtual size (scrolling) | |
1164 | wxSize m_virtualSize; | |
1165 | ||
1166 | int m_minVirtualWidth; // VirtualSizeHints | |
1167 | int m_minVirtualHeight; | |
1168 | int m_maxVirtualWidth; | |
1169 | int m_maxVirtualHeight; | |
1170 | ||
1171 | wxWindowVariant m_windowVariant ; | |
1172 | ||
1173 | // override this to change the default (i.e. used when no style is | |
1174 | // specified) border for the window class | |
1175 | virtual wxBorder GetDefaultBorder() const; | |
1176 | ||
1177 | // Get the default size for the new window if no explicit size given. TLWs | |
1178 | // have their own default size so this is just for non top-level windows. | |
1179 | static int WidthDefault(int w) { return w == -1 ? 20 : w; } | |
1180 | static int HeightDefault(int h) { return h == -1 ? 20 : h; } | |
1181 | ||
1182 | ||
1183 | // Used to save the results of DoGetBestSize so it doesn't need to be | |
1184 | // recalculated each time the value is needed. | |
1185 | wxSize m_bestSizeCache; | |
1186 | ||
1187 | // keep the old name for compatibility, at least until all the internal | |
1188 | // usages of it are changed to SetBestFittingSize | |
1189 | void SetBestSize(const wxSize& size) { SetBestFittingSize(size); } | |
1190 | ||
1191 | // set the initial window size if none is given (i.e. at least one of the | |
1192 | // components of the size passed to ctor/Create() is -1) | |
1193 | // | |
1194 | // normally just calls SetBestSize() for controls, but can be overridden | |
1195 | // not to do it for the controls which have to do some additional | |
1196 | // initialization (e.g. add strings to list box) before their best size | |
1197 | // can be accurately calculated | |
1198 | virtual void SetInitialBestSize(const wxSize& WXUNUSED(size)) {} | |
1199 | ||
1200 | ||
1201 | ||
1202 | // more pure virtual functions | |
1203 | // --------------------------- | |
1204 | ||
1205 | // NB: we must have DoSomething() function when Something() is an overloaded | |
1206 | // method: indeed, we can't just have "virtual Something()" in case when | |
1207 | // the function is overloaded because then we'd have to make virtual all | |
1208 | // the variants (otherwise only the virtual function may be called on a | |
1209 | // pointer to derived class according to C++ rules) which is, in | |
1210 | // general, absolutely not needed. So instead we implement all | |
1211 | // overloaded Something()s in terms of DoSomething() which will be the | |
1212 | // only one to be virtual. | |
1213 | ||
1214 | // coordinates translation | |
1215 | virtual void DoClientToScreen( int *x, int *y ) const = 0; | |
1216 | virtual void DoScreenToClient( int *x, int *y ) const = 0; | |
1217 | ||
1218 | virtual wxHitTest DoHitTest(wxCoord x, wxCoord y) const; | |
1219 | ||
1220 | // capture/release the mouse, used by Capture/ReleaseMouse() | |
1221 | virtual void DoCaptureMouse() = 0; | |
1222 | virtual void DoReleaseMouse() = 0; | |
1223 | ||
1224 | // retrieve the position/size of the window | |
1225 | virtual void DoGetPosition( int *x, int *y ) const = 0; | |
1226 | virtual void DoGetSize( int *width, int *height ) const = 0; | |
1227 | virtual void DoGetClientSize( int *width, int *height ) const = 0; | |
1228 | ||
1229 | // get the size which best suits the window: for a control, it would be | |
1230 | // the minimal size which doesn't truncate the control, for a panel - the | |
1231 | // same size as it would have after a call to Fit() | |
1232 | virtual wxSize DoGetBestSize() const; | |
1233 | ||
1234 | // this is the virtual function to be overriden in any derived class which | |
1235 | // wants to change how SetSize() or Move() works - it is called by all | |
1236 | // versions of these functions in the base class | |
1237 | virtual void DoSetSize(int x, int y, | |
1238 | int width, int height, | |
1239 | int sizeFlags = wxSIZE_AUTO) = 0; | |
1240 | ||
1241 | // same as DoSetSize() for the client size | |
1242 | virtual void DoSetClientSize(int width, int height) = 0; | |
1243 | ||
1244 | // move the window to the specified location and resize it: this is called | |
1245 | // from both DoSetSize() and DoSetClientSize() and would usually just | |
1246 | // reposition this window except for composite controls which will want to | |
1247 | // arrange themselves inside the given rectangle | |
1248 | virtual void DoMoveWindow(int x, int y, int width, int height) = 0; | |
1249 | ||
1250 | #if wxUSE_TOOLTIPS | |
1251 | virtual void DoSetToolTip( wxToolTip *tip ); | |
1252 | #endif // wxUSE_TOOLTIPS | |
1253 | ||
1254 | #if wxUSE_MENUS | |
1255 | virtual bool DoPopupMenu(wxMenu *menu, int x, int y) = 0; | |
1256 | #endif // wxUSE_MENUS | |
1257 | ||
1258 | // Makes an adjustment to the window position to make it relative to the | |
1259 | // parents client area, e.g. if the parent is a frame with a toolbar, its | |
1260 | // (0, 0) is just below the toolbar | |
1261 | virtual void AdjustForParentClientOrigin(int& x, int& y, | |
1262 | int sizeFlags = 0) const; | |
1263 | ||
1264 | // implements the window variants | |
1265 | virtual void DoSetWindowVariant( wxWindowVariant variant ) ; | |
1266 | ||
1267 | private: | |
1268 | // contains the last id generated by NewControlId | |
1269 | static int ms_lastControlId; | |
1270 | ||
1271 | // the stack of windows which have captured the mouse | |
1272 | static struct WXDLLEXPORT wxWindowNext *ms_winCaptureNext; | |
1273 | ||
1274 | DECLARE_ABSTRACT_CLASS(wxWindowBase) | |
1275 | DECLARE_NO_COPY_CLASS(wxWindowBase) | |
1276 | DECLARE_EVENT_TABLE() | |
1277 | }; | |
1278 | ||
1279 | // ---------------------------------------------------------------------------- | |
1280 | // now include the declaration of wxWindow class | |
1281 | // ---------------------------------------------------------------------------- | |
1282 | ||
1283 | // include the declaration of the platform-specific class | |
1284 | #if defined(__WXMSW__) | |
1285 | #ifdef __WXUNIVERSAL__ | |
1286 | #define wxWindowNative wxWindowMSW | |
1287 | #else // !wxUniv | |
1288 | #define wxWindowMSW wxWindow | |
1289 | #endif // wxUniv/!wxUniv | |
1290 | #include "wx/msw/window.h" | |
1291 | #elif defined(__WXMOTIF__) | |
1292 | #include "wx/motif/window.h" | |
1293 | #elif defined(__WXGTK__) | |
1294 | #ifdef __WXUNIVERSAL__ | |
1295 | #define wxWindowNative wxWindowGTK | |
1296 | #else // !wxUniv | |
1297 | #define wxWindowGTK wxWindow | |
1298 | #endif // wxUniv | |
1299 | #include "wx/gtk/window.h" | |
1300 | #elif defined(__WXX11__) | |
1301 | #ifdef __WXUNIVERSAL__ | |
1302 | #define wxWindowNative wxWindowX11 | |
1303 | #else // !wxUniv | |
1304 | #define wxWindowX11 wxWindow | |
1305 | #endif // wxUniv | |
1306 | #include "wx/x11/window.h" | |
1307 | #elif defined(__WXMGL__) | |
1308 | #ifdef __WXUNIVERSAL__ | |
1309 | #define wxWindowNative wxWindowMGL | |
1310 | #else // !wxUniv | |
1311 | #define wxWindowMGL wxWindow | |
1312 | #endif // wxUniv | |
1313 | #include "wx/mgl/window.h" | |
1314 | #elif defined(__WXMAC__) | |
1315 | #ifdef __WXUNIVERSAL__ | |
1316 | #define wxWindowNative wxWindowMac | |
1317 | #else // !wxUniv | |
1318 | #define wxWindowMac wxWindow | |
1319 | #endif // wxUniv | |
1320 | #include "wx/mac/window.h" | |
1321 | #elif defined(__WXCOCOA__) | |
1322 | #ifdef __WXUNIVERSAL__ | |
1323 | #define wxWindowNative wxWindowCocoa | |
1324 | #else // !wxUniv | |
1325 | #define wxWindowCocoa wxWindow | |
1326 | #endif // wxUniv | |
1327 | #include "wx/cocoa/window.h" | |
1328 | #elif defined(__WXPM__) | |
1329 | #ifdef __WXUNIVERSAL__ | |
1330 | #define wxWindowNative wxWindowOS2 | |
1331 | #else // !wxUniv | |
1332 | #define wxWindowOS2 wxWindow | |
1333 | #endif // wxUniv/!wxUniv | |
1334 | #include "wx/os2/window.h" | |
1335 | #endif | |
1336 | ||
1337 | // for wxUniversal, we now derive the real wxWindow from wxWindow<platform>, | |
1338 | // for the native ports we already have defined it above | |
1339 | #if defined(__WXUNIVERSAL__) | |
1340 | #ifndef wxWindowNative | |
1341 | #error "wxWindowNative must be defined above!" | |
1342 | #endif | |
1343 | ||
1344 | #include "wx/univ/window.h" | |
1345 | #endif // wxUniv | |
1346 | ||
1347 | // ---------------------------------------------------------------------------- | |
1348 | // inline functions which couldn't be declared in the class body because of | |
1349 | // forward dependencies | |
1350 | // ---------------------------------------------------------------------------- | |
1351 | ||
1352 | inline wxWindow *wxWindowBase::GetGrandParent() const | |
1353 | { | |
1354 | return m_parent ? m_parent->GetParent() : (wxWindow *)NULL; | |
1355 | } | |
1356 | ||
1357 | // ---------------------------------------------------------------------------- | |
1358 | // global functions | |
1359 | // ---------------------------------------------------------------------------- | |
1360 | ||
1361 | // Find the wxWindow at the current mouse position, also returning the mouse | |
1362 | // position. | |
1363 | WXDLLEXPORT extern wxWindow* wxFindWindowAtPointer(wxPoint& pt); | |
1364 | ||
1365 | // Get the current mouse position. | |
1366 | WXDLLEXPORT extern wxPoint wxGetMousePosition(); | |
1367 | ||
1368 | // get the currently active window of this application or NULL | |
1369 | WXDLLEXPORT extern wxWindow *wxGetActiveWindow(); | |
1370 | ||
1371 | // get the (first) top level parent window | |
1372 | WXDLLEXPORT wxWindow* wxGetTopLevelParent(wxWindow *win); | |
1373 | ||
1374 | // deprecated (doesn't start with 'wx' prefix), use wxWindow::NewControlId() | |
1375 | inline int NewControlId() { return wxWindowBase::NewControlId(); } | |
1376 | ||
1377 | #if wxUSE_ACCESSIBILITY | |
1378 | // ---------------------------------------------------------------------------- | |
1379 | // accessible object for windows | |
1380 | // ---------------------------------------------------------------------------- | |
1381 | ||
1382 | class WXDLLEXPORT wxWindowAccessible: public wxAccessible | |
1383 | { | |
1384 | public: | |
1385 | wxWindowAccessible(wxWindow* win): wxAccessible(win) { if (win) win->SetAccessible(this); } | |
1386 | virtual ~wxWindowAccessible() {}; | |
1387 | ||
1388 | // Overridables | |
1389 | ||
1390 | // Can return either a child object, or an integer | |
1391 | // representing the child element, starting from 1. | |
1392 | virtual wxAccStatus HitTest(const wxPoint& pt, int* childId, wxAccessible** childObject); | |
1393 | ||
1394 | // Returns the rectangle for this object (id = 0) or a child element (id > 0). | |
1395 | virtual wxAccStatus GetLocation(wxRect& rect, int elementId); | |
1396 | ||
1397 | // Navigates from fromId to toId/toObject. | |
1398 | virtual wxAccStatus Navigate(wxNavDir navDir, int fromId, | |
1399 | int* toId, wxAccessible** toObject); | |
1400 | ||
1401 | // Gets the name of the specified object. | |
1402 | virtual wxAccStatus GetName(int childId, wxString* name); | |
1403 | ||
1404 | // Gets the number of children. | |
1405 | virtual wxAccStatus GetChildCount(int* childCount); | |
1406 | ||
1407 | // Gets the specified child (starting from 1). | |
1408 | // If *child is NULL and return value is wxACC_OK, | |
1409 | // this means that the child is a simple element and | |
1410 | // not an accessible object. | |
1411 | virtual wxAccStatus GetChild(int childId, wxAccessible** child); | |
1412 | ||
1413 | // Gets the parent, or NULL. | |
1414 | virtual wxAccStatus GetParent(wxAccessible** parent); | |
1415 | ||
1416 | // Performs the default action. childId is 0 (the action for this object) | |
1417 | // or > 0 (the action for a child). | |
1418 | // Return wxACC_NOT_SUPPORTED if there is no default action for this | |
1419 | // window (e.g. an edit control). | |
1420 | virtual wxAccStatus DoDefaultAction(int childId); | |
1421 | ||
1422 | // Gets the default action for this object (0) or > 0 (the action for a child). | |
1423 | // Return wxACC_OK even if there is no action. actionName is the action, or the empty | |
1424 | // string if there is no action. | |
1425 | // The retrieved string describes the action that is performed on an object, | |
1426 | // not what the object does as a result. For example, a toolbar button that prints | |
1427 | // a document has a default action of "Press" rather than "Prints the current document." | |
1428 | virtual wxAccStatus GetDefaultAction(int childId, wxString* actionName); | |
1429 | ||
1430 | // Returns the description for this object or a child. | |
1431 | virtual wxAccStatus GetDescription(int childId, wxString* description); | |
1432 | ||
1433 | // Returns help text for this object or a child, similar to tooltip text. | |
1434 | virtual wxAccStatus GetHelpText(int childId, wxString* helpText); | |
1435 | ||
1436 | // Returns the keyboard shortcut for this object or child. | |
1437 | // Return e.g. ALT+K | |
1438 | virtual wxAccStatus GetKeyboardShortcut(int childId, wxString* shortcut); | |
1439 | ||
1440 | // Returns a role constant. | |
1441 | virtual wxAccStatus GetRole(int childId, wxAccRole* role); | |
1442 | ||
1443 | // Returns a state constant. | |
1444 | virtual wxAccStatus GetState(int childId, long* state); | |
1445 | ||
1446 | // Returns a localized string representing the value for the object | |
1447 | // or child. | |
1448 | virtual wxAccStatus GetValue(int childId, wxString* strValue); | |
1449 | ||
1450 | // Selects the object or child. | |
1451 | virtual wxAccStatus Select(int childId, wxAccSelectionFlags selectFlags); | |
1452 | ||
1453 | // Gets the window with the keyboard focus. | |
1454 | // If childId is 0 and child is NULL, no object in | |
1455 | // this subhierarchy has the focus. | |
1456 | // If this object has the focus, child should be 'this'. | |
1457 | virtual wxAccStatus GetFocus(int* childId, wxAccessible** child); | |
1458 | ||
1459 | // Gets a variant representing the selected children | |
1460 | // of this object. | |
1461 | // Acceptable values: | |
1462 | // - a null variant (IsNull() returns true) | |
1463 | // - a list variant (GetType() == wxT("list") | |
1464 | // - an integer representing the selected child element, | |
1465 | // or 0 if this object is selected (GetType() == wxT("long") | |
1466 | // - a "void*" pointer to a wxAccessible child object | |
1467 | virtual wxAccStatus GetSelections(wxVariant* selections); | |
1468 | }; | |
1469 | ||
1470 | #endif // wxUSE_ACCESSIBILITY | |
1471 | ||
1472 | ||
1473 | #endif | |
1474 | // _WX_WINDOW_H_BASE_ | |
1475 |