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