]> git.saurik.com Git - wxWidgets.git/blame_incremental - interface/wx/toplevel.h
undo the last change as it results in buildbot configuration error
[wxWidgets.git] / interface / wx / toplevel.h
... / ...
CommitLineData
1/////////////////////////////////////////////////////////////////////////////
2// Name: toplevel.h
3// Purpose: interface of wxTopLevelWindow
4// Author: wxWidgets team
5// RCS-ID: $Id$
6// Licence: wxWindows license
7/////////////////////////////////////////////////////////////////////////////
8
9/**
10 Styles used with wxTopLevelWindow::RequestUserAttention().
11*/
12enum
13{
14 wxUSER_ATTENTION_INFO = 1, ///< Requests user attention,
15 wxUSER_ATTENTION_ERROR = 2 ///< Results in a more drastic action.
16};
17
18/**
19 Styles used with wxTopLevelWindow::ShowFullScreen().
20*/
21enum
22{
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.
28
29 /**
30 Combination of all above, will display the least possible.
31 */
32 wxFULLSCREEN_ALL = wxFULLSCREEN_NOMENUBAR | wxFULLSCREEN_NOTOOLBAR |
33 wxFULLSCREEN_NOSTATUSBAR | wxFULLSCREEN_NOBORDER |
34 wxFULLSCREEN_NOCAPTION
35};
36
37/**
38 @class wxTopLevelWindow
39
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
43 above.
44
45 Note that the instances of wxTopLevelWindow are managed by wxWidgets in the
46 internal top level window list.
47
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.
53 See wxMoveEvent.
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.
57 See wxMoveEvent.
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.
61 See wxMoveEvent.
62 @endEventTable
63
64 @library{wxcore}
65 @category{managedwnd}
66
67 @see wxDialog, wxFrame
68*/
69class wxTopLevelWindow : public wxWindow
70{
71public:
72 /**
73 Default ctor.
74 */
75 wxTopLevelWindow();
76
77 /**
78 Constructor creating the top level window.
79 */
80 wxTopLevelWindow(wxWindow *parent,
81 wxWindowID winid,
82 const wxString& title,
83 const wxPoint& pos = wxDefaultPosition,
84 const wxSize& size = wxDefaultSize,
85 long style = wxDEFAULT_FRAME_STYLE,
86 const wxString& name = wxFrameNameStr);
87
88 /**
89 Destructor. Remember that wxTopLevelWindows do not get immediately
90 destroyed when the user (or the app) closes them; they have a
91 @b delayed destruction.
92
93 See @ref overview_windowdeletion for more info.
94 */
95 virtual ~wxTopLevelWindow();
96
97 /**
98 Creates the top level window.
99 */
100 bool Create(wxWindow *parent,
101 wxWindowID id,
102 const wxString& title,
103 const wxPoint& pos = wxDefaultPosition,
104 const wxSize& size = wxDefaultSize,
105 long style = wxDEFAULT_FRAME_STYLE,
106 const wxString& name = wxFrameNameStr);
107
108 /**
109 Returns @true if the platform supports making the window translucent.
110
111 @see SetTransparent()
112 */
113 virtual bool CanSetTransparent();
114
115 /**
116 A synonym for CentreOnScreen().
117 */
118 void CenterOnScreen(int direction);
119
120 /**
121 Centres the window on screen.
122
123 @param direction
124 Specifies the direction for the centering. May be @c wxHORIZONTAL,
125 @c wxVERTICAL or @c wxBOTH.
126
127 @see wxWindow::CentreOnParent()
128 */
129 void CentreOnScreen(int direction = wxBOTH);
130
131 /**
132 Enables or disables the Close button (most often in the right upper
133 corner of a dialog) and the Close entry of the system menu (most often
134 in the left upper corner of the dialog).
135
136 Currently only implemented for wxMSW and wxGTK.
137
138 Returns @true if operation was successful. This may be wrong on X11
139 (including GTK+) where the window manager may not support this operation
140 and there is no way to find out.
141 */
142 virtual bool EnableCloseButton(bool enable = true);
143
144 /**
145 Returns a pointer to the button which is the default for this window, or
146 @c @NULL. The default button is the one activated by pressing the Enter
147 key.
148 */
149 wxWindow* GetDefaultItem() const;
150
151 /**
152 Returns the standard icon of the window. The icon will be invalid if it
153 hadn't been previously set by SetIcon().
154
155 @see GetIcons()
156 */
157 wxIcon GetIcon() const;
158
159 /**
160 Returns all icons associated with the window, there will be none of them
161 if neither SetIcon() nor SetIcons() had been called before. Use
162 GetIcon() to get the main icon of the window.
163
164 @see wxIconBundle
165 */
166 const wxIconBundle& GetIcons() const;
167
168 /**
169 Gets a string containing the window title.
170
171 @see SetTitle()
172 */
173 virtual wxString GetTitle() const;
174
175 /**
176 Unique to the wxWinCE port. Responds to showing/hiding SIP (soft input
177 panel) area and resize window accordingly. Override this if you want to
178 avoid resizing or do additional operations.
179 */
180 virtual bool HandleSettingChange(WXWPARAM wParam,
181 WXLPARAM lParam);
182
183 /**
184 Iconizes or restores the window.
185
186 @param iconize
187 If @true, iconizes the window; if @false, shows and restores it.
188
189 @see IsIconized(), Maximize(), wxIconizeEvent.
190 */
191 virtual void Iconize(bool iconize = true);
192
193 /**
194 Returns @true if this window is currently active, i.e. if the user is
195 currently working with it.
196 */
197 virtual bool IsActive();
198
199 /**
200 Returns @true if this window is expected to be always maximized, either
201 due to platform policy or due to local policy regarding particular
202 class.
203 */
204 virtual bool IsAlwaysMaximized() const;
205
206 /**
207 Returns @true if the window is in fullscreen mode.
208
209 @see ShowFullScreen()
210 */
211 virtual bool IsFullScreen() const;
212
213 /**
214 Returns @true if the window is iconized.
215 */
216 virtual bool IsIconized() const;
217
218 /**
219 Returns @true if the window is maximized.
220 */
221 virtual bool IsMaximized() const;
222
223 /**
224 This method is specific to wxUniversal port.
225
226 Returns @true if this window is using native decorations, @false if we
227 draw them ourselves.
228
229 @see UseNativeDecorations(),
230 UseNativeDecorationsByDefault()
231 */
232 bool IsUsingNativeDecorations() const;
233
234 /**
235 See wxWindow::SetAutoLayout(): when auto layout is on, this function gets
236 called automatically when the window is resized.
237 */
238 virtual bool Layout();
239
240 /**
241 Maximizes or restores the window.
242
243 @param maximize
244 If @true, maximizes the window, otherwise it restores it.
245
246 @see Iconize()
247 */
248 virtual void Maximize(bool maximize = true);
249
250 /**
251 Use a system-dependent way to attract users attention to the window when
252 it is in background.
253
254 @a flags may have the value of either @c ::wxUSER_ATTENTION_INFO
255 (default) or @c ::wxUSER_ATTENTION_ERROR which results in a more drastic
256 action. When in doubt, use the default value.
257
258
259 @note This function should normally be only used when the application
260 is not already in foreground.
261
262 This function is currently implemented for Win32 where it flashes
263 the window icon in the taskbar, and for wxGTK with task bars
264 supporting it.
265
266 */
267 virtual void RequestUserAttention(int flags = wxUSER_ATTENTION_INFO);
268
269 /**
270 Changes the default item for the panel, usually @a win is a button.
271
272 @see GetDefaultItem()
273 */
274 wxWindow* SetDefaultItem(wxWindow* win);
275
276 /**
277 Sets the icon for this window.
278
279 @param icon
280 The wxIcon to associate with this window.
281
282 @remarks The window takes a 'copy' of @a icon, but since it uses
283 reference counting, the copy is very quick. It is safe to
284 delete @a icon after calling this function.
285
286 @note In wxMSW, @a icon must be either 16x16 or 32x32 icon.
287
288 @see wxIcon, SetIcons()
289 */
290 void SetIcon(const wxIcon& icon);
291
292 /**
293 Sets several icons of different sizes for this window: this allows to
294 use different icons for different situations (e.g. task switching bar,
295 taskbar, window title bar) instead of scaling, with possibly bad looking
296 results, the only icon set by SetIcon().
297
298 @param icons
299 The icons to associate with this window.
300
301 @note In wxMSW, @a icons must contain a 16x16 or 32x32 icon,
302 preferably both.
303
304 @see wxIconBundle
305 */
306 virtual void SetIcons(const wxIconBundle& icons);
307
308 /**
309 Sets action or menu activated by pressing left hardware button on the
310 smart phones. Unavailable on full keyboard machines.
311
312 @param id
313 Identifier for this button.
314 @param label
315 Text to be displayed on the screen area dedicated to this hardware
316 button.
317 @param subMenu
318 The menu to be opened after pressing this hardware button.
319
320 @see SetRightMenu().
321 */
322 void SetLeftMenu(int id = wxID_ANY,
323 const wxString& label = wxEmptyString,
324 wxMenu* subMenu = NULL);
325
326 /**
327 A simpler interface for setting the size hints than SetSizeHints().
328 */
329 virtual void SetMaxSize(const wxSize& size);
330
331 /**
332 A simpler interface for setting the size hints than SetSizeHints().
333 */
334 virtual void SetMinSize(const wxSize& size);
335
336 /**
337 Sets action or menu activated by pressing right hardware button on the
338 smart phones. Unavailable on full keyboard machines.
339
340 @param id
341 Identifier for this button.
342 @param label
343 Text to be displayed on the screen area dedicated to this hardware
344 button.
345 @param subMenu
346 The menu to be opened after pressing this hardware button.
347
348 @see SetLeftMenu().
349 */
350 void SetRightMenu(int id = wxID_ANY,
351 const wxString& label = wxEmptyString,
352 wxMenu* subMenu = NULL);
353
354 /**
355 If the platform supports it, sets the shape of the window to that
356 depicted by @a region. The system will not display or respond to any
357 mouse event for the pixels that lie outside of the region. To reset the
358 window to the normal rectangular shape simply call SetShape() again with
359 an empty wxRegion. Returns @true if the operation is successful.
360 */
361 virtual bool SetShape(const wxRegion& region);
362
363 /**
364 Allows specification of minimum and maximum window sizes, and window
365 size increments. If a pair of values is not set (or set to -1), no
366 constraints will be used.
367
368 @param minW
369 The minimum width.
370 @param minH
371 The minimum height.
372 @param maxW
373 The maximum width.
374 @param maxH
375 The maximum height.
376 @param incW
377 Specifies the increment for sizing the width (GTK/Motif/Xt only).
378 @param incH
379 Specifies the increment for sizing the height (GTK/Motif/Xt only).
380
381 @remarks Notice that this function not only prevents the user from
382 resizing the window outside the given bounds but it also
383 prevents the program itself from doing it using
384 wxWindow::SetSize().
385
386 */
387 virtual void SetSizeHints(int minW, int minH,
388 int maxW = -1, int maxH = -1,
389 int incW = -1, int incH = -1);
390
391 /**
392 Allows specification of minimum and maximum window sizes, and window
393 size increments. If a pair of values is not set (or set to -1), no
394 constraints will be used.
395
396 @param minSize
397 The minimum size of the window.
398 @param maxSize
399 The maximum size of the window.
400 @param incSize
401 Increment size (only taken into account under X11-based ports such
402 as wxGTK/wxMotif/wxX11).
403
404 @remarks Notice that this function not only prevents the user from
405 resizing the window outside the given bounds but it also
406 prevents the program itself from doing it using
407 wxWindow::SetSize().
408 */
409 void SetSizeHints(const wxSize& minSize,
410 const wxSize& maxSize = wxDefaultSize,
411 const wxSize& incSize = wxDefaultSize);
412
413 /**
414 Sets the window title.
415
416 @param title
417 The window title.
418
419 @see GetTitle()
420 */
421 virtual void SetTitle(const wxString& title);
422
423 /**
424 If the platform supports it will set the window to be translucent.
425
426 @param alpha
427 Determines how opaque or transparent the window will be, if the
428 platform supports the opreration. A value of 0 sets the window to be
429 fully transparent, and a value of 255 sets the window to be fully
430 opaque.
431 */
432 virtual bool SetTransparent(wxByte alpha);
433
434 /**
435 This virtual function is not meant to be called directly but can be
436 overridden to return @false (it returns @true by default) to allow the
437 application to close even if this, presumably not very important, window
438 is still opened. By default, the application stays alive as long as
439 there are any open top level windows.
440 */
441 virtual bool ShouldPreventAppExit() const;
442
443 /**
444 Depending on the value of @a show parameter the window is either shown
445 full screen or restored to its normal state. @a style is a bit list
446 containing some or all of the following values, which indicate what
447 elements of the window to hide in full-screen mode:
448
449 - @c ::wxFULLSCREEN_NOMENUBAR
450 - @c ::wxFULLSCREEN_NOTOOLBAR
451 - @c ::wxFULLSCREEN_NOSTATUSBAR
452 - @c ::wxFULLSCREEN_NOBORDER
453 - @c ::wxFULLSCREEN_NOCAPTION
454 - @c ::wxFULLSCREEN_ALL (all of the above)
455
456 This function has not been tested with MDI frames.
457
458 @note Showing a window full screen also actually @ref wxWindow::Show()
459 "Show()"s the window if it isn't shown.
460
461 @see IsFullScreen()
462 */
463 virtual bool ShowFullScreen(bool show, long style = wxFULLSCREEN_ALL);
464
465 /**
466 This method is specific to wxUniversal port.
467
468 Use native or custom-drawn decorations for this window only. Notice that
469 to have any effect this method must be called before really creating the
470 window, i.e. two step creation must be used:
471
472 @code
473 MyFrame *frame = new MyFrame; // use default ctor
474 frame->UseNativeDecorations(false); // change from default "true"
475 frame->Create(parent, title, ...); // really create the frame
476 @endcode
477
478 @see UseNativeDecorationsByDefault(),
479 IsUsingNativeDecorations()
480 */
481 void UseNativeDecorations(bool native = true);
482
483 /**
484 This method is specific to wxUniversal port.
485
486 Top level windows in wxUniversal port can use either system-provided
487 window decorations (i.e. title bar and various icons, buttons and menus
488 in it) or draw the decorations themselves. By default the system
489 decorations are used if they are available, but this method can be
490 called with @a native set to @false to change this for all windows
491 created after this point.
492
493 Also note that if @c WXDECOR environment variable is set, then custom
494 decorations are used by default and so it may make sense to call this
495 method with default argument if the application can't use custom
496 decorations at all for some reason.
497
498 @see UseNativeDecorations()
499 */
500 void UseNativeDecorationsByDefault(bool native = true);
501};
502