]>
git.saurik.com Git - wxWidgets.git/blob - interface/wx/toplevel.h
1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: interface of wxTopLevelWindow
4 // Author: wxWidgets team
6 // Licence: wxWindows licence
7 /////////////////////////////////////////////////////////////////////////////
10 Styles used with wxTopLevelWindow::RequestUserAttention().
14 wxUSER_ATTENTION_INFO
= 1, ///< Requests user attention,
15 wxUSER_ATTENTION_ERROR
= 2 ///< Results in a more drastic action.
19 Styles used with wxTopLevelWindow::ShowFullScreen().
23 wxFULLSCREEN_NOMENUBAR
= 0x0001, ///< Don't display the menu bar.
24 wxFULLSCREEN_NOTOOLBAR
= 0x0002, ///< Don't display toolbar bars.
25 wxFULLSCREEN_NOSTATUSBAR
= 0x0004, ///< Don't display the status bar.
26 wxFULLSCREEN_NOBORDER
= 0x0008, ///< Don't display any border.
27 wxFULLSCREEN_NOCAPTION
= 0x0010, ///< Don't display a caption.
30 Combination of all above, will display the least possible.
32 wxFULLSCREEN_ALL
= wxFULLSCREEN_NOMENUBAR
| wxFULLSCREEN_NOTOOLBAR
|
33 wxFULLSCREEN_NOSTATUSBAR
| wxFULLSCREEN_NOBORDER
|
34 wxFULLSCREEN_NOCAPTION
38 @class wxTopLevelWindow
40 wxTopLevelWindow is a common base class for wxDialog and wxFrame. It is an
41 abstract base class meaning that you never work with objects of this class
42 directly, but all of its methods are also applicable for the two classes
45 Note that the instances of wxTopLevelWindow are managed by wxWidgets in the
46 internal top level window list.
48 @beginEventEmissionTable
49 @event{EVT_ACTIVATE(id, func)}
50 Process a @c wxEVT_MAXIMIZE event. See wxMaximizeEvent.
51 @event{EVT_MOVE(func)}
52 Process a @c wxEVT_MOVE event, which is generated when a window is moved.
54 @event{EVT_MOVE_START(func)}
55 Process a @c wxEVT_MOVE_START event, which is generated when the user starts
56 to move or size a window. wxMSW only.
58 @event{EVT_MOVE_END(func)}
59 Process a @c wxEVT_MOVE_END event, which is generated when the user stops
60 moving or sizing a window. wxMSW only.
62 @event{EVT_SHOW(func)}
63 Process a @c wxEVT_SHOW event. See wxShowEvent.
69 @see wxDialog, wxFrame
71 class wxTopLevelWindow
: public wxWindow
80 Constructor creating the top level window.
82 wxTopLevelWindow(wxWindow
*parent
,
84 const wxString
& title
,
85 const wxPoint
& pos
= wxDefaultPosition
,
86 const wxSize
& size
= wxDefaultSize
,
87 long style
= wxDEFAULT_FRAME_STYLE
,
88 const wxString
& name
= wxFrameNameStr
);
91 Destructor. Remember that wxTopLevelWindows do not get immediately
92 destroyed when the user (or the app) closes them; they have a
93 @b delayed destruction.
95 See @ref overview_windowdeletion for more info.
97 virtual ~wxTopLevelWindow();
100 Creates the top level window.
102 bool Create(wxWindow
*parent
,
104 const wxString
& title
,
105 const wxPoint
& pos
= wxDefaultPosition
,
106 const wxSize
& size
= wxDefaultSize
,
107 long style
= wxDEFAULT_FRAME_STYLE
,
108 const wxString
& name
= wxFrameNameStr
);
111 Returns @true if the platform supports making the window translucent.
113 @see SetTransparent()
115 virtual bool CanSetTransparent();
118 A synonym for CentreOnScreen().
120 void CenterOnScreen(int direction
);
123 Centres the window on screen.
126 Specifies the direction for the centering. May be @c wxHORIZONTAL,
127 @c wxVERTICAL or @c wxBOTH.
129 @see wxWindow::CentreOnParent()
131 void CentreOnScreen(int direction
= wxBOTH
);
134 Enables or disables the Close button (most often in the right upper
135 corner of a dialog) and the Close entry of the system menu (most often
136 in the left upper corner of the dialog).
138 Currently only implemented for wxMSW and wxGTK.
140 Returns @true if operation was successful. This may be wrong on X11
141 (including GTK+) where the window manager may not support this operation
142 and there is no way to find out.
144 virtual bool EnableCloseButton(bool enable
= true);
147 Returns a pointer to the button which is the default for this window, or
148 @c @NULL. The default button is the one activated by pressing the Enter
151 wxWindow
* GetDefaultItem() const;
154 Get the default size for a new top level window.
156 This is used internally by wxWidgets on some platforms to determine the
157 default size for a window created using ::wxDefaultSize so it is not
158 necessary to use it when creating a wxTopLevelWindow, however it may be
159 useful if a rough estimation of the window size is needed for some
164 static wxSize
GetDefaultSize();
167 Returns the standard icon of the window. The icon will be invalid if it
168 hadn't been previously set by SetIcon().
172 wxIcon
GetIcon() const;
175 Returns all icons associated with the window, there will be none of them
176 if neither SetIcon() nor SetIcons() had been called before. Use
177 GetIcon() to get the main icon of the window.
181 const wxIconBundle
& GetIcons() const;
184 Gets a string containing the window title.
188 virtual wxString
GetTitle() const;
191 Unique to the wxWinCE port. Responds to showing/hiding SIP (soft input
192 panel) area and resize window accordingly. Override this if you want to
193 avoid resizing or do additional operations.
195 virtual bool HandleSettingChange(WXWPARAM wParam
,
199 Iconizes or restores the window.
202 If @true, iconizes the window; if @false, shows and restores it.
204 @see IsIconized(), Maximize(), wxIconizeEvent.
206 virtual void Iconize(bool iconize
= true);
209 Returns @true if this window is currently active, i.e. if the user is
210 currently working with it.
212 virtual bool IsActive();
215 Returns @true if this window is expected to be always maximized, either
216 due to platform policy or due to local policy regarding particular
219 virtual bool IsAlwaysMaximized() const;
222 Returns @true if the window is in fullscreen mode.
224 @see ShowFullScreen()
226 virtual bool IsFullScreen() const;
229 Returns @true if the window is iconized.
231 virtual bool IsIconized() const;
234 Returns @true if the window is maximized.
236 virtual bool IsMaximized() const;
239 This method is specific to wxUniversal port.
241 Returns @true if this window is using native decorations, @false if we
244 @see UseNativeDecorations(),
245 UseNativeDecorationsByDefault()
247 bool IsUsingNativeDecorations() const;
250 See wxWindow::SetAutoLayout(): when auto layout is on, this function gets
251 called automatically when the window is resized.
253 virtual bool Layout();
256 Maximizes or restores the window.
259 If @true, maximizes the window, otherwise it restores it.
263 virtual void Maximize(bool maximize
= true);
266 Use a system-dependent way to attract users attention to the window when
269 @a flags may have the value of either @c ::wxUSER_ATTENTION_INFO
270 (default) or @c ::wxUSER_ATTENTION_ERROR which results in a more drastic
271 action. When in doubt, use the default value.
274 @note This function should normally be only used when the application
275 is not already in foreground.
277 This function is currently implemented for Win32 where it flashes
278 the window icon in the taskbar, and for wxGTK with task bars
282 virtual void RequestUserAttention(int flags
= wxUSER_ATTENTION_INFO
);
285 Changes the default item for the panel, usually @a win is a button.
287 @see GetDefaultItem()
289 wxWindow
* SetDefaultItem(wxWindow
* win
);
292 Sets the icon for this window.
295 The wxIcon to associate with this window.
297 @remarks The window takes a 'copy' of @a icon, but since it uses
298 reference counting, the copy is very quick. It is safe to
299 delete @a icon after calling this function.
301 @note In wxMSW, @a icon must be either 16x16 or 32x32 icon.
303 @see wxIcon, SetIcons()
305 void SetIcon(const wxIcon
& icon
);
308 Sets several icons of different sizes for this window: this allows to
309 use different icons for different situations (e.g. task switching bar,
310 taskbar, window title bar) instead of scaling, with possibly bad looking
311 results, the only icon set by SetIcon().
314 The icons to associate with this window.
316 @note In wxMSW, @a icons must contain a 16x16 or 32x32 icon,
321 virtual void SetIcons(const wxIconBundle
& icons
);
324 Sets action or menu activated by pressing left hardware button on the
325 smart phones. Unavailable on full keyboard machines.
328 Identifier for this button.
330 Text to be displayed on the screen area dedicated to this hardware
333 The menu to be opened after pressing this hardware button.
337 void SetLeftMenu(int id
= wxID_ANY
,
338 const wxString
& label
= wxEmptyString
,
339 wxMenu
* subMenu
= NULL
);
342 A simpler interface for setting the size hints than SetSizeHints().
344 virtual void SetMaxSize(const wxSize
& size
);
347 A simpler interface for setting the size hints than SetSizeHints().
349 virtual void SetMinSize(const wxSize
& size
);
352 Sets action or menu activated by pressing right hardware button on the
353 smart phones. Unavailable on full keyboard machines.
356 Identifier for this button.
358 Text to be displayed on the screen area dedicated to this hardware
361 The menu to be opened after pressing this hardware button.
365 void SetRightMenu(int id
= wxID_ANY
,
366 const wxString
& label
= wxEmptyString
,
367 wxMenu
* subMenu
= NULL
);
370 If the platform supports it, sets the shape of the window to that
371 depicted by @a region. The system will not display or respond to any
372 mouse event for the pixels that lie outside of the region. To reset the
373 window to the normal rectangular shape simply call SetShape() again with
374 an empty wxRegion. Returns @true if the operation is successful.
376 virtual bool SetShape(const wxRegion
& region
);
379 Allows specification of minimum and maximum window sizes, and window
380 size increments. If a pair of values is not set (or set to -1), no
381 constraints will be used.
392 Specifies the increment for sizing the width (GTK/Motif/Xt only).
394 Specifies the increment for sizing the height (GTK/Motif/Xt only).
396 @remarks Notice that this function not only prevents the user from
397 resizing the window outside the given bounds but it also
398 prevents the program itself from doing it using
402 virtual void SetSizeHints(int minW
, int minH
,
403 int maxW
= -1, int maxH
= -1,
404 int incW
= -1, int incH
= -1);
407 Allows specification of minimum and maximum window sizes, and window
408 size increments. If a pair of values is not set (or set to -1), no
409 constraints will be used.
412 The minimum size of the window.
414 The maximum size of the window.
416 Increment size (only taken into account under X11-based ports such
417 as wxGTK/wxMotif/wxX11).
419 @remarks Notice that this function not only prevents the user from
420 resizing the window outside the given bounds but it also
421 prevents the program itself from doing it using
424 void SetSizeHints(const wxSize
& minSize
,
425 const wxSize
& maxSize
= wxDefaultSize
,
426 const wxSize
& incSize
= wxDefaultSize
);
429 Sets the window title.
436 virtual void SetTitle(const wxString
& title
);
439 If the platform supports it will set the window to be translucent.
442 Determines how opaque or transparent the window will be, if the
443 platform supports the opreration. A value of 0 sets the window to be
444 fully transparent, and a value of 255 sets the window to be fully
447 virtual bool SetTransparent(wxByte alpha
);
450 This virtual function is not meant to be called directly but can be
451 overridden to return @false (it returns @true by default) to allow the
452 application to close even if this, presumably not very important, window
453 is still opened. By default, the application stays alive as long as
454 there are any open top level windows.
456 virtual bool ShouldPreventAppExit() const;
459 This function sets the wxTopLevelWindow's modified state on OS X,
460 which currently draws a black dot in the wxTopLevelWindow's close button.
461 On other platforms, this method does nothing.
465 virtual void OSXSetModified(bool modified
);
468 Returns the current modified state of the wxTopLevelWindow on OS X.
469 On other platforms, this method does nothing.
471 @see OSXSetModified()
473 virtual bool OSXIsModified() const;
476 Depending on the value of @a show parameter the window is either shown
477 full screen or restored to its normal state. @a style is a bit list
478 containing some or all of the following values, which indicate what
479 elements of the window to hide in full-screen mode:
481 - @c ::wxFULLSCREEN_NOMENUBAR
482 - @c ::wxFULLSCREEN_NOTOOLBAR
483 - @c ::wxFULLSCREEN_NOSTATUSBAR
484 - @c ::wxFULLSCREEN_NOBORDER
485 - @c ::wxFULLSCREEN_NOCAPTION
486 - @c ::wxFULLSCREEN_ALL (all of the above)
488 This function has not been tested with MDI frames.
490 @note Showing a window full screen also actually @ref wxWindow::Show()
491 "Show()"s the window if it isn't shown.
495 virtual bool ShowFullScreen(bool show
, long style
= wxFULLSCREEN_ALL
);
498 This method is specific to wxUniversal port.
500 Use native or custom-drawn decorations for this window only. Notice that
501 to have any effect this method must be called before really creating the
502 window, i.e. two step creation must be used:
505 MyFrame *frame = new MyFrame; // use default ctor
506 frame->UseNativeDecorations(false); // change from default "true"
507 frame->Create(parent, title, ...); // really create the frame
510 @see UseNativeDecorationsByDefault(),
511 IsUsingNativeDecorations()
513 void UseNativeDecorations(bool native
= true);
516 This method is specific to wxUniversal port.
518 Top level windows in wxUniversal port can use either system-provided
519 window decorations (i.e. title bar and various icons, buttons and menus
520 in it) or draw the decorations themselves. By default the system
521 decorations are used if they are available, but this method can be
522 called with @a native set to @false to change this for all windows
523 created after this point.
525 Also note that if @c WXDECOR environment variable is set, then custom
526 decorations are used by default and so it may make sense to call this
527 method with default argument if the application can't use custom
528 decorations at all for some reason.
530 @see UseNativeDecorations()
532 void UseNativeDecorationsByDefault(bool native
= true);