.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxDocParentFrame 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxDocParentFrame \- 
  A parent frame to contain views
 
.SH DESCRIPTION

  


   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
   .
  
 
.SH "PARENTS"

  wxFrame
   
  wxWindow
   
  wxEvtHandler
   
  wxObject
 
.SH "INCLUDE FILES"
wx/docview.h
.SH MEMBERS

  
.SS  wxDocParentFrame (wxDocManager* managerwxFrame *parentwxWindowID idconst wxString& titleconst wxPoint& pos = wxDefaultPositionconst wxSize& size = wxDefaultSizelong style = wxDEFAULT_FRAME_STYLEconst wxString& name = "frame")

     


      Constructor.
     
    
   
  
.SS  ~wxDocParentFrame ()

     


      Destructor.
     
    
   
  
.SS 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();
}

    
 
.SH "SEE ALSO"

  wxFrame
   
  wxWindow
   
  wxEvtHandler
   
  wxObject
 
  Document/view overview
  wxFrame
 
.SH "AUTHORS"
Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al

Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.