#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"
class WXDLLIMPEXP_FWD_CORE wxDocManager;
class WXDLLIMPEXP_FWD_CORE wxPrintInfo;
class WXDLLIMPEXP_FWD_CORE wxCommandProcessor;
-class WXDLLIMPEXP_FWD_CORE wxFileHistory;
class WXDLLIMPEXP_FWD_BASE wxConfigBase;
class wxDocChildFrameAnyBase;
#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)
// deletes the document if this is there are no more views.
virtual void OnChangedViewList();
+ // Called from OnCloseDocument(), does nothing by default but may be
+ // overridden. Return value is ignored.
virtual bool DeleteContents();
virtual bool Draw(wxDC&);
virtual bool IsModified() const { return m_documentModified; }
- virtual void Modify(bool mod) { m_documentModified = mod; }
+ virtual void Modify(bool mod);
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);
};
// set the associated frame, it is used to reset its view when we're
// destroyed
- void SetDocChildFrame(wxDocChildFrameAnyBase *docChildFrame)
- {
- m_docChildFrame = docChildFrame;
- }
+ void SetDocChildFrame(wxDocChildFrameAnyBase *docChildFrame);
protected:
// hook the document into event handlers chain here
void OnFileRevert(wxCommandEvent& event);
void OnFileSave(wxCommandEvent& event);
void OnFileSaveAs(wxCommandEvent& event);
+ void OnMRUFile(wxCommandEvent& event);
+#if wxUSE_PRINTING_ARCHITECTURE
void OnPrint(wxCommandEvent& event);
void OnPreview(wxCommandEvent& event);
+ void OnPageSetup(wxCommandEvent& event);
+#endif // wxUSE_PRINTING_ARCHITECTURE
void OnUndo(wxCommandEvent& event);
void OnRedo(wxCommandEvent& event);
// Handlers for UI update commands
void OnUpdateFileOpen(wxUpdateUIEvent& event);
void OnUpdateDisableIfNoDoc(wxUpdateUIEvent& 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);
void AssociateTemplate(wxDocTemplate *temp);
void DisassociateTemplate(wxDocTemplate *temp);
+ // 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; }
+#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(
wxDEPRECATED( size_t GetNoHistoryFiles() const );
#endif // WXWIN_COMPATIBILITY_2_6
+
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
+ virtual wxPreviewFrame* CreatePreviewFrame(wxPrintPreviewBase* preview,
+ wxWindow *parent,
+ const wxString& title);
+#endif // wxUSE_PRINTING_ARCHITECTURE
+
// hook the currently active view into event handlers chain here
virtual bool TryBefore(wxEvent& event);
// view and returns it then
wxView *GetActiveView() const;
-
int m_defaultDocumentNameCounter;
int m_maxDocsOpen;
wxList m_docs;
wxString m_lastDirectory;
static wxDocManager* sm_docManager;
+#if wxUSE_PRINTING_ARCHITECTURE
+ wxPageSetupDialogData m_pageSetupDialogData;
+#endif // wxUSE_PRINTING_ARCHITECTURE
+
DECLARE_EVENT_TABLE()
DECLARE_DYNAMIC_CLASS(wxDocManager)
wxDECLARE_NO_COPY_CLASS(wxDocManager);
// wxDocChildFrameAny does
// ----------------------------------------------------------------------------
-class wxDocChildFrameAnyBase
+class WXDLLIMPEXP_CORE wxDocChildFrameAnyBase
{
public:
- wxDocChildFrameAnyBase(wxDocument *doc, wxView *view)
+ // default ctor, use Create() after it
+ wxDocChildFrameAnyBase()
+ {
+ m_childDocument = NULL;
+ m_childView = NULL;
+ m_win = NULL;
+ }
+
+ // full ctor equivalent to using the default one and Create(0
+ wxDocChildFrameAnyBase(wxDocument *doc, wxView *view, wxWindow *win)
+ {
+ Create(doc, view, win);
+ }
+
+ // method which must be called for an object created using the default ctor
+ //
+ // note that it returns bool just for consistency with Create() methods in
+ // other classes, we never return false from here
+ bool Create(wxDocument *doc, wxView *view, wxWindow *win)
{
m_childDocument = doc;
m_childView = view;
+ m_win = win;
if ( view )
view->SetDocChildFrame(this);
+
+ return true;
+ }
+
+ // dtor doesn't need to be virtual, an object should never be destroyed via
+ // a pointer to this class
+ ~wxDocChildFrameAnyBase()
+ {
+ // prevent the view from deleting us if we're being deleted directly
+ // (and not via Close() + Destroy())
+ if ( m_childView )
+ m_childView->SetDocChildFrame(NULL);
}
wxDocument *GetDocument() const { return m_childDocument; }
void SetDocument(wxDocument *doc) { m_childDocument = doc; }
void SetView(wxView *view) { m_childView = view; }
+ wxWindow *GetWindow() const { return m_win; }
+
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->ProcessEventHere(event);
+ return m_childView && m_childView->ProcessEventLocally(event);
}
// called from EVT_CLOSE handler in the frame: check if we can close and do
wxDocument* m_childDocument;
wxView* m_childView;
+ // the associated window: having it here is not terribly elegant but it
+ // allows us to avoid having any virtual functions in this class
+ wxWindow* m_win;
+
+
wxDECLARE_NO_COPY_CLASS(wxDocChildFrameAnyBase);
};
public:
typedef ChildFrame BaseClass;
+ // default ctor, use Create after it
+ wxDocChildFrameAny() { }
+
// ctor for a frame showing the given view of the specified document
wxDocChildFrameAny(wxDocument *doc,
wxView *view,
const wxSize& size = wxDefaultSize,
long style = wxDEFAULT_FRAME_STYLE,
const wxString& name = wxFrameNameStr)
- : BaseClass(parent, id, title, pos, size, style, name),
- wxDocChildFrameAnyBase(doc, view)
{
- if ( view )
- view->SetFrame(this);
+ Create(doc, view, parent, id, title, pos, size, style, name);
+ }
+
+ bool Create(wxDocument *doc,
+ wxView *view,
+ ParentFrame *parent,
+ wxWindowID id,
+ const wxString& title,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ long style = wxDEFAULT_FRAME_STYLE,
+ const wxString& name = wxFrameNameStr)
+ {
+ if ( !wxDocChildFrameAnyBase::Create(doc, view, this) )
+ return false;
+
+ if ( !BaseClass::Create(parent, id, title, pos, size, style, name) )
+ return false;
this->Connect(wxEVT_ACTIVATE,
wxActivateEventHandler(wxDocChildFrameAny::OnActivate));
this->Connect(wxEVT_CLOSE_WINDOW,
wxCloseEventHandler(wxDocChildFrameAny::OnCloseWindow));
+
+ return true;
}
virtual bool Destroy()
// otherwise we could simply typedef it
// ----------------------------------------------------------------------------
+#ifdef __VISUALC6__
+ // "non dll-interface class 'wxDocChildFrameAny<>' used as base interface
+ // for dll-interface class 'wxDocChildFrame'" -- this is bogus as the
+ // template will be DLL-exported but only once it is used as base class
+ // here!
+ #pragma warning (push)
+ #pragma warning (disable:4275)
+#endif
+
typedef wxDocChildFrameAny<wxFrame, wxFrame> wxDocChildFrameBase;
class WXDLLIMPEXP_CORE wxDocChildFrame : public wxDocChildFrameBase
{
public:
+ wxDocChildFrame()
+ {
+ }
+
wxDocChildFrame(wxDocument *doc,
wxView *view,
wxFrame *parent,
{
}
+ bool Create(wxDocument *doc,
+ wxView *view,
+ wxFrame *parent,
+ wxWindowID id,
+ const wxString& title,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ long style = wxDEFAULT_FRAME_STYLE,
+ const wxString& name = wxFrameNameStr)
+ {
+ return wxDocChildFrameBase::Create
+ (
+ doc, view,
+ parent, id, title, pos, size, style, name
+ );
+ }
+
private:
DECLARE_CLASS(wxDocChildFrame)
wxDECLARE_NO_COPY_CLASS(wxDocChildFrame);
};
-WXDLLIMPEXP_TEMPLATE_INSTANCE_BASE( wxDocChildFrameBase )
-
// ----------------------------------------------------------------------------
-// A default parent frame
+// wxDocParentFrame and related classes.
+//
+// As with wxDocChildFrame we define a template base class used by both normal
+// and MDI versions
// ----------------------------------------------------------------------------
-class WXDLLIMPEXP_CORE wxDocParentFrame : public wxFrame
+// Base class containing type-independent code of wxDocParentFrameAny
+//
+// Similarly to wxDocChildFrameAnyBase, this class is a mix-in and doesn't
+// derive from wxWindow.
+class WXDLLIMPEXP_CORE wxDocParentFrameAnyBase
{
public:
- wxDocParentFrame();
- wxDocParentFrame(wxDocManager *manager,
- wxFrame *frame,
- wxWindowID id,
- const wxString& title,
- const wxPoint& pos = wxDefaultPosition,
- const wxSize& size = wxDefaultSize,
- long style = wxDEFAULT_FRAME_STYLE,
- const wxString& name = wxFrameNameStr);
+ wxDocParentFrameAnyBase() { m_docManager = NULL; }
+
+ wxDocManager *GetDocumentManager() const { return m_docManager; }
+
+protected:
+ wxDocManager *m_docManager;
+
+ wxDECLARE_NO_COPY_CLASS(wxDocParentFrameAnyBase);
+};
+
+// This is similar to wxDocChildFrameAny and is used to provide common
+// implementation for both wxDocParentFrame and wxDocMDIParentFrame
+template <class BaseFrame>
+class WXDLLIMPEXP_CORE wxDocParentFrameAny : public BaseFrame,
+ public wxDocParentFrameAnyBase
+{
+public:
+ wxDocParentFrameAny() { }
+ wxDocParentFrameAny(wxDocManager *manager,
+ wxFrame *frame,
+ wxWindowID id,
+ const wxString& title,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ long style = wxDEFAULT_FRAME_STYLE,
+ const wxString& name = wxFrameNameStr)
+ {
+ Create(manager, frame, id, title, pos, size, style, name);
+ }
bool Create(wxDocManager *manager,
wxFrame *frame,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxDEFAULT_FRAME_STYLE,
- const wxString& name = wxFrameNameStr);
+ const wxString& name = wxFrameNameStr)
+ {
+ m_docManager = manager;
- wxDocManager *GetDocumentManager() const { return m_docManager; }
+ if ( !BaseFrame::Create(frame, id, title, pos, size, style, name) )
+ return false;
- void OnExit(wxCommandEvent& event);
- void OnMRUFile(wxCommandEvent& event);
- void OnCloseWindow(wxCloseEvent& event);
+ this->Connect(wxID_EXIT, wxEVT_MENU,
+ wxCommandEventHandler(wxDocParentFrameAny::OnExit));
+ this->Connect(wxEVT_CLOSE_WINDOW,
+ wxCloseEventHandler(wxDocParentFrameAny::OnCloseWindow));
+
+ return true;
+ }
protected:
// hook the document manager into event handling chain here
- virtual bool TryBefore(wxEvent& event);
+ virtual bool TryBefore(wxEvent& event)
+ {
+ if ( m_docManager && m_docManager->ProcessEventLocally(event) )
+ return true;
- wxDocManager *m_docManager;
+ return BaseFrame::TryBefore(event);
+ }
+
+private:
+ void OnExit(wxCommandEvent& WXUNUSED(event))
+ {
+ this->Close();
+ }
+
+ void OnCloseWindow(wxCloseEvent& event)
+ {
+ if ( m_docManager && !m_docManager->Clear(!event.CanVeto()) )
+ {
+ // The user decided not to close finally, abort.
+ event.Veto();
+ }
+ else
+ {
+ // Just skip the event, base class handler will destroy the window.
+ event.Skip();
+ }
+ }
+
+
+ wxDECLARE_NO_COPY_CLASS(wxDocParentFrameAny);
+};
+
+typedef wxDocParentFrameAny<wxFrame> wxDocParentFrameBase;
+
+class WXDLLIMPEXP_CORE wxDocParentFrame : public wxDocParentFrameBase
+{
+public:
+ wxDocParentFrame() : wxDocParentFrameBase() { }
+
+ 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)
+ : wxDocParentFrameBase(manager,
+ parent, id, title, pos, size, style, name)
+ {
+ }
+
+ 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 = wxFrameNameStr)
+ {
+ return wxDocParentFrameBase::Create(manager,
+ parent, id, title,
+ pos, size, style, name);
+ }
private:
- typedef wxFrame base_type;
DECLARE_CLASS(wxDocParentFrame)
- DECLARE_EVENT_TABLE()
wxDECLARE_NO_COPY_CLASS(wxDocParentFrame);
};
+#ifdef __VISUALC6__
+ // reenable warning 4275
+ #pragma warning (pop)
+#endif
+
// ----------------------------------------------------------------------------
// Provide simple default printing facilities
// ----------------------------------------------------------------------------
class WXDLLIMPEXP_CORE wxDocPrintout : public wxPrintout
{
public:
- wxDocPrintout(wxView *view = NULL, const wxString& title = wxT("Printout"));
+ wxDocPrintout(wxView *view = NULL, const wxString& title = wxString());
// implement wxPrintout methods
virtual bool OnPrintPage(int page);
};
#endif // wxUSE_PRINTING_ARCHITECTURE
-// ----------------------------------------------------------------------------
-// File history management
-// ----------------------------------------------------------------------------
-
-class WXDLLIMPEXP_CORE wxFileHistory : public wxObject
-{
-public:
- wxFileHistory(size_t maxFiles = 9, wxWindowID idBase = wxID_FILE1);
-
- // Operations
- virtual void AddFileToHistory(const wxString& file);
- virtual void RemoveFileFromHistory(size_t i);
- virtual int GetMaxFiles() const { return (int)m_fileMaxFiles; }
- virtual void UseMenu(wxMenu *menu);
-
- // Remove menu from the list (MDI child may be closing)
- virtual void RemoveMenu(wxMenu *menu);
-
-#if wxUSE_CONFIG
- virtual void Load(const wxConfigBase& config);
- virtual void Save(wxConfigBase& config);
-#endif // wxUSE_CONFIG
-
- virtual void AddFilesToMenu();
- virtual void AddFilesToMenu(wxMenu* menu); // Single menu
-
- // Accessors
- virtual wxString GetHistoryFile(size_t i) const { return m_fileHistory[i]; }
- virtual size_t GetCount() const { return m_fileHistory.GetCount(); }
-
- const wxList& GetMenus() const { return m_fileMenus; }
-
- // Set/get base id
- void SetBaseId(wxWindowID baseId) { m_idBase = baseId; }
- wxWindowID GetBaseId() const { return m_idBase; }
-
-#if WXWIN_COMPATIBILITY_2_6
- // deprecated, use GetCount() instead
- wxDEPRECATED( size_t GetNoHistoryFiles() const );
-#endif // WXWIN_COMPATIBILITY_2_6
-
-protected:
- // Last n files
- wxArrayString m_fileHistory;
-
- // Menus to maintain (may need several for an MDI app)
- wxList m_fileMenus;
-
- // Max files to maintain
- size_t m_fileMaxFiles;
-
-private:
- // The ID of the first history menu item (Doesn't have to be wxID_FILE1)
- wxWindowID m_idBase;
-
- DECLARE_DYNAMIC_CLASS(wxFileHistory)
- wxDECLARE_NO_COPY_CLASS(wxFileHistory);
-};
-
-#if WXWIN_COMPATIBILITY_2_6
-inline size_t wxFileHistory::GetNoHistoryFiles() const
-{
- return m_fileHistory.GetCount();
-}
-#endif // WXWIN_COMPATIBILITY_2_6
-
// For compatibility with existing file formats:
// converts from/to a stream to/from a temporary file.
#if wxUSE_STD_IOSTREAM
// 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