1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/common/framecmn.cpp
3 // Purpose: common (for all platforms) wxFrame functions
4 // Author: Julian Smart, Vadim Zeitlin
7 // Copyright: (c) 1998 Robert Roebling and Julian Smart
8 // Licence: wxWindows licence
9 /////////////////////////////////////////////////////////////////////////////
11 // ============================================================================
13 // ============================================================================
15 // ----------------------------------------------------------------------------
17 // ----------------------------------------------------------------------------
19 // For compilers that support precompilation, includes "wx.h".
20 #include "wx/wxprec.h"
30 #include "wx/menuitem.h"
31 #include "wx/dcclient.h"
32 #include "wx/toolbar.h"
33 #include "wx/statusbr.h"
36 extern WXDLLEXPORT_DATA(const char) wxFrameNameStr
[] = "frame";
37 extern WXDLLEXPORT_DATA(const char) wxStatusLineNameStr
[] = "status_line";
39 // ----------------------------------------------------------------------------
41 // ----------------------------------------------------------------------------
43 #if wxUSE_MENUS && wxUSE_STATUSBAR
45 BEGIN_EVENT_TABLE(wxFrameBase
, wxTopLevelWindow
)
46 EVT_MENU_OPEN(wxFrameBase::OnMenuOpen
)
47 EVT_MENU_CLOSE(wxFrameBase::OnMenuClose
)
49 EVT_MENU_HIGHLIGHT_ALL(wxFrameBase::OnMenuHighlight
)
52 #endif // wxUSE_MENUS && wxUSE_STATUSBAR
54 // ============================================================================
56 // ============================================================================
58 // ----------------------------------------------------------------------------
60 // ----------------------------------------------------------------------------
62 wxDEFINE_FLAGS( wxFrameStyle
)
63 wxBEGIN_FLAGS( wxFrameStyle
)
64 // new style border flags, we put them first to
65 // use them for streaming out
66 wxFLAGS_MEMBER(wxBORDER_SIMPLE
)
67 wxFLAGS_MEMBER(wxBORDER_SUNKEN
)
68 wxFLAGS_MEMBER(wxBORDER_DOUBLE
)
69 wxFLAGS_MEMBER(wxBORDER_RAISED
)
70 wxFLAGS_MEMBER(wxBORDER_STATIC
)
71 wxFLAGS_MEMBER(wxBORDER_NONE
)
73 // old style border flags
74 wxFLAGS_MEMBER(wxSIMPLE_BORDER
)
75 wxFLAGS_MEMBER(wxSUNKEN_BORDER
)
76 wxFLAGS_MEMBER(wxDOUBLE_BORDER
)
77 wxFLAGS_MEMBER(wxRAISED_BORDER
)
78 wxFLAGS_MEMBER(wxSTATIC_BORDER
)
79 wxFLAGS_MEMBER(wxBORDER
)
81 // standard window styles
82 wxFLAGS_MEMBER(wxTAB_TRAVERSAL
)
83 wxFLAGS_MEMBER(wxCLIP_CHILDREN
)
84 wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW
)
85 wxFLAGS_MEMBER(wxWANTS_CHARS
)
86 wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE
)
87 wxFLAGS_MEMBER(wxALWAYS_SHOW_SB
)
88 wxFLAGS_MEMBER(wxVSCROLL
)
89 wxFLAGS_MEMBER(wxHSCROLL
)
92 wxFLAGS_MEMBER(wxSTAY_ON_TOP
)
93 wxFLAGS_MEMBER(wxCAPTION
)
94 #if WXWIN_COMPATIBILITY_2_6
95 wxFLAGS_MEMBER(wxTHICK_FRAME
)
96 #endif // WXWIN_COMPATIBILITY_2_6
97 wxFLAGS_MEMBER(wxSYSTEM_MENU
)
98 wxFLAGS_MEMBER(wxRESIZE_BORDER
)
99 #if WXWIN_COMPATIBILITY_2_6
100 wxFLAGS_MEMBER(wxRESIZE_BOX
)
101 #endif // WXWIN_COMPATIBILITY_2_6
102 wxFLAGS_MEMBER(wxCLOSE_BOX
)
103 wxFLAGS_MEMBER(wxMAXIMIZE_BOX
)
104 wxFLAGS_MEMBER(wxMINIMIZE_BOX
)
106 wxFLAGS_MEMBER(wxFRAME_TOOL_WINDOW
)
107 wxFLAGS_MEMBER(wxFRAME_FLOAT_ON_PARENT
)
109 wxFLAGS_MEMBER(wxFRAME_SHAPED
)
110 wxEND_FLAGS( wxFrameStyle
)
112 wxIMPLEMENT_DYNAMIC_CLASS_XTI(wxFrame
, wxTopLevelWindow
, "wx/frame.h")
114 wxBEGIN_PROPERTIES_TABLE(wxFrame
)
115 wxEVENT_PROPERTY( Menu
, wxEVT_COMMAND_MENU_SELECTED
, wxCommandEvent
)
117 wxPROPERTY( Title
,wxString
, SetTitle
, GetTitle
, wxString(), 0 /*flags*/, \
118 wxT("Helpstring"), wxT("group"))
119 wxPROPERTY_FLAGS( WindowStyle
, wxFrameStyle
, long, SetWindowStyleFlag
, \
120 GetWindowStyleFlag
, wxEMPTY_PARAMETER_VALUE
, 0 /*flags*/, \
121 wxT("Helpstring"), wxT("group")) // style
122 wxPROPERTY( MenuBar
, wxMenuBar
*, SetMenuBar
, GetMenuBar
, wxEMPTY_PARAMETER_VALUE
, \
123 0 /*flags*/, wxT("Helpstring"), wxT("group"))
124 wxEND_PROPERTIES_TABLE()
126 wxEMPTY_HANDLERS_TABLE(wxFrame
)
128 wxCONSTRUCTOR_6( wxFrame
, wxWindow
*, Parent
, wxWindowID
, Id
, wxString
, Title
, \
129 wxPoint
, Position
, wxSize
, Size
, long, WindowStyle
)
131 // ----------------------------------------------------------------------------
132 // construction/destruction
133 // ----------------------------------------------------------------------------
135 wxFrameBase::wxFrameBase()
138 m_frameMenuBar
= NULL
;
139 #endif // wxUSE_MENUS
142 m_frameToolBar
= NULL
;
143 #endif // wxUSE_TOOLBAR
146 m_frameStatusBar
= NULL
;
147 #endif // wxUSE_STATUSBAR
152 wxFrameBase::~wxFrameBase()
154 // this destructor is required for Darwin
157 wxFrame
*wxFrameBase::New(wxWindow
*parent
,
159 const wxString
& title
,
163 const wxString
& name
)
165 return new wxFrame(parent
, id
, title
, pos
, size
, style
, name
);
168 void wxFrameBase::DeleteAllBars()
171 wxDELETE(m_frameMenuBar
);
172 #endif // wxUSE_MENUS
175 wxDELETE(m_frameStatusBar
);
176 #endif // wxUSE_STATUSBAR
179 wxDELETE(m_frameToolBar
);
180 #endif // wxUSE_TOOLBAR
183 bool wxFrameBase::IsOneOfBars(const wxWindow
*win
) const
186 if ( win
== GetMenuBar() )
188 #endif // wxUSE_MENUS
191 if ( win
== GetStatusBar() )
193 #endif // wxUSE_STATUSBAR
196 if ( win
== GetToolBar() )
198 #endif // wxUSE_TOOLBAR
205 // ----------------------------------------------------------------------------
206 // wxFrame size management: we exclude the areas taken by menu/status/toolbars
207 // from the client area, so the client area is what's really available for the
209 // ----------------------------------------------------------------------------
211 // get the origin of the client area in the client coordinates
212 wxPoint
wxFrameBase::GetClientAreaOrigin() const
214 wxPoint pt
= wxTopLevelWindow::GetClientAreaOrigin();
216 #if wxUSE_TOOLBAR && !defined(__WXUNIVERSAL__)
217 wxToolBar
*toolbar
= GetToolBar();
218 if ( toolbar
&& toolbar
->IsShown() )
221 toolbar
->GetSize(&w
, &h
);
223 if ( toolbar
->GetWindowStyleFlag() & wxTB_VERTICAL
)
232 #endif // wxUSE_TOOLBAR
237 // ----------------------------------------------------------------------------
239 // ----------------------------------------------------------------------------
243 bool wxFrameBase::ProcessCommand(int id
)
245 wxMenuItem
* const item
= FindItemInMenuBar(id
);
249 return ProcessCommand(item
);
252 bool wxFrameBase::ProcessCommand(wxMenuItem
*item
)
254 wxCHECK_MSG( item
, false, wxS("Menu item can't be NULL") );
256 if (!item
->IsEnabled())
259 if ((item
->GetKind() == wxITEM_RADIO
) && item
->IsChecked() )
263 if (item
->IsCheckable())
268 checked
= item
->IsChecked();
270 else // Uncheckable item.
275 wxMenu
* const menu
= item
->GetMenu();
276 wxCHECK_MSG( menu
, false, wxS("Menu item should be attached to a menu") );
278 return menu
->SendEvent(item
->GetId(), checked
);
281 #endif // wxUSE_MENUS
283 // Do the UI update processing for this window. This is
284 // provided for the application to call if it wants to
285 // force a UI update, particularly for the menus and toolbar.
286 void wxFrameBase::UpdateWindowUI(long flags
)
288 wxWindowBase::UpdateWindowUI(flags
);
292 GetToolBar()->UpdateWindowUI(flags
);
298 // If coming from an idle event, we only want to update the menus if
299 // we're in the wxUSE_IDLEMENUUPDATES configuration, otherwise they
300 // will be update when the menu is opened later
301 #if !wxUSE_IDLEMENUUPDATES
302 if ( !(flags
& wxUPDATE_UI_FROMIDLE
) )
303 #endif // wxUSE_IDLEMENUUPDATES
306 #endif // wxUSE_MENUS
309 // ----------------------------------------------------------------------------
310 // event handlers for status bar updates from menus
311 // ----------------------------------------------------------------------------
313 #if wxUSE_MENUS && wxUSE_STATUSBAR
315 void wxFrameBase::OnMenuHighlight(wxMenuEvent
& event
)
318 (void)ShowMenuHelp(event
.GetMenuId());
319 #endif // wxUSE_STATUSBAR
322 void wxFrameBase::OnMenuOpen(wxMenuEvent
& event
)
324 #if wxUSE_IDLEMENUUPDATES
326 #else // !wxUSE_IDLEMENUUPDATES
327 // as we didn't update the menus from idle time, do it now
328 DoMenuUpdates(event
.GetMenu());
329 #endif // wxUSE_IDLEMENUUPDATES/!wxUSE_IDLEMENUUPDATES
332 void wxFrameBase::OnMenuClose(wxMenuEvent
& WXUNUSED(event
))
334 DoGiveHelp(wxEmptyString
, false);
337 #endif // wxUSE_MENUS && wxUSE_STATUSBAR
339 // Implement internal behaviour (menu updating on some platforms)
340 void wxFrameBase::OnInternalIdle()
342 wxTopLevelWindow::OnInternalIdle();
344 #if wxUSE_MENUS && wxUSE_IDLEMENUUPDATES
345 if (wxUpdateUIEvent::CanUpdate(this))
350 // ----------------------------------------------------------------------------
352 // ----------------------------------------------------------------------------
356 wxStatusBar
* wxFrameBase::CreateStatusBar(int number
,
359 const wxString
& name
)
361 // the main status bar can only be created once (or else it should be
362 // deleted before calling CreateStatusBar() again)
363 wxCHECK_MSG( !m_frameStatusBar
, NULL
,
364 wxT("recreating status bar in wxFrame") );
366 SetStatusBar(OnCreateStatusBar(number
, style
, id
, name
));
368 return m_frameStatusBar
;
371 wxStatusBar
*wxFrameBase::OnCreateStatusBar(int number
,
374 const wxString
& name
)
376 wxStatusBar
*statusBar
= new wxStatusBar(this, id
, style
, name
);
378 statusBar
->SetFieldsCount(number
);
383 void wxFrameBase::SetStatusText(const wxString
& text
, int number
)
385 wxCHECK_RET( m_frameStatusBar
!= NULL
, wxT("no statusbar to set text for") );
387 m_frameStatusBar
->SetStatusText(text
, number
);
390 void wxFrameBase::SetStatusWidths(int n
, const int widths_field
[] )
392 wxCHECK_RET( m_frameStatusBar
!= NULL
, wxT("no statusbar to set widths for") );
394 m_frameStatusBar
->SetStatusWidths(n
, widths_field
);
399 void wxFrameBase::PushStatusText(const wxString
& text
, int number
)
401 wxCHECK_RET( m_frameStatusBar
!= NULL
, wxT("no statusbar to set text for") );
403 m_frameStatusBar
->PushStatusText(text
, number
);
406 void wxFrameBase::PopStatusText(int number
)
408 wxCHECK_RET( m_frameStatusBar
!= NULL
, wxT("no statusbar to set text for") );
410 m_frameStatusBar
->PopStatusText(number
);
413 bool wxFrameBase::ShowMenuHelp(int menuId
)
416 // if no help string found, we will clear the status bar text
418 // NB: wxID_NONE is used for (sub)menus themselves by wxMSW
420 if ( menuId
!= wxID_SEPARATOR
&& menuId
!= wxID_NONE
)
422 const wxMenuItem
* const item
= FindItemInMenuBar(menuId
);
423 if ( item
&& !item
->IsSeparator() )
424 helpString
= item
->GetHelp();
426 // notice that it's ok if we don't find the item because it might
427 // belong to the popup menu, so don't assert here
430 DoGiveHelp(helpString
, true);
432 return !helpString
.empty();
433 #else // !wxUSE_MENUS
435 #endif // wxUSE_MENUS/!wxUSE_MENUS
438 void wxFrameBase::SetStatusBar(wxStatusBar
*statBar
)
440 bool hadBar
= m_frameStatusBar
!= NULL
;
441 m_frameStatusBar
= statBar
;
443 if ( (m_frameStatusBar
!= NULL
) != hadBar
)
451 #endif // wxUSE_STATUSBAR
453 #if wxUSE_MENUS || wxUSE_TOOLBAR
454 void wxFrameBase::DoGiveHelp(const wxString
& help
, bool show
)
457 if ( m_statusBarPane
< 0 )
459 // status bar messages disabled
463 wxStatusBar
*statbar
= GetStatusBar();
470 // remember the old status bar text if this is the first time we're
471 // called since the menu has been opened as we're going to overwrite it
472 // in our DoGiveHelp() and we want to restore it when the menu is
475 // note that it would be logical to do this in OnMenuOpen() but under
476 // MSW we get an EVT_MENU_HIGHLIGHT before EVT_MENU_OPEN, strangely
477 // enough, and so this doesn't work and instead we use the ugly trick
478 // with using special m_oldStatusText value as "menu opened" (but it is
479 // arguably better than adding yet another member variable to wxFrame
481 if ( m_oldStatusText
.empty() )
483 m_oldStatusText
= statbar
->GetStatusText(m_statusBarPane
);
484 if ( m_oldStatusText
.empty() )
486 // use special value to prevent us from doing this the next time
487 m_oldStatusText
+= wxT('\0');
494 else // hide help, restore the original text
496 // clear the last shown help string but remember its value
497 wxString lastHelpShown
;
498 lastHelpShown
.swap(m_lastHelpShown
);
500 // also clear the old status text but remember it too to restore it
502 text
.swap(m_oldStatusText
);
504 if ( statbar
->GetStatusText(m_statusBarPane
) != lastHelpShown
)
506 // if the text was changed with an explicit SetStatusText() call
507 // from the user code in the meanwhile, do not overwrite it with
508 // the old status bar contents -- this is almost certainly not what
509 // the user expects and would be very hard to avoid from user code
514 statbar
->SetStatusText(text
, m_statusBarPane
);
518 #endif // wxUSE_STATUSBAR
520 #endif // wxUSE_MENUS || wxUSE_TOOLBAR
523 // ----------------------------------------------------------------------------
525 // ----------------------------------------------------------------------------
529 wxToolBar
* wxFrameBase::CreateToolBar(long style
,
531 const wxString
& name
)
533 // the main toolbar can't be recreated (unless it was explicitly deleted
535 wxCHECK_MSG( !m_frameToolBar
, NULL
,
536 wxT("recreating toolbar in wxFrame") );
542 // NB: we don't specify the default value in the method declaration
544 // a) this allows us to have different defaults for different
545 // platforms (even if we don't have them right now)
546 // b) we don't need to include wx/toolbar.h in the header then
547 style
= wxBORDER_NONE
| wxTB_HORIZONTAL
| wxTB_FLAT
;
550 SetToolBar(OnCreateToolBar(style
, id
, name
));
552 return m_frameToolBar
;
555 wxToolBar
* wxFrameBase::OnCreateToolBar(long style
,
557 const wxString
& name
)
559 #if defined(__WXWINCE__) && defined(__POCKETPC__)
560 return new wxToolMenuBar(this, id
,
561 wxDefaultPosition
, wxDefaultSize
,
564 return new wxToolBar(this, id
,
565 wxDefaultPosition
, wxDefaultSize
,
570 void wxFrameBase::SetToolBar(wxToolBar
*toolbar
)
572 if ( (toolbar
!= NULL
) != (m_frameToolBar
!= NULL
) )
574 // the toolbar visibility must have changed so we need to both position
575 // the toolbar itself (if it appeared) and to relayout the frame
576 // contents in any case
580 // we need to assign it to m_frameToolBar for PositionToolBar() to
582 m_frameToolBar
= toolbar
;
585 //else: tricky: do not reset m_frameToolBar yet as otherwise DoLayout()
586 // wouldn't recognize the (still existing) toolbar as one of our
587 // bars and wouldn't layout the single child of the frame correctly
590 // and this is even more tricky: we want DoLayout() to recognize the
591 // old toolbar for the purpose of not counting it among our non-bar
592 // children but we don't want to reserve any more space for it so we
593 // temporarily hide it
594 if ( m_frameToolBar
)
595 m_frameToolBar
->Hide();
599 if ( m_frameToolBar
)
600 m_frameToolBar
->Show();
603 // this might have been already done above but it's simpler to just always
604 // do it unconditionally instead of testing for whether we already did it
605 m_frameToolBar
= toolbar
;
608 #endif // wxUSE_TOOLBAR
610 // ----------------------------------------------------------------------------
612 // ----------------------------------------------------------------------------
617 void wxFrameBase::DoMenuUpdates(wxMenu
* menu
)
621 wxEvtHandler
* source
= GetEventHandler();
622 menu
->UpdateUI(source
);
626 wxMenuBar
* bar
= GetMenuBar();
632 void wxFrameBase::DetachMenuBar()
634 if ( m_frameMenuBar
)
636 m_frameMenuBar
->Detach();
637 m_frameMenuBar
= NULL
;
641 void wxFrameBase::AttachMenuBar(wxMenuBar
*menubar
)
645 menubar
->Attach((wxFrame
*)this);
646 m_frameMenuBar
= menubar
;
650 void wxFrameBase::SetMenuBar(wxMenuBar
*menubar
)
652 if ( menubar
== GetMenuBar() )
660 this->AttachMenuBar(menubar
);
663 wxMenuItem
*wxFrameBase::FindItemInMenuBar(int menuId
) const
665 const wxMenuBar
* const menuBar
= GetMenuBar();
667 return menuBar
? menuBar
->FindItem(menuId
) : NULL
;
670 #endif // wxUSE_MENUS