]>
git.saurik.com Git - wxWidgets.git/blob - interface/wx/toplevel.h
1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: interface of wxTopLevelWindow
4 // Author: wxWidgets team
6 // Licence: wxWindows license
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
48 @see wxDialog, wxFrame
50 class wxTopLevelWindow
: public wxWindow
54 Returns @true if the platform supports making the window translucent.
58 virtual bool CanSetTransparent();
61 A synonym for CentreOnScreen().
63 void CenterOnScreen(int direction
);
66 Centres the window on screen.
69 Specifies the direction for the centering. May be @c wxHORIZONTAL,
70 @c wxVERTICAL or @c wxBOTH.
72 @see wxWindow::CentreOnParent()
74 void CentreOnScreen(int direction
= wxBOTH
);
77 Enables or disables the Close button (most often in the right upper
78 corner of a dialog) and the Close entry of the system menu (most often
79 in the left upper corner of the dialog).
81 Currently only implemented for wxMSW and wxGTK.
83 Returns @true if operation was successful. This may be wrong on X11
84 (including GTK+) where the window manager may not support this operation
85 and there is no way to find out.
87 virtual bool EnableCloseButton(bool enable
= true);
90 Returns a pointer to the button which is the default for this window, or
91 @c @NULL. The default button is the one activated by pressing the Enter
94 wxWindow
* GetDefaultItem() const;
97 Returns the standard icon of the window. The icon will be invalid if it
98 hadn't been previously set by SetIcon().
102 wxIcon
GetIcon() const;
105 Returns all icons associated with the window, there will be none of them
106 if neither SetIcon() nor SetIcons() had been called before. Use
107 GetIcon() to get the main icon of the window.
111 const wxIconBundle
& GetIcons() const;
114 Gets a string containing the window title.
118 virtual wxString
GetTitle() const;
121 Unique to the wxWinCE port. Responds to showing/hiding SIP (soft input
122 panel) area and resize window accordingly. Override this if you want to
123 avoid resizing or do additional operations.
125 virtual bool HandleSettingChange(WXWPARAM wParam
,
129 Iconizes or restores the window.
132 If @true, iconizes the window; if @false, shows and restores it.
134 @see IsIconized(), Maximize(), wxIconizeEvent.
136 virtual void Iconize(bool iconize
= true);
139 Returns @true if this window is currently active, i.e. if the user is
140 currently working with it.
142 virtual bool IsActive();
145 Returns @true if this window is expected to be always maximized, either
146 due to platform policy or due to local policy regarding particular
149 virtual bool IsAlwaysMaximized() const;
152 Returns @true if the window is in fullscreen mode.
154 @see ShowFullScreen()
156 virtual bool IsFullScreen() const;
159 Returns @true if the window is iconized.
161 virtual bool IsIconized() const;
164 Returns @true if the window is maximized.
166 virtual bool IsMaximized() const;
169 This method is specific to wxUniversal port.
171 Returns @true if this window is using native decorations, @false if we
174 @see UseNativeDecorations(),
175 UseNativeDecorationsByDefault()
177 bool IsUsingNativeDecorations() const;
180 Maximizes or restores the window.
183 If @true, maximizes the window, otherwise it restores it.
187 virtual void Maximize(bool maximize
= true);
190 Use a system-dependent way to attract users attention to the window when
193 @a flags may have the value of either @c ::wxUSER_ATTENTION_INFO
194 (default) or @c ::wxUSER_ATTENTION_ERROR which results in a more drastic
195 action. When in doubt, use the default value.
198 @note This function should normally be only used when the application
199 is not already in foreground.
201 This function is currently implemented for Win32 where it flashes
202 the window icon in the taskbar, and for wxGTK with task bars
206 virtual void RequestUserAttention(int flags
= wxUSER_ATTENTION_INFO
);
209 Changes the default item for the panel, usually @a win is a button.
211 @see GetDefaultItem()
213 wxWindow
* SetDefaultItem(wxWindow
* win
);
216 Sets the icon for this window.
219 The wxIcon to associate with this window.
221 @remarks The window takes a 'copy' of @a icon, but since it uses
222 reference counting, the copy is very quick. It is safe to
223 delete @a icon after calling this function.
225 @note In wxMSW, @a icon must be either 16x16 or 32x32 icon.
227 @see wxIcon, SetIcons()
229 void SetIcon(const wxIcon
& icon
);
232 Sets several icons of different sizes for this window: this allows to
233 use different icons for different situations (e.g. task switching bar,
234 taskbar, window title bar) instead of scaling, with possibly bad looking
235 results, the only icon set by SetIcon().
238 The icons to associate with this window.
240 @note In wxMSW, @a icons must contain a 16x16 or 32x32 icon,
245 virtual void SetIcons(const wxIconBundle
& icons
);
248 Sets action or menu activated by pressing left hardware button on the
249 smart phones. Unavailable on full keyboard machines.
252 Identifier for this button.
254 Text to be displayed on the screen area dedicated to this hardware
257 The menu to be opened after pressing this hardware button.
261 void SetLeftMenu(int id
= wxID_ANY
,
262 const wxString
& label
= wxEmptyString
,
263 wxMenu
* subMenu
= NULL
);
266 A simpler interface for setting the size hints than SetSizeHints().
268 virtual void SetMaxSize(const wxSize
& size
);
271 A simpler interface for setting the size hints than SetSizeHints().
273 virtual void SetMinSize(const wxSize
& size
);
276 Sets action or menu activated by pressing right hardware button on the
277 smart phones. Unavailable on full keyboard machines.
280 Identifier for this button.
282 Text to be displayed on the screen area dedicated to this hardware
285 The menu to be opened after pressing this hardware button.
289 void SetRightMenu(int id
= wxID_ANY
,
290 const wxString
& label
= wxEmptyString
,
291 wxMenu
* subMenu
= NULL
);
294 If the platform supports it, sets the shape of the window to that
295 depicted by @a region. The system will not display or respond to any
296 mouse event for the pixels that lie outside of the region. To reset the
297 window to the normal rectangular shape simply call SetShape() again with
298 an empty wxRegion. Returns @true if the operation is successful.
300 virtual bool SetShape(const wxRegion
& region
);
303 Allows specification of minimum and maximum window sizes, and window
304 size increments. If a pair of values is not set (or set to -1), no
305 constraints will be used.
316 Specifies the increment for sizing the width (GTK/Motif/Xt only).
318 Specifies the increment for sizing the height (GTK/Motif/Xt only).
320 @remarks Notice that this function not only prevents the user from
321 resizing the window outside the given bounds but it also
322 prevents the program itself from doing it using
326 virtual void SetSizeHints(int minW
, int minH
,
327 int maxW
= -1, int maxH
= -1,
328 int incW
= -1, int incH
= -1);
331 Allows specification of minimum and maximum window sizes, and window
332 size increments. If a pair of values is not set (or set to -1), no
333 constraints will be used.
336 The minimum size of the window.
338 The maximum size of the window.
340 Increment size (only taken into account under X11-based ports such
341 as wxGTK/wxMotif/wxX11).
343 @remarks Notice that this function not only prevents the user from
344 resizing the window outside the given bounds but it also
345 prevents the program itself from doing it using
348 void SetSizeHints(const wxSize
& minSize
,
349 const wxSize
& maxSize
= wxDefaultSize
,
350 const wxSize
& incSize
= wxDefaultSize
);
353 Sets the window title.
360 virtual void SetTitle(const wxString
& title
);
363 If the platform supports it will set the window to be translucent.
366 Determines how opaque or transparent the window will be, if the
367 platform supports the opreration. A value of 0 sets the window to be
368 fully transparent, and a value of 255 sets the window to be fully
371 virtual bool SetTransparent(wxByte alpha
);
374 This virtual function is not meant to be called directly but can be
375 overridden to return @false (it returns @true by default) to allow the
376 application to close even if this, presumably not very important, window
377 is still opened. By default, the application stays alive as long as
378 there are any open top level windows.
380 virtual bool ShouldPreventAppExit() const;
383 Depending on the value of @a show parameter the window is either shown
384 full screen or restored to its normal state. @a style is a bit list
385 containing some or all of the following values, which indicate what
386 elements of the window to hide in full-screen mode:
388 - @c ::wxFULLSCREEN_NOMENUBAR
389 - @c ::wxFULLSCREEN_NOTOOLBAR
390 - @c ::wxFULLSCREEN_NOSTATUSBAR
391 - @c ::wxFULLSCREEN_NOBORDER
392 - @c ::wxFULLSCREEN_NOCAPTION
393 - @c ::wxFULLSCREEN_ALL (all of the above)
395 This function has not been tested with MDI frames.
397 @note Showing a window full screen also actually @ref wxWindow::Show()
398 "Show()"s the window if it isn't shown.
402 virtual bool ShowFullScreen(bool show
, long style
= wxFULLSCREEN_ALL
);
405 This method is specific to wxUniversal port.
407 Use native or custom-drawn decorations for this window only. Notice that
408 to have any effect this method must be called before really creating the
409 window, i.e. two step creation must be used:
412 MyFrame *frame = new MyFrame; // use default ctor
413 frame->UseNativeDecorations(false); // change from default "true"
414 frame->Create(parent, title, ...); // really create the frame
417 @see UseNativeDecorationsByDefault(),
418 IsUsingNativeDecorations()
420 void UseNativeDecorations(bool native
= true);
423 This method is specific to wxUniversal port.
425 Top level windows in wxUniversal port can use either system-provided
426 window decorations (i.e. title bar and various icons, buttons and menus
427 in it) or draw the decorations themselves. By default the system
428 decorations are used if they are available, but this method can be
429 called with @a native set to @false to change this for all windows
430 created after this point.
432 Also note that if @c WXDECOR environment variable is set, then custom
433 decorations are used by default and so it may make sense to call this
434 method with default argument if the application can't use custom
435 decorations at all for some reason.
437 @see UseNativeDecorations()
439 void UseNativeDecorationsByDefault(bool native
= true);