wxDocParentFrame Class Reference
[Document/View Framework]

#include <wx/docview.h>

Inheritance diagram for wxDocParentFrame:
Inheritance graph
[legend]

Detailed 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 wxDocTemplate classes.

Library:  wxCore
Category:  Document/View Framework
See also:
Document/View Framework, Document/View Sample, wxFrame

Public Member Functions

 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=wxFrameNameStr)
 Constructor.
virtual ~wxDocParentFrame ()
 Destructor.
bool Create (wxDocManager *manager, wxFrame *parent, wxWindowID id, const wxString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=541072960, const wxString &name=wxFrameNameStr)
 Used in two-step construction.
wxDocManagerGetDocumentManager () const
 Returns the associated document manager object.
void OnCloseWindow (wxCloseEvent &event)
 Deletes all views and documents.

List of all members.


Constructor & Destructor Documentation

wxDocParentFrame::wxDocParentFrame (  ) 

Default constructor.

wxDocParentFrame::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 = wxFrameNameStr 
)

Constructor.

virtual wxDocParentFrame::~wxDocParentFrame (  )  [virtual]

Destructor.


Member Function Documentation

bool wxDocParentFrame::Create ( wxDocManager manager,
wxFrame parent,
wxWindowID  id,
const wxString title,
const wxPoint pos = wxDefaultPosition,
const wxSize size = wxDefaultSize,
long  style = 541072960,
const wxString name = wxFrameNameStr 
)

Used in two-step construction.

wxDocManager* wxDocParentFrame::GetDocumentManager (  )  const

Returns the associated document manager object.

void wxDocParentFrame::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();
        }
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines



wxWidgets logo

[ top ]