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
123 wxPROPERTY( MenuBar
, wxMenuBar
*, SetMenuBar
, GetMenuBar
, wxEMPTY_PARAMETER_VALUE
, \
124 0 /*flags*/, wxT("Helpstring"), wxT("group"))
126 wxEND_PROPERTIES_TABLE()
128 wxEMPTY_HANDLERS_TABLE(wxFrame
)
130 wxCONSTRUCTOR_6( wxFrame
, wxWindow
*, Parent
, wxWindowID
, Id
, wxString
, Title
, \
131 wxPoint
, Position
, wxSize
, Size
, long, WindowStyle
)
133 // ----------------------------------------------------------------------------
134 // construction/destruction
135 // ----------------------------------------------------------------------------
137 wxFrameBase::wxFrameBase()
140 m_frameMenuBar
= NULL
;
141 #endif // wxUSE_MENUS
144 m_frameToolBar
= NULL
;
145 #endif // wxUSE_TOOLBAR
148 m_frameStatusBar
= NULL
;
149 #endif // wxUSE_STATUSBAR
154 wxFrameBase::~wxFrameBase()
156 // this destructor is required for Darwin
159 wxFrame
*wxFrameBase::New(wxWindow
*parent
,
161 const wxString
& title
,
165 const wxString
& name
)
167 return new wxFrame(parent
, id
, title
, pos
, size
, style
, name
);
170 void wxFrameBase::DeleteAllBars()
173 wxDELETE(m_frameMenuBar
);
174 #endif // wxUSE_MENUS
177 wxDELETE(m_frameStatusBar
);
178 #endif // wxUSE_STATUSBAR
181 wxDELETE(m_frameToolBar
);
182 #endif // wxUSE_TOOLBAR
185 bool wxFrameBase::IsOneOfBars(const wxWindow
*win
) const
188 if ( win
== GetMenuBar() )
190 #endif // wxUSE_MENUS
193 if ( win
== GetStatusBar() )
195 #endif // wxUSE_STATUSBAR
198 if ( win
== GetToolBar() )
200 #endif // wxUSE_TOOLBAR
207 // ----------------------------------------------------------------------------
208 // wxFrame size management: we exclude the areas taken by menu/status/toolbars
209 // from the client area, so the client area is what's really available for the
211 // ----------------------------------------------------------------------------
213 // get the origin of the client area in the client coordinates
214 wxPoint
wxFrameBase::GetClientAreaOrigin() const
216 wxPoint pt
= wxTopLevelWindow::GetClientAreaOrigin();
218 #if wxUSE_TOOLBAR && !defined(__WXUNIVERSAL__)
219 wxToolBar
*toolbar
= GetToolBar();
220 if ( toolbar
&& toolbar
->IsShown() )
223 toolbar
->GetSize(&w
, &h
);
225 if ( toolbar
->GetWindowStyleFlag() & wxTB_VERTICAL
)
234 #endif // wxUSE_TOOLBAR
239 // ----------------------------------------------------------------------------
241 // ----------------------------------------------------------------------------
245 bool wxFrameBase::ProcessCommand(int id
)
247 wxMenuItem
* const item
= FindItemInMenuBar(id
);
251 return ProcessCommand(item
);
254 bool wxFrameBase::ProcessCommand(wxMenuItem
*item
)
256 wxCHECK_MSG( item
, false, wxS("Menu item can't be NULL") );
258 if (!item
->IsEnabled())
261 if ((item
->GetKind() == wxITEM_RADIO
) && item
->IsChecked() )
265 if (item
->IsCheckable())
270 checked
= item
->IsChecked();
272 else // Uncheckable item.
277 wxMenu
* const menu
= item
->GetMenu();
278 wxCHECK_MSG( menu
, false, wxS("Menu item should be attached to a menu") );
280 return menu
->SendEvent(item
->GetId(), checked
);
283 #endif // wxUSE_MENUS
285 // Do the UI update processing for this window. This is
286 // provided for the application to call if it wants to
287 // force a UI update, particularly for the menus and toolbar.
288 void wxFrameBase::UpdateWindowUI(long flags
)
290 wxWindowBase::UpdateWindowUI(flags
);
294 GetToolBar()->UpdateWindowUI(flags
);
300 // If coming from an idle event, we only want to update the menus if
301 // we're in the wxUSE_IDLEMENUUPDATES configuration, otherwise they
302 // will be update when the menu is opened later
303 #if !wxUSE_IDLEMENUUPDATES
304 if ( !(flags
& wxUPDATE_UI_FROMIDLE
) )
305 #endif // wxUSE_IDLEMENUUPDATES
308 #endif // wxUSE_MENUS
311 // ----------------------------------------------------------------------------
312 // event handlers for status bar updates from menus
313 // ----------------------------------------------------------------------------
315 #if wxUSE_MENUS && wxUSE_STATUSBAR
317 void wxFrameBase::OnMenuHighlight(wxMenuEvent
& event
)
320 (void)ShowMenuHelp(event
.GetMenuId());
321 #endif // wxUSE_STATUSBAR
324 void wxFrameBase::OnMenuOpen(wxMenuEvent
& event
)
326 #if wxUSE_IDLEMENUUPDATES
328 #else // !wxUSE_IDLEMENUUPDATES
329 // as we didn't update the menus from idle time, do it now
330 DoMenuUpdates(event
.GetMenu());
331 #endif // wxUSE_IDLEMENUUPDATES/!wxUSE_IDLEMENUUPDATES
334 void wxFrameBase::OnMenuClose(wxMenuEvent
& WXUNUSED(event
))
336 DoGiveHelp(wxEmptyString
, false);
339 #endif // wxUSE_MENUS && wxUSE_STATUSBAR
341 // Implement internal behaviour (menu updating on some platforms)
342 void wxFrameBase::OnInternalIdle()
344 wxTopLevelWindow::OnInternalIdle();
346 #if wxUSE_MENUS && wxUSE_IDLEMENUUPDATES
347 if (wxUpdateUIEvent::CanUpdate(this))
352 // ----------------------------------------------------------------------------
354 // ----------------------------------------------------------------------------
358 wxStatusBar
* wxFrameBase::CreateStatusBar(int number
,
361 const wxString
& name
)
363 // the main status bar can only be created once (or else it should be
364 // deleted before calling CreateStatusBar() again)
365 wxCHECK_MSG( !m_frameStatusBar
, NULL
,
366 wxT("recreating status bar in wxFrame") );
368 SetStatusBar(OnCreateStatusBar(number
, style
, id
, name
));
370 return m_frameStatusBar
;
373 wxStatusBar
*wxFrameBase::OnCreateStatusBar(int number
,
376 const wxString
& name
)
378 wxStatusBar
*statusBar
= new wxStatusBar(this, id
, style
, name
);
380 statusBar
->SetFieldsCount(number
);
385 void wxFrameBase::SetStatusText(const wxString
& text
, int number
)
387 wxCHECK_RET( m_frameStatusBar
!= NULL
, wxT("no statusbar to set text for") );
389 m_frameStatusBar
->SetStatusText(text
, number
);
392 void wxFrameBase::SetStatusWidths(int n
, const int widths_field
[] )
394 wxCHECK_RET( m_frameStatusBar
!= NULL
, wxT("no statusbar to set widths for") );
396 m_frameStatusBar
->SetStatusWidths(n
, widths_field
);
401 void wxFrameBase::PushStatusText(const wxString
& text
, int number
)
403 wxCHECK_RET( m_frameStatusBar
!= NULL
, wxT("no statusbar to set text for") );
405 m_frameStatusBar
->PushStatusText(text
, number
);
408 void wxFrameBase::PopStatusText(int number
)
410 wxCHECK_RET( m_frameStatusBar
!= NULL
, wxT("no statusbar to set text for") );
412 m_frameStatusBar
->PopStatusText(number
);
415 bool wxFrameBase::ShowMenuHelp(int menuId
)
418 // if no help string found, we will clear the status bar text
420 // NB: wxID_NONE is used for (sub)menus themselves by wxMSW
422 if ( menuId
!= wxID_SEPARATOR
&& menuId
!= wxID_NONE
)
424 const wxMenuItem
* const item
= FindItemInMenuBar(menuId
);
425 if ( item
&& !item
->IsSeparator() )
426 helpString
= item
->GetHelp();
428 // notice that it's ok if we don't find the item because it might
429 // belong to the popup menu, so don't assert here
432 DoGiveHelp(helpString
, true);
434 return !helpString
.empty();
435 #else // !wxUSE_MENUS
437 #endif // wxUSE_MENUS/!wxUSE_MENUS
440 void wxFrameBase::SetStatusBar(wxStatusBar
*statBar
)
442 bool hadBar
= m_frameStatusBar
!= NULL
;
443 m_frameStatusBar
= statBar
;
445 if ( (m_frameStatusBar
!= NULL
) != hadBar
)
453 #endif // wxUSE_STATUSBAR
455 #if wxUSE_MENUS || wxUSE_TOOLBAR
456 void wxFrameBase::DoGiveHelp(const wxString
& help
, bool show
)
459 if ( m_statusBarPane
< 0 )
461 // status bar messages disabled
465 wxStatusBar
*statbar
= GetStatusBar();
472 // remember the old status bar text if this is the first time we're
473 // called since the menu has been opened as we're going to overwrite it
474 // in our DoGiveHelp() and we want to restore it when the menu is
477 // note that it would be logical to do this in OnMenuOpen() but under
478 // MSW we get an EVT_MENU_HIGHLIGHT before EVT_MENU_OPEN, strangely
479 // enough, and so this doesn't work and instead we use the ugly trick
480 // with using special m_oldStatusText value as "menu opened" (but it is
481 // arguably better than adding yet another member variable to wxFrame
483 if ( m_oldStatusText
.empty() )
485 m_oldStatusText
= statbar
->GetStatusText(m_statusBarPane
);
486 if ( m_oldStatusText
.empty() )
488 // use special value to prevent us from doing this the next time
489 m_oldStatusText
+= wxT('\0');
496 else // hide help, restore the original text
498 // clear the last shown help string but remember its value
499 wxString lastHelpShown
;
500 lastHelpShown
.swap(m_lastHelpShown
);
502 // also clear the old status text but remember it too to restore it
504 text
.swap(m_oldStatusText
);
506 if ( statbar
->GetStatusText(m_statusBarPane
) != lastHelpShown
)
508 // if the text was changed with an explicit SetStatusText() call
509 // from the user code in the meanwhile, do not overwrite it with
510 // the old status bar contents -- this is almost certainly not what
511 // the user expects and would be very hard to avoid from user code
516 statbar
->SetStatusText(text
, m_statusBarPane
);
520 #endif // wxUSE_STATUSBAR
522 #endif // wxUSE_MENUS || wxUSE_TOOLBAR
525 // ----------------------------------------------------------------------------
527 // ----------------------------------------------------------------------------
531 wxToolBar
* wxFrameBase::CreateToolBar(long style
,
533 const wxString
& name
)
535 // the main toolbar can't be recreated (unless it was explicitly deleted
537 wxCHECK_MSG( !m_frameToolBar
, NULL
,
538 wxT("recreating toolbar in wxFrame") );
544 // NB: we don't specify the default value in the method declaration
546 // a) this allows us to have different defaults for different
547 // platforms (even if we don't have them right now)
548 // b) we don't need to include wx/toolbar.h in the header then
549 style
= wxBORDER_NONE
| wxTB_HORIZONTAL
| wxTB_FLAT
;
552 SetToolBar(OnCreateToolBar(style
, id
, name
));
554 return m_frameToolBar
;
557 wxToolBar
* wxFrameBase::OnCreateToolBar(long style
,
559 const wxString
& name
)
561 #if defined(__WXWINCE__) && defined(__POCKETPC__)
562 return new wxToolMenuBar(this, id
,
563 wxDefaultPosition
, wxDefaultSize
,
566 return new wxToolBar(this, id
,
567 wxDefaultPosition
, wxDefaultSize
,
572 void wxFrameBase::SetToolBar(wxToolBar
*toolbar
)
574 if ( (toolbar
!= NULL
) != (m_frameToolBar
!= NULL
) )
576 // the toolbar visibility must have changed so we need to both position
577 // the toolbar itself (if it appeared) and to relayout the frame
578 // contents in any case
582 // we need to assign it to m_frameToolBar for PositionToolBar() to
584 m_frameToolBar
= toolbar
;
587 //else: tricky: do not reset m_frameToolBar yet as otherwise DoLayout()
588 // wouldn't recognize the (still existing) toolbar as one of our
589 // bars and wouldn't layout the single child of the frame correctly
592 // and this is even more tricky: we want DoLayout() to recognize the
593 // old toolbar for the purpose of not counting it among our non-bar
594 // children but we don't want to reserve any more space for it so we
595 // temporarily hide it
596 if ( m_frameToolBar
)
597 m_frameToolBar
->Hide();
601 if ( m_frameToolBar
)
602 m_frameToolBar
->Show();
605 // this might have been already done above but it's simpler to just always
606 // do it unconditionally instead of testing for whether we already did it
607 m_frameToolBar
= toolbar
;
610 #endif // wxUSE_TOOLBAR
612 // ----------------------------------------------------------------------------
614 // ----------------------------------------------------------------------------
619 void wxFrameBase::DoMenuUpdates(wxMenu
* menu
)
623 wxEvtHandler
* source
= GetEventHandler();
624 menu
->UpdateUI(source
);
628 wxMenuBar
* bar
= GetMenuBar();
634 void wxFrameBase::DetachMenuBar()
636 if ( m_frameMenuBar
)
638 m_frameMenuBar
->Detach();
639 m_frameMenuBar
= NULL
;
643 void wxFrameBase::AttachMenuBar(wxMenuBar
*menubar
)
647 menubar
->Attach((wxFrame
*)this);
648 m_frameMenuBar
= menubar
;
652 void wxFrameBase::SetMenuBar(wxMenuBar
*menubar
)
654 if ( menubar
== GetMenuBar() )
662 this->AttachMenuBar(menubar
);
665 wxMenuItem
*wxFrameBase::FindItemInMenuBar(int menuId
) const
667 const wxMenuBar
* const menuBar
= GetMenuBar();
669 return menuBar
? menuBar
->FindItem(menuId
) : NULL
;
672 #endif // wxUSE_MENUS