]> git.saurik.com Git - wxWidgets.git/blob - src/gtk/frame.cpp
Small doc corrections
[wxWidgets.git] / src / gtk / frame.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: frame.cpp
3 // Purpose:
4 // Author: Robert Roebling
5 // Id: $Id$
6 // Copyright: (c) 1998 Robert Roebling
7 // Licence: wxWindows licence
8 /////////////////////////////////////////////////////////////////////////////
9
10 #ifdef __GNUG__
11 #pragma implementation "frame.h"
12 #endif
13
14 #include "wx/frame.h"
15 #include "wx/dialog.h"
16 #include "wx/control.h"
17 #include "wx/app.h"
18 #include "wx/menu.h"
19 #include "wx/toolbar.h"
20 #include "wx/statusbr.h"
21 #include "wx/dcclient.h"
22
23 #include "glib.h"
24 #include "gdk/gdk.h"
25 #include "gtk/gtk.h"
26 #include "wx/gtk/win_gtk.h"
27
28 //-----------------------------------------------------------------------------
29 // constants
30 //-----------------------------------------------------------------------------
31
32 const int wxMENU_HEIGHT = 27;
33 const int wxSTATUS_HEIGHT = 25;
34
35 //-----------------------------------------------------------------------------
36 // data
37 //-----------------------------------------------------------------------------
38
39 extern wxList wxTopLevelWindows;
40 extern wxList wxPendingDelete;
41
42 //-----------------------------------------------------------------------------
43 // "size_allocate"
44 //-----------------------------------------------------------------------------
45
46 static void gtk_frame_size_callback( GtkWidget *WXUNUSED(widget), GtkAllocation* alloc, wxFrame *win )
47 {
48 if (!win->HasVMT()) return;
49
50 /*
51 printf( "OnFrameResize from " );
52 if (win->GetClassInfo() && win->GetClassInfo()->GetClassName())
53 printf( win->GetClassInfo()->GetClassName() );
54 printf( ".\n" );
55 */
56
57 if ((win->m_width != alloc->width) || (win->m_height != alloc->height))
58 {
59 win->m_sizeSet = FALSE;
60 win->m_width = alloc->width;
61 win->m_height = alloc->height;
62 }
63 }
64
65 //-----------------------------------------------------------------------------
66 // "delete_event"
67 //-----------------------------------------------------------------------------
68
69 static gint gtk_frame_delete_callback( GtkWidget *WXUNUSED(widget), GdkEvent *WXUNUSED(event), wxFrame *win )
70 {
71 /*
72 printf( "OnDelete from " );
73 if (win->GetClassInfo() && win->GetClassInfo()->GetClassName())
74 printf( win->GetClassInfo()->GetClassName() );
75 printf( ".\n" );
76 */
77
78 win->Close();
79
80 return TRUE;
81 }
82
83 //-----------------------------------------------------------------------------
84 // "configure_event"
85 //-----------------------------------------------------------------------------
86
87 static gint gtk_frame_configure_callback( GtkWidget *WXUNUSED(widget), GdkEventConfigure *event, wxFrame *win )
88 {
89 if (!win->HasVMT()) return FALSE;
90
91 win->m_x = event->x;
92 win->m_y = event->y;
93
94 wxMoveEvent mevent( wxPoint(win->m_x,win->m_y), win->GetId() );
95 mevent.SetEventObject( win );
96 win->GetEventHandler()->ProcessEvent( mevent );
97
98 return FALSE;
99 }
100
101 //-----------------------------------------------------------------------------
102 // wxFrame
103 //-----------------------------------------------------------------------------
104
105 BEGIN_EVENT_TABLE(wxFrame, wxWindow)
106 EVT_SIZE(wxFrame::OnSize)
107 EVT_CLOSE(wxFrame::OnCloseWindow)
108 END_EVENT_TABLE()
109
110 IMPLEMENT_DYNAMIC_CLASS(wxFrame,wxWindow)
111
112 wxFrame::wxFrame()
113 {
114 m_frameMenuBar = (wxMenuBar *) NULL;
115 m_frameStatusBar = (wxStatusBar *) NULL;
116 m_frameToolBar = (wxToolBar *) NULL;
117 m_sizeSet = FALSE;
118 m_miniEdge = 0;
119 m_miniTitle = 0;
120 }
121
122 wxFrame::wxFrame( wxWindow *parent, wxWindowID id, const wxString &title,
123 const wxPoint &pos, const wxSize &size,
124 long style, const wxString &name )
125 {
126 m_frameMenuBar = (wxMenuBar *) NULL;
127 m_frameStatusBar = (wxStatusBar *) NULL;
128 m_frameToolBar = (wxToolBar *) NULL;
129 m_sizeSet = FALSE;
130 m_miniEdge = 0;
131 m_miniTitle = 0;
132 Create( parent, id, title, pos, size, style, name );
133 }
134
135 bool wxFrame::Create( wxWindow *parent, wxWindowID id, const wxString &title,
136 const wxPoint &pos, const wxSize &size,
137 long style, const wxString &name )
138 {
139 wxTopLevelWindows.Append( this );
140
141 m_needParent = FALSE;
142
143 PreCreation( parent, id, pos, size, style, name );
144
145 m_title = title;
146
147 GtkWindowType win_type = GTK_WINDOW_TOPLEVEL;
148 if (style & wxSIMPLE_BORDER) win_type = GTK_WINDOW_POPUP;
149
150 m_widget = gtk_window_new( win_type );
151
152 #ifdef __WXDEBUG__
153 debug_focus_in( m_widget, "wxFrame::m_widget", name );
154 #endif
155
156 if ((size.x != -1) && (size.y != -1))
157 gtk_widget_set_usize( m_widget, m_width, m_height );
158 if ((pos.x != -1) && (pos.y != -1))
159 gtk_widget_set_uposition( m_widget, m_x, m_y );
160
161 gtk_window_set_title( GTK_WINDOW(m_widget), title );
162 GTK_WIDGET_UNSET_FLAGS( m_widget, GTK_CAN_FOCUS );
163
164 gtk_widget_set( m_widget, "GtkWindow::allow_shrink", TRUE, NULL );
165
166 gtk_signal_connect( GTK_OBJECT(m_widget), "delete_event",
167 GTK_SIGNAL_FUNC(gtk_frame_delete_callback), (gpointer)this );
168
169 m_wxwindow = gtk_myfixed_new();
170 gtk_widget_show( m_wxwindow );
171 GTK_WIDGET_UNSET_FLAGS( m_wxwindow, GTK_CAN_FOCUS );
172
173 #ifdef __WXDEBUG__
174 debug_focus_in( m_wxwindow, "wxFrame::m_wxwindow", name );
175 #endif
176
177 gtk_container_add( GTK_CONTAINER(m_widget), m_wxwindow );
178
179 gtk_signal_connect( GTK_OBJECT(m_widget), "size_allocate",
180 GTK_SIGNAL_FUNC(gtk_frame_size_callback), (gpointer)this );
181
182 gtk_signal_connect( GTK_OBJECT(m_widget), "configure_event",
183 GTK_SIGNAL_FUNC(gtk_frame_configure_callback), (gpointer)this );
184
185 if (m_parent) m_parent->AddChild( this );
186
187 PostCreation();
188
189 return TRUE;
190 }
191
192 wxFrame::~wxFrame()
193 {
194 if (m_frameMenuBar) delete m_frameMenuBar;
195 if (m_frameStatusBar) delete m_frameStatusBar;
196 if (m_frameToolBar) delete m_frameToolBar;
197
198 wxTopLevelWindows.DeleteObject( this );
199
200 if (wxTheApp->GetTopWindow() == this)
201 {
202 wxTheApp->SetTopWindow( (wxWindow*) NULL );
203 }
204
205 if (wxTopLevelWindows.Number() == 0)
206 {
207 wxTheApp->ExitMainLoop();
208 }
209 }
210
211 bool wxFrame::Show( bool show )
212 {
213 wxASSERT_MSG( (m_widget != NULL), "invalid frame" );
214
215 if (show && !m_sizeSet)
216 {
217 // by calling GtkOnSize here, we don't have to call
218 // either after showing the frame, which would entail
219 // much ugly flicker nor from within the size_allocate
220 // handler, because GTK 1.1.X forbids that.
221
222 GtkOnSize( m_x, m_y, m_width, m_height );
223 }
224
225 return wxWindow::Show( show );
226 }
227
228 void wxFrame::OnCloseWindow( wxCloseEvent &event )
229 {
230 if (GetEventHandler()->OnClose() || event.GetForce()) this->Destroy();
231 }
232
233 bool wxFrame::Destroy()
234 {
235 wxASSERT_MSG( (m_widget != NULL), "invalid frame" );
236
237 if (!wxPendingDelete.Member(this)) wxPendingDelete.Append(this);
238
239 return TRUE;
240 }
241
242 wxPoint wxFrame::GetClientAreaOrigin() const
243 {
244 wxPoint pt( m_miniEdge, m_miniEdge + m_miniTitle );
245 if (m_frameMenuBar)
246 {
247 int h = 0;
248 m_frameMenuBar->GetSize( (int*)NULL, &h );
249 pt.y += h;
250 }
251 if (m_frameToolBar)
252 {
253 int h = 0;
254 m_frameToolBar->GetSize( (int*)NULL, &h );
255 pt.y += h;
256 }
257 return pt;
258 }
259
260 void wxFrame::SetSize( int x, int y, int width, int height, int sizeFlags )
261 {
262 wxASSERT_MSG( (m_widget != NULL), "invalid window" );
263
264 // Don't do anything for children of wxMDIChildFrame
265 if (!m_wxwindow) return;
266
267 if (m_resizing) return; // I don't like recursions
268 m_resizing = TRUE;
269
270 int old_x = m_x;
271 int old_y = m_y;
272 int old_width = m_width;
273 int old_height = m_height;
274
275 if ((sizeFlags & wxSIZE_USE_EXISTING) == wxSIZE_USE_EXISTING)
276 {
277 if (x != -1) m_x = x;
278 if (y != -1) m_y = y;
279 if (width != -1) m_width = width;
280 if (height != -1) m_height = height;
281 }
282 else
283 {
284 m_x = x;
285 m_y = y;
286 m_width = width;
287 m_height = height;
288 }
289
290 if ((sizeFlags & wxSIZE_AUTO_WIDTH) == wxSIZE_AUTO_WIDTH)
291 {
292 if (width == -1) m_width = 80;
293 }
294
295 if ((sizeFlags & wxSIZE_AUTO_HEIGHT) == wxSIZE_AUTO_HEIGHT)
296 {
297 if (height == -1) m_height = 26;
298 }
299
300 if ((m_minWidth != -1) && (m_width < m_minWidth)) m_width = m_minWidth;
301 if ((m_minHeight != -1) && (m_height < m_minHeight)) m_height = m_minHeight;
302 if ((m_maxWidth != -1) && (m_width > m_maxWidth)) m_width = m_minWidth;
303 if ((m_maxHeight != -1) && (m_height > m_maxHeight)) m_height = m_minHeight;
304
305 if ((m_x != -1) || (m_y != -1))
306 {
307 if ((m_x != old_x) || (m_y != old_y))
308 gtk_widget_set_uposition( m_widget, m_x, m_y );
309 }
310
311 if ((m_width != old_width) || (m_height != old_height))
312 {
313 gtk_widget_set_usize( m_widget, m_width, m_height );
314 }
315
316 wxSizeEvent event( wxSize(m_width,m_height), GetId() );
317 event.SetEventObject( this );
318 GetEventHandler()->ProcessEvent( event );
319
320 m_resizing = FALSE;
321 }
322
323 void wxFrame::SetSize( int width, int height )
324 {
325 SetSize( -1, -1, width, height, wxSIZE_USE_EXISTING );
326 }
327
328 void wxFrame::Centre( int direction )
329 {
330 wxASSERT_MSG( (m_widget != NULL), "invalid frame" );
331
332 int x = 0;
333 int y = 0;
334
335 if (direction & wxHORIZONTAL == wxHORIZONTAL) x = (gdk_screen_width () - m_width) / 2;
336 if (direction & wxVERTICAL == wxVERTICAL) y = (gdk_screen_height () - m_height) / 2;
337
338 Move( x, y );
339 }
340
341 void wxFrame::GetClientSize( int *width, int *height ) const
342 {
343 wxASSERT_MSG( (m_widget != NULL), "invalid frame" );
344
345 wxWindow::GetClientSize( width, height );
346 if (height)
347 {
348 if (m_frameMenuBar) (*height) -= wxMENU_HEIGHT;
349 if (m_frameStatusBar) (*height) -= wxSTATUS_HEIGHT;
350 if (m_frameToolBar)
351 {
352 int y = 0;
353 m_frameToolBar->GetSize( (int *) NULL, &y );
354 (*height) -= y;
355 }
356 (*height) -= m_miniEdge*2 + m_miniTitle;
357 }
358 if (width)
359 {
360 (*width) -= m_miniEdge*2;
361 }
362 }
363
364 void wxFrame::SetClientSize( int const width, int const height )
365 {
366 wxASSERT_MSG( (m_widget != NULL), "invalid frame" );
367
368 int h = height;
369 if (m_frameMenuBar) h += wxMENU_HEIGHT;
370 if (m_frameStatusBar) h += wxSTATUS_HEIGHT;
371 if (m_frameToolBar)
372 {
373 int y = 0;
374 m_frameToolBar->GetSize( (int *) NULL, &y );
375 h += y;
376 }
377 wxWindow::SetClientSize( width + m_miniEdge*2, h + m_miniEdge*2 + m_miniTitle );
378 }
379
380 void wxFrame::GtkOnSize( int WXUNUSED(x), int WXUNUSED(y), int width, int height )
381 {
382 // due to a bug in gtk, x,y are always 0
383 // m_x = x;
384 // m_y = y;
385
386 if (m_resizing) return;
387 m_resizing = TRUE;
388
389 if (!m_wxwindow) return;
390
391 m_width = width;
392 m_height = height;
393
394 if ((m_minWidth != -1) && (m_width < m_minWidth)) m_width = m_minWidth;
395 if ((m_minHeight != -1) && (m_height < m_minHeight)) m_height = m_minHeight;
396 if ((m_maxWidth != -1) && (m_width > m_maxWidth)) m_width = m_minWidth;
397 if ((m_maxHeight != -1) && (m_height > m_maxHeight)) m_height = m_minHeight;
398
399 gtk_widget_set_usize( m_widget, m_width, m_height );
400
401 // this emulates the new wxMSW behaviour of placing all
402 // frame-subwindows (menu, toolbar..) on one native window
403 // OK, this hurts in the eye, but I don't want to call SetSize()
404 // because I don't want to call any non-native functions here.
405
406 if (m_frameMenuBar)
407 {
408 int xx = m_miniEdge;
409 int yy = m_miniEdge + m_miniTitle;
410 int ww = m_width - 2*m_miniEdge;
411 int hh = wxMENU_HEIGHT;
412 m_frameMenuBar->m_x = xx;
413 m_frameMenuBar->m_y = yy;
414 m_frameMenuBar->m_width = ww;
415 m_frameMenuBar->m_height = hh;
416
417 gtk_myfixed_move( GTK_MYFIXED(m_wxwindow), m_frameMenuBar->m_widget, xx, yy );
418 gtk_widget_set_usize( m_frameMenuBar->m_widget, ww, hh );
419 }
420
421 if (m_frameToolBar)
422 {
423 int xx = m_miniEdge;
424 int yy = m_miniEdge + m_miniTitle;
425 if (m_frameMenuBar) yy += wxMENU_HEIGHT;
426 int ww = m_width - 2*m_miniEdge;
427 int hh = m_frameToolBar->m_height;
428
429 m_frameToolBar->m_x = xx;
430 m_frameToolBar->m_y = yy;
431 m_frameToolBar->m_height = hh;
432 m_frameToolBar->m_width = ww;
433
434 gtk_myfixed_move( GTK_MYFIXED(m_wxwindow), m_frameToolBar->m_widget, xx, yy );
435 gtk_widget_set_usize( m_frameToolBar->m_widget, ww, hh );
436 }
437
438 if (m_frameStatusBar)
439 {
440 int xx = 0 + m_miniEdge;
441 int yy = m_height - wxSTATUS_HEIGHT - m_miniEdge;
442 int ww = m_width - 2*m_miniEdge;
443 int hh = wxSTATUS_HEIGHT;
444
445 m_frameStatusBar->m_x = xx;
446 m_frameStatusBar->m_y = yy;
447 m_frameStatusBar->m_width = ww;
448 m_frameStatusBar->m_height = hh;
449
450 gtk_myfixed_move( GTK_MYFIXED(m_wxwindow), m_frameStatusBar->m_widget, xx, yy );
451 gtk_widget_set_usize( m_frameStatusBar->m_widget, ww, hh );
452 }
453
454 m_sizeSet = TRUE;
455
456 wxSizeEvent event( wxSize(m_width,m_height), GetId() );
457 event.SetEventObject( this );
458 GetEventHandler()->ProcessEvent( event );
459
460 m_resizing = FALSE;
461 }
462
463 void wxFrame::OnInternalIdle()
464 {
465 if (!m_sizeSet)
466 GtkOnSize( m_x, m_y, m_width, m_height );
467
468 DoMenuUpdates();
469 }
470
471 void wxFrame::OnSize( wxSizeEvent &WXUNUSED(event) )
472 {
473 wxASSERT_MSG( (m_widget != NULL), "invalid frame" );
474
475 if (GetAutoLayout())
476 {
477 Layout();
478 }
479 else
480 {
481 // no child: go out !
482 if (!GetChildren().First()) return;
483
484 // do we have exactly one child?
485 wxWindow *child = (wxWindow *) NULL;
486 for(wxNode *node = GetChildren().First(); node; node = node->Next())
487 {
488 wxWindow *win = (wxWindow *)node->Data();
489 if (!wxIS_KIND_OF(win,wxFrame) && !wxIS_KIND_OF(win,wxDialog)
490 #if 0 // not in m_children anyway ?
491 && (win != m_frameMenuBar) &&
492 (win != m_frameToolBar) &&
493 (win != m_frameStatusBar)
494 #endif
495 )
496 {
497 // it's the second one: do nothing
498 if (child) return;
499 child = win;
500 }
501 }
502
503 // yes: set it's size to fill all the frame
504 int client_x, client_y;
505 GetClientSize( &client_x, &client_y );
506 child->SetSize( 1, 1, client_x-2, client_y-2 );
507 }
508 }
509
510 static void SetInvokingWindow( wxMenu *menu, wxWindow *win )
511 {
512 menu->SetInvokingWindow( win );
513 wxNode *node = menu->m_items.First();
514 while (node)
515 {
516 wxMenuItem *menuitem = (wxMenuItem*)node->Data();
517 if (menuitem->IsSubMenu())
518 SetInvokingWindow( menuitem->GetSubMenu(), win );
519 node = node->Next();
520 }
521 }
522
523 void wxFrame::SetMenuBar( wxMenuBar *menuBar )
524 {
525 wxASSERT_MSG( (m_widget != NULL), "invalid frame" );
526 wxASSERT_MSG( (m_wxwindow != NULL), "invalid frame" );
527
528 m_frameMenuBar = menuBar;
529
530 if (m_frameMenuBar)
531 {
532 wxNode *node = m_frameMenuBar->m_menus.First();
533 while (node)
534 {
535 wxMenu *menu = (wxMenu*)node->Data();
536 SetInvokingWindow( menu, this );
537 node = node->Next();
538 }
539
540 if (m_frameMenuBar->m_parent != this)
541 {
542 m_frameMenuBar->m_parent = this;
543 gtk_myfixed_put( GTK_MYFIXED(m_wxwindow),
544 m_frameMenuBar->m_widget, m_frameMenuBar->m_x, m_frameMenuBar->m_y );
545 }
546 }
547
548 m_sizeSet = FALSE;
549 }
550
551 wxMenuBar *wxFrame::GetMenuBar() const
552 {
553 return m_frameMenuBar;
554 }
555
556 wxToolBar* wxFrame::CreateToolBar(long style, wxWindowID id, const wxString& name)
557 {
558 wxASSERT_MSG( (m_widget != NULL), "invalid frame" );
559
560 wxCHECK_MSG( m_frameToolBar == NULL, FALSE, "recreating toolbar in wxFrame" );
561
562 m_frameToolBar = OnCreateToolBar( style, id, name );
563
564 GetChildren().DeleteObject( m_frameToolBar );
565
566 m_sizeSet = FALSE;
567
568 return m_frameToolBar;
569 }
570
571 wxToolBar* wxFrame::OnCreateToolBar( long style, wxWindowID id, const wxString& name )
572 {
573 return new wxToolBar( this, id, wxDefaultPosition, wxDefaultSize, style, name );
574 }
575
576 wxToolBar *wxFrame::GetToolBar() const
577 {
578 return m_frameToolBar;
579 }
580
581 wxStatusBar* wxFrame::CreateStatusBar( int number, long style, wxWindowID id, const wxString& name )
582 {
583 wxASSERT_MSG( (m_widget != NULL), "invalid frame" );
584
585 wxCHECK_MSG( m_frameStatusBar == NULL, FALSE, "recreating status bar in wxFrame" );
586
587 m_frameStatusBar = OnCreateStatusBar( number, style, id, name );
588
589 m_sizeSet = FALSE;
590
591 return m_frameStatusBar;
592 }
593
594 wxStatusBar *wxFrame::OnCreateStatusBar( int number, long style, wxWindowID id, const wxString& name )
595 {
596 wxStatusBar *statusBar = (wxStatusBar *) NULL;
597
598 statusBar = new wxStatusBar(this, id, wxPoint(0, 0), wxSize(100, 20), style, name);
599
600 // Set the height according to the font and the border size
601 wxClientDC dc(statusBar);
602 dc.SetFont( statusBar->GetFont() );
603
604 long x, y;
605 dc.GetTextExtent( "X", &x, &y );
606
607 int height = (int)( (y * 1.1) + 2* statusBar->GetBorderY());
608
609 statusBar->SetSize( -1, -1, 100, height );
610
611 statusBar->SetFieldsCount( number );
612 return statusBar;
613 }
614
615 void wxFrame::SetStatusText(const wxString& text, int number)
616 {
617 wxASSERT_MSG( (m_widget != NULL), "invalid frame" );
618
619 wxCHECK_RET( m_frameStatusBar != NULL, "no statusbar to set text for" );
620
621 m_frameStatusBar->SetStatusText(text, number);
622 }
623
624 void wxFrame::SetStatusWidths(int n, const int widths_field[] )
625 {
626 wxASSERT_MSG( (m_widget != NULL), "invalid frame" );
627
628 wxCHECK_RET( m_frameStatusBar != NULL, "no statusbar to set widths for" );
629
630 m_frameStatusBar->SetStatusWidths(n, widths_field);
631 }
632
633 wxStatusBar *wxFrame::GetStatusBar() const
634 {
635 return m_frameStatusBar;
636 }
637
638 void wxFrame::SetTitle( const wxString &title )
639 {
640 wxASSERT_MSG( (m_widget != NULL), "invalid frame" );
641
642 m_title = title;
643 if (m_title.IsNull()) m_title = "";
644 gtk_window_set_title( GTK_WINDOW(m_widget), title );
645 }
646
647 void wxFrame::SetIcon( const wxIcon &icon )
648 {
649 wxASSERT_MSG( (m_widget != NULL), "invalid frame" );
650
651 m_icon = icon;
652 if (!icon.Ok()) return;
653
654 wxMask *mask = icon.GetMask();
655 GdkBitmap *bm = (GdkBitmap *) NULL;
656 if (mask) bm = mask->GetBitmap();
657
658 gdk_window_set_icon( m_widget->window, (GdkWindow *) NULL, icon.GetPixmap(), bm );
659 }
660