| 1 | ///////////////////////////////////////////////////////////////////////////// |
| 2 | // Name: window.h |
| 3 | // Purpose: interface of wxWindow |
| 4 | // Author: wxWidgets team |
| 5 | // RCS-ID: $Id$ |
| 6 | // Licence: wxWindows license |
| 7 | ///////////////////////////////////////////////////////////////////////////// |
| 8 | |
| 9 | |
| 10 | /** |
| 11 | Background styles. See wxWindow::SetBackgroundStyle(). |
| 12 | */ |
| 13 | enum wxBackgroundStyle |
| 14 | { |
| 15 | /// Use the default background, as determined by |
| 16 | /// the system or the current theme. |
| 17 | wxBG_STYLE_SYSTEM, |
| 18 | |
| 19 | /// Use a solid colour for the background, this style is set automatically if you call |
| 20 | /// SetBackgroundColour() so you only need to set it explicitly if you had |
| 21 | /// changed the background style to something else before. |
| 22 | wxBG_STYLE_COLOUR, |
| 23 | |
| 24 | /// Don't draw the background at all, it's supposed that it is drawn by |
| 25 | /// the user-defined erase background event handler. |
| 26 | /// This style should be used to avoid flicker when the background is entirely |
| 27 | /// custom-drawn. |
| 28 | wxBG_STYLE_CUSTOM, |
| 29 | |
| 30 | /// The background is (partially) transparent,this style is automatically set if you call |
| 31 | /// SetTransparent() which is used to set the transparency level. |
| 32 | wxBG_STYLE_TRANSPARENT |
| 33 | }; |
| 34 | |
| 35 | |
| 36 | /** |
| 37 | Valid values for wxWindow::ShowWithEffect() and wxWindow::HideWithEffect(). |
| 38 | */ |
| 39 | enum wxShowEffect |
| 40 | { |
| 41 | /// Roll window to the left |
| 42 | wxSHOW_EFFECT_ROLL_TO_LEFT, |
| 43 | |
| 44 | /// Roll window to the right |
| 45 | wxSHOW_EFFECT_ROLL_TO_RIGHT, |
| 46 | |
| 47 | /// Roll window to the top |
| 48 | wxSHOW_EFFECT_ROLL_TO_TOP, |
| 49 | |
| 50 | /// Roll window to the bottom |
| 51 | wxSHOW_EFFECT_ROLL_TO_BOTTOM, |
| 52 | |
| 53 | /// Slide window to the left |
| 54 | wxSHOW_EFFECT_SLIDE_TO_LEFT, |
| 55 | |
| 56 | /// Slide window to the right |
| 57 | wxSHOW_EFFECT_SLIDE_TO_RIGHT, |
| 58 | |
| 59 | /// Slide window to the top |
| 60 | wxSHOW_EFFECT_SLIDE_TO_TOP, |
| 61 | |
| 62 | /// Slide window to the bottom |
| 63 | wxSHOW_EFFECT_SLIDE_TO_BOTTOM, |
| 64 | |
| 65 | /// Fade in or out effect |
| 66 | wxSHOW_EFFECT_BLEND, |
| 67 | |
| 68 | /// Expanding or collapsing effect |
| 69 | wxSHOW_EFFECT_EXPAND |
| 70 | }; |
| 71 | |
| 72 | /** |
| 73 | Different window variants, on platforms like eg mac uses different |
| 74 | rendering sizes. |
| 75 | */ |
| 76 | enum wxWindowVariant |
| 77 | { |
| 78 | wxWINDOW_VARIANT_NORMAL, //!< Normal size |
| 79 | wxWINDOW_VARIANT_SMALL, //!< Smaller size (about 25 % smaller than normal) |
| 80 | wxWINDOW_VARIANT_MINI, //!< Mini size (about 33 % smaller than normal) |
| 81 | wxWINDOW_VARIANT_LARGE, //!< Large size (about 25 % larger than normal) |
| 82 | wxWINDOW_VARIANT_MAX |
| 83 | }; |
| 84 | |
| 85 | |
| 86 | /** |
| 87 | Flags which can be used in wxWindow::UpdateWindowUI(). |
| 88 | */ |
| 89 | enum wxUpdateUI |
| 90 | { |
| 91 | wxUPDATE_UI_NONE, |
| 92 | wxUPDATE_UI_RECURSE, |
| 93 | wxUPDATE_UI_FROMIDLE /**< Invoked from On(Internal)Idle */ |
| 94 | }; |
| 95 | |
| 96 | |
| 97 | /** |
| 98 | @class wxWindow |
| 99 | |
| 100 | wxWindow is the base class for all windows and represents any visible object |
| 101 | om screen. All controls, top level windows and so on are windows. Sizers and |
| 102 | device contexts are not, however, as they don't appear on screen themselves. |
| 103 | |
| 104 | Please note that all children of the window will be deleted automatically by |
| 105 | the destructor before the window itself is deleted which means that you don't |
| 106 | have to worry about deleting them manually. Please see the @ref |
| 107 | overview_windowdeletion "window deletion overview" for more information. |
| 108 | |
| 109 | Also note that in this, and many others, wxWidgets classes some |
| 110 | @c GetXXX() methods may be overloaded (as, for example, |
| 111 | wxWindow::GetSize or wxWindow::GetClientSize). In this case, the overloads |
| 112 | are non-virtual because having multiple virtual functions with the same name |
| 113 | results in a virtual function name hiding at the derived class level (in |
| 114 | English, this means that the derived class has to override all overloaded |
| 115 | variants if it overrides any of them). To allow overriding them in the derived |
| 116 | class, wxWidgets uses a unique protected virtual @c DoGetXXX() method |
| 117 | and all @c GetXXX() ones are forwarded to it, so overriding the former |
| 118 | changes the behaviour of the latter. |
| 119 | |
| 120 | @beginStyleTable |
| 121 | @style{wxBORDER_DEFAULT} |
| 122 | The window class will decide the kind of border to show, if any. |
| 123 | @style{wxBORDER_SIMPLE} |
| 124 | Displays a thin border around the window. wxSIMPLE_BORDER is the |
| 125 | old name for this style. |
| 126 | @style{wxBORDER_SUNKEN} |
| 127 | Displays a sunken border. wxSUNKEN_BORDER is the old name for this |
| 128 | style. |
| 129 | @style{wxBORDER_RAISED} |
| 130 | Displays a raised border. wxRAISED_BORDER is the old name for this |
| 131 | style. |
| 132 | @style{wxBORDER_STATIC} |
| 133 | Displays a border suitable for a static control. wxSTATIC_BORDER |
| 134 | is the old name for this style. Windows only. |
| 135 | @style{wxBORDER_THEME} |
| 136 | Displays a native border suitable for a control, on the current |
| 137 | platform. On Windows XP or Vista, this will be a themed border; on |
| 138 | most other platforms a sunken border will be used. For more |
| 139 | information for themed borders on Windows, please see Themed |
| 140 | borders on Windows. |
| 141 | @style{wxBORDER_NONE} |
| 142 | Displays no border, overriding the default border style for the |
| 143 | window. wxNO_BORDER is the old name for this style. |
| 144 | @style{wxBORDER_DOUBLE} |
| 145 | This style is obsolete and should not be used. |
| 146 | @style{wxTRANSPARENT_WINDOW} |
| 147 | The window is transparent, that is, it will not receive paint |
| 148 | events. Windows only. |
| 149 | @style{wxTAB_TRAVERSAL} |
| 150 | Use this to enable tab traversal for non-dialog windows. |
| 151 | @style{wxWANTS_CHARS} |
| 152 | Use this to indicate that the window wants to get all char/key |
| 153 | events for all keys - even for keys like TAB or ENTER which are |
| 154 | usually used for dialog navigation and which wouldn't be generated |
| 155 | without this style. If you need to use this style in order to get |
| 156 | the arrows or etc., but would still like to have normal keyboard |
| 157 | navigation take place, you should call Navigate in response to the |
| 158 | key events for Tab and Shift-Tab. |
| 159 | @style{wxNO_FULL_REPAINT_ON_RESIZE} |
| 160 | On Windows, this style used to disable repainting the window |
| 161 | completely when its size is changed. Since this behaviour is now |
| 162 | the default, the style is now obsolete and no longer has an effect. |
| 163 | @style{wxVSCROLL} |
| 164 | Use this style to enable a vertical scrollbar. Notice that this |
| 165 | style cannot be used with native controls which don't support |
| 166 | scrollbars nor with top-level windows in most ports. |
| 167 | @style{wxHSCROLL} |
| 168 | Use this style to enable a horizontal scrollbar. The same |
| 169 | limitations as for wxVSCROLL apply to this style. |
| 170 | @style{wxALWAYS_SHOW_SB} |
| 171 | If a window has scrollbars, disable them instead of hiding them |
| 172 | when they are not needed (i.e. when the size of the window is big |
| 173 | enough to not require the scrollbars to navigate it). This style is |
| 174 | currently implemented for wxMSW, wxGTK and wxUniversal and does |
| 175 | nothing on the other platforms. |
| 176 | @style{wxCLIP_CHILDREN} |
| 177 | Use this style to eliminate flicker caused by the background being |
| 178 | repainted, then children being painted over them. Windows only. |
| 179 | @style{wxFULL_REPAINT_ON_RESIZE} |
| 180 | Use this style to force a complete redraw of the window whenever it |
| 181 | is resized instead of redrawing just the part of the window |
| 182 | affected by resizing. Note that this was the behaviour by default |
| 183 | before 2.5.1 release and that if you experience redraw problems |
| 184 | with code which previously used to work you may want to try this. |
| 185 | Currently this style applies on GTK+ 2 and Windows only, and full |
| 186 | repainting is always done on other platforms. |
| 187 | @endStyleTable |
| 188 | |
| 189 | @beginExtraStyleTable |
| 190 | @style{wxWS_EX_VALIDATE_RECURSIVELY} |
| 191 | By default, Validate/TransferDataTo/FromWindow() only work on |
| 192 | direct children of the window (compatible behaviour). Set this flag |
| 193 | to make them recursively descend into all subwindows. |
| 194 | @style{wxWS_EX_BLOCK_EVENTS} |
| 195 | wxCommandEvents and the objects of the derived classes are |
| 196 | forwarded to the parent window and so on recursively by default. |
| 197 | Using this flag for the given window allows to block this |
| 198 | propagation at this window, i.e. prevent the events from being |
| 199 | propagated further upwards. Dialogs have this flag on by default |
| 200 | for the reasons explained in the @ref overview_eventhandling "Event Handling Overview". |
| 201 | @style{wxWS_EX_TRANSIENT} |
| 202 | Don't use this window as an implicit parent for the other windows: |
| 203 | this must be used with transient windows as otherwise there is the |
| 204 | risk of creating a dialog/frame with this window as a parent which |
| 205 | would lead to a crash if the parent is destroyed before the child. |
| 206 | @style{wxWS_EX_CONTEXTHELP} |
| 207 | Under Windows, puts a query button on the caption. When pressed, |
| 208 | Windows will go into a context-sensitive help mode and wxWidgets |
| 209 | will send a wxEVT_HELP event if the user clicked on an application window. |
| 210 | This style cannot be used together with wxMAXIMIZE_BOX or wxMINIMIZE_BOX, so |
| 211 | these two styles are automatically turned of if this one is used. |
| 212 | @style{wxWS_EX_PROCESS_IDLE} |
| 213 | This window should always process idle events, even if the mode set |
| 214 | by wxIdleEvent::SetMode is wxIDLE_PROCESS_SPECIFIED. |
| 215 | @style{wxWS_EX_PROCESS_UI_UPDATES} |
| 216 | This window should always process UI update events, even if the |
| 217 | mode set by wxUpdateUIEvent::SetMode is wxUPDATE_UI_PROCESS_SPECIFIED. |
| 218 | @endExtraStyleTable |
| 219 | |
| 220 | @library{wxcore} |
| 221 | @category{miscwnd} |
| 222 | |
| 223 | @see @ref overview_eventhandling "Event handling overview", |
| 224 | @ref overview_windowsizing "Window sizing overview" |
| 225 | */ |
| 226 | class wxWindow : public wxEvtHandler |
| 227 | { |
| 228 | public: |
| 229 | /** |
| 230 | Default constructor |
| 231 | */ |
| 232 | wxWindow(); |
| 233 | |
| 234 | /** |
| 235 | Constructs a window, which can be a child of a frame, dialog or any other |
| 236 | non-control window. |
| 237 | |
| 238 | @param parent |
| 239 | Pointer to a parent window. |
| 240 | @param id |
| 241 | Window identifier. If wxID_ANY, will automatically create an identifier. |
| 242 | @param pos |
| 243 | Window position. wxDefaultPosition indicates that wxWidgets |
| 244 | should generate a default position for the window. |
| 245 | If using the wxWindow class directly, supply an actual position. |
| 246 | @param size |
| 247 | Window size. wxDefaultSize indicates that wxWidgets should generate |
| 248 | a default size for the window. If no suitable size can be found, the |
| 249 | window will be sized to 20x20 pixels so that the window is visible but |
| 250 | obviously not correctly sized. |
| 251 | @param style |
| 252 | Window style. For generic window styles, please see wxWindow. |
| 253 | @param name |
| 254 | Window name. |
| 255 | */ |
| 256 | wxWindow(wxWindow* parent, wxWindowID id, |
| 257 | const wxPoint& pos = wxDefaultPosition, |
| 258 | const wxSize& size = wxDefaultSize, |
| 259 | long style = 0, |
| 260 | const wxString& name = wxPanelNameStr); |
| 261 | |
| 262 | /** |
| 263 | Destructor. |
| 264 | |
| 265 | Deletes all sub-windows, then deletes itself. Instead of using |
| 266 | the @b delete operator explicitly, you should normally use Destroy() |
| 267 | so that wxWidgets can delete a window only when it is safe to do so, in idle time. |
| 268 | |
| 269 | @see @ref overview_windowdeletion "Window Deletion Overview", |
| 270 | Destroy(), wxCloseEvent |
| 271 | */ |
| 272 | virtual ~wxWindow(); |
| 273 | |
| 274 | /** |
| 275 | This method may be overridden in the derived classes to return @false to |
| 276 | indicate that this control doesn't accept input at all (i.e. behaves like |
| 277 | e.g. wxStaticText) and so doesn't need focus. |
| 278 | |
| 279 | @see AcceptsFocusFromKeyboard() |
| 280 | */ |
| 281 | virtual bool AcceptsFocus() const; |
| 282 | |
| 283 | /** |
| 284 | This method may be overridden in the derived classes to return @false to |
| 285 | indicate that while this control can, in principle, have focus if the user |
| 286 | clicks it with the mouse, it shouldn't be included in the TAB traversal chain |
| 287 | when using the keyboard. |
| 288 | */ |
| 289 | virtual bool AcceptsFocusFromKeyboard() const; |
| 290 | |
| 291 | /** |
| 292 | Overridden to indicate wehter this window or one of its children accepts |
| 293 | focus. Usually it's the same as AcceptsFocus() but is overridden for |
| 294 | container windows. |
| 295 | */ |
| 296 | virtual bool AcceptsFocusRecursively() const; |
| 297 | |
| 298 | /** |
| 299 | Adds a child window. This is called automatically by window creation |
| 300 | functions so should not be required by the application programmer. |
| 301 | Notice that this function is mostly internal to wxWidgets and shouldn't be |
| 302 | called by the user code. |
| 303 | |
| 304 | @param child |
| 305 | Child window to add. |
| 306 | */ |
| 307 | virtual void AddChild(wxWindow* child); |
| 308 | |
| 309 | /** |
| 310 | Call this function to force one or both scrollbars to be always shown, even if |
| 311 | the window is big enough to show its entire contents without scrolling. |
| 312 | |
| 313 | @since 2.9.0 |
| 314 | |
| 315 | @param hflag |
| 316 | Whether the horizontal scroll bar should always be visible. |
| 317 | @param vflag |
| 318 | Whether the vertical scroll bar should always be visible. |
| 319 | |
| 320 | @remarks This function is currently only implemented under Mac/Carbon. |
| 321 | */ |
| 322 | virtual void AlwaysShowScrollbars(bool hflag = true, bool vflag = true); |
| 323 | |
| 324 | /** |
| 325 | Sets the cached best size value. |
| 326 | */ |
| 327 | void CacheBestSize(const wxSize& size) const; |
| 328 | |
| 329 | /** |
| 330 | Returns @true if the system supports transparent windows and calling |
| 331 | SetTransparent() may succeed. If this function returns @false, transparent |
| 332 | windows are definitely not supported by the current system. |
| 333 | */ |
| 334 | virtual bool CanSetTransparent(); |
| 335 | |
| 336 | /** |
| 337 | Directs all mouse input to this window. |
| 338 | Call ReleaseMouse() to release the capture. |
| 339 | |
| 340 | Note that wxWidgets maintains the stack of windows having captured the mouse |
| 341 | and when the mouse is released the capture returns to the window which had had |
| 342 | captured it previously and it is only really released if there were no previous |
| 343 | window. In particular, this means that you must release the mouse as many times |
| 344 | as you capture it, unless the window receives the wxMouseCaptureLostEvent event. |
| 345 | |
| 346 | Any application which captures the mouse in the beginning of some operation |
| 347 | must handle wxMouseCaptureLostEvent and cancel this operation when it receives |
| 348 | the event. The event handler must not recapture mouse. |
| 349 | |
| 350 | @see ReleaseMouse(), wxMouseCaptureLostEvent |
| 351 | */ |
| 352 | void CaptureMouse(); |
| 353 | |
| 354 | /** |
| 355 | A synonym for Centre(). |
| 356 | */ |
| 357 | void Center(int dir = wxBOTH); |
| 358 | |
| 359 | /** |
| 360 | A synonym for CentreOnParent(). |
| 361 | */ |
| 362 | void CenterOnParent(int dir = wxBOTH); |
| 363 | |
| 364 | /** |
| 365 | Centres the window. |
| 366 | |
| 367 | @param direction |
| 368 | Specifies the direction for the centering. May be wxHORIZONTAL, wxVERTICAL |
| 369 | or wxBOTH. It may also include wxCENTRE_ON_SCREEN flag |
| 370 | if you want to center the window on the entire screen and not on its |
| 371 | parent window. |
| 372 | |
| 373 | @remarks If the window is a top level one (i.e. doesn't have a parent), |
| 374 | it will be centered relative to the screen anyhow. |
| 375 | |
| 376 | @see Center() |
| 377 | */ |
| 378 | void Centre(int direction = wxBOTH); |
| 379 | |
| 380 | /** |
| 381 | Centres the window on its parent. This is a more readable synonym for Centre(). |
| 382 | |
| 383 | @param direction |
| 384 | Specifies the direction for the centering. May be wxHORIZONTAL, wxVERTICAL |
| 385 | or wxBOTH. |
| 386 | |
| 387 | @remarks This methods provides for a way to center top level windows over |
| 388 | their parents instead of the entire screen. If there |
| 389 | is no parent or if the window is not a top level |
| 390 | window, then behaviour is the same as Centre(). |
| 391 | |
| 392 | @see wxTopLevelWindow::CentreOnScreen |
| 393 | */ |
| 394 | void CentreOnParent(int direction = wxBOTH); |
| 395 | |
| 396 | /** |
| 397 | Clears the window by filling it with the current background colour. Does not |
| 398 | cause an erase background event to be generated. |
| 399 | */ |
| 400 | virtual void ClearBackground(); |
| 401 | |
| 402 | /** |
| 403 | Converts to screen coordinates from coordinates relative to this window. |
| 404 | |
| 405 | @param x |
| 406 | A pointer to a integer value for the x coordinate. Pass the client |
| 407 | coordinate in, and a screen coordinate will be passed out. |
| 408 | @param y |
| 409 | A pointer to a integer value for the y coordinate. Pass the client |
| 410 | coordinate in, and a screen coordinate will be passed out. |
| 411 | |
| 412 | @beginWxPythonOnly |
| 413 | In place of a single overloaded method name, wxPython implements the following methods: |
| 414 | - ClientToScreen(point): Accepts and returns a wxPoint |
| 415 | - ClientToScreenXY(x, y): Returns a 2-tuple, (x, y) |
| 416 | @endWxPythonOnly |
| 417 | */ |
| 418 | void ClientToScreen(int* x, int* y) const; |
| 419 | |
| 420 | /** |
| 421 | Converts to screen coordinates from coordinates relative to this window. |
| 422 | |
| 423 | @param pt |
| 424 | The client position for the second form of the function. |
| 425 | */ |
| 426 | wxPoint ClientToScreen(const wxPoint& pt) const; |
| 427 | |
| 428 | /** |
| 429 | Converts client area size @a size to corresponding window size. |
| 430 | |
| 431 | In other words, the returned value is what would GetSize() return if this |
| 432 | window had client area of given size. Components with wxDefaultCoord |
| 433 | value are left unchanged. Note that the conversion is not always |
| 434 | exact, it assumes that non-client area doesn't change and so doesn't |
| 435 | take into account things like menu bar (un)wrapping or (dis)appearance |
| 436 | of the scrollbars. |
| 437 | |
| 438 | @since 2.8.8 |
| 439 | |
| 440 | @see WindowToClientSize() |
| 441 | */ |
| 442 | virtual wxSize ClientToWindowSize(const wxSize& size) const; |
| 443 | |
| 444 | /** |
| 445 | Converts window size @a size to corresponding client area size |
| 446 | In other words, the returned value is what would GetClientSize() return if |
| 447 | this window had given window size. Components with wxDefaultCoord value |
| 448 | are left unchanged. |
| 449 | |
| 450 | Note that the conversion is not always exact, it assumes that |
| 451 | non-client area doesn't change and so doesn't take into account things |
| 452 | like menu bar (un)wrapping or (dis)appearance of the scrollbars. |
| 453 | |
| 454 | @since 2.8.8 |
| 455 | |
| 456 | @see ClientToWindowSize() |
| 457 | */ |
| 458 | virtual wxSize WindowToClientSize(const wxSize& size) const; |
| 459 | |
| 460 | /** |
| 461 | This function simply generates a wxCloseEvent whose handler usually tries |
| 462 | to close the window. It doesn't close the window itself, however. |
| 463 | |
| 464 | @param force |
| 465 | @false if the window's close handler should be able to veto the destruction |
| 466 | of this window, @true if it cannot. |
| 467 | |
| 468 | @remarks Close calls the close handler for the window, providing an |
| 469 | opportunity for the window to choose whether to destroy |
| 470 | the window. Usually it is only used with the top level |
| 471 | windows (wxFrame and wxDialog classes) as the others |
| 472 | are not supposed to have any special OnClose() logic. |
| 473 | The close handler should check whether the window is being deleted |
| 474 | forcibly, using wxCloseEvent::CanVeto, in which case it should |
| 475 | destroy the window using wxWindow::Destroy. |
| 476 | Note that calling Close does not guarantee that the window will |
| 477 | be destroyed; but it provides a way to simulate a manual close |
| 478 | of a window, which may or may not be implemented by destroying |
| 479 | the window. The default implementation of wxDialog::OnCloseWindow |
| 480 | does not necessarily delete the dialog, since it will simply |
| 481 | simulate an wxID_CANCEL event which is handled by the appropriate |
| 482 | button event handler and may do anything at all. |
| 483 | To guarantee that the window will be destroyed, call |
| 484 | wxWindow::Destroy instead |
| 485 | |
| 486 | @see @ref overview_windowdeletion "Window Deletion Overview", |
| 487 | Destroy(), wxCloseEvent |
| 488 | */ |
| 489 | bool Close(bool force = false); |
| 490 | |
| 491 | //@{ |
| 492 | /** |
| 493 | Converts a point or size from dialog units to pixels. |
| 494 | |
| 495 | For the x dimension, the dialog units are multiplied by the average character |
| 496 | width and then divided by 4. |
| 497 | For the y dimension, the dialog units are multiplied by the average character |
| 498 | height and then divided by 8. |
| 499 | |
| 500 | @remarks Dialog units are used for maintaining a dialog's proportions |
| 501 | even if the font changes. |
| 502 | You can also use these functions programmatically. |
| 503 | A convenience macro is defined: |
| 504 | @code |
| 505 | #define wxDLG_UNIT(parent, pt) parent->ConvertDialogToPixels(pt) |
| 506 | @endcode |
| 507 | |
| 508 | @see ConvertPixelsToDialog() |
| 509 | */ |
| 510 | wxPoint ConvertDialogToPixels(const wxPoint& pt); |
| 511 | wxSize ConvertDialogToPixels(const wxSize& sz); |
| 512 | //@} |
| 513 | |
| 514 | //@{ |
| 515 | /** |
| 516 | Converts a point or size from pixels to dialog units. |
| 517 | |
| 518 | For the x dimension, the pixels are multiplied by 4 and then divided by the |
| 519 | average character width. |
| 520 | For the y dimension, the pixels are multiplied by 8 and then divided by the |
| 521 | average character height. |
| 522 | |
| 523 | @remarks Dialog units are used for maintaining a dialog's proportions |
| 524 | even if the font changes. |
| 525 | |
| 526 | @see ConvertDialogToPixels() |
| 527 | */ |
| 528 | wxPoint ConvertPixelsToDialog(const wxPoint& pt); |
| 529 | wxSize ConvertPixelsToDialog(const wxSize& sz); |
| 530 | //@} |
| 531 | |
| 532 | /** |
| 533 | Destroys the window safely. Use this function instead of the delete operator, |
| 534 | since different window classes can be destroyed differently. Frames and dialogs |
| 535 | are not destroyed immediately when this function is called -- they are added |
| 536 | to a list of windows to be deleted on idle time, when all the window's events |
| 537 | have been processed. This prevents problems with events being sent to |
| 538 | non-existent windows. |
| 539 | |
| 540 | @return @true if the window has either been successfully deleted, or it |
| 541 | has been added to the list of windows pending real deletion. |
| 542 | */ |
| 543 | virtual bool Destroy(); |
| 544 | |
| 545 | /** |
| 546 | Destroys all children of a window. Called automatically by the destructor. |
| 547 | */ |
| 548 | bool DestroyChildren(); |
| 549 | |
| 550 | /** |
| 551 | Returns true if this window is in process of being destroyed. |
| 552 | |
| 553 | The top level windows are not deleted immediately but are rather |
| 554 | scheduled for later destruction to give them time to process any |
| 555 | pending messages, see Destroy() description. |
| 556 | |
| 557 | This function returns @true if this window, or one of its parent |
| 558 | windows, is scheduled for destruction and can be useful to avoid |
| 559 | manipulating it as it's usually useless to do something with a window |
| 560 | which is on the point of disappearing anyhow. |
| 561 | */ |
| 562 | bool IsBeingDeleted() const; |
| 563 | |
| 564 | /** |
| 565 | Disables the window. Same as @ref Enable() Enable(@false). |
| 566 | |
| 567 | @return Returns @true if the window has been disabled, @false if it had |
| 568 | been already disabled before the call to this function. |
| 569 | */ |
| 570 | bool Disable(); |
| 571 | |
| 572 | /** |
| 573 | Does the window-specific updating after processing the update event. |
| 574 | This function is called by UpdateWindowUI() in order to check return |
| 575 | values in the wxUpdateUIEvent and act appropriately. |
| 576 | For example, to allow frame and dialog title updating, wxWidgets |
| 577 | implements this function as follows: |
| 578 | |
| 579 | @code |
| 580 | // do the window-specific processing after processing the update event |
| 581 | void wxTopLevelWindowBase::DoUpdateWindowUI(wxUpdateUIEvent& event) |
| 582 | { |
| 583 | if ( event.GetSetEnabled() ) |
| 584 | Enable(event.GetEnabled()); |
| 585 | |
| 586 | if ( event.GetSetText() ) |
| 587 | { |
| 588 | if ( event.GetText() != GetTitle() ) |
| 589 | SetTitle(event.GetText()); |
| 590 | } |
| 591 | } |
| 592 | @endcode |
| 593 | */ |
| 594 | virtual void DoUpdateWindowUI(wxUpdateUIEvent& event); |
| 595 | |
| 596 | /** |
| 597 | Enables or disables eligibility for drop file events (OnDropFiles). |
| 598 | |
| 599 | @param accept |
| 600 | If @true, the window is eligible for drop file events. |
| 601 | If @false, the window will not accept drop file events. |
| 602 | |
| 603 | @remarks Windows only until version 2.8.9, available on all platforms |
| 604 | since 2.8.10. Cannot be used together with SetDropTarget() on |
| 605 | non-Windows platforms. |
| 606 | |
| 607 | @see SetDropTarget() |
| 608 | */ |
| 609 | virtual void DragAcceptFiles(bool accept); |
| 610 | |
| 611 | /** |
| 612 | Enable or disable the window for user input. Note that when a parent window is |
| 613 | disabled, all of its children are disabled as well and they are reenabled again |
| 614 | when the parent is. |
| 615 | |
| 616 | @param enable |
| 617 | If @true, enables the window for input. If @false, disables the window. |
| 618 | |
| 619 | @return Returns @true if the window has been enabled or disabled, @false |
| 620 | if nothing was done, i.e. if the window had already |
| 621 | been in the specified state. |
| 622 | |
| 623 | @see IsEnabled(), Disable(), wxRadioBox::Enable |
| 624 | */ |
| 625 | virtual bool Enable(bool enable = true); |
| 626 | |
| 627 | /** |
| 628 | Finds the window or control which currently has the keyboard focus. |
| 629 | |
| 630 | @remarks Note that this is a static function, so it can be called without |
| 631 | needing a wxWindow pointer. |
| 632 | |
| 633 | @see SetFocus(), HasFocus() |
| 634 | */ |
| 635 | static wxWindow* FindFocus(); |
| 636 | |
| 637 | /** |
| 638 | Find a child of this window, by @a id. |
| 639 | May return @a this if it matches itself. |
| 640 | */ |
| 641 | wxWindow* FindWindow(long id) const; |
| 642 | |
| 643 | /** |
| 644 | Find a child of this window, by name. |
| 645 | May return @a this if it matches itself. |
| 646 | */ |
| 647 | wxWindow* FindWindow(const wxString& name) const; |
| 648 | |
| 649 | /** |
| 650 | Find the first window with the given @e id. |
| 651 | |
| 652 | If @a parent is @NULL, the search will start from all top-level frames |
| 653 | and dialog boxes; if non-@NULL, the search will be limited to the given |
| 654 | window hierarchy. |
| 655 | The search is recursive in both cases. |
| 656 | |
| 657 | @see FindWindow() |
| 658 | */ |
| 659 | static wxWindow* FindWindowById(long id, wxWindow* parent = NULL); |
| 660 | |
| 661 | /** |
| 662 | Find a window by its label. |
| 663 | |
| 664 | Depending on the type of window, the label may be a window title |
| 665 | or panel item label. If @a parent is @NULL, the search will start from all |
| 666 | top-level frames and dialog boxes; if non-@NULL, the search will be |
| 667 | limited to the given window hierarchy. |
| 668 | The search is recursive in both cases. |
| 669 | |
| 670 | @see FindWindow() |
| 671 | */ |
| 672 | static wxWindow* FindWindowByLabel(const wxString& label, |
| 673 | wxWindow* parent = NULL); |
| 674 | |
| 675 | /** |
| 676 | Find a window by its name (as given in a window constructor or @b Create |
| 677 | function call). |
| 678 | |
| 679 | If @a parent is @NULL, the search will start from all top-level frames |
| 680 | and dialog boxes; if non-@NULL, the search will be limited to the given |
| 681 | window hierarchy. |
| 682 | |
| 683 | The search is recursive in both cases. If no window with such name is found, |
| 684 | FindWindowByLabel() is called. |
| 685 | |
| 686 | @see FindWindow() |
| 687 | */ |
| 688 | static wxWindow* FindWindowByName(const wxString& name, |
| 689 | wxWindow* parent = NULL); |
| 690 | |
| 691 | /** |
| 692 | Sizes the window so that it fits around its subwindows. |
| 693 | |
| 694 | This function won't do anything if there are no subwindows and will only really |
| 695 | work correctly if sizers are used for the subwindows layout. |
| 696 | |
| 697 | Also, if the window has exactly one subwindow it is better (faster and the result |
| 698 | is more precise as Fit() adds some margin to account for fuzziness of its calculations) |
| 699 | to call: |
| 700 | |
| 701 | @code |
| 702 | window->SetClientSize(child->GetSize()); |
| 703 | @endcode |
| 704 | |
| 705 | instead of calling Fit(). |
| 706 | |
| 707 | @see @ref overview_windowsizing |
| 708 | */ |
| 709 | virtual void Fit(); |
| 710 | |
| 711 | /** |
| 712 | Similar to Fit(), but sizes the interior (virtual) size of a window. |
| 713 | |
| 714 | Mainly useful with scrolled windows to reset scrollbars after sizing |
| 715 | changes that do not trigger a size event, and/or scrolled windows without |
| 716 | an interior sizer. This function similarly won't do anything if there are |
| 717 | no subwindows. |
| 718 | */ |
| 719 | virtual void FitInside(); |
| 720 | |
| 721 | /** |
| 722 | Freezes the window or, in other words, prevents any updates from taking |
| 723 | place on screen, the window is not redrawn at all. |
| 724 | |
| 725 | Thaw() must be called to reenable window redrawing. Calls to these two |
| 726 | functions may be nested but to ensure that the window is properly |
| 727 | repainted again, you must thaw it exactly as many times as you froze it. |
| 728 | |
| 729 | If the window has any children, they are recursively frozen too. |
| 730 | |
| 731 | This method is useful for visual appearance optimization (for example, |
| 732 | it is a good idea to use it before doing many large text insertions in |
| 733 | a row into a wxTextCtrl under wxGTK) but is not implemented on all |
| 734 | platforms nor for all controls so it is mostly just a hint to wxWidgets |
| 735 | and not a mandatory directive. |
| 736 | |
| 737 | @see wxWindowUpdateLocker, Thaw(), IsFrozen() |
| 738 | */ |
| 739 | void Freeze(); |
| 740 | |
| 741 | /** |
| 742 | Gets the accelerator table for this window. See wxAcceleratorTable. |
| 743 | */ |
| 744 | wxAcceleratorTable* GetAcceleratorTable(); |
| 745 | |
| 746 | /** |
| 747 | Returns the accessible object for this window, if any. |
| 748 | See also wxAccessible. |
| 749 | */ |
| 750 | wxAccessible* GetAccessible(); |
| 751 | |
| 752 | /** |
| 753 | Returns the background colour of the window. |
| 754 | |
| 755 | @see SetBackgroundColour(), SetForegroundColour(), GetForegroundColour() |
| 756 | */ |
| 757 | wxColour GetBackgroundColour() const; |
| 758 | |
| 759 | /** |
| 760 | Returns the background style of the window. |
| 761 | The background style can be one of the wxBackgroundStyle. |
| 762 | |
| 763 | @see SetBackgroundColour(), GetForegroundColour(), |
| 764 | SetBackgroundStyle(), SetTransparent() |
| 765 | */ |
| 766 | virtual wxBackgroundStyle GetBackgroundStyle() const; |
| 767 | |
| 768 | /** |
| 769 | This functions returns the best acceptable minimal size for the window. |
| 770 | |
| 771 | For example, for a static control, it will be the minimal size such that the |
| 772 | control label is not truncated. For windows containing subwindows (typically |
| 773 | wxPanel), the size returned by this function will be the same as the size |
| 774 | the window would have had after calling Fit(). |
| 775 | */ |
| 776 | wxSize GetBestSize() const; |
| 777 | |
| 778 | /** |
| 779 | Returns the currently captured window. |
| 780 | |
| 781 | @see HasCapture(), CaptureMouse(), ReleaseMouse(), |
| 782 | wxMouseCaptureLostEvent, wxMouseCaptureChangedEvent |
| 783 | */ |
| 784 | static wxWindow* GetCapture(); |
| 785 | |
| 786 | /** |
| 787 | Returns the caret() associated with the window. |
| 788 | */ |
| 789 | wxCaret* GetCaret() const; |
| 790 | |
| 791 | /** |
| 792 | Returns the character height for this window. |
| 793 | */ |
| 794 | virtual int GetCharHeight() const; |
| 795 | |
| 796 | /** |
| 797 | Returns the average character width for this window. |
| 798 | */ |
| 799 | virtual int GetCharWidth() const; |
| 800 | |
| 801 | //@{ |
| 802 | /** |
| 803 | Returns a reference to the list of the window's children. @c wxWindowList |
| 804 | is a type-safe wxList-like class whose elements are of type @c wxWindow*. |
| 805 | */ |
| 806 | wxWindowList& GetChildren(); |
| 807 | const wxWindowList& GetChildren() const; |
| 808 | //@} |
| 809 | |
| 810 | /** |
| 811 | Returns the default font and colours which are used by the control. |
| 812 | |
| 813 | This is useful if you want to use the same font or colour in your own control |
| 814 | as in a standard control -- which is a much better idea than hard coding specific |
| 815 | colours or fonts which might look completely out of place on the users |
| 816 | system, especially if it uses themes. |
| 817 | |
| 818 | The @a variant parameter is only relevant under Mac currently and is |
| 819 | ignore under other platforms. Under Mac, it will change the size of the |
| 820 | returned font. See SetWindowVariant() for more about this. |
| 821 | |
| 822 | This static method is "overridden" in many derived classes and so calling, |
| 823 | for example, wxButton::GetClassDefaultAttributes() will typically |
| 824 | return the values appropriate for a button which will be normally different |
| 825 | from those returned by, say, wxListCtrl::GetClassDefaultAttributes(). |
| 826 | |
| 827 | The @c wxVisualAttributes structure has at least the fields |
| 828 | @c font, @c colFg and @c colBg. All of them may be invalid |
| 829 | if it was not possible to determine the default control appearance or, |
| 830 | especially for the background colour, if the field doesn't make sense as is |
| 831 | the case for @c colBg for the controls with themed background. |
| 832 | |
| 833 | @see InheritAttributes() |
| 834 | */ |
| 835 | static wxVisualAttributes GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL); |
| 836 | |
| 837 | //@{ |
| 838 | /** |
| 839 | Returns the size of the window 'client area' in pixels. |
| 840 | |
| 841 | The client area is the area which may be drawn on by the programmer, |
| 842 | excluding title bar, border, scrollbars, etc. |
| 843 | Note that if this window is a top-level one and it is currently minimized, the |
| 844 | return size is empty (both width and height are 0). |
| 845 | |
| 846 | @see GetSize(), GetVirtualSize() |
| 847 | */ |
| 848 | void GetClientSize(int* width, int* height) const; |
| 849 | wxSize GetClientSize() const; |
| 850 | //@} |
| 851 | |
| 852 | /** |
| 853 | Returns a pointer to the window's layout constraints, or @NULL if there are none. |
| 854 | */ |
| 855 | wxLayoutConstraints* GetConstraints() const; |
| 856 | |
| 857 | /** |
| 858 | Return the sizer that this window is a member of, if any, otherwise @NULL. |
| 859 | */ |
| 860 | wxSizer* GetContainingSizer() const; |
| 861 | |
| 862 | /** |
| 863 | Return the cursor associated with this window. |
| 864 | |
| 865 | @see SetCursor() |
| 866 | */ |
| 867 | const wxCursor& GetCursor() const; |
| 868 | |
| 869 | /** |
| 870 | Currently this is the same as calling |
| 871 | wxWindow::GetClassDefaultAttributes(wxWindow::GetWindowVariant()). |
| 872 | |
| 873 | One advantage of using this function compared to the static version is that |
| 874 | the call is automatically dispatched to the correct class (as usual with |
| 875 | virtual functions) and you don't have to specify the class name explicitly. |
| 876 | |
| 877 | The other one is that in the future this function could return different |
| 878 | results, for example it might return a different font for an "Ok" button |
| 879 | than for a generic button if the users GUI is configured to show such buttons |
| 880 | in bold font. Of course, the down side is that it is impossible to call this |
| 881 | function without actually having an object to apply it to whereas the static |
| 882 | version can be used without having to create an object first. |
| 883 | */ |
| 884 | virtual wxVisualAttributes GetDefaultAttributes() const; |
| 885 | |
| 886 | /** |
| 887 | Returns the associated drop target, which may be @NULL. |
| 888 | |
| 889 | @see SetDropTarget(), @ref overview_dnd |
| 890 | */ |
| 891 | virtual wxDropTarget* GetDropTarget() const; |
| 892 | |
| 893 | /** |
| 894 | Merges the window's best size into the min size and returns the result. |
| 895 | This is the value used by sizers to determine the appropriate |
| 896 | ammount of space to allocate for the widget. |
| 897 | |
| 898 | @see GetBestSize(), SetInitialSize(), @ref overview_windowsizing |
| 899 | */ |
| 900 | wxSize GetEffectiveMinSize() const; |
| 901 | |
| 902 | /** |
| 903 | Returns the event handler for this window. |
| 904 | By default, the window is its own event handler. |
| 905 | |
| 906 | @see SetEventHandler(), PushEventHandler(), |
| 907 | PopEventHandler(), wxEvtHandler::ProcessEvent, wxEvtHandler |
| 908 | */ |
| 909 | wxEvtHandler* GetEventHandler() const; |
| 910 | |
| 911 | /** |
| 912 | Returns the extra style bits for the window. |
| 913 | */ |
| 914 | long GetExtraStyle() const; |
| 915 | |
| 916 | /** |
| 917 | Returns the font for this window. |
| 918 | |
| 919 | @see SetFont() |
| 920 | */ |
| 921 | wxFont GetFont() const; |
| 922 | |
| 923 | /** |
| 924 | Returns the foreground colour of the window. |
| 925 | |
| 926 | @remarks The interpretation of foreground colour is open to |
| 927 | interpretation according to the window class; it may be |
| 928 | the text colour or other colour, or it may not be used at all. |
| 929 | |
| 930 | @see SetForegroundColour(), SetBackgroundColour(), |
| 931 | GetBackgroundColour() |
| 932 | */ |
| 933 | wxColour GetForegroundColour() const; |
| 934 | |
| 935 | /** |
| 936 | Returns the grandparent of a window, or @NULL if there isn't one. |
| 937 | */ |
| 938 | wxWindow* GetGrandParent() const; |
| 939 | |
| 940 | /** |
| 941 | Returns the platform-specific handle of the physical window. |
| 942 | Cast it to an appropriate handle, such as @b HWND for Windows, |
| 943 | @b Widget for Motif, @b GtkWidget for GTK or @b WinHandle for PalmOS. |
| 944 | */ |
| 945 | virtual WXWidget GetHandle() const; |
| 946 | |
| 947 | /** |
| 948 | Gets the help text to be used as context-sensitive help for this window. |
| 949 | Note that the text is actually stored by the current wxHelpProvider |
| 950 | implementation, and not in the window object itself. |
| 951 | |
| 952 | @see SetHelpText(), GetHelpTextAtPoint(), wxHelpProvider |
| 953 | */ |
| 954 | wxString GetHelpText() const; |
| 955 | |
| 956 | /** |
| 957 | Gets the help text to be used as context-sensitive help for this window. |
| 958 | This method should be overridden if the help message depends on the position |
| 959 | inside the window, otherwise GetHelpText() can be used. |
| 960 | |
| 961 | @param point |
| 962 | Coordinates of the mouse at the moment of help event emission. |
| 963 | @param origin |
| 964 | Help event origin, see also wxHelpEvent::GetOrigin. |
| 965 | */ |
| 966 | virtual wxString GetHelpTextAtPoint(const wxPoint& point, |
| 967 | wxHelpEvent::Origin origin) const; |
| 968 | |
| 969 | /** |
| 970 | Returns the identifier of the window. |
| 971 | |
| 972 | @remarks Each window has an integer identifier. If the application |
| 973 | has not provided one (or the default wxID_ANY) an unique |
| 974 | identifier with a negative value will be generated. |
| 975 | |
| 976 | @see SetId(), @ref overview_windowids |
| 977 | */ |
| 978 | wxWindowID GetId() const; |
| 979 | |
| 980 | /** |
| 981 | Generic way of getting a label from any window, for |
| 982 | identification purposes. |
| 983 | |
| 984 | @remarks The interpretation of this function differs from class to class. |
| 985 | For frames and dialogs, the value returned is the |
| 986 | title. For buttons or static text controls, it is the |
| 987 | button text. This function can be useful for |
| 988 | meta-programs (such as testing tools or special-needs |
| 989 | access programs) which need to identify windows by name. |
| 990 | */ |
| 991 | virtual wxString GetLabel() const; |
| 992 | |
| 993 | /** |
| 994 | Returns the maximum size of window's client area. |
| 995 | |
| 996 | This is an indication to the sizer layout mechanism that this is the maximum |
| 997 | possible size as well as the upper bound on window's size settable using |
| 998 | SetClientSize(). |
| 999 | |
| 1000 | @see GetMaxSize() |
| 1001 | */ |
| 1002 | virtual wxSize GetMaxClientSize() const; |
| 1003 | |
| 1004 | /** |
| 1005 | Returns the maximum size of the window. |
| 1006 | |
| 1007 | This is an indication to the sizer layout mechanism that this is the maximum |
| 1008 | possible size as well as the upper bound on window's size settable using SetSize(). |
| 1009 | |
| 1010 | @see GetMaxClientSize() |
| 1011 | */ |
| 1012 | virtual wxSize GetMaxSize() const; |
| 1013 | |
| 1014 | /** |
| 1015 | Returns the minimum size of window's client area, an indication to the sizer |
| 1016 | layout mechanism that this is the minimum required size of its client area. |
| 1017 | |
| 1018 | It normally just returns the value set by SetMinClientSize(), but it can be |
| 1019 | overridden to do the calculation on demand. |
| 1020 | |
| 1021 | @see GetMinSize() |
| 1022 | */ |
| 1023 | virtual wxSize GetMinClientSize() const; |
| 1024 | |
| 1025 | /** |
| 1026 | Returns the minimum size of the window, an indication to the sizer layout |
| 1027 | mechanism that this is the minimum required size. |
| 1028 | |
| 1029 | This method normally just returns the value set by SetMinSize(), but it |
| 1030 | can be overridden to do the calculation on demand. |
| 1031 | |
| 1032 | @see GetMinClientSize() |
| 1033 | */ |
| 1034 | virtual wxSize GetMinSize() const; |
| 1035 | |
| 1036 | /** |
| 1037 | Returns the window's name. |
| 1038 | |
| 1039 | @remarks This name is not guaranteed to be unique; it is up to the |
| 1040 | programmer to supply an appropriate name in the window |
| 1041 | constructor or via SetName(). |
| 1042 | |
| 1043 | @see SetName() |
| 1044 | */ |
| 1045 | virtual wxString GetName() const; |
| 1046 | |
| 1047 | /** |
| 1048 | Returns the next window after this one among the parent children or @NULL |
| 1049 | if this window is the last child. |
| 1050 | |
| 1051 | @since 2.8.8 |
| 1052 | |
| 1053 | @see GetPrevSibling() |
| 1054 | */ |
| 1055 | wxWindow* GetNextSibling() const; |
| 1056 | |
| 1057 | /** |
| 1058 | Returns the parent of the window, or @NULL if there is no parent. |
| 1059 | */ |
| 1060 | wxWindow* GetParent() const; |
| 1061 | |
| 1062 | /** |
| 1063 | This function shows a popup menu at the given position in this window and |
| 1064 | returns the selected id. It can be more convenient than the general purpose |
| 1065 | PopupMenu() function for simple menus proposing a choice in a list of |
| 1066 | strings to the user. |
| 1067 | |
| 1068 | @param menu |
| 1069 | The menu to show |
| 1070 | @param pos |
| 1071 | The position at which to show the menu in client coordinates |
| 1072 | |
| 1073 | @return The selected menu item id or wxID_NONE if none selected or an |
| 1074 | error occurred. |
| 1075 | */ |
| 1076 | int GetPopupMenuSelectionFromUser(wxMenu& menu, const wxPoint& pos); |
| 1077 | |
| 1078 | /** |
| 1079 | See the GetPopupMenuSelectionFromUser(wxMenu&, const wxPoint&) overload. |
| 1080 | This overload differs only because it takes two integers for the |
| 1081 | menu position instead of a wxPoint. |
| 1082 | */ |
| 1083 | int GetPopupMenuSelectionFromUser(wxMenu& menu, int x, int y); |
| 1084 | |
| 1085 | /** |
| 1086 | This gets the position of the window in pixels, relative to the parent window |
| 1087 | for the child windows or relative to the display origin for the top level windows. |
| 1088 | |
| 1089 | @param x |
| 1090 | Receives the x position of the window if non-@NULL. |
| 1091 | @param y |
| 1092 | Receives the y position of the window if non-@NULL. |
| 1093 | |
| 1094 | @see GetScreenPosition() |
| 1095 | */ |
| 1096 | void GetPosition(int* x, int* y) const; |
| 1097 | |
| 1098 | /** |
| 1099 | This gets the position of the window in pixels, relative to the parent window |
| 1100 | for the child windows or relative to the display origin for the top level windows. |
| 1101 | |
| 1102 | @see GetScreenPosition() |
| 1103 | */ |
| 1104 | wxPoint GetPosition() const; |
| 1105 | |
| 1106 | /** |
| 1107 | Returns the previous window before this one among the parent children or @c |
| 1108 | @NULL if this window is the first child. |
| 1109 | |
| 1110 | @since 2.8.8 |
| 1111 | |
| 1112 | @see GetNextSibling() |
| 1113 | */ |
| 1114 | wxWindow* GetPrevSibling() const; |
| 1115 | |
| 1116 | /** |
| 1117 | Returns the position and size of the window as a wxRect object. |
| 1118 | |
| 1119 | @see GetScreenRect() |
| 1120 | */ |
| 1121 | wxRect GetRect() const; |
| 1122 | |
| 1123 | /** |
| 1124 | Returns the window position in screen coordinates, whether the window is a |
| 1125 | child window or a top level one. |
| 1126 | |
| 1127 | @param x |
| 1128 | Receives the x position of the window on the screen if non-@NULL. |
| 1129 | @param y |
| 1130 | Receives the y position of the window on the screen if non-@NULL. |
| 1131 | |
| 1132 | @see GetPosition() |
| 1133 | */ |
| 1134 | void GetScreenPosition(int* x, int* y) const; |
| 1135 | |
| 1136 | /** |
| 1137 | Returns the window position in screen coordinates, whether the window is a |
| 1138 | child window or a top level one. |
| 1139 | |
| 1140 | @see GetPosition() |
| 1141 | */ |
| 1142 | wxPoint GetScreenPosition() const; |
| 1143 | |
| 1144 | /** |
| 1145 | Returns the position and size of the window on the screen as a wxRect object. |
| 1146 | |
| 1147 | @see GetRect() |
| 1148 | */ |
| 1149 | wxRect GetScreenRect() const; |
| 1150 | |
| 1151 | /** |
| 1152 | Returns the built-in scrollbar position. |
| 1153 | |
| 1154 | @see See SetScrollbar() |
| 1155 | */ |
| 1156 | virtual int GetScrollPos(int orientation) const; |
| 1157 | |
| 1158 | /** |
| 1159 | Returns the built-in scrollbar range. |
| 1160 | |
| 1161 | @see SetScrollbar() |
| 1162 | */ |
| 1163 | virtual int GetScrollRange(int orientation) const; |
| 1164 | |
| 1165 | /** |
| 1166 | Returns the built-in scrollbar thumb size. |
| 1167 | |
| 1168 | @see SetScrollbar() |
| 1169 | */ |
| 1170 | virtual int GetScrollThumb(int orientation) const; |
| 1171 | |
| 1172 | /** |
| 1173 | Returns the size of the entire window in pixels, including title bar, border, |
| 1174 | scrollbars, etc. |
| 1175 | |
| 1176 | Note that if this window is a top-level one and it is currently minimized, the |
| 1177 | returned size is the restored window size, not the size of the window icon. |
| 1178 | |
| 1179 | @param width |
| 1180 | Receives the window width. |
| 1181 | @param height |
| 1182 | Receives the window height. |
| 1183 | |
| 1184 | @see GetClientSize(), GetVirtualSize() |
| 1185 | */ |
| 1186 | void GetSize(int* width, int* height) const; |
| 1187 | |
| 1188 | /** |
| 1189 | See the GetSize(int*,int*) overload for more info. |
| 1190 | */ |
| 1191 | wxSize GetSize() const; |
| 1192 | |
| 1193 | /** |
| 1194 | Return the sizer associated with the window by a previous call to |
| 1195 | SetSizer() or @NULL. |
| 1196 | */ |
| 1197 | wxSizer* GetSizer() const; |
| 1198 | |
| 1199 | /** |
| 1200 | Gets the dimensions of the string as it would be drawn on the |
| 1201 | window with the currently selected font. |
| 1202 | |
| 1203 | The text extent is returned in @a w and @a h pointers. |
| 1204 | |
| 1205 | @param string |
| 1206 | String whose extent is to be measured. |
| 1207 | @param w |
| 1208 | Return value for width. |
| 1209 | @param h |
| 1210 | Return value for height. |
| 1211 | @param descent |
| 1212 | Return value for descent (optional). |
| 1213 | @param externalLeading |
| 1214 | Return value for external leading (optional). |
| 1215 | @param font |
| 1216 | Font to use instead of the current window font (optional). |
| 1217 | */ |
| 1218 | virtual void GetTextExtent(const wxString& string, int* w, int* h, |
| 1219 | int* descent = NULL, |
| 1220 | int* externalLeading = NULL, |
| 1221 | const wxFont* font = NULL) const; |
| 1222 | |
| 1223 | /** |
| 1224 | Gets the dimensions of the string as it would be drawn on the |
| 1225 | window with the currently selected font. |
| 1226 | */ |
| 1227 | wxSize GetTextExtent(const wxString& string) const; |
| 1228 | |
| 1229 | /** |
| 1230 | Get the associated tooltip or @NULL if none. |
| 1231 | */ |
| 1232 | wxToolTip* GetToolTip() const; |
| 1233 | |
| 1234 | /** |
| 1235 | Returns the region specifying which parts of the window have been damaged. |
| 1236 | Should only be called within an wxPaintEvent handler. |
| 1237 | |
| 1238 | @see wxRegion, wxRegionIterator |
| 1239 | */ |
| 1240 | const wxRegion& GetUpdateRegion() const; |
| 1241 | |
| 1242 | /** |
| 1243 | Returns a pointer to the current validator for the window, or @NULL if |
| 1244 | there is none. |
| 1245 | */ |
| 1246 | virtual wxValidator* GetValidator(); |
| 1247 | |
| 1248 | //@{ |
| 1249 | /** |
| 1250 | This gets the virtual size of the window in pixels. |
| 1251 | By default it returns the client size of the window, but after a call to |
| 1252 | SetVirtualSize() it will return the size set with that method. |
| 1253 | */ |
| 1254 | wxSize GetVirtualSize() const; |
| 1255 | |
| 1256 | /** |
| 1257 | Like the other GetVirtualSize() overload but uses pointers instead. |
| 1258 | |
| 1259 | @param width |
| 1260 | Receives the window virtual width. |
| 1261 | @param height |
| 1262 | Receives the window virtual height. |
| 1263 | */ |
| 1264 | void GetVirtualSize(int* width, int* height) const; |
| 1265 | //@} |
| 1266 | |
| 1267 | /** |
| 1268 | Returns the size of the left/right and top/bottom borders of this window in x |
| 1269 | and y components of the result respectively. |
| 1270 | */ |
| 1271 | virtual wxSize GetWindowBorderSize() const; |
| 1272 | |
| 1273 | /** |
| 1274 | Gets the window style that was passed to the constructor or @b Create |
| 1275 | method. @b GetWindowStyle() is another name for the same function. |
| 1276 | */ |
| 1277 | virtual long GetWindowStyleFlag() const; |
| 1278 | |
| 1279 | /** |
| 1280 | Returns the value previously passed to SetWindowVariant(). |
| 1281 | */ |
| 1282 | wxWindowVariant GetWindowVariant() const; |
| 1283 | |
| 1284 | /** |
| 1285 | This function will generate the appropriate call to |
| 1286 | Navigate() if the key event is one normally used for |
| 1287 | keyboard navigation and return @true in this case. |
| 1288 | |
| 1289 | @return Returns @true if the key pressed was for navigation and was |
| 1290 | handled, @false otherwise. |
| 1291 | |
| 1292 | @see Navigate() |
| 1293 | */ |
| 1294 | bool HandleAsNavigationKey(const wxKeyEvent& event); |
| 1295 | |
| 1296 | /** |
| 1297 | Shorthand for: |
| 1298 | @code |
| 1299 | GetEventHandler()->SafelyProcessEvent(event); |
| 1300 | @endcode |
| 1301 | */ |
| 1302 | bool HandleWindowEvent(wxEvent& event) const; |
| 1303 | |
| 1304 | /** |
| 1305 | Returns @true if this window has the current mouse capture. |
| 1306 | |
| 1307 | @see CaptureMouse(), ReleaseMouse(), wxMouseCaptureLostEvent, |
| 1308 | wxMouseCaptureChangedEvent |
| 1309 | */ |
| 1310 | virtual bool HasCapture() const; |
| 1311 | |
| 1312 | /** |
| 1313 | Returns @true if the window has the given @a exFlag bit set in its |
| 1314 | extra styles. |
| 1315 | |
| 1316 | @see SetExtraStyle() |
| 1317 | */ |
| 1318 | bool HasExtraStyle(int exFlag) const; |
| 1319 | |
| 1320 | /** |
| 1321 | Returns @true if the window has the given @a flag bit set. |
| 1322 | */ |
| 1323 | bool HasFlag(int flag) const; |
| 1324 | |
| 1325 | /** |
| 1326 | Returns @true if the window (or in case of composite controls, its main |
| 1327 | child window) has focus. |
| 1328 | |
| 1329 | @see FindFocus() |
| 1330 | */ |
| 1331 | virtual bool HasFocus() const; |
| 1332 | |
| 1333 | /** |
| 1334 | This method should be overridden to return @true if this window has |
| 1335 | multiple pages. All standard class with multiple pages such as |
| 1336 | wxNotebook, wxListbook and wxTreebook already override it to return @true |
| 1337 | and user-defined classes with similar behaviour should do it as well to |
| 1338 | allow the library to handle such windows appropriately. |
| 1339 | */ |
| 1340 | virtual bool HasMultiplePages() const; |
| 1341 | |
| 1342 | /** |
| 1343 | Returns @true if this window has a scroll bar for this orientation. |
| 1344 | |
| 1345 | @param orient |
| 1346 | Orientation to check, either wxHORIZONTAL or wxVERTICAL. |
| 1347 | */ |
| 1348 | bool HasScrollbar(int orient) const; |
| 1349 | |
| 1350 | /** |
| 1351 | Returns @true if this window background is transparent (as, for example, |
| 1352 | for wxStaticText) and should show the parent window background. |
| 1353 | |
| 1354 | This method is mostly used internally by the library itself and you normally |
| 1355 | shouldn't have to call it. You may, however, have to override it in your |
| 1356 | wxWindow-derived class to ensure that background is painted correctly. |
| 1357 | */ |
| 1358 | virtual bool HasTransparentBackground(); |
| 1359 | |
| 1360 | /** |
| 1361 | Equivalent to calling wxWindow::Show(@false). |
| 1362 | */ |
| 1363 | bool Hide(); |
| 1364 | |
| 1365 | /** |
| 1366 | This function hides a window, like Hide(), but using a special visual |
| 1367 | effect if possible. |
| 1368 | |
| 1369 | The parameters of this function are the same as for ShowWithEffect(), |
| 1370 | please see their description there. |
| 1371 | |
| 1372 | @since 2.9.0 |
| 1373 | */ |
| 1374 | virtual bool HideWithEffect(wxShowEffect effect, |
| 1375 | unsigned int timeout = 0); |
| 1376 | |
| 1377 | /** |
| 1378 | This function is (or should be, in case of custom controls) called during |
| 1379 | window creation to intelligently set up the window visual attributes, that is |
| 1380 | the font and the foreground and background colours. |
| 1381 | |
| 1382 | By "intelligently" the following is meant: by default, all windows use their |
| 1383 | own @ref GetClassDefaultAttributes() default attributes. |
| 1384 | However if some of the parents attributes are explicitly (that is, using |
| 1385 | SetFont() and not wxWindow::SetOwnFont) changed and if the corresponding |
| 1386 | attribute hadn't been explicitly set for this window itself, then this |
| 1387 | window takes the same value as used by the parent. |
| 1388 | In addition, if the window overrides ShouldInheritColours() to return @false, |
| 1389 | the colours will not be changed no matter what and only the font might. |
| 1390 | |
| 1391 | This rather complicated logic is necessary in order to accommodate the |
| 1392 | different usage scenarios. The most common one is when all default attributes |
| 1393 | are used and in this case, nothing should be inherited as in modern GUIs |
| 1394 | different controls use different fonts (and colours) than their siblings so |
| 1395 | they can't inherit the same value from the parent. However it was also deemed |
| 1396 | desirable to allow to simply change the attributes of all children at once by |
| 1397 | just changing the font or colour of their common parent, hence in this case we |
| 1398 | do inherit the parents attributes. |
| 1399 | */ |
| 1400 | virtual void InheritAttributes(); |
| 1401 | |
| 1402 | /** |
| 1403 | Sends an @c wxEVT_INIT_DIALOG event, whose handler usually transfers data |
| 1404 | to the dialog via validators. |
| 1405 | */ |
| 1406 | virtual void InitDialog(); |
| 1407 | |
| 1408 | /** |
| 1409 | Resets the cached best size value so it will be recalculated the next time it |
| 1410 | is needed. |
| 1411 | */ |
| 1412 | void InvalidateBestSize(); |
| 1413 | |
| 1414 | /** |
| 1415 | Returns @true if the window contents is double-buffered by the system, i.e. if |
| 1416 | any drawing done on the window is really done on a temporary backing surface |
| 1417 | and transferred to the screen all at once later. |
| 1418 | |
| 1419 | @see wxBufferedDC |
| 1420 | */ |
| 1421 | virtual bool IsDoubleBuffered() const; |
| 1422 | |
| 1423 | /** |
| 1424 | Returns @true if the window is enabled, i.e. if it accepts user input, |
| 1425 | @false otherwise. |
| 1426 | |
| 1427 | Notice that this method can return @false even if this window itself hadn't |
| 1428 | been explicitly disabled when one of its parent windows is disabled. |
| 1429 | To get the intrinsic status of this window, use IsThisEnabled() |
| 1430 | |
| 1431 | @see Enable() |
| 1432 | */ |
| 1433 | bool IsEnabled() const; |
| 1434 | |
| 1435 | //@{ |
| 1436 | /** |
| 1437 | Returns @true if the given point or rectangle area has been exposed since the |
| 1438 | last repaint. Call this in an paint event handler to optimize redrawing by |
| 1439 | only redrawing those areas, which have been exposed. |
| 1440 | */ |
| 1441 | bool IsExposed(int x, int y) const; |
| 1442 | bool IsExposed(wxPoint& pt) const; |
| 1443 | bool IsExposed(int x, int y, int w, int h) const; |
| 1444 | bool IsExposed(wxRect& rect) const; |
| 1445 | //@} |
| 1446 | |
| 1447 | /** |
| 1448 | Returns @true if the window is currently frozen by a call to Freeze(). |
| 1449 | |
| 1450 | @see Freeze(), Thaw() |
| 1451 | */ |
| 1452 | bool IsFrozen() const; |
| 1453 | |
| 1454 | /** |
| 1455 | Returns @true if the window is retained, @false otherwise. |
| 1456 | |
| 1457 | @remarks Retained windows are only available on X platforms. |
| 1458 | */ |
| 1459 | virtual bool IsRetained() const; |
| 1460 | |
| 1461 | /** |
| 1462 | Return whether a scrollbar is always shown. |
| 1463 | |
| 1464 | @param orient |
| 1465 | Orientation to check, either wxHORIZONTAL or wxVERTICAL. |
| 1466 | |
| 1467 | @see AlwaysShowScrollbars() |
| 1468 | */ |
| 1469 | virtual bool IsScrollbarAlwaysShown(int orient) const; |
| 1470 | |
| 1471 | /** |
| 1472 | Returns @true if the window is shown, @false if it has been hidden. |
| 1473 | |
| 1474 | @see IsShownOnScreen() |
| 1475 | */ |
| 1476 | virtual bool IsShown() const; |
| 1477 | |
| 1478 | /** |
| 1479 | Returns @true if the window is physically visible on the screen, i.e. it |
| 1480 | is shown and all its parents up to the toplevel window are shown as well. |
| 1481 | |
| 1482 | @see IsShown() |
| 1483 | */ |
| 1484 | virtual bool IsShownOnScreen() const; |
| 1485 | |
| 1486 | /** |
| 1487 | Returns @true if this window is intrinsically enabled, @false otherwise, |
| 1488 | i.e. if @ref Enable() Enable(@false) had been called. This method is |
| 1489 | mostly used for wxWidgets itself, user code should normally use |
| 1490 | IsEnabled() instead. |
| 1491 | */ |
| 1492 | bool IsThisEnabled() const; |
| 1493 | |
| 1494 | /** |
| 1495 | Returns @true if the given window is a top-level one. Currently all frames and |
| 1496 | dialogs are considered to be top-level windows (even if they have a parent |
| 1497 | window). |
| 1498 | */ |
| 1499 | virtual bool IsTopLevel() const; |
| 1500 | |
| 1501 | /** |
| 1502 | Invokes the constraint-based layout algorithm or the sizer-based algorithm |
| 1503 | for this window. |
| 1504 | |
| 1505 | See SetAutoLayout(): when auto layout is on, this function gets called automatically |
| 1506 | when the window is resized. |
| 1507 | |
| 1508 | @see @ref overview_windowsizing |
| 1509 | */ |
| 1510 | virtual bool Layout(); |
| 1511 | |
| 1512 | /** |
| 1513 | Lowers the window to the bottom of the window hierarchy (Z-order). |
| 1514 | |
| 1515 | @see Raise() |
| 1516 | */ |
| 1517 | virtual void Lower(); |
| 1518 | |
| 1519 | /** |
| 1520 | Disables all other windows in the application so that |
| 1521 | the user can only interact with this window. |
| 1522 | |
| 1523 | @param modal |
| 1524 | If @true, this call disables all other windows in the application so that |
| 1525 | the user can only interact with this window. If @false, the effect is |
| 1526 | reversed. |
| 1527 | */ |
| 1528 | virtual void MakeModal(bool modal = true); |
| 1529 | |
| 1530 | /** |
| 1531 | Moves the window to the given position. |
| 1532 | |
| 1533 | @param x |
| 1534 | Required x position. |
| 1535 | @param y |
| 1536 | Required y position. |
| 1537 | @param flags |
| 1538 | See SetSize() for more info about this parameter. |
| 1539 | |
| 1540 | @remarks Implementations of SetSize can also implicitly implement the |
| 1541 | Move() function, which is defined in the base wxWindow class as the call: |
| 1542 | @code |
| 1543 | SetSize(x, y, wxDefaultCoord, wxDefaultCoord, wxSIZE_USE_EXISTING); |
| 1544 | @endcode |
| 1545 | |
| 1546 | @see SetSize() |
| 1547 | */ |
| 1548 | void Move(int x, int y, int flags = wxSIZE_USE_EXISTING); |
| 1549 | |
| 1550 | /** |
| 1551 | Moves the window to the given position. |
| 1552 | |
| 1553 | @param pt |
| 1554 | wxPoint object representing the position. |
| 1555 | @param flags |
| 1556 | See SetSize() for more info about this parameter. |
| 1557 | |
| 1558 | @remarks Implementations of SetSize() can also implicitly implement the |
| 1559 | Move() function, which is defined in the base wxWindow class as the call: |
| 1560 | @code |
| 1561 | SetSize(x, y, wxDefaultCoord, wxDefaultCoord, wxSIZE_USE_EXISTING); |
| 1562 | @endcode |
| 1563 | |
| 1564 | @see SetSize() |
| 1565 | */ |
| 1566 | void Move(const wxPoint& pt, int flags = wxSIZE_USE_EXISTING); |
| 1567 | |
| 1568 | /** |
| 1569 | Moves this window in the tab navigation order after the specified @e win. |
| 1570 | This means that when the user presses @c TAB key on that other window, |
| 1571 | the focus switches to this window. |
| 1572 | |
| 1573 | Default tab order is the same as creation order, this function and |
| 1574 | MoveBeforeInTabOrder() allow to change |
| 1575 | it after creating all the windows. |
| 1576 | |
| 1577 | @param win |
| 1578 | A sibling of this window which should precede it in tab order, |
| 1579 | must not be @NULL |
| 1580 | */ |
| 1581 | void MoveAfterInTabOrder(wxWindow* win); |
| 1582 | |
| 1583 | /** |
| 1584 | Same as MoveAfterInTabOrder() except that it inserts this window just |
| 1585 | before @a win instead of putting it right after it. |
| 1586 | */ |
| 1587 | void MoveBeforeInTabOrder(wxWindow* win); |
| 1588 | |
| 1589 | /** |
| 1590 | Performs a keyboard navigation action starting from this window. |
| 1591 | This method is equivalent to calling NavigateIn() method on the |
| 1592 | parent window. |
| 1593 | |
| 1594 | @param flags |
| 1595 | A combination of wxNavigationKeyEvent::IsForward and |
| 1596 | wxNavigationKeyEvent::WinChange. |
| 1597 | |
| 1598 | @return Returns @true if the focus was moved to another window or @false |
| 1599 | if nothing changed. |
| 1600 | |
| 1601 | @remarks You may wish to call this from a text control custom keypress |
| 1602 | handler to do the default navigation behaviour for the |
| 1603 | tab key, since the standard default behaviour for a |
| 1604 | multiline text control with the wxTE_PROCESS_TAB style |
| 1605 | is to insert a tab and not navigate to the next |
| 1606 | control. See also wxNavigationKeyEvent and |
| 1607 | HandleAsNavigationKey. |
| 1608 | */ |
| 1609 | bool Navigate(int flags = IsForward); |
| 1610 | |
| 1611 | /** |
| 1612 | Performs a keyboard navigation action inside this window. |
| 1613 | See Navigate() for more information. |
| 1614 | */ |
| 1615 | bool NavigateIn(int flags = IsForward); |
| 1616 | |
| 1617 | /** |
| 1618 | Create a new ID or range of IDs that are not currently in use. |
| 1619 | The IDs will be reserved until assigned to a wxWindow ID |
| 1620 | or unreserved with UnreserveControlId(). |
| 1621 | |
| 1622 | See @ref overview_windowids for more information. |
| 1623 | |
| 1624 | @param count |
| 1625 | The number of sequential IDs to reserve. |
| 1626 | |
| 1627 | @return Returns the ID or the first ID of the range, or wxID_NONE if the |
| 1628 | specified number of identifiers couldn't be allocated. |
| 1629 | |
| 1630 | @see UnreserveControlId(), wxIdManager, |
| 1631 | @ref overview_windowids |
| 1632 | */ |
| 1633 | static wxWindowID NewControlId(int count = 1); |
| 1634 | |
| 1635 | /** |
| 1636 | This virtual function is normally only used internally, but |
| 1637 | sometimes an application may need it to implement functionality |
| 1638 | that should not be disabled by an application defining an OnIdle |
| 1639 | handler in a derived class. |
| 1640 | |
| 1641 | This function may be used to do delayed painting, for example, |
| 1642 | and most implementations call UpdateWindowUI() |
| 1643 | in order to send update events to the window in idle time. |
| 1644 | */ |
| 1645 | virtual void OnInternalIdle(); |
| 1646 | |
| 1647 | /** |
| 1648 | Same as #ScrollLines (-1). |
| 1649 | */ |
| 1650 | bool LineUp(); |
| 1651 | |
| 1652 | /** |
| 1653 | Same as #ScrollLines (1). |
| 1654 | */ |
| 1655 | bool LineDown(); |
| 1656 | |
| 1657 | /** |
| 1658 | Same as #ScrollPages (-1). |
| 1659 | */ |
| 1660 | bool PageUp(); |
| 1661 | |
| 1662 | /** |
| 1663 | Same as #ScrollPages (1). |
| 1664 | */ |
| 1665 | bool PageDown(); |
| 1666 | |
| 1667 | |
| 1668 | /** |
| 1669 | Removes and returns the top-most event handler on the event handler stack. |
| 1670 | |
| 1671 | @param deleteHandler |
| 1672 | If this is @true, the handler will be deleted after it is removed. |
| 1673 | The default value is @false. |
| 1674 | |
| 1675 | @see SetEventHandler(), GetEventHandler(), |
| 1676 | PushEventHandler(), wxEvtHandler::ProcessEvent, wxEvtHandler |
| 1677 | */ |
| 1678 | wxEvtHandler* PopEventHandler(bool deleteHandler = false); |
| 1679 | |
| 1680 | //@{ |
| 1681 | /** |
| 1682 | Pops up the given menu at the specified coordinates, relative to this |
| 1683 | window, and returns control when the user has dismissed the menu. |
| 1684 | |
| 1685 | If a menu item is selected, the corresponding menu event is generated and will be |
| 1686 | processed as usually. If the coordinates are not specified, current mouse |
| 1687 | cursor position is used. |
| 1688 | |
| 1689 | @a menu is the menu to pop up. |
| 1690 | |
| 1691 | The position where the menu will appear can be specified either as a |
| 1692 | wxPoint @a pos or by two integers (@a x and @a y). |
| 1693 | |
| 1694 | @remarks Just before the menu is popped up, wxMenu::UpdateUI is called to |
| 1695 | ensure that the menu items are in the correct state. |
| 1696 | The menu does not get deleted by the window. |
| 1697 | It is recommended to not explicitly specify coordinates when |
| 1698 | calling PopupMenu in response to mouse click, because some of |
| 1699 | the ports (namely, wxGTK) can do a better job of positioning |
| 1700 | the menu in that case. |
| 1701 | |
| 1702 | @see wxMenu |
| 1703 | */ |
| 1704 | bool PopupMenu(wxMenu* menu, |
| 1705 | const wxPoint& pos = wxDefaultPosition); |
| 1706 | bool PopupMenu(wxMenu* menu, int x, int y); |
| 1707 | //@} |
| 1708 | |
| 1709 | /** |
| 1710 | Posts a size event to the window. |
| 1711 | |
| 1712 | This is the same as SendSizeEvent() with @c wxSEND_EVENT_POST argument. |
| 1713 | */ |
| 1714 | void PostSizeEvent(); |
| 1715 | |
| 1716 | /** |
| 1717 | Posts a size event to the parent of this window. |
| 1718 | |
| 1719 | This is the same as SendSizeEventToParent() with @c wxSEND_EVENT_POST |
| 1720 | argument. |
| 1721 | */ |
| 1722 | void PostSizeEventToParent(); |
| 1723 | |
| 1724 | /** |
| 1725 | Pushes this event handler onto the event stack for the window. |
| 1726 | |
| 1727 | @param handler |
| 1728 | Specifies the handler to be pushed. |
| 1729 | |
| 1730 | @remarks An event handler is an object that is capable of processing the |
| 1731 | events sent to a window. By default, the window is its |
| 1732 | own event handler, but an application may wish to |
| 1733 | substitute another, for example to allow central |
| 1734 | implementation of event-handling for a variety of |
| 1735 | different window classes. |
| 1736 | wxWindow::PushEventHandler allows an application to set up a |
| 1737 | chain of event handlers, where an event not handled by one event |
| 1738 | handler is handed to the next one in the chain. |
| 1739 | Use wxWindow::PopEventHandler to remove the event handler. |
| 1740 | |
| 1741 | @see SetEventHandler(), GetEventHandler(), |
| 1742 | PopEventHandler(), wxEvtHandler::ProcessEvent, wxEvtHandler |
| 1743 | */ |
| 1744 | void PushEventHandler(wxEvtHandler* handler); |
| 1745 | |
| 1746 | /** |
| 1747 | Raises the window to the top of the window hierarchy (Z-order). |
| 1748 | In current version of wxWidgets this works both for managed and child windows. |
| 1749 | |
| 1750 | @see Lower() |
| 1751 | */ |
| 1752 | virtual void Raise(); |
| 1753 | |
| 1754 | /** |
| 1755 | Causes this window, and all of its children recursively (except under wxGTK1 |
| 1756 | where this is not implemented), to be repainted. Note that repainting doesn't |
| 1757 | happen immediately but only during the next event loop iteration, if you need |
| 1758 | to update the window immediately you should use Update() instead. |
| 1759 | |
| 1760 | @param eraseBackground |
| 1761 | If @true, the background will be erased. |
| 1762 | @param rect |
| 1763 | If non-@NULL, only the given rectangle will be treated as damaged. |
| 1764 | |
| 1765 | @see RefreshRect() |
| 1766 | */ |
| 1767 | virtual void Refresh(bool eraseBackground = true, |
| 1768 | const wxRect* rect = NULL); |
| 1769 | |
| 1770 | /** |
| 1771 | Redraws the contents of the given rectangle: only the area inside it will be |
| 1772 | repainted. |
| 1773 | |
| 1774 | This is the same as Refresh() but has a nicer syntax as it can be called |
| 1775 | with a temporary wxRect object as argument like this @c RefreshRect(wxRect(x, y, w, h)). |
| 1776 | */ |
| 1777 | void RefreshRect(const wxRect& rect, bool eraseBackground = true); |
| 1778 | |
| 1779 | /** |
| 1780 | Registers a system wide hotkey. Every time the user presses the hotkey |
| 1781 | registered here, this window will receive a hotkey event. |
| 1782 | |
| 1783 | It will receive the event even if the application is in the background |
| 1784 | and does not have the input focus because the user is working with some |
| 1785 | other application. |
| 1786 | |
| 1787 | @param hotkeyId |
| 1788 | Numeric identifier of the hotkey. For applications this must be between 0 |
| 1789 | and 0xBFFF. If this function is called from a shared DLL, it must be a |
| 1790 | system wide unique identifier between 0xC000 and 0xFFFF. |
| 1791 | This is a MSW specific detail. |
| 1792 | @param modifiers |
| 1793 | A bitwise combination of wxMOD_SHIFT, wxMOD_CONTROL, wxMOD_ALT |
| 1794 | or wxMOD_WIN specifying the modifier keys that have to be pressed along |
| 1795 | with the key. |
| 1796 | @param virtualKeyCode |
| 1797 | The virtual key code of the hotkey. |
| 1798 | |
| 1799 | @return @true if the hotkey was registered successfully. @false if some |
| 1800 | other application already registered a hotkey with this |
| 1801 | modifier/virtualKeyCode combination. |
| 1802 | |
| 1803 | @remarks Use EVT_HOTKEY(hotkeyId, fnc) in the event table to capture the |
| 1804 | event. This function is currently only implemented |
| 1805 | under Windows. It is used in the Windows CE port for |
| 1806 | detecting hardware button presses. |
| 1807 | |
| 1808 | @see UnregisterHotKey() |
| 1809 | */ |
| 1810 | virtual bool RegisterHotKey(int hotkeyId, int modifiers, |
| 1811 | int virtualKeyCode); |
| 1812 | |
| 1813 | /** |
| 1814 | Releases mouse input captured with CaptureMouse(). |
| 1815 | |
| 1816 | @see CaptureMouse(), HasCapture(), ReleaseMouse(), |
| 1817 | wxMouseCaptureLostEvent, wxMouseCaptureChangedEvent |
| 1818 | */ |
| 1819 | void ReleaseMouse(); |
| 1820 | |
| 1821 | /** |
| 1822 | Removes a child window. |
| 1823 | |
| 1824 | This is called automatically by window deletion functions so should not |
| 1825 | be required by the application programmer. |
| 1826 | Notice that this function is mostly internal to wxWidgets and shouldn't be |
| 1827 | called by the user code. |
| 1828 | |
| 1829 | @param child |
| 1830 | Child window to remove. |
| 1831 | */ |
| 1832 | virtual void RemoveChild(wxWindow* child); |
| 1833 | |
| 1834 | /** |
| 1835 | Find the given @a handler in the windows event handler chain and remove |
| 1836 | (but not delete) it from it. |
| 1837 | |
| 1838 | @param handler |
| 1839 | The event handler to remove, must be non-@NULL and |
| 1840 | must be present in this windows event handlers chain |
| 1841 | |
| 1842 | @return Returns @true if it was found and @false otherwise (this also |
| 1843 | results in an assert failure so this function should |
| 1844 | only be called when the handler is supposed to be there). |
| 1845 | |
| 1846 | @see PushEventHandler(), PopEventHandler() |
| 1847 | */ |
| 1848 | bool RemoveEventHandler(wxEvtHandler* handler); |
| 1849 | |
| 1850 | /** |
| 1851 | Reparents the window, i.e the window will be removed from its |
| 1852 | current parent window (e.g. a non-standard toolbar in a wxFrame) |
| 1853 | and then re-inserted into another. |
| 1854 | |
| 1855 | @param newParent |
| 1856 | New parent. |
| 1857 | */ |
| 1858 | virtual bool Reparent(wxWindow* newParent); |
| 1859 | |
| 1860 | /** |
| 1861 | Converts from screen to client window coordinates. |
| 1862 | |
| 1863 | @param x |
| 1864 | Stores the screen x coordinate and receives the client x coordinate. |
| 1865 | @param y |
| 1866 | Stores the screen x coordinate and receives the client x coordinate. |
| 1867 | */ |
| 1868 | void ScreenToClient(int* x, int* y) const; |
| 1869 | |
| 1870 | /** |
| 1871 | Converts from screen to client window coordinates. |
| 1872 | |
| 1873 | @param pt |
| 1874 | The screen position. |
| 1875 | */ |
| 1876 | wxPoint ScreenToClient(const wxPoint& pt) const; |
| 1877 | |
| 1878 | /** |
| 1879 | Scrolls the window by the given number of lines down (if @a lines is |
| 1880 | positive) or up. |
| 1881 | |
| 1882 | @return Returns @true if the window was scrolled, @false if it was already |
| 1883 | on top/bottom and nothing was done. |
| 1884 | |
| 1885 | @remarks This function is currently only implemented under MSW and |
| 1886 | wxTextCtrl under wxGTK (it also works for wxScrolled classes |
| 1887 | under all platforms). |
| 1888 | |
| 1889 | @see ScrollPages() |
| 1890 | */ |
| 1891 | virtual bool ScrollLines(int lines); |
| 1892 | |
| 1893 | /** |
| 1894 | Scrolls the window by the given number of pages down (if @a pages is |
| 1895 | positive) or up. |
| 1896 | |
| 1897 | @return Returns @true if the window was scrolled, @false if it was already |
| 1898 | on top/bottom and nothing was done. |
| 1899 | |
| 1900 | @remarks This function is currently only implemented under MSW and wxGTK. |
| 1901 | |
| 1902 | @see ScrollLines() |
| 1903 | */ |
| 1904 | virtual bool ScrollPages(int pages); |
| 1905 | |
| 1906 | /** |
| 1907 | Physically scrolls the pixels in the window and move child windows accordingly. |
| 1908 | |
| 1909 | @param dx |
| 1910 | Amount to scroll horizontally. |
| 1911 | @param dy |
| 1912 | Amount to scroll vertically. |
| 1913 | @param rect |
| 1914 | Rectangle to scroll, if it is @NULL, the whole window is |
| 1915 | scrolled (this is always the case under wxGTK which doesn't support this |
| 1916 | parameter) |
| 1917 | |
| 1918 | @remarks Note that you can often use wxScrolled instead of using this |
| 1919 | function directly. |
| 1920 | */ |
| 1921 | virtual void ScrollWindow(int dx, int dy, |
| 1922 | const wxRect* rect = NULL); |
| 1923 | |
| 1924 | /** |
| 1925 | This function sends a dummy @ref wxSizeEvent "size event" to |
| 1926 | the window allowing it to re-layout its children positions. |
| 1927 | |
| 1928 | It is sometimes useful to call this function after adding or deleting a |
| 1929 | children after the frame creation or if a child size changes. Note that |
| 1930 | if the frame is using either sizers or constraints for the children |
| 1931 | layout, it is enough to call wxWindow::Layout() directly and this |
| 1932 | function should not be used in this case. |
| 1933 | |
| 1934 | If @a flags includes @c wxSEND_EVENT_POST value, this function posts |
| 1935 | the event, i.e. schedules it for later processing, instead of |
| 1936 | dispatching it directly. You can also use PostSizeEvent() as a more |
| 1937 | readable equivalent of calling this function with this flag. |
| 1938 | |
| 1939 | @param flags |
| 1940 | May include @c wxSEND_EVENT_POST. Default value is 0. |
| 1941 | */ |
| 1942 | virtual void SendSizeEvent(int flags = 0); |
| 1943 | |
| 1944 | /** |
| 1945 | Safe wrapper for GetParent()->SendSizeEvent(). |
| 1946 | |
| 1947 | This function simply checks that the window has a valid parent which is |
| 1948 | not in process of being deleted and calls SendSizeEvent() on it. It is |
| 1949 | used internally by windows such as toolbars changes to whose state |
| 1950 | should result in parent re-layout (e.g. when a toolbar is added to the |
| 1951 | top of the window, all the other windows must be shifted down). |
| 1952 | |
| 1953 | @see PostSizeEventToParent() |
| 1954 | |
| 1955 | @param flags |
| 1956 | See description of this parameter in SendSizeEvent() documentation. |
| 1957 | */ |
| 1958 | void SendSizeEventToParent(int flags = 0); |
| 1959 | |
| 1960 | /** |
| 1961 | Sets the accelerator table for this window. See wxAcceleratorTable. |
| 1962 | */ |
| 1963 | virtual void SetAcceleratorTable(const wxAcceleratorTable& accel); |
| 1964 | |
| 1965 | /** |
| 1966 | Sets the accessible for this window. Any existing accessible for this window |
| 1967 | will be deleted first, if not identical to @e accessible. |
| 1968 | See also wxAccessible. |
| 1969 | */ |
| 1970 | void SetAccessible(wxAccessible* accessible); |
| 1971 | |
| 1972 | /** |
| 1973 | Determines whether the Layout() function will be called automatically |
| 1974 | when the window is resized. Please note that this only happens for the |
| 1975 | windows usually used to contain children, namely wxPanel and wxTopLevelWindow |
| 1976 | (and the classes deriving from them). |
| 1977 | |
| 1978 | This method is called implicitly by SetSizer() but if you use SetConstraints() |
| 1979 | you should call it manually or otherwise the window layout won't be correctly |
| 1980 | updated when its size changes. |
| 1981 | |
| 1982 | @param autoLayout |
| 1983 | Set this to @true if you wish the Layout function to be |
| 1984 | called automatically when the window is resized. |
| 1985 | |
| 1986 | @see SetConstraints() |
| 1987 | */ |
| 1988 | void SetAutoLayout(bool autoLayout); |
| 1989 | |
| 1990 | /** |
| 1991 | Sets the background colour of the window. |
| 1992 | Please see InheritAttributes() for explanation of the difference between |
| 1993 | this method and SetOwnBackgroundColour(). |
| 1994 | |
| 1995 | @param colour |
| 1996 | The colour to be used as the background colour, pass |
| 1997 | wxNullColour to reset to the default colour. |
| 1998 | |
| 1999 | @remarks The background colour is usually painted by the default |
| 2000 | wxEraseEvent event handler function under Windows and |
| 2001 | automatically under GTK. |
| 2002 | Note that setting the background colour does not cause an |
| 2003 | immediate refresh, so you may wish to call wxWindow::ClearBackground |
| 2004 | or wxWindow::Refresh after calling this function. |
| 2005 | Using this function will disable attempts to use themes for |
| 2006 | this window, if the system supports them. Use with care since |
| 2007 | usually the themes represent the appearance chosen by the user |
| 2008 | to be used for all applications on the system. |
| 2009 | |
| 2010 | @see GetBackgroundColour(), SetForegroundColour(), |
| 2011 | GetForegroundColour(), ClearBackground(), |
| 2012 | Refresh(), wxEraseEvent |
| 2013 | */ |
| 2014 | virtual bool SetBackgroundColour(const wxColour& colour); |
| 2015 | |
| 2016 | /** |
| 2017 | Sets the background style of the window. see GetBackgroundStyle() for |
| 2018 | the description of the possible style values. |
| 2019 | |
| 2020 | @see SetBackgroundColour(), GetForegroundColour(), |
| 2021 | SetTransparent() |
| 2022 | */ |
| 2023 | virtual bool SetBackgroundStyle(wxBackgroundStyle style); |
| 2024 | |
| 2025 | /** |
| 2026 | This method is only implemented by ports which have support for |
| 2027 | native TAB traversal (such as GTK+ 2.0). |
| 2028 | |
| 2029 | It is called by wxWidgets' container control code to give the native |
| 2030 | system a hint when doing TAB traversal. A call to this does not disable |
| 2031 | or change the effect of programmatically calling SetFocus(). |
| 2032 | |
| 2033 | @see wxFocusEvent, wxPanel::SetFocus, wxPanel::SetFocusIgnoringChildren |
| 2034 | */ |
| 2035 | virtual void SetCanFocus(bool canFocus); |
| 2036 | |
| 2037 | /** |
| 2038 | Sets the caret() associated with the window. |
| 2039 | */ |
| 2040 | void SetCaret(wxCaret* caret); |
| 2041 | |
| 2042 | //@{ |
| 2043 | /** |
| 2044 | This sets the size of the window client area in pixels. |
| 2045 | |
| 2046 | Using this function to size a window tends to be more device-independent |
| 2047 | than SetSize(), since the application need not worry about what dimensions |
| 2048 | the border or title bar have when trying to fit the window around panel |
| 2049 | items, for example. |
| 2050 | */ |
| 2051 | virtual void SetClientSize(int width, int height); |
| 2052 | virtual void SetClientSize(const wxSize& size); |
| 2053 | //@} |
| 2054 | |
| 2055 | /** |
| 2056 | Sets the window to have the given layout constraints. The window |
| 2057 | will then own the object, and will take care of its deletion. |
| 2058 | If an existing layout constraints object is already owned by the |
| 2059 | window, it will be deleted. |
| 2060 | |
| 2061 | @param constraints |
| 2062 | The constraints to set. Pass @NULL to disassociate and delete the window's |
| 2063 | constraints. |
| 2064 | |
| 2065 | @remarks You must call SetAutoLayout() to tell a window to use |
| 2066 | the constraints automatically in OnSize; otherwise, you |
| 2067 | must override OnSize and call Layout() explicitly. When |
| 2068 | setting both a wxLayoutConstraints and a wxSizer, only |
| 2069 | the sizer will have effect. |
| 2070 | */ |
| 2071 | void SetConstraints(wxLayoutConstraints* constraints); |
| 2072 | |
| 2073 | /** |
| 2074 | This normally does not need to be called by user code. |
| 2075 | It is called when a window is added to a sizer, and is used so the window |
| 2076 | can remove itself from the sizer when it is destroyed. |
| 2077 | */ |
| 2078 | void SetContainingSizer(wxSizer* sizer); |
| 2079 | |
| 2080 | /** |
| 2081 | Sets the window's cursor. Notice that the window cursor also sets it for the |
| 2082 | children of the window implicitly. |
| 2083 | |
| 2084 | The @a cursor may be @c wxNullCursor in which case the window cursor will |
| 2085 | be reset back to default. |
| 2086 | |
| 2087 | @param cursor |
| 2088 | Specifies the cursor that the window should normally display. |
| 2089 | |
| 2090 | @see ::wxSetCursor, wxCursor |
| 2091 | */ |
| 2092 | virtual bool SetCursor(const wxCursor& cursor); |
| 2093 | |
| 2094 | /** |
| 2095 | Associates a drop target with this window. |
| 2096 | If the window already has a drop target, it is deleted. |
| 2097 | |
| 2098 | @see GetDropTarget(), @ref overview_dnd |
| 2099 | */ |
| 2100 | virtual void SetDropTarget(wxDropTarget* target); |
| 2101 | |
| 2102 | /** |
| 2103 | Sets the event handler for this window. |
| 2104 | |
| 2105 | @param handler |
| 2106 | Specifies the handler to be set. |
| 2107 | |
| 2108 | @remarks An event handler is an object that is capable of processing the |
| 2109 | events sent to a window. By default, the window is its |
| 2110 | own event handler, but an application may wish to |
| 2111 | substitute another, for example to allow central |
| 2112 | implementation of event-handling for a variety of |
| 2113 | different window classes. |
| 2114 | It is usually better to use wxWindow::PushEventHandler since |
| 2115 | this sets up a chain of event handlers, where an event not |
| 2116 | handled by one event handler is handed to the next one in the chain. |
| 2117 | |
| 2118 | @see GetEventHandler(), PushEventHandler(), |
| 2119 | PopEventHandler(), wxEvtHandler::ProcessEvent, wxEvtHandler |
| 2120 | */ |
| 2121 | void SetEventHandler(wxEvtHandler* handler); |
| 2122 | |
| 2123 | /** |
| 2124 | Sets the extra style bits for the window. |
| 2125 | The currently defined extra style bits are reported in the class |
| 2126 | description. |
| 2127 | */ |
| 2128 | virtual void SetExtraStyle(long exStyle); |
| 2129 | |
| 2130 | /** |
| 2131 | This sets the window to receive keyboard input. |
| 2132 | |
| 2133 | @see HasFocus(), wxFocusEvent, wxPanel::SetFocus, |
| 2134 | wxPanel::SetFocusIgnoringChildren |
| 2135 | */ |
| 2136 | virtual void SetFocus(); |
| 2137 | |
| 2138 | /** |
| 2139 | This function is called by wxWidgets keyboard navigation code when the user |
| 2140 | gives the focus to this window from keyboard (e.g. using @c TAB key). |
| 2141 | |
| 2142 | By default this method simply calls SetFocus() but |
| 2143 | can be overridden to do something in addition to this in the derived classes. |
| 2144 | */ |
| 2145 | virtual void SetFocusFromKbd(); |
| 2146 | |
| 2147 | /** |
| 2148 | Sets the font for this window. This function should not be called for the |
| 2149 | parent window if you don't want its font to be inherited by its children, |
| 2150 | use SetOwnFont() instead in this case and see InheritAttributes() for more |
| 2151 | explanations. |
| 2152 | |
| 2153 | Please notice that the given font is not automatically used for |
| 2154 | wxPaintDC objects associated with this window, you need to |
| 2155 | call wxDC::SetFont too. However this font is used by |
| 2156 | any standard controls for drawing their text as well as by |
| 2157 | GetTextExtent(). |
| 2158 | |
| 2159 | @param font |
| 2160 | Font to associate with this window, pass |
| 2161 | wxNullFont to reset to the default font. |
| 2162 | |
| 2163 | @return @true if the want was really changed, @false if it was already set |
| 2164 | to this font and so nothing was done. |
| 2165 | |
| 2166 | @see GetFont(), InheritAttributes() |
| 2167 | */ |
| 2168 | virtual bool SetFont(const wxFont& font); |
| 2169 | |
| 2170 | /** |
| 2171 | Sets the foreground colour of the window. |
| 2172 | Please see InheritAttributes() for explanation of the difference between |
| 2173 | this method and SetOwnForegroundColour(). |
| 2174 | |
| 2175 | @param colour |
| 2176 | The colour to be used as the foreground colour, pass |
| 2177 | wxNullColour to reset to the default colour. |
| 2178 | |
| 2179 | @remarks The interpretation of foreground colour is open to |
| 2180 | interpretation according to the window class; it may be |
| 2181 | the text colour or other colour, or it may not be used at all. |
| 2182 | |
| 2183 | @see GetForegroundColour(), SetBackgroundColour(), |
| 2184 | GetBackgroundColour(), ShouldInheritColours() |
| 2185 | */ |
| 2186 | virtual bool SetForegroundColour(const wxColour& colour); |
| 2187 | |
| 2188 | /** |
| 2189 | Sets the help text to be used as context-sensitive help for this window. |
| 2190 | Note that the text is actually stored by the current wxHelpProvider |
| 2191 | implementation, and not in the window object itself. |
| 2192 | |
| 2193 | @see GetHelpText(), wxHelpProvider::AddHelp() |
| 2194 | */ |
| 2195 | void SetHelpText(const wxString& helpText); |
| 2196 | |
| 2197 | /** |
| 2198 | Sets the identifier of the window. |
| 2199 | |
| 2200 | @remarks Each window has an integer identifier. If the application has |
| 2201 | not provided one, an identifier will be generated. |
| 2202 | Normally, the identifier should be provided on creation |
| 2203 | and should not be modified subsequently. |
| 2204 | |
| 2205 | @see GetId(), @ref overview_windowids |
| 2206 | */ |
| 2207 | void SetId(wxWindowID winid); |
| 2208 | |
| 2209 | /** |
| 2210 | A @e smart SetSize that will fill in default size components with the |
| 2211 | window's @e best size values. |
| 2212 | |
| 2213 | Also sets the window's minsize to the value passed in for use with sizers. |
| 2214 | This means that if a full or partial size is passed to this function then |
| 2215 | the sizers will use that size instead of the results of GetBestSize() to |
| 2216 | determine the minimum needs of the window for layout. |
| 2217 | |
| 2218 | Most controls will use this to set their initial size, and their min |
| 2219 | size to the passed in value (if any.) |
| 2220 | |
| 2221 | @see SetSize(), GetBestSize(), GetEffectiveMinSize(), |
| 2222 | @ref overview_windowsizing |
| 2223 | */ |
| 2224 | void SetInitialSize(const wxSize& size = wxDefaultSize); |
| 2225 | |
| 2226 | /** |
| 2227 | Sets the window's label. |
| 2228 | |
| 2229 | @param label |
| 2230 | The window label. |
| 2231 | |
| 2232 | @see GetLabel() |
| 2233 | */ |
| 2234 | virtual void SetLabel(const wxString& label); |
| 2235 | |
| 2236 | /** |
| 2237 | Sets the maximum client size of the window, to indicate to the sizer |
| 2238 | layout mechanism that this is the maximum possible size of its client area. |
| 2239 | |
| 2240 | @see SetMaxSize() |
| 2241 | */ |
| 2242 | virtual void SetMaxClientSize(const wxSize& size); |
| 2243 | |
| 2244 | /** |
| 2245 | Sets the maximum size of the window, to indicate to the sizer layout mechanism |
| 2246 | that this is the maximum possible size. |
| 2247 | |
| 2248 | @see SetMaxClientSize() |
| 2249 | */ |
| 2250 | virtual void SetMaxSize(const wxSize& size); |
| 2251 | |
| 2252 | /** |
| 2253 | Sets the minimum client size of the window, to indicate to the sizer |
| 2254 | layout mechanism that this is the minimum required size of window's client |
| 2255 | area. |
| 2256 | |
| 2257 | You may need to call this if you change the window size after |
| 2258 | construction and before adding to its parent sizer. |
| 2259 | |
| 2260 | Note, that just as with SetMinSize(), calling this method doesn't |
| 2261 | prevent the program from explicitly making the window smaller than the |
| 2262 | specified size. |
| 2263 | |
| 2264 | @see SetMinSize() |
| 2265 | */ |
| 2266 | virtual void SetMinClientSize(const wxSize& size); |
| 2267 | |
| 2268 | /** |
| 2269 | Sets the minimum size of the window, to indicate to the sizer layout |
| 2270 | mechanism that this is the minimum required size. |
| 2271 | |
| 2272 | You may need to call this if you change the window size after |
| 2273 | construction and before adding to its parent sizer. |
| 2274 | |
| 2275 | Notice that calling this method doesn't prevent the program from making |
| 2276 | the window explicitly smaller than the specified size by calling |
| 2277 | SetSize(), it just ensures that it won't become smaller than this size |
| 2278 | during the automatic layout. |
| 2279 | |
| 2280 | @see SetMinClientSize() |
| 2281 | */ |
| 2282 | virtual void SetMinSize(const wxSize& size); |
| 2283 | |
| 2284 | /** |
| 2285 | Sets the window's name. |
| 2286 | |
| 2287 | @param name |
| 2288 | A name to set for the window. |
| 2289 | |
| 2290 | @see GetName() |
| 2291 | */ |
| 2292 | virtual void SetName(const wxString& name); |
| 2293 | |
| 2294 | /** |
| 2295 | Sets the background colour of the window but prevents it from being inherited |
| 2296 | by the children of this window. |
| 2297 | |
| 2298 | @see SetBackgroundColour(), InheritAttributes() |
| 2299 | */ |
| 2300 | void SetOwnBackgroundColour(const wxColour& colour); |
| 2301 | |
| 2302 | /** |
| 2303 | Sets the font of the window but prevents it from being inherited by the |
| 2304 | children of this window. |
| 2305 | |
| 2306 | @see SetFont(), InheritAttributes() |
| 2307 | */ |
| 2308 | void SetOwnFont(const wxFont& font); |
| 2309 | |
| 2310 | /** |
| 2311 | Sets the foreground colour of the window but prevents it from being inherited |
| 2312 | by the children of this window. |
| 2313 | |
| 2314 | @see SetForegroundColour(), InheritAttributes() |
| 2315 | */ |
| 2316 | void SetOwnForegroundColour(const wxColour& colour); |
| 2317 | |
| 2318 | /** |
| 2319 | @deprecated use wxDC::SetPalette instead. |
| 2320 | */ |
| 2321 | void SetPalette(const wxPalette& pal); |
| 2322 | |
| 2323 | /** |
| 2324 | Sets the position of one of the built-in scrollbars. |
| 2325 | |
| 2326 | @param orientation |
| 2327 | Determines the scrollbar whose position is to be set. |
| 2328 | May be wxHORIZONTAL or wxVERTICAL. |
| 2329 | @param pos |
| 2330 | Position in scroll units. |
| 2331 | @param refresh |
| 2332 | @true to redraw the scrollbar, @false otherwise. |
| 2333 | |
| 2334 | @remarks This function does not directly affect the contents of the |
| 2335 | window: it is up to the application to take note of |
| 2336 | scrollbar attributes and redraw contents accordingly. |
| 2337 | |
| 2338 | @see SetScrollbar(), GetScrollPos(), GetScrollThumb(), wxScrollBar, |
| 2339 | wxScrolled |
| 2340 | */ |
| 2341 | virtual void SetScrollPos(int orientation, int pos, |
| 2342 | bool refresh = true); |
| 2343 | |
| 2344 | /** |
| 2345 | Sets the scrollbar properties of a built-in scrollbar. |
| 2346 | |
| 2347 | @param orientation |
| 2348 | Determines the scrollbar whose page size is to be set. |
| 2349 | May be wxHORIZONTAL or wxVERTICAL. |
| 2350 | @param position |
| 2351 | The position of the scrollbar in scroll units. |
| 2352 | @param thumbSize |
| 2353 | The size of the thumb, or visible portion of the scrollbar, in scroll units. |
| 2354 | @param range |
| 2355 | The maximum position of the scrollbar. |
| 2356 | @param refresh |
| 2357 | @true to redraw the scrollbar, @false otherwise. |
| 2358 | |
| 2359 | @remarks |
| 2360 | Let's say you wish to display 50 lines of text, using the same font. |
| 2361 | The window is sized so that you can only see 16 lines at a time. |
| 2362 | You would use: |
| 2363 | @code |
| 2364 | SetScrollbar(wxVERTICAL, 0, 16, 50); |
| 2365 | @endcode |
| 2366 | Note that with the window at this size, the thumb position can never |
| 2367 | go above 50 minus 16, or 34. You can determine how many lines are |
| 2368 | currently visible by dividing the current view size by the character |
| 2369 | height in pixels. |
| 2370 | When defining your own scrollbar behaviour, you will always need |
| 2371 | to recalculate the scrollbar settings when the window size changes. |
| 2372 | You could therefore put your scrollbar calculations and SetScrollbar |
| 2373 | call into a function named AdjustScrollbars, which can be called |
| 2374 | initially and also from your wxSizeEvent handler function. |
| 2375 | |
| 2376 | @see @ref overview_scrolling, wxScrollBar, wxScrolled, wxScrollWinEvent |
| 2377 | */ |
| 2378 | virtual void SetScrollbar(int orientation, int position, |
| 2379 | int thumbSize, int range, |
| 2380 | bool refresh = true); |
| 2381 | |
| 2382 | /** |
| 2383 | Sets the size of the window in pixels. |
| 2384 | |
| 2385 | @param x |
| 2386 | Required x position in pixels, or wxDefaultCoord to indicate that the |
| 2387 | existing value should be used. |
| 2388 | @param y |
| 2389 | Required y position in pixels, or wxDefaultCoord to indicate that the |
| 2390 | existing value should be used. |
| 2391 | @param width |
| 2392 | Required width in pixels, or wxDefaultCoord to indicate that the existing |
| 2393 | value should be used. |
| 2394 | @param height |
| 2395 | Required height position in pixels, or wxDefaultCoord to indicate that the |
| 2396 | existing value should be used. |
| 2397 | @param sizeFlags |
| 2398 | Indicates the interpretation of other parameters. |
| 2399 | It is a bit list of the following: |
| 2400 | - @c wxSIZE_AUTO_WIDTH: a wxDefaultCoord width value is taken to indicate |
| 2401 | a wxWidgets-supplied default width. |
| 2402 | - @c wxSIZE_AUTO_HEIGHT: a wxDefaultCoord height value is taken to indicate |
| 2403 | a wxWidgets-supplied default height. |
| 2404 | - @c wxSIZE_AUTO: wxDefaultCoord size values are taken to indicate |
| 2405 | a wxWidgets-supplied default size. |
| 2406 | - @c wxSIZE_USE_EXISTING: existing dimensions should be used |
| 2407 | if wxDefaultCoord values are supplied. |
| 2408 | - @c wxSIZE_ALLOW_MINUS_ONE: allow negative dimensions (i.e. value of |
| 2409 | wxDefaultCoord) to be interpreted as real |
| 2410 | dimensions, not default values. |
| 2411 | - @c wxSIZE_FORCE: normally, if the position and the size of the window are |
| 2412 | already the same as the parameters of this function, |
| 2413 | nothing is done. but with this flag a window resize may |
| 2414 | be forced even in this case (supported in wx 2.6.2 and |
| 2415 | later and only implemented for MSW and ignored elsewhere |
| 2416 | currently). |
| 2417 | |
| 2418 | @remarks This overload sets the position and optionally size, of the window. |
| 2419 | Parameters may be wxDefaultCoord to indicate either that a default |
| 2420 | should be supplied by wxWidgets, or that the current value of the |
| 2421 | dimension should be used. |
| 2422 | |
| 2423 | @see Move() |
| 2424 | */ |
| 2425 | void SetSize(int x, int y, int width, int height, |
| 2426 | int sizeFlags = wxSIZE_AUTO); |
| 2427 | |
| 2428 | //@{ |
| 2429 | /** |
| 2430 | Sets the size of the window in pixels. |
| 2431 | The size is specified using a wxRect, wxSize or by a couple of @c int objects. |
| 2432 | |
| 2433 | @remarks This form must be used with non-default width and height values. |
| 2434 | |
| 2435 | @see Move() |
| 2436 | */ |
| 2437 | virtual void SetSize(const wxRect& rect); |
| 2438 | virtual void SetSize(const wxSize& size); |
| 2439 | virtual void SetSize(int width, int height); |
| 2440 | //@} |
| 2441 | |
| 2442 | /** |
| 2443 | Sets the window to have the given layout sizer. |
| 2444 | The window will then own the object, and will take care of its deletion. |
| 2445 | If an existing layout constraints object is already owned by the |
| 2446 | window, it will be deleted if the deleteOld parameter is @true. |
| 2447 | |
| 2448 | Note that this function will also call SetAutoLayout() implicitly with @true |
| 2449 | parameter if the @a sizer is non-@NULL and @false otherwise. |
| 2450 | |
| 2451 | @param sizer |
| 2452 | The sizer to set. Pass @NULL to disassociate and conditionally delete |
| 2453 | the window's sizer. See below. |
| 2454 | @param deleteOld |
| 2455 | If @true (the default), this will delete any pre-existing sizer. |
| 2456 | Pass @false if you wish to handle deleting the old sizer yourself. |
| 2457 | |
| 2458 | @remarks SetSizer enables and disables Layout automatically. |
| 2459 | */ |
| 2460 | void SetSizer(wxSizer* sizer, bool deleteOld = true); |
| 2461 | |
| 2462 | /** |
| 2463 | This method calls SetSizer() and then wxSizer::SetSizeHints which sets the initial |
| 2464 | window size to the size needed to accommodate all sizer elements and sets the |
| 2465 | size hints which, if this window is a top level one, prevent the user from |
| 2466 | resizing it to be less than this minimial size. |
| 2467 | */ |
| 2468 | void SetSizerAndFit(wxSizer* sizer, bool deleteOld = true); |
| 2469 | |
| 2470 | /** |
| 2471 | This function tells a window if it should use the system's "theme" code |
| 2472 | to draw the windows' background instead if its own background drawing |
| 2473 | code. This does not always have any effect since the underlying platform |
| 2474 | obviously needs to support the notion of themes in user defined windows. |
| 2475 | One such platform is GTK+ where windows can have (very colourful) backgrounds |
| 2476 | defined by a user's selected theme. |
| 2477 | |
| 2478 | Dialogs, notebook pages and the status bar have this flag set to @true |
| 2479 | by default so that the default look and feel is simulated best. |
| 2480 | */ |
| 2481 | virtual void SetThemeEnabled(bool enable); |
| 2482 | |
| 2483 | //@{ |
| 2484 | /** |
| 2485 | Attach a tooltip to the window. |
| 2486 | |
| 2487 | wxToolTip pointer can be @NULL in the overload taking the pointer, |
| 2488 | meaning to unset any existing tooltips, however UnsetToolTip() provides |
| 2489 | a more readable alternative to this operation. |
| 2490 | |
| 2491 | Notice that these methods are always available, even if wxWidgets was |
| 2492 | compiled with @c wxUSE_TOOLTIPS set to 0, but don't do anything in this |
| 2493 | case. |
| 2494 | |
| 2495 | @see GetToolTip(), wxToolTip |
| 2496 | */ |
| 2497 | void SetToolTip(const wxString& tip); |
| 2498 | void SetToolTip(wxToolTip* tip); |
| 2499 | //@} |
| 2500 | |
| 2501 | /** |
| 2502 | Set the transparency of the window. If the system supports transparent windows, |
| 2503 | returns @true, otherwise returns @false and the window remains fully opaque. |
| 2504 | See also CanSetTransparent(). |
| 2505 | |
| 2506 | The parameter @a alpha is in the range 0..255 where 0 corresponds to a |
| 2507 | fully transparent window and 255 to the fully opaque one. The constants |
| 2508 | @c wxIMAGE_ALPHA_TRANSPARENT and @c wxIMAGE_ALPHA_OPAQUE can be used. |
| 2509 | */ |
| 2510 | virtual bool SetTransparent(wxByte alpha); |
| 2511 | |
| 2512 | /** |
| 2513 | Deletes the current validator (if any) and sets the window validator, having |
| 2514 | called wxValidator::Clone to create a new validator of this type. |
| 2515 | */ |
| 2516 | virtual void SetValidator(const wxValidator& validator); |
| 2517 | |
| 2518 | //@{ |
| 2519 | /** |
| 2520 | Sets the virtual size of the window in pixels. |
| 2521 | */ |
| 2522 | void SetVirtualSize(int width, int height); |
| 2523 | void SetVirtualSize(const wxSize& size); |
| 2524 | //@} |
| 2525 | |
| 2526 | /** |
| 2527 | Identical to SetWindowStyleFlag(). |
| 2528 | */ |
| 2529 | void SetWindowStyle(long style); |
| 2530 | |
| 2531 | /** |
| 2532 | Sets the style of the window. Please note that some styles cannot be changed |
| 2533 | after the window creation and that Refresh() might need to be be called |
| 2534 | after changing the others for the change to take place immediately. |
| 2535 | |
| 2536 | See @ref overview_windowstyles "Window styles" for more information about flags. |
| 2537 | |
| 2538 | @see GetWindowStyleFlag() |
| 2539 | */ |
| 2540 | virtual void SetWindowStyleFlag(long style); |
| 2541 | |
| 2542 | /** |
| 2543 | This function can be called under all platforms but only does anything under |
| 2544 | Mac OS X 10.3+ currently. Under this system, each of the standard control can |
| 2545 | exist in several sizes which correspond to the elements of wxWindowVariant enum. |
| 2546 | |
| 2547 | By default the controls use the normal size, of course, but this function can |
| 2548 | be used to change this. |
| 2549 | */ |
| 2550 | void SetWindowVariant(wxWindowVariant variant); |
| 2551 | |
| 2552 | /** |
| 2553 | Return @true from here to allow the colours of this window to be changed by |
| 2554 | InheritAttributes(), returning @false forbids inheriting them from the parent window. |
| 2555 | |
| 2556 | The base class version returns @false, but this method is overridden in |
| 2557 | wxControl where it returns @true. |
| 2558 | */ |
| 2559 | virtual bool ShouldInheritColours() const; |
| 2560 | |
| 2561 | /** |
| 2562 | Shows or hides the window. You may need to call Raise() |
| 2563 | for a top level window if you want to bring it to top, although this is not |
| 2564 | needed if Show() is called immediately after the frame creation. |
| 2565 | |
| 2566 | @param show |
| 2567 | If @true displays the window. Otherwise, hides it. |
| 2568 | |
| 2569 | @return @true if the window has been shown or hidden or @false if nothing |
| 2570 | was done because it already was in the requested state. |
| 2571 | |
| 2572 | @see IsShown(), Hide(), wxRadioBox::Show, wxShowEvent. |
| 2573 | */ |
| 2574 | virtual bool Show(bool show = true); |
| 2575 | |
| 2576 | /** |
| 2577 | This function shows a window, like Show(), but using a special visual |
| 2578 | effect if possible. |
| 2579 | |
| 2580 | @param effect |
| 2581 | The effect to use. |
| 2582 | |
| 2583 | @param timeout |
| 2584 | The @a timeout parameter specifies the time of the animation, in |
| 2585 | milliseconds. If the default value of 0 is used, the default |
| 2586 | animation time for the current platform is used. |
| 2587 | |
| 2588 | @note Currently this function is only implemented in wxMSW and does the |
| 2589 | same thing as Show() in the other ports. |
| 2590 | |
| 2591 | @since 2.9.0 |
| 2592 | |
| 2593 | @see HideWithEffect() |
| 2594 | */ |
| 2595 | virtual bool ShowWithEffect(wxShowEffect effect, |
| 2596 | unsigned int timeout = 0); |
| 2597 | |
| 2598 | /** |
| 2599 | Reenables window updating after a previous call to Freeze(). |
| 2600 | |
| 2601 | To really thaw the control, it must be called exactly the same number |
| 2602 | of times as Freeze(). |
| 2603 | |
| 2604 | If the window has any children, they are recursively thawn too. |
| 2605 | |
| 2606 | @see wxWindowUpdateLocker, Freeze(), IsFrozen() |
| 2607 | */ |
| 2608 | void Thaw(); |
| 2609 | |
| 2610 | /** |
| 2611 | Turns the given @a flag on if it's currently turned off and vice versa. |
| 2612 | This function cannot be used if the value of the flag is 0 (which is often |
| 2613 | the case for default flags). |
| 2614 | |
| 2615 | Also, please notice that not all styles can be changed after the control |
| 2616 | creation. |
| 2617 | |
| 2618 | @return Returns @true if the style was turned on by this function, @false |
| 2619 | if it was switched off. |
| 2620 | |
| 2621 | @see SetWindowStyleFlag(), HasFlag() |
| 2622 | */ |
| 2623 | bool ToggleWindowStyle(int flag); |
| 2624 | |
| 2625 | /** |
| 2626 | Transfers values from child controls to data areas specified by their |
| 2627 | validators. Returns @false if a transfer failed. |
| 2628 | |
| 2629 | If the window has @c wxWS_EX_VALIDATE_RECURSIVELY extra style flag set, |
| 2630 | the method will also call TransferDataFromWindow() of all child windows. |
| 2631 | |
| 2632 | @see TransferDataToWindow(), wxValidator, Validate() |
| 2633 | */ |
| 2634 | virtual bool TransferDataFromWindow(); |
| 2635 | |
| 2636 | /** |
| 2637 | Transfers values to child controls from data areas specified by their |
| 2638 | validators. |
| 2639 | |
| 2640 | If the window has @c wxWS_EX_VALIDATE_RECURSIVELY extra style flag set, |
| 2641 | the method will also call TransferDataToWindow() of all child windows. |
| 2642 | |
| 2643 | @return Returns @false if a transfer failed. |
| 2644 | |
| 2645 | @see TransferDataFromWindow(), wxValidator, Validate() |
| 2646 | */ |
| 2647 | virtual bool TransferDataToWindow(); |
| 2648 | |
| 2649 | /** |
| 2650 | Unregisters a system wide hotkey. |
| 2651 | |
| 2652 | @param hotkeyId |
| 2653 | Numeric identifier of the hotkey. Must be the same id that was passed to |
| 2654 | RegisterHotKey(). |
| 2655 | |
| 2656 | @return @true if the hotkey was unregistered successfully, @false if the |
| 2657 | id was invalid. |
| 2658 | |
| 2659 | @remarks This function is currently only implemented under MSW. |
| 2660 | |
| 2661 | @see RegisterHotKey() |
| 2662 | */ |
| 2663 | virtual bool UnregisterHotKey(int hotkeyId); |
| 2664 | |
| 2665 | /** |
| 2666 | Unreserve an ID or range of IDs that was reserved by NewControlId(). |
| 2667 | See @ref overview_windowids for more information. |
| 2668 | |
| 2669 | @param id |
| 2670 | The starting ID of the range of IDs to unreserve. |
| 2671 | @param count |
| 2672 | The number of sequential IDs to unreserve. |
| 2673 | |
| 2674 | @see NewControlId(), wxIdManager, @ref overview_windowids |
| 2675 | */ |
| 2676 | static void UnreserveControlId(wxWindowID id, int count = 1); |
| 2677 | |
| 2678 | /** |
| 2679 | Unset any existing tooltip. |
| 2680 | |
| 2681 | @since 2.9.0 |
| 2682 | |
| 2683 | @see SetToolTip() |
| 2684 | */ |
| 2685 | void UnsetToolTip(); |
| 2686 | |
| 2687 | /** |
| 2688 | Calling this method immediately repaints the invalidated area of the window and |
| 2689 | all of its children recursively while this would usually only happen when the |
| 2690 | flow of control returns to the event loop. |
| 2691 | |
| 2692 | Notice that this function doesn't invalidate any area of the window so |
| 2693 | nothing happens if nothing has been invalidated (i.e. marked as requiring |
| 2694 | a redraw). Use Refresh() first if you want to immediately redraw the |
| 2695 | window unconditionally. |
| 2696 | */ |
| 2697 | virtual void Update(); |
| 2698 | |
| 2699 | /** |
| 2700 | This function sends one or more wxUpdateUIEvent to the window. |
| 2701 | The particular implementation depends on the window; for example a |
| 2702 | wxToolBar will send an update UI event for each toolbar button, |
| 2703 | and a wxFrame will send an update UI event for each menubar menu item. |
| 2704 | |
| 2705 | You can call this function from your application to ensure that your |
| 2706 | UI is up-to-date at this point (as far as your wxUpdateUIEvent handlers |
| 2707 | are concerned). This may be necessary if you have called |
| 2708 | wxUpdateUIEvent::SetMode() or wxUpdateUIEvent::SetUpdateInterval() to limit |
| 2709 | the overhead that wxWidgets incurs by sending update UI events in idle time. |
| 2710 | @a flags should be a bitlist of one or more of the wxUpdateUI enumeration. |
| 2711 | |
| 2712 | If you are calling this function from an OnInternalIdle or OnIdle |
| 2713 | function, make sure you pass the wxUPDATE_UI_FROMIDLE flag, since |
| 2714 | this tells the window to only update the UI elements that need |
| 2715 | to be updated in idle time. Some windows update their elements |
| 2716 | only when necessary, for example when a menu is about to be shown. |
| 2717 | The following is an example of how to call UpdateWindowUI from |
| 2718 | an idle function. |
| 2719 | |
| 2720 | @code |
| 2721 | void MyWindow::OnInternalIdle() |
| 2722 | { |
| 2723 | if (wxUpdateUIEvent::CanUpdate(this)) |
| 2724 | UpdateWindowUI(wxUPDATE_UI_FROMIDLE); |
| 2725 | } |
| 2726 | @endcode |
| 2727 | |
| 2728 | @see wxUpdateUIEvent, DoUpdateWindowUI(), OnInternalIdle() |
| 2729 | */ |
| 2730 | virtual void UpdateWindowUI(long flags = wxUPDATE_UI_NONE); |
| 2731 | |
| 2732 | /** |
| 2733 | Validates the current values of the child controls using their validators. |
| 2734 | If the window has @c wxWS_EX_VALIDATE_RECURSIVELY extra style flag set, |
| 2735 | the method will also call Validate() of all child windows. |
| 2736 | |
| 2737 | @return Returns @false if any of the validations failed. |
| 2738 | |
| 2739 | @see TransferDataFromWindow(), TransferDataToWindow(), |
| 2740 | wxValidator |
| 2741 | */ |
| 2742 | virtual bool Validate(); |
| 2743 | |
| 2744 | /** |
| 2745 | Moves the pointer to the given position on the window. |
| 2746 | |
| 2747 | @note This function is not supported under Mac because Apple Human |
| 2748 | Interface Guidelines forbid moving the mouse cursor programmatically. |
| 2749 | |
| 2750 | @param x |
| 2751 | The new x position for the cursor. |
| 2752 | @param y |
| 2753 | The new y position for the cursor. |
| 2754 | */ |
| 2755 | virtual void WarpPointer(int x, int y); |
| 2756 | |
| 2757 | |
| 2758 | protected: |
| 2759 | |
| 2760 | /** |
| 2761 | Gets the size which best suits the window: for a control, it would be |
| 2762 | the minimal size which doesn't truncate the control, for a panel - the |
| 2763 | same size as it would have after a call to Fit(). |
| 2764 | |
| 2765 | The default implementation of this function is designed for use in container |
| 2766 | windows, such as wxPanel, and works something like this: |
| 2767 | -# If the window has a sizer then it is used to calculate the best size. |
| 2768 | -# Otherwise if the window has layout constraints then those are used to |
| 2769 | calculate the best size. |
| 2770 | -# Otherwise if the window has children then the best size is set to be large |
| 2771 | enough to show all the children. |
| 2772 | -# Otherwise if there are no children then the window's minimal size will be |
| 2773 | used as its best size. |
| 2774 | -# Otherwise if there is no minimal size set, then the current size is used |
| 2775 | for the best size. |
| 2776 | |
| 2777 | @see @ref overview_windowsizing |
| 2778 | */ |
| 2779 | virtual wxSize DoGetBestSize() const; |
| 2780 | |
| 2781 | |
| 2782 | /** |
| 2783 | Sets the initial window size if none is given (i.e. at least one of the |
| 2784 | components of the size passed to ctor/Create() is wxDefaultCoord). |
| 2785 | @deprecated @todo provide deprecation description |
| 2786 | */ |
| 2787 | virtual void SetInitialBestSize(const wxSize& size); |
| 2788 | }; |
| 2789 | |
| 2790 | |
| 2791 | |
| 2792 | // ============================================================================ |
| 2793 | // Global functions/macros |
| 2794 | // ============================================================================ |
| 2795 | |
| 2796 | /** @ingroup group_funcmacro_misc */ |
| 2797 | //@{ |
| 2798 | |
| 2799 | /** |
| 2800 | Find the deepest window at the mouse pointer position, returning the window |
| 2801 | and current pointer position in screen coordinates. |
| 2802 | |
| 2803 | @header{wx/window.h} |
| 2804 | */ |
| 2805 | wxWindow* wxFindWindowAtPointer(wxPoint& pt); |
| 2806 | |
| 2807 | /** |
| 2808 | Gets the currently active window (implemented for MSW and GTK only |
| 2809 | currently, always returns @NULL in the other ports). |
| 2810 | |
| 2811 | @header{wx/window.h} |
| 2812 | */ |
| 2813 | wxWindow* wxGetActiveWindow(); |
| 2814 | |
| 2815 | /** |
| 2816 | Returns the first top level parent of the given window, or in other words, |
| 2817 | the frame or dialog containing it, or @NULL. |
| 2818 | |
| 2819 | @header{wx/window.h} |
| 2820 | */ |
| 2821 | wxWindow* wxGetTopLevelParent(wxWindow* window); |
| 2822 | |
| 2823 | //@} |
| 2824 | |