1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597
|
/////////////////////////////////////////////////////////////////////////////
// Name: toplevel.h
// Purpose: interface of wxTopLevelWindow
// Author: wxWidgets team
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
Styles used with wxTopLevelWindow::RequestUserAttention().
*/
enum
{
wxUSER_ATTENTION_INFO = 1, ///< Requests user attention,
wxUSER_ATTENTION_ERROR = 2 ///< Results in a more drastic action.
};
/**
Styles used with wxTopLevelWindow::ShowFullScreen().
*/
enum
{
wxFULLSCREEN_NOMENUBAR = 0x0001, ///< Don't display the menu bar.
wxFULLSCREEN_NOTOOLBAR = 0x0002, ///< Don't display toolbar bars.
wxFULLSCREEN_NOSTATUSBAR = 0x0004, ///< Don't display the status bar.
wxFULLSCREEN_NOBORDER = 0x0008, ///< Don't display any border.
wxFULLSCREEN_NOCAPTION = 0x0010, ///< Don't display a caption.
/**
Combination of all above, will display the least possible.
*/
wxFULLSCREEN_ALL = wxFULLSCREEN_NOMENUBAR | wxFULLSCREEN_NOTOOLBAR |
wxFULLSCREEN_NOSTATUSBAR | wxFULLSCREEN_NOBORDER |
wxFULLSCREEN_NOCAPTION
};
#define wxDEFAULT_FRAME_STYLE (wxSYSTEM_MENU | \
wxRESIZE_BORDER | \
wxMINIMIZE_BOX | \
wxMAXIMIZE_BOX | \
wxCLOSE_BOX | \
wxCAPTION | \
wxCLIP_CHILDREN)
/**
@class wxTopLevelWindow
wxTopLevelWindow is a common base class for wxDialog and wxFrame. It is an
abstract base class meaning that you never work with objects of this class
directly, but all of its methods are also applicable for the two classes
above.
Note that the instances of wxTopLevelWindow are managed by wxWidgets in the
internal top level window list.
@beginEventEmissionTable
@event{EVT_MAXIMIZE(id, func)}
Process a @c wxEVT_MAXIMIZE event. See wxMaximizeEvent.
@event{EVT_MOVE(func)}
Process a @c wxEVT_MOVE event, which is generated when a window is moved.
See wxMoveEvent.
@event{EVT_MOVE_START(func)}
Process a @c wxEVT_MOVE_START event, which is generated when the user starts
to move or size a window. wxMSW only.
See wxMoveEvent.
@event{EVT_MOVE_END(func)}
Process a @c wxEVT_MOVE_END event, which is generated when the user stops
moving or sizing a window. wxMSW only.
See wxMoveEvent.
@event{EVT_SHOW(func)}
Process a @c wxEVT_SHOW event. See wxShowEvent.
@endEventTable
@library{wxcore}
@category{managedwnd}
@see wxDialog, wxFrame
*/
class wxTopLevelWindow : public wxNonOwnedWindow
{
public:
/**
Default ctor.
*/
wxTopLevelWindow();
/**
Constructor creating the top level window.
*/
wxTopLevelWindow(wxWindow *parent,
wxWindowID id,
const wxString& title,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxDEFAULT_FRAME_STYLE,
const wxString& name = wxFrameNameStr);
/**
Destructor. Remember that wxTopLevelWindows do not get immediately
destroyed when the user (or the app) closes them; they have a
@b delayed destruction.
See @ref overview_windowdeletion for more info.
*/
virtual ~wxTopLevelWindow();
/**
Creates the top level window.
*/
bool Create(wxWindow *parent,
wxWindowID id,
const wxString& title,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxDEFAULT_FRAME_STYLE,
const wxString& name = wxFrameNameStr);
/**
Returns @true if the platform supports making the window translucent.
@see SetTransparent()
*/
virtual bool CanSetTransparent();
/**
A synonym for CentreOnScreen().
*/
void CenterOnScreen(int direction = wxBOTH);
/**
Centres the window on screen.
@param direction
Specifies the direction for the centering. May be @c wxHORIZONTAL,
@c wxVERTICAL or @c wxBOTH.
@see wxWindow::CentreOnParent()
*/
void CentreOnScreen(int direction = wxBOTH);
/**
Enables or disables the Close button (most often in the right upper
corner of a dialog) and the Close entry of the system menu (most often
in the left upper corner of the dialog).
Currently only implemented for wxMSW and wxGTK.
Returns @true if operation was successful. This may be wrong on X11
(including GTK+) where the window manager may not support this operation
and there is no way to find out.
*/
virtual bool EnableCloseButton(bool enable = true);
/**
Returns a pointer to the button which is the default for this window, or
@c @NULL. The default button is the one activated by pressing the Enter
key.
*/
wxWindow* GetDefaultItem() const;
/**
Get the default size for a new top level window.
This is used internally by wxWidgets on some platforms to determine the
default size for a window created using ::wxDefaultSize so it is not
necessary to use it when creating a wxTopLevelWindow, however it may be
useful if a rough estimation of the window size is needed for some
other reason.
@since 2.9.2
*/
static wxSize GetDefaultSize();
/**
Returns the standard icon of the window. The icon will be invalid if it
hadn't been previously set by SetIcon().
@see GetIcons()
*/
wxIcon GetIcon() const;
/**
Returns all icons associated with the window, there will be none of them
if neither SetIcon() nor SetIcons() had been called before. Use
GetIcon() to get the main icon of the window.
@see wxIconBundle
*/
const wxIconBundle& GetIcons() const;
/**
Gets a string containing the window title.
@see SetTitle()
*/
virtual wxString GetTitle() const;
/**
Unique to the wxWinCE port. Responds to showing/hiding SIP (soft input
panel) area and resize window accordingly. Override this if you want to
avoid resizing or do additional operations.
*/
virtual bool HandleSettingChange(WXWPARAM wParam,
WXLPARAM lParam);
/**
Iconizes or restores the window.
@param iconize
If @true, iconizes the window; if @false, shows and restores it.
@see IsIconized(), Maximize(), wxIconizeEvent.
*/
virtual void Iconize(bool iconize = true);
/**
Returns @true if this window is currently active, i.e.\ if the user is
currently working with it.
*/
virtual bool IsActive();
/**
Returns @true if this window is expected to be always maximized, either
due to platform policy or due to local policy regarding particular
class.
*/
virtual bool IsAlwaysMaximized() const;
/**
Returns @true if the window is in fullscreen mode.
@see ShowFullScreen()
*/
virtual bool IsFullScreen() const;
/**
Returns @true if the window is iconized.
*/
virtual bool IsIconized() const;
/**
Returns @true if the window is maximized.
*/
virtual bool IsMaximized() const;
/**
This method is specific to wxUniversal port.
Returns @true if this window is using native decorations, @false if we
draw them ourselves.
@see UseNativeDecorations(),
UseNativeDecorationsByDefault()
*/
bool IsUsingNativeDecorations() const;
/**
See wxWindow::SetAutoLayout(): when auto layout is on, this function gets
called automatically when the window is resized.
*/
virtual bool Layout();
/**
Maximizes or restores the window.
@param maximize
If @true, maximizes the window, otherwise it restores it.
@see Iconize()
*/
virtual void Maximize(bool maximize = true);
/**
MSW-specific function for accessing the system menu.
Returns a wxMenu pointer representing the system menu of the window
under MSW. The returned wxMenu may be used, if non-@c NULL, to add
extra items to the system menu. The usual @c wxEVT_MENU
events (that can be processed using @c EVT_MENU event table macro) will
then be generated for them. All the other wxMenu methods may be used as
well but notice that they won't allow you to access any standard system
menu items (e.g. they can't be deleted or modified in any way
currently).
Notice that because of the native system limitations the identifiers of
the items added to the system menu must be multiples of 16, otherwise
no events will be generated for them.
The returned pointer must @em not be deleted, it is owned by the window
and will be only deleted when the window itself is destroyed.
This function is not available in the other ports by design, any
occurrences of it in the portable code must be guarded by
@code #ifdef __WXMSW__ @endcode preprocessor guards.
@since 2.9.3
*/
wxMenu *MSWGetSystemMenu() const;
/**
Use a system-dependent way to attract users attention to the window when
it is in background.
@a flags may have the value of either @c ::wxUSER_ATTENTION_INFO
(default) or @c ::wxUSER_ATTENTION_ERROR which results in a more drastic
action. When in doubt, use the default value.
@note This function should normally be only used when the application
is not already in foreground.
This function is currently implemented for Win32 where it flashes
the window icon in the taskbar, and for wxGTK with task bars
supporting it.
*/
virtual void RequestUserAttention(int flags = wxUSER_ATTENTION_INFO);
/**
Restore a previously iconized or maximized window to its normal state.
In wxGTK this method currently doesn't return the maximized window to
its normal state and you must use Maximize() with @false argument
explicitly for this. In the other ports, it both unmaximizes the
maximized windows and uniconizes the iconized ones.
@see Iconize(), Maximize()
*/
void Restore();
/**
Changes the default item for the panel, usually @a win is a button.
@see GetDefaultItem()
*/
wxWindow* SetDefaultItem(wxWindow* win);
wxWindow* SetTmpDefaultItem(wxWindow * win);
wxWindow* GetTmpDefaultItem() const;
/**
Sets the icon for this window.
@param icon
The wxIcon to associate with this window.
@remarks The window takes a 'copy' of @a icon, but since it uses
reference counting, the copy is very quick. It is safe to
delete @a icon after calling this function.
@note In wxMSW, @a icon must be either 16x16 or 32x32 icon.
@see wxIcon, SetIcons()
*/
void SetIcon(const wxIcon& icon);
/**
Sets several icons of different sizes for this window: this allows
using different icons for different situations (e.g. task switching bar,
taskbar, window title bar) instead of scaling, with possibly bad looking
results, the only icon set by SetIcon().
@param icons
The icons to associate with this window.
@note In wxMSW, @a icons must contain a 16x16 or 32x32 icon,
preferably both.
@see wxIconBundle
*/
virtual void SetIcons(const wxIconBundle& icons);
/**
Sets action or menu activated by pressing left hardware button on the
smart phones. Unavailable on full keyboard machines.
@param id
Identifier for this button.
@param label
Text to be displayed on the screen area dedicated to this hardware
button.
@param subMenu
The menu to be opened after pressing this hardware button.
@see SetRightMenu().
*/
void SetLeftMenu(int id = wxID_ANY,
const wxString& label = wxEmptyString,
wxMenu* subMenu = NULL);
/**
A simpler interface for setting the size hints than SetSizeHints().
*/
virtual void SetMaxSize(const wxSize& size);
/**
A simpler interface for setting the size hints than SetSizeHints().
*/
virtual void SetMinSize(const wxSize& size);
/**
Sets action or menu activated by pressing right hardware button on the
smart phones. Unavailable on full keyboard machines.
@param id
Identifier for this button.
@param label
Text to be displayed on the screen area dedicated to this hardware
button.
@param subMenu
The menu to be opened after pressing this hardware button.
@see SetLeftMenu().
*/
void SetRightMenu(int id = wxID_ANY,
const wxString& label = wxEmptyString,
wxMenu* subMenu = NULL);
/**
Allows specification of minimum and maximum window sizes, and window
size increments. If a pair of values is not set (or set to -1), no
constraints will be used.
@param minW
The minimum width.
@param minH
The minimum height.
@param maxW
The maximum width.
@param maxH
The maximum height.
@param incW
Specifies the increment for sizing the width (GTK/Motif/Xt only).
@param incH
Specifies the increment for sizing the height (GTK/Motif/Xt only).
@remarks Notice that this function not only prevents the user from
resizing the window outside the given bounds but it also
prevents the program itself from doing it using
wxWindow::SetSize().
*/
virtual void SetSizeHints(int minW, int minH,
int maxW = -1, int maxH = -1,
int incW = -1, int incH = -1);
/**
Allows specification of minimum and maximum window sizes, and window
size increments. If a pair of values is not set (or set to -1), no
constraints will be used.
@param minSize
The minimum size of the window.
@param maxSize
The maximum size of the window.
@param incSize
Increment size (only taken into account under X11-based ports such
as wxGTK/wxMotif/wxX11).
@remarks Notice that this function not only prevents the user from
resizing the window outside the given bounds but it also
prevents the program itself from doing it using
wxWindow::SetSize().
*/
void SetSizeHints(const wxSize& minSize,
const wxSize& maxSize = wxDefaultSize,
const wxSize& incSize = wxDefaultSize);
/**
Sets the window title.
@param title
The window title.
@see GetTitle()
*/
virtual void SetTitle(const wxString& title);
/**
If the platform supports it will set the window to be translucent.
@param alpha
Determines how opaque or transparent the window will be, if the
platform supports the operation. A value of 0 sets the window to be
fully transparent, and a value of 255 sets the window to be fully
opaque.
*/
virtual bool SetTransparent(wxByte alpha);
/**
This virtual function is not meant to be called directly but can be
overridden to return @false (it returns @true by default) to allow the
application to close even if this, presumably not very important, window
is still opened. By default, the application stays alive as long as
there are any open top level windows.
*/
virtual bool ShouldPreventAppExit() const;
/**
This function sets the wxTopLevelWindow's modified state on OS X,
which currently draws a black dot in the wxTopLevelWindow's close button.
On other platforms, this method does nothing.
@see OSXIsModified()
*/
virtual void OSXSetModified(bool modified);
/**
Returns the current modified state of the wxTopLevelWindow on OS X.
On other platforms, this method does nothing.
@see OSXSetModified()
*/
virtual bool OSXIsModified() const;
/**
Sets the file name represented by this wxTopLevelWindow.
Under OS X, this file name is used to set the "proxy icon", which
appears in the window title bar near its title, corresponding to this
file name. Under other platforms it currently doesn't do anything but
it is harmless to call it now and it might be implemented to do
something useful in the future so you're encouraged to use it for any
window representing a file-based document.
@since 2.9.4
*/
virtual void SetRepresentedFilename(const wxString& filename);
/**
Show the wxTopLevelWindow, but do not give it keyboard focus. This can be
used for pop up or notification windows that should not steal the current
focus.
*/
virtual void ShowWithoutActivating();
/**
Depending on the value of @a show parameter the window is either shown
full screen or restored to its normal state. @a style is a bit list
containing some or all of the following values, which indicate what
elements of the window to hide in full-screen mode:
- @c ::wxFULLSCREEN_NOMENUBAR
- @c ::wxFULLSCREEN_NOTOOLBAR
- @c ::wxFULLSCREEN_NOSTATUSBAR
- @c ::wxFULLSCREEN_NOBORDER
- @c ::wxFULLSCREEN_NOCAPTION
- @c ::wxFULLSCREEN_ALL (all of the above)
This function has not been tested with MDI frames.
@note Showing a window full screen also actually @ref wxWindow::Show()
"Show()"s the window if it isn't shown.
@see IsFullScreen()
*/
virtual bool ShowFullScreen(bool show, long style = wxFULLSCREEN_ALL);
/**
This method is specific to wxUniversal port.
Use native or custom-drawn decorations for this window only. Notice that
to have any effect this method must be called before really creating the
window, i.e. two step creation must be used:
@code
MyFrame *frame = new MyFrame; // use default ctor
frame->UseNativeDecorations(false); // change from default "true"
frame->Create(parent, title, ...); // really create the frame
@endcode
@see UseNativeDecorationsByDefault(),
IsUsingNativeDecorations()
*/
void UseNativeDecorations(bool native = true);
/**
This method is specific to wxUniversal port.
Top level windows in wxUniversal port can use either system-provided
window decorations (i.e. title bar and various icons, buttons and menus
in it) or draw the decorations themselves. By default the system
decorations are used if they are available, but this method can be
called with @a native set to @false to change this for all windows
created after this point.
Also note that if @c WXDECOR environment variable is set, then custom
decorations are used by default and so it may make sense to call this
method with default argument if the application can't use custom
decorations at all for some reason.
@see UseNativeDecorations()
*/
void UseNativeDecorationsByDefault(bool native = true);
};
|