wxDocParentFrame

The wxDocParentFrame class provides a default top-level frame for applications using the document/view framework. This class can only be used for SDI (not MDI) parent frames.
It cooperates with the wxView, wxDocument, wxDocManager and wxDocTemplates classes.
See the example application in samples/docview.

Derived from

wxFrame
wxWindow
wxEvtHandler
wxObject

Include files

<wx/docview.h>

See also

Document/view overview, wxFrame

Members


wxDocParentFrame::wxDocParentFrame

wxDocParentFrame()
Default constructor.
wxDocParentFrame(wxDocManager* manager, wxFrame * parent, wxWindowID id, const wxString& title, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = wxDEFAULT_FRAME_STYLE, const wxString& name = "frame")
Constructor.

wxDocParentFrame::~wxDocParentFrame

~wxDocParentFrame()
Destructor.

wxDocParentFrame::Create

bool Create(wxDocManager* manager, wxFrame * parent, wxWindowID id, const wxString& title, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = wxDEFAULT_FRAME_STYLE, const wxString& name = "frame")
Used in two-step construction.

wxDocParentFrame::GetDocumentManager

wxDocManager * GetDocumentManager() const
Returns the associated document manager object.

wxDocParentFrame::OnCloseWindow

void OnCloseWindow(wxCloseEvent& event)
Deletes all views and documents. If no user input cancelled the operation, the frame will be destroyed and the application will exit.
Since understanding how document/view clean-up takes place can be difficult, the implementation of this function is shown below.
void wxDocParentFrame::OnCloseWindow(wxCloseEvent& event)
{
  if (m_docManager->Clear(!event.CanVeto()))
  {
    this->Destroy();
  }
  else
    event.Veto();
}