// Author: Julian Smart
// Modified by:
// Created: 01/02/97
-// RCS-ID: $Id$
// Copyright: (c) Julian Smart
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#if wxUSE_DOC_VIEW_ARCHITECTURE
#include "wx/list.h"
+#include "wx/dlist.h"
#include "wx/string.h"
#include "wx/frame.h"
#include "wx/filehistory.h"
+#include "wx/vector.h"
#if wxUSE_PRINTING_ARCHITECTURE
#include "wx/print.h"
#define wxMAX_FILE_HISTORY 9
+typedef wxVector<wxDocument*> wxDocVector;
+typedef wxVector<wxView*> wxViewVector;
+typedef wxVector<wxDocTemplate*> wxDocTemplateVector;
+
class WXDLLIMPEXP_CORE wxDocument : public wxEvtHandler
{
public:
bool GetDocumentSaved() const { return m_savedYet; }
void SetDocumentSaved(bool saved = true) { m_savedYet = saved; }
+ // activate the first view of the document if any
+ void Activate();
+
// return true if the document hasn't been modified since the last time it
// was saved (implying that it returns false if it was never saved, even if
// the document is not modified)
virtual bool AddView(wxView *view);
virtual bool RemoveView(wxView *view);
+
+#ifndef __VISUALC6__
+ wxViewVector GetViewsVector() const;
+#endif // !__VISUALC6__
+
wxList& GetViews() { return m_documentViews; }
const wxList& GetViews() const { return m_documentViews; }
+
wxView *GetFirstView() const;
virtual void UpdateAllViews(wxView *sender = NULL, wxObject *hint = NULL);
// dialogs. Override if necessary.
virtual wxWindow *GetDocumentWindow() const;
+ // Returns true if this document is a child document corresponding to a
+ // part of the parent document and not a disk file as usual.
+ bool IsChildDocument() const { return m_documentParent != NULL; }
+
protected:
wxList m_documentViews;
wxString m_documentFile;
wxString m_documentTypeName;
wxDocTemplate* m_documentTemplate;
bool m_documentModified;
+
+ // if the document parent is non-NULL, it's a pseudo-document corresponding
+ // to a part of the parent document which can't be saved or loaded
+ // independently of its parent and is always closed when its parent is
wxDocument* m_documentParent;
+
wxCommandProcessor* m_commandProcessor;
bool m_savedYet;
// Called by OnSaveDocument and OnOpenDocument to implement standard
- // Save/Load behavior. Re-implement in derived class for custom
- // behavior.
+ // Save/Load behaviour. Re-implement in derived class for custom
+ // behaviour.
virtual bool DoSaveDocument(const wxString& file);
virtual bool DoOpenDocument(const wxString& file);
wxString DoGetUserReadableName() const;
private:
+ // list of all documents whose m_documentParent is this one
+ typedef wxDList<wxDocument> DocsList;
+ DocsList m_childDocuments;
+
DECLARE_ABSTRACT_CLASS(wxDocument)
wxDECLARE_NO_COPY_CLASS(wxDocument);
};
// destroyed
void SetDocChildFrame(wxDocChildFrameAnyBase *docChildFrame);
+ // get the associated frame, may be NULL during destruction
+ wxDocChildFrameAnyBase* GetDocChildFrame() const { return m_docChildFrame; }
+
protected:
// hook the document into event handlers chain here
virtual bool TryBefore(wxEvent& event);
void OnUpdateFileRevert(wxUpdateUIEvent& event);
void OnUpdateFileNew(wxUpdateUIEvent& event);
void OnUpdateFileSave(wxUpdateUIEvent& event);
+ void OnUpdateFileSaveAs(wxUpdateUIEvent& event);
void OnUpdateUndo(wxUpdateUIEvent& event);
void OnUpdateRedo(wxUpdateUIEvent& event);
// Find template from document class info, may return NULL.
wxDocTemplate* FindTemplate(const wxClassInfo* documentClassInfo);
+ // Find document from file name, may return NULL.
+ wxDocument* FindDocumentByPath(const wxString& path) const;
+
wxDocument *GetCurrentDocument() const;
void SetMaxDocsOpen(int n) { m_maxDocsOpen = n; }
virtual void ActivateView(wxView *view, bool activate = true);
virtual wxView *GetCurrentView() const { return m_currentView; }
+ // This method tries to find an active view harder than GetCurrentView():
+ // if the latter is NULL, it also checks if we don't have just a single
+ // view and returns it then.
+ wxView *GetAnyUsableView() const;
+
+
+#ifndef __VISUALC6__
+ wxDocVector GetDocumentsVector() const;
+ wxDocTemplateVector GetTemplatesVector() const;
+#endif // !__VISUALC6__
+
wxList& GetDocuments() { return m_docs; }
wxList& GetTemplates() { return m_templates; }
// Get the current document manager
static wxDocManager* GetDocumentManager() { return sm_docManager; }
+#if wxUSE_PRINTING_ARCHITECTURE
+ wxPageSetupDialogData& GetPageSetupDialogData()
+ { return m_pageSetupDialogData; }
+ const wxPageSetupDialogData& GetPageSetupDialogData() const
+ { return m_pageSetupDialogData; }
+#endif // wxUSE_PRINTING_ARCHITECTURE
+
#if WXWIN_COMPATIBILITY_2_8
// deprecated, override GetDefaultName() instead
wxDEPRECATED_BUT_USED_INTERNALLY(
protected:
+ // Called when a file selected from the MRU list doesn't exist any more.
+ // The default behaviour is to remove the file from the MRU and notify the
+ // user about it but this method can be overridden to customize it.
+ virtual void OnMRUFileNotExist(unsigned n, const wxString& filename);
+
// Open the MRU file with the given index in our associated file history.
void DoOpenMRUFile(unsigned n);
#if wxUSE_PRINTING_ARCHITECTURE
// return the command processor for the current document, if any
wxCommandProcessor *GetCurrentCommandProcessor() const;
- // this method tries to find an active view harder than GetCurrentView():
- // if the latter is NULL, it also checks if we don't have just a single
- // view and returns it then
- wxView *GetActiveView() const;
-
- // activate the first view of the given document if any
- void ActivateDocument(wxDocument *doc);
-
-
int m_defaultDocumentNameCounter;
int m_maxDocsOpen;
wxList m_docs;
m_childDocument = NULL;
m_childView = NULL;
m_win = NULL;
+ m_lastEvent = NULL;
}
- // full ctor equivalent to using the default one and Create(0
+ // full ctor equivalent to using the default one and Create()
wxDocChildFrameAnyBase(wxDocument *doc, wxView *view, wxWindow *win)
{
Create(doc, view, win);
wxWindow *GetWindow() const { return m_win; }
+ // implementation only
+
+ // Check if this event had been just processed in this frame.
+ bool HasAlreadyProcessed(wxEvent& event) const
+ {
+ return m_lastEvent == &event;
+ }
+
protected:
// we're not a wxEvtHandler but we provide this wxEvtHandler-like function
// which is called from TryBefore() of the derived classes to give our view
// a chance to process the message before the frame event handlers are used
- bool TryProcessEvent(wxEvent& event)
- {
- return m_childView && m_childView->ProcessEventLocally(event);
- }
+ bool TryProcessEvent(wxEvent& event);
// called from EVT_CLOSE handler in the frame: check if we can close and do
// cleanup if so; veto the event otherwise
// allows us to avoid having any virtual functions in this class
wxWindow* m_win;
+private:
+ // Pointer to the last processed event used to avoid sending the same event
+ // twice to wxDocManager, from here and from wxDocParentFrameAnyBase.
+ wxEvent* m_lastEvent;
wxDECLARE_NO_COPY_CLASS(wxDocChildFrameAnyBase);
};
class WXDLLIMPEXP_CORE wxDocParentFrameAnyBase
{
public:
- wxDocParentFrameAnyBase() { m_docManager = NULL; }
+ wxDocParentFrameAnyBase(wxWindow* frame)
+ : m_frame(frame)
+ {
+ m_docManager = NULL;
+ }
wxDocManager *GetDocumentManager() const { return m_docManager; }
protected:
+ // This is similar to wxDocChildFrameAnyBase method with the same name:
+ // while we're not an event handler ourselves and so can't override
+ // TryBefore(), we provide a helper that the derived template class can use
+ // from its TryBefore() implementation.
+ bool TryProcessEvent(wxEvent& event);
+
+ wxWindow* const m_frame;
wxDocManager *m_docManager;
wxDECLARE_NO_COPY_CLASS(wxDocParentFrameAnyBase);
public wxDocParentFrameAnyBase
{
public:
- wxDocParentFrameAny() { }
+ wxDocParentFrameAny() : wxDocParentFrameAnyBase(this) { }
wxDocParentFrameAny(wxDocManager *manager,
wxFrame *frame,
wxWindowID id,
const wxSize& size = wxDefaultSize,
long style = wxDEFAULT_FRAME_STYLE,
const wxString& name = wxFrameNameStr)
+ : wxDocParentFrameAnyBase(this)
{
Create(manager, frame, id, title, pos, size, style, name);
}
if ( !BaseFrame::Create(frame, id, title, pos, size, style, name) )
return false;
- this->Connect(wxID_EXIT, wxEVT_COMMAND_MENU_SELECTED,
+ this->Connect(wxID_EXIT, wxEVT_MENU,
wxCommandEventHandler(wxDocParentFrameAny::OnExit));
this->Connect(wxEVT_CLOSE_WINDOW,
wxCloseEventHandler(wxDocParentFrameAny::OnCloseWindow));
// hook the document manager into event handling chain here
virtual bool TryBefore(wxEvent& event)
{
- if ( m_docManager && m_docManager->ProcessEventLocally(event) )
- return true;
-
- return BaseFrame::TryBefore(event);
+ // It is important to send the event to the base class first as
+ // wxMDIParentFrame overrides its TryBefore() to send the menu events
+ // to the currently active child frame and the child must get them
+ // before our own TryProcessEvent() is executed, not afterwards.
+ return BaseFrame::TryBefore(event) || TryProcessEvent(event);
}
private:
class WXDLLIMPEXP_CORE wxDocPrintout : public wxPrintout
{
public:
- wxDocPrintout(wxView *view = NULL, const wxString& title = _("Printout"));
+ wxDocPrintout(wxView *view = NULL, const wxString& title = wxString());
// implement wxPrintout methods
virtual bool OnPrintPage(int page);
// these flags are not used anywhere by wxWidgets and kept only for an unlikely
// case of existing user code using them for its own purposes
-#ifdef WXWIN_COMPATIBILITY_2_8
+#if WXWIN_COMPATIBILITY_2_8
enum
{
wxDOC_SDI = 1,
};
#endif // WXWIN_COMPATIBILITY_2_8
+#ifndef __VISUALC6__
+inline wxViewVector wxDocument::GetViewsVector() const
+{
+ return m_documentViews.AsVector<wxView*>();
+}
+
+inline wxDocVector wxDocManager::GetDocumentsVector() const
+{
+ return m_docs.AsVector<wxDocument*>();
+}
+
+inline wxDocTemplateVector wxDocManager::GetTemplatesVector() const
+{
+ return m_templates.AsVector<wxDocTemplate*>();
+}
+#endif // !__VISUALC6__
+
#endif // wxUSE_DOC_VIEW_ARCHITECTURE
#endif // _WX_DOCH__
projects / wxWidgets.git / blobdiff