1998-05-20 10:01:55 -04:00
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
2006-03-30 09:04:17 -05:00
|
|
|
// Name: wx/docview.h
|
1998-05-20 10:01:55 -04:00
|
|
|
// Purpose: Doc/View classes
|
|
|
|
// Author: Julian Smart
|
|
|
|
// Modified by:
|
|
|
|
// Created: 01/02/97
|
|
|
|
// RCS-ID: $Id$
|
2005-05-04 14:57:50 -04:00
|
|
|
// Copyright: (c) Julian Smart
|
2004-05-23 16:53:33 -04:00
|
|
|
// Licence: wxWindows licence
|
1998-05-20 10:01:55 -04:00
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
|
1998-08-14 20:23:28 -04:00
|
|
|
#ifndef _WX_DOCH__
|
|
|
|
#define _WX_DOCH__
|
1998-05-20 10:01:55 -04:00
|
|
|
|
|
|
|
#include "wx/defs.h"
|
2003-01-12 17:20:46 -05:00
|
|
|
|
|
|
|
#if wxUSE_DOC_VIEW_ARCHITECTURE
|
|
|
|
|
1998-05-20 10:01:55 -04:00
|
|
|
#include "wx/list.h"
|
|
|
|
#include "wx/string.h"
|
2001-11-02 18:33:08 -05:00
|
|
|
#include "wx/frame.h"
|
1998-05-20 10:01:55 -04:00
|
|
|
|
1998-09-25 09:28:52 -04:00
|
|
|
#if wxUSE_PRINTING_ARCHITECTURE
|
1999-05-10 12:19:09 -04:00
|
|
|
#include "wx/print.h"
|
1998-05-20 10:01:55 -04:00
|
|
|
#endif
|
|
|
|
|
2007-07-09 06:09:52 -04:00
|
|
|
class WXDLLIMPEXP_FWD_CORE wxWindow;
|
|
|
|
class WXDLLIMPEXP_FWD_CORE wxDocument;
|
|
|
|
class WXDLLIMPEXP_FWD_CORE wxView;
|
|
|
|
class WXDLLIMPEXP_FWD_CORE wxDocTemplate;
|
|
|
|
class WXDLLIMPEXP_FWD_CORE wxDocManager;
|
|
|
|
class WXDLLIMPEXP_FWD_CORE wxPrintInfo;
|
|
|
|
class WXDLLIMPEXP_FWD_CORE wxCommandProcessor;
|
|
|
|
class WXDLLIMPEXP_FWD_CORE wxFileHistory;
|
2007-11-23 09:13:50 -05:00
|
|
|
class WXDLLIMPEXP_FWD_BASE wxConfigBase;
|
1998-05-20 10:01:55 -04:00
|
|
|
|
1999-06-29 19:16:45 -04:00
|
|
|
#if wxUSE_STD_IOSTREAM
|
2003-01-25 19:12:12 -05:00
|
|
|
#include "wx/iosfwrap.h"
|
1999-06-29 19:16:45 -04:00
|
|
|
#else
|
|
|
|
#include "wx/stream.h"
|
|
|
|
#endif
|
1998-05-20 10:01:55 -04:00
|
|
|
|
|
|
|
// Document manager flags
|
1999-05-10 12:19:09 -04:00
|
|
|
enum
|
|
|
|
{
|
|
|
|
wxDOC_SDI = 1,
|
|
|
|
wxDOC_MDI,
|
|
|
|
wxDOC_NEW,
|
|
|
|
wxDOC_SILENT,
|
|
|
|
wxDEFAULT_DOCMAN_FLAGS = wxDOC_SDI
|
|
|
|
};
|
1998-05-20 10:01:55 -04:00
|
|
|
|
|
|
|
// Document template flags
|
1999-05-10 12:19:09 -04:00
|
|
|
enum
|
|
|
|
{
|
|
|
|
wxTEMPLATE_VISIBLE = 1,
|
|
|
|
wxTEMPLATE_INVISIBLE,
|
|
|
|
wxDEFAULT_TEMPLATE_FLAGS = wxTEMPLATE_VISIBLE
|
|
|
|
};
|
1998-05-20 10:01:55 -04:00
|
|
|
|
1999-05-10 12:19:09 -04:00
|
|
|
#define wxMAX_FILE_HISTORY 9
|
1998-05-20 10:01:55 -04:00
|
|
|
|
|
|
|
class WXDLLEXPORT wxDocument : public wxEvtHandler
|
|
|
|
{
|
1999-05-10 12:19:09 -04:00
|
|
|
public:
|
|
|
|
wxDocument(wxDocument *parent = (wxDocument *) NULL);
|
2006-09-05 16:47:48 -04:00
|
|
|
virtual ~wxDocument();
|
1999-05-10 12:19:09 -04:00
|
|
|
|
|
|
|
// accessors
|
2004-09-10 08:56:07 -04:00
|
|
|
void SetFilename(const wxString& filename, bool notifyViews = false);
|
1999-05-10 12:19:09 -04:00
|
|
|
wxString GetFilename() const { return m_documentFile; }
|
|
|
|
|
2007-04-14 05:58:37 -04:00
|
|
|
void SetTitle(const wxString& title) { m_documentTitle = title; }
|
1999-05-10 12:19:09 -04:00
|
|
|
wxString GetTitle() const { return m_documentTitle; }
|
|
|
|
|
2007-04-14 05:58:37 -04:00
|
|
|
void SetDocumentName(const wxString& name) { m_documentTypeName = name; }
|
1999-05-10 12:19:09 -04:00
|
|
|
wxString GetDocumentName() const { return m_documentTypeName; }
|
|
|
|
|
|
|
|
bool GetDocumentSaved() const { return m_savedYet; }
|
2004-09-10 08:56:07 -04:00
|
|
|
void SetDocumentSaved(bool saved = true) { m_savedYet = saved; }
|
1999-05-10 12:19:09 -04:00
|
|
|
|
|
|
|
virtual bool Close();
|
|
|
|
virtual bool Save();
|
|
|
|
virtual bool SaveAs();
|
|
|
|
virtual bool Revert();
|
|
|
|
|
1999-06-29 19:16:45 -04:00
|
|
|
#if wxUSE_STD_IOSTREAM
|
2001-06-06 12:51:53 -04:00
|
|
|
virtual wxSTD ostream& SaveObject(wxSTD ostream& stream);
|
|
|
|
virtual wxSTD istream& LoadObject(wxSTD istream& stream);
|
1999-06-29 19:16:45 -04:00
|
|
|
#else
|
1999-08-01 07:02:05 -04:00
|
|
|
virtual wxOutputStream& SaveObject(wxOutputStream& stream);
|
|
|
|
virtual wxInputStream& LoadObject(wxInputStream& stream);
|
1999-06-29 19:16:45 -04:00
|
|
|
#endif
|
1999-05-10 12:19:09 -04:00
|
|
|
|
2004-05-23 10:56:36 -04:00
|
|
|
// Called by wxWidgets
|
1999-05-10 12:19:09 -04:00
|
|
|
virtual bool OnSaveDocument(const wxString& filename);
|
|
|
|
virtual bool OnOpenDocument(const wxString& filename);
|
|
|
|
virtual bool OnNewDocument();
|
|
|
|
virtual bool OnCloseDocument();
|
|
|
|
|
2004-09-10 08:56:07 -04:00
|
|
|
// Prompts for saving if about to close a modified document. Returns true
|
1999-05-10 12:19:09 -04:00
|
|
|
// if ok to close the document (may have saved in the meantime, or set
|
2004-09-10 08:56:07 -04:00
|
|
|
// modified to false)
|
1999-05-10 12:19:09 -04:00
|
|
|
virtual bool OnSaveModified();
|
|
|
|
|
|
|
|
// Called by framework if created automatically by the default document
|
|
|
|
// manager: gives document a chance to initialise and (usually) create a
|
|
|
|
// view
|
|
|
|
virtual bool OnCreate(const wxString& path, long flags);
|
|
|
|
|
|
|
|
// By default, creates a base wxCommandProcessor.
|
|
|
|
virtual wxCommandProcessor *OnCreateCommandProcessor();
|
|
|
|
virtual wxCommandProcessor *GetCommandProcessor() const { return m_commandProcessor; }
|
|
|
|
virtual void SetCommandProcessor(wxCommandProcessor *proc) { m_commandProcessor = proc; }
|
|
|
|
|
|
|
|
// Called after a view is added or removed. The default implementation
|
|
|
|
// deletes the document if this is there are no more views.
|
|
|
|
virtual void OnChangedViewList();
|
|
|
|
|
|
|
|
virtual bool DeleteContents();
|
|
|
|
|
|
|
|
virtual bool Draw(wxDC&);
|
|
|
|
virtual bool IsModified() const { return m_documentModified; }
|
|
|
|
virtual void Modify(bool mod) { m_documentModified = mod; }
|
|
|
|
|
|
|
|
virtual bool AddView(wxView *view);
|
|
|
|
virtual bool RemoveView(wxView *view);
|
2005-09-25 18:50:26 -04:00
|
|
|
wxList& GetViews() { return m_documentViews; }
|
|
|
|
const wxList& GetViews() const { return m_documentViews; }
|
1999-05-10 12:19:09 -04:00
|
|
|
wxView *GetFirstView() const;
|
|
|
|
|
|
|
|
virtual void UpdateAllViews(wxView *sender = (wxView *) NULL, wxObject *hint = (wxObject *) NULL);
|
2002-07-12 12:08:03 -04:00
|
|
|
virtual void NotifyClosing();
|
1999-05-10 12:19:09 -04:00
|
|
|
|
|
|
|
// Remove all views (because we're closing the document)
|
|
|
|
virtual bool DeleteAllViews();
|
|
|
|
|
|
|
|
// Other stuff
|
|
|
|
virtual wxDocManager *GetDocumentManager() const;
|
|
|
|
virtual wxDocTemplate *GetDocumentTemplate() const { return m_documentTemplate; }
|
|
|
|
virtual void SetDocumentTemplate(wxDocTemplate *temp) { m_documentTemplate = temp; }
|
|
|
|
|
2007-06-16 08:49:56 -04:00
|
|
|
// Get the document name to be shown to the user: the title if there is
|
|
|
|
// any, otherwise the filename if the document was saved and, finally,
|
|
|
|
// "unnamed" otherwise
|
|
|
|
virtual wxString GetUserReadableName() const;
|
|
|
|
|
|
|
|
#if WXWIN_COMPATIBILITY_2_8
|
|
|
|
// use GetUserReadableName() instead
|
|
|
|
wxDEPRECATED_BUT_USED_INTERNALLY(
|
|
|
|
virtual bool GetPrintableName(wxString& buf) const
|
|
|
|
);
|
|
|
|
#endif // WXWIN_COMPATIBILITY_2_8
|
1999-05-10 12:19:09 -04:00
|
|
|
|
|
|
|
// Returns a window that can be used as a parent for document-related
|
|
|
|
// dialogs. Override if necessary.
|
|
|
|
virtual wxWindow *GetDocumentWindow() const;
|
|
|
|
|
|
|
|
protected:
|
|
|
|
wxList m_documentViews;
|
|
|
|
wxString m_documentFile;
|
|
|
|
wxString m_documentTitle;
|
|
|
|
wxString m_documentTypeName;
|
|
|
|
wxDocTemplate* m_documentTemplate;
|
|
|
|
bool m_documentModified;
|
|
|
|
wxDocument* m_documentParent;
|
|
|
|
wxCommandProcessor* m_commandProcessor;
|
|
|
|
bool m_savedYet;
|
2003-05-09 08:04:01 -04:00
|
|
|
|
2004-07-25 11:42:11 -04:00
|
|
|
// Called by OnSaveDocument and OnOpenDocument to implement standard
|
|
|
|
// Save/Load behavior. Re-implement in derived class for custom
|
|
|
|
// behavior.
|
|
|
|
virtual bool DoSaveDocument(const wxString& file);
|
|
|
|
virtual bool DoOpenDocument(const wxString& file);
|
|
|
|
|
2007-06-16 08:49:56 -04:00
|
|
|
// the default implementation of GetUserReadableName()
|
|
|
|
wxString DoGetUserReadableName() const;
|
|
|
|
|
2002-12-04 09:11:26 -05:00
|
|
|
private:
|
|
|
|
DECLARE_ABSTRACT_CLASS(wxDocument)
|
2003-01-02 18:38:11 -05:00
|
|
|
DECLARE_NO_COPY_CLASS(wxDocument)
|
1998-05-20 10:01:55 -04:00
|
|
|
};
|
|
|
|
|
|
|
|
class WXDLLEXPORT wxView: public wxEvtHandler
|
|
|
|
{
|
1999-05-10 12:19:09 -04:00
|
|
|
public:
|
|
|
|
// wxView(wxDocument *doc = (wxDocument *) NULL);
|
|
|
|
wxView();
|
2006-09-05 16:47:48 -04:00
|
|
|
virtual ~wxView();
|
1998-05-20 10:01:55 -04:00
|
|
|
|
1999-05-10 12:19:09 -04:00
|
|
|
wxDocument *GetDocument() const { return m_viewDocument; }
|
2002-04-12 09:15:44 -04:00
|
|
|
virtual void SetDocument(wxDocument *doc);
|
1998-05-20 10:01:55 -04:00
|
|
|
|
1999-05-10 12:19:09 -04:00
|
|
|
wxString GetViewName() const { return m_viewTypeName; }
|
2007-04-14 05:58:37 -04:00
|
|
|
void SetViewName(const wxString& name) { m_viewTypeName = name; }
|
1998-05-20 10:01:55 -04:00
|
|
|
|
2002-08-20 05:09:55 -04:00
|
|
|
wxWindow *GetFrame() const { return m_viewFrame ; }
|
|
|
|
void SetFrame(wxWindow *frame) { m_viewFrame = frame; }
|
1998-05-20 10:01:55 -04:00
|
|
|
|
1999-05-10 12:19:09 -04:00
|
|
|
virtual void OnActivateView(bool activate, wxView *activeView, wxView *deactiveView);
|
|
|
|
virtual void OnDraw(wxDC *dc) = 0;
|
|
|
|
virtual void OnPrint(wxDC *dc, wxObject *info);
|
|
|
|
virtual void OnUpdate(wxView *sender, wxObject *hint = (wxObject *) NULL);
|
2004-10-13 10:04:19 -04:00
|
|
|
virtual void OnClosingDocument() {}
|
1999-05-10 12:19:09 -04:00
|
|
|
virtual void OnChangeFilename();
|
1998-05-20 10:01:55 -04:00
|
|
|
|
1999-05-10 12:19:09 -04:00
|
|
|
// Called by framework if created automatically by the default document
|
|
|
|
// manager class: gives view a chance to initialise
|
2007-04-14 05:58:37 -04:00
|
|
|
virtual bool OnCreate(wxDocument *WXUNUSED(doc), long WXUNUSED(flags)) { return true; }
|
1998-05-20 10:01:55 -04:00
|
|
|
|
1999-05-10 12:19:09 -04:00
|
|
|
// Checks if the view is the last one for the document; if so, asks user
|
|
|
|
// to confirm save data (if modified). If ok, deletes itself and returns
|
2004-09-10 08:56:07 -04:00
|
|
|
// true.
|
|
|
|
virtual bool Close(bool deleteWindow = true);
|
1999-05-10 12:19:09 -04:00
|
|
|
|
|
|
|
// Override to do cleanup/veto close
|
|
|
|
virtual bool OnClose(bool deleteWindow);
|
1999-02-05 09:26:48 -05:00
|
|
|
|
1999-05-10 12:19:09 -04:00
|
|
|
// Extend event processing to search the document's event table
|
|
|
|
virtual bool ProcessEvent(wxEvent& event);
|
1998-05-20 10:01:55 -04:00
|
|
|
|
1999-05-10 12:19:09 -04:00
|
|
|
// A view's window can call this to notify the view it is (in)active.
|
|
|
|
// The function then notifies the document manager.
|
|
|
|
virtual void Activate(bool activate);
|
1998-05-20 10:01:55 -04:00
|
|
|
|
1999-05-10 12:19:09 -04:00
|
|
|
wxDocManager *GetDocumentManager() const
|
|
|
|
{ return m_viewDocument->GetDocumentManager(); }
|
1998-05-20 10:01:55 -04:00
|
|
|
|
1998-09-25 09:28:52 -04:00
|
|
|
#if wxUSE_PRINTING_ARCHITECTURE
|
1999-05-10 12:19:09 -04:00
|
|
|
virtual wxPrintout *OnCreatePrintout();
|
1998-05-20 10:01:55 -04:00
|
|
|
#endif
|
|
|
|
|
1999-05-10 12:19:09 -04:00
|
|
|
protected:
|
|
|
|
wxDocument* m_viewDocument;
|
|
|
|
wxString m_viewTypeName;
|
2002-08-20 05:09:55 -04:00
|
|
|
wxWindow* m_viewFrame;
|
2003-01-02 18:38:11 -05:00
|
|
|
|
2002-12-04 09:11:26 -05:00
|
|
|
private:
|
|
|
|
DECLARE_ABSTRACT_CLASS(wxView)
|
2003-01-02 18:38:11 -05:00
|
|
|
DECLARE_NO_COPY_CLASS(wxView)
|
1998-05-20 10:01:55 -04:00
|
|
|
};
|
|
|
|
|
|
|
|
// Represents user interface (and other) properties of documents and views
|
|
|
|
class WXDLLEXPORT wxDocTemplate: public wxObject
|
|
|
|
{
|
1999-05-10 12:19:09 -04:00
|
|
|
|
2007-07-09 06:09:52 -04:00
|
|
|
friend class WXDLLIMPEXP_FWD_CORE wxDocManager;
|
1999-05-10 12:19:09 -04:00
|
|
|
|
|
|
|
public:
|
|
|
|
// Associate document and view types. They're for identifying what view is
|
|
|
|
// associated with what template/document type
|
|
|
|
wxDocTemplate(wxDocManager *manager,
|
|
|
|
const wxString& descr,
|
|
|
|
const wxString& filter,
|
|
|
|
const wxString& dir,
|
|
|
|
const wxString& ext,
|
|
|
|
const wxString& docTypeName,
|
|
|
|
const wxString& viewTypeName,
|
|
|
|
wxClassInfo *docClassInfo = (wxClassInfo *) NULL,
|
|
|
|
wxClassInfo *viewClassInfo = (wxClassInfo *)NULL,
|
|
|
|
long flags = wxDEFAULT_TEMPLATE_FLAGS);
|
|
|
|
|
2006-09-05 16:47:48 -04:00
|
|
|
virtual ~wxDocTemplate();
|
1999-05-10 12:19:09 -04:00
|
|
|
|
|
|
|
// By default, these two member functions dynamically creates document and
|
|
|
|
// view using dynamic instance construction. Override these if you need a
|
|
|
|
// different method of construction.
|
|
|
|
virtual wxDocument *CreateDocument(const wxString& path, long flags = 0);
|
|
|
|
virtual wxView *CreateView(wxDocument *doc, long flags = 0);
|
|
|
|
|
2004-06-03 10:19:39 -04:00
|
|
|
// Helper method for CreateDocument; also allows you to do your own document
|
|
|
|
// creation
|
|
|
|
virtual bool InitDocument(wxDocument* doc, const wxString& path, long flags = 0);
|
|
|
|
|
2007-04-14 05:58:37 -04:00
|
|
|
wxString GetDefaultExtension() const { return m_defaultExt; }
|
1999-05-10 12:19:09 -04:00
|
|
|
wxString GetDescription() const { return m_description; }
|
2007-04-14 05:58:37 -04:00
|
|
|
wxString GetDirectory() const { return m_directory; }
|
1999-05-10 12:19:09 -04:00
|
|
|
wxDocManager *GetDocumentManager() const { return m_documentManager; }
|
|
|
|
void SetDocumentManager(wxDocManager *manager) { m_documentManager = manager; }
|
2007-04-14 05:58:37 -04:00
|
|
|
wxString GetFileFilter() const { return m_fileFilter; }
|
|
|
|
long GetFlags() const { return m_flags; }
|
1999-05-10 12:19:09 -04:00
|
|
|
virtual wxString GetViewName() const { return m_viewTypeName; }
|
|
|
|
virtual wxString GetDocumentName() const { return m_docTypeName; }
|
|
|
|
|
2007-04-14 05:58:37 -04:00
|
|
|
void SetFileFilter(const wxString& filter) { m_fileFilter = filter; }
|
|
|
|
void SetDirectory(const wxString& dir) { m_directory = dir; }
|
|
|
|
void SetDescription(const wxString& descr) { m_description = descr; }
|
|
|
|
void SetDefaultExtension(const wxString& ext) { m_defaultExt = ext; }
|
|
|
|
void SetFlags(long flags) { m_flags = flags; }
|
1999-05-10 12:19:09 -04:00
|
|
|
|
|
|
|
bool IsVisible() const { return ((m_flags & wxTEMPLATE_VISIBLE) == wxTEMPLATE_VISIBLE); }
|
|
|
|
|
2004-06-03 15:04:16 -04:00
|
|
|
wxClassInfo* GetDocClassInfo() const { return m_docClassInfo; }
|
|
|
|
wxClassInfo* GetViewClassInfo() const { return m_viewClassInfo; }
|
|
|
|
|
1999-05-10 12:19:09 -04:00
|
|
|
virtual bool FileMatchesTemplate(const wxString& path);
|
|
|
|
|
|
|
|
protected:
|
|
|
|
long m_flags;
|
|
|
|
wxString m_fileFilter;
|
|
|
|
wxString m_directory;
|
|
|
|
wxString m_description;
|
|
|
|
wxString m_defaultExt;
|
|
|
|
wxString m_docTypeName;
|
|
|
|
wxString m_viewTypeName;
|
|
|
|
wxDocManager* m_documentManager;
|
|
|
|
|
|
|
|
// For dynamic creation of appropriate instances.
|
|
|
|
wxClassInfo* m_docClassInfo;
|
|
|
|
wxClassInfo* m_viewClassInfo;
|
2003-05-09 08:04:01 -04:00
|
|
|
|
2004-07-25 11:42:11 -04:00
|
|
|
// Called by CreateDocument and CreateView to create the actual document/view object.
|
|
|
|
// By default uses the ClassInfo provided to the constructor. Override these functions
|
|
|
|
// to provide a different method of creation.
|
|
|
|
virtual wxDocument *DoCreateDocument();
|
|
|
|
virtual wxView *DoCreateView();
|
|
|
|
|
2002-12-04 09:11:26 -05:00
|
|
|
private:
|
|
|
|
DECLARE_CLASS(wxDocTemplate)
|
2003-01-02 18:38:11 -05:00
|
|
|
DECLARE_NO_COPY_CLASS(wxDocTemplate)
|
1998-05-20 10:01:55 -04:00
|
|
|
};
|
|
|
|
|
1999-05-10 12:19:09 -04:00
|
|
|
// One object of this class may be created in an application, to manage all
|
|
|
|
// the templates and documents.
|
1998-05-20 10:01:55 -04:00
|
|
|
class WXDLLEXPORT wxDocManager: public wxEvtHandler
|
|
|
|
{
|
1999-05-10 12:19:09 -04:00
|
|
|
public:
|
2004-09-10 08:56:07 -04:00
|
|
|
wxDocManager(long flags = wxDEFAULT_DOCMAN_FLAGS, bool initialize = true);
|
2006-09-05 16:47:48 -04:00
|
|
|
virtual ~wxDocManager();
|
1999-05-10 12:19:09 -04:00
|
|
|
|
|
|
|
virtual bool Initialize();
|
|
|
|
|
|
|
|
// Handlers for common user commands
|
|
|
|
void OnFileClose(wxCommandEvent& event);
|
2001-12-30 12:35:07 -05:00
|
|
|
void OnFileCloseAll(wxCommandEvent& event);
|
1999-05-10 12:19:09 -04:00
|
|
|
void OnFileNew(wxCommandEvent& event);
|
|
|
|
void OnFileOpen(wxCommandEvent& event);
|
|
|
|
void OnFileRevert(wxCommandEvent& event);
|
|
|
|
void OnFileSave(wxCommandEvent& event);
|
|
|
|
void OnFileSaveAs(wxCommandEvent& event);
|
|
|
|
void OnPrint(wxCommandEvent& event);
|
|
|
|
void OnPreview(wxCommandEvent& event);
|
|
|
|
void OnUndo(wxCommandEvent& event);
|
|
|
|
void OnRedo(wxCommandEvent& event);
|
|
|
|
|
2000-02-20 07:40:08 -05:00
|
|
|
// Handlers for UI update commands
|
|
|
|
void OnUpdateFileOpen(wxUpdateUIEvent& event);
|
|
|
|
void OnUpdateFileClose(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 OnUpdatePrint(wxUpdateUIEvent& event);
|
|
|
|
void OnUpdatePreview(wxUpdateUIEvent& event);
|
|
|
|
|
1999-05-10 12:19:09 -04:00
|
|
|
// Extend event processing to search the view's event table
|
|
|
|
virtual bool ProcessEvent(wxEvent& event);
|
|
|
|
|
2000-03-13 10:48:03 -05:00
|
|
|
// called when file format detection didn't work, can be overridden to do
|
|
|
|
// something in this case
|
2000-03-20 08:41:16 -05:00
|
|
|
virtual void OnOpenFileFailure() { }
|
2000-03-13 10:48:03 -05:00
|
|
|
|
1999-05-10 12:19:09 -04:00
|
|
|
virtual wxDocument *CreateDocument(const wxString& path, long flags = 0);
|
|
|
|
virtual wxView *CreateView(wxDocument *doc, long flags = 0);
|
|
|
|
virtual void DeleteTemplate(wxDocTemplate *temp, long flags = 0);
|
|
|
|
virtual bool FlushDoc(wxDocument *doc);
|
|
|
|
virtual wxDocTemplate *MatchTemplate(const wxString& path);
|
|
|
|
virtual wxDocTemplate *SelectDocumentPath(wxDocTemplate **templates,
|
2004-09-10 08:56:07 -04:00
|
|
|
int noTemplates, wxString& path, long flags, bool save = false);
|
1999-05-10 12:19:09 -04:00
|
|
|
virtual wxDocTemplate *SelectDocumentType(wxDocTemplate **templates,
|
2004-09-10 08:56:07 -04:00
|
|
|
int noTemplates, bool sort = false);
|
1999-05-10 12:19:09 -04:00
|
|
|
virtual wxDocTemplate *SelectViewType(wxDocTemplate **templates,
|
2004-09-10 08:56:07 -04:00
|
|
|
int noTemplates, bool sort = false);
|
1999-05-10 12:19:09 -04:00
|
|
|
virtual wxDocTemplate *FindTemplateForPath(const wxString& path);
|
|
|
|
|
|
|
|
void AssociateTemplate(wxDocTemplate *temp);
|
|
|
|
void DisassociateTemplate(wxDocTemplate *temp);
|
|
|
|
|
|
|
|
wxDocument *GetCurrentDocument() const;
|
|
|
|
|
|
|
|
void SetMaxDocsOpen(int n) { m_maxDocsOpen = n; }
|
|
|
|
int GetMaxDocsOpen() const { return m_maxDocsOpen; }
|
|
|
|
|
|
|
|
// Add and remove a document from the manager's list
|
|
|
|
void AddDocument(wxDocument *doc);
|
|
|
|
void RemoveDocument(wxDocument *doc);
|
|
|
|
|
2001-12-30 12:35:07 -05:00
|
|
|
// closes all currently open documents
|
2004-09-10 08:56:07 -04:00
|
|
|
bool CloseDocuments(bool force = true);
|
2001-12-30 12:35:07 -05:00
|
|
|
|
2003-05-01 11:40:39 -04:00
|
|
|
// closes the specified document
|
2004-09-10 08:56:07 -04:00
|
|
|
bool CloseDocument(wxDocument* doc, bool force = false);
|
2003-05-01 11:40:39 -04:00
|
|
|
|
1999-05-10 12:19:09 -04:00
|
|
|
// Clear remaining documents and templates
|
2004-09-10 08:56:07 -04:00
|
|
|
bool Clear(bool force = true);
|
1999-05-10 12:19:09 -04:00
|
|
|
|
|
|
|
// Views or windows should inform the document manager
|
|
|
|
// when a view is going in or out of focus
|
2004-09-10 08:56:07 -04:00
|
|
|
virtual void ActivateView(wxView *view, bool activate = true);
|
1999-05-10 12:19:09 -04:00
|
|
|
virtual wxView *GetCurrentView() const;
|
|
|
|
|
2001-01-05 05:50:24 -05:00
|
|
|
wxList& GetDocuments() { return m_docs; }
|
|
|
|
wxList& GetTemplates() { return m_templates; }
|
1999-05-10 12:19:09 -04:00
|
|
|
|
2007-06-16 08:49:56 -04:00
|
|
|
// Return the default name for a new document (by default returns strings
|
|
|
|
// in the form "unnamed <counter>" but can be overridden)
|
|
|
|
virtual wxString MakeNewDocumentName();
|
1999-05-10 12:19:09 -04:00
|
|
|
|
2000-02-20 07:40:08 -05:00
|
|
|
// Make a frame title (override this to do something different)
|
|
|
|
virtual wxString MakeFrameTitle(wxDocument* doc);
|
|
|
|
|
1999-05-10 12:19:09 -04:00
|
|
|
virtual wxFileHistory *OnCreateFileHistory();
|
|
|
|
virtual wxFileHistory *GetFileHistory() const { return m_fileHistory; }
|
|
|
|
|
|
|
|
// File history management
|
|
|
|
virtual void AddFileToHistory(const wxString& file);
|
2003-03-02 18:35:17 -05:00
|
|
|
virtual void RemoveFileFromHistory(size_t i);
|
2003-05-08 20:02:58 -04:00
|
|
|
virtual size_t GetHistoryFilesCount() const;
|
2003-03-02 18:35:17 -05:00
|
|
|
virtual wxString GetHistoryFile(size_t i) const;
|
1999-05-10 12:19:09 -04:00
|
|
|
virtual void FileHistoryUseMenu(wxMenu *menu);
|
|
|
|
virtual void FileHistoryRemoveMenu(wxMenu *menu);
|
1999-01-08 05:23:39 -05:00
|
|
|
#if wxUSE_CONFIG
|
1999-05-10 12:19:09 -04:00
|
|
|
virtual void FileHistoryLoad(wxConfigBase& config);
|
|
|
|
virtual void FileHistorySave(wxConfigBase& config);
|
|
|
|
#endif // wxUSE_CONFIG
|
|
|
|
|
|
|
|
virtual void FileHistoryAddFilesToMenu();
|
|
|
|
virtual void FileHistoryAddFilesToMenu(wxMenu* menu);
|
|
|
|
|
2003-05-08 20:02:58 -04:00
|
|
|
wxString GetLastDirectory() const { return m_lastDirectory; }
|
|
|
|
void SetLastDirectory(const wxString& dir) { m_lastDirectory = dir; }
|
1999-10-19 18:18:32 -04:00
|
|
|
|
2000-02-20 07:40:08 -05:00
|
|
|
// Get the current document manager
|
|
|
|
static wxDocManager* GetDocumentManager() { return sm_docManager; }
|
|
|
|
|
2007-06-16 08:49:56 -04:00
|
|
|
#if WXWIN_COMPATIBILITY_2_8
|
|
|
|
// deprecated, override GetDefaultName() instead
|
|
|
|
wxDEPRECATED_BUT_USED_INTERNALLY(
|
|
|
|
virtual bool MakeDefaultName(wxString& buf)
|
|
|
|
);
|
|
|
|
#endif
|
|
|
|
|
2006-03-30 09:04:17 -05:00
|
|
|
#if WXWIN_COMPATIBILITY_2_6
|
2003-05-09 08:04:01 -04:00
|
|
|
// deprecated, use GetHistoryFilesCount() instead
|
|
|
|
wxDEPRECATED( size_t GetNoHistoryFiles() const );
|
2006-03-30 09:04:17 -05:00
|
|
|
#endif // WXWIN_COMPATIBILITY_2_6
|
2003-05-08 20:02:58 -04:00
|
|
|
|
1999-05-10 12:19:09 -04:00
|
|
|
protected:
|
|
|
|
long m_flags;
|
|
|
|
int m_defaultDocumentNameCounter;
|
|
|
|
int m_maxDocsOpen;
|
|
|
|
wxList m_docs;
|
|
|
|
wxList m_templates;
|
|
|
|
wxView* m_currentView;
|
|
|
|
wxFileHistory* m_fileHistory;
|
1999-10-19 18:18:32 -04:00
|
|
|
wxString m_lastDirectory;
|
2000-02-20 07:40:08 -05:00
|
|
|
static wxDocManager* sm_docManager;
|
1999-05-10 12:19:09 -04:00
|
|
|
|
|
|
|
DECLARE_EVENT_TABLE()
|
2003-05-09 08:04:01 -04:00
|
|
|
DECLARE_DYNAMIC_CLASS(wxDocManager)
|
2003-01-02 18:38:11 -05:00
|
|
|
DECLARE_NO_COPY_CLASS(wxDocManager)
|
1998-05-20 10:01:55 -04:00
|
|
|
};
|
|
|
|
|
2006-03-30 09:04:17 -05:00
|
|
|
#if WXWIN_COMPATIBILITY_2_6
|
2003-05-09 08:04:01 -04:00
|
|
|
inline size_t wxDocManager::GetNoHistoryFiles() const
|
|
|
|
{
|
|
|
|
return GetHistoryFilesCount();
|
|
|
|
}
|
2006-03-30 09:04:17 -05:00
|
|
|
#endif // WXWIN_COMPATIBILITY_2_6
|
2003-05-09 08:04:01 -04:00
|
|
|
|
1999-05-10 12:19:09 -04:00
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// A default child frame
|
|
|
|
// ----------------------------------------------------------------------------
|
1998-05-20 10:01:55 -04:00
|
|
|
|
1999-05-10 12:19:09 -04:00
|
|
|
class WXDLLEXPORT wxDocChildFrame : public wxFrame
|
1998-05-20 10:01:55 -04:00
|
|
|
{
|
1999-05-10 12:19:09 -04:00
|
|
|
public:
|
|
|
|
wxDocChildFrame(wxDocument *doc,
|
|
|
|
wxView *view,
|
|
|
|
wxFrame *frame,
|
|
|
|
wxWindowID id,
|
|
|
|
const wxString& title,
|
|
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
|
|
const wxSize& size = wxDefaultSize,
|
|
|
|
long type = wxDEFAULT_FRAME_STYLE,
|
2002-12-04 09:11:26 -05:00
|
|
|
const wxString& name = wxT("frame"));
|
2006-09-05 16:47:48 -04:00
|
|
|
virtual ~wxDocChildFrame(){}
|
1999-05-10 12:19:09 -04:00
|
|
|
|
|
|
|
// Extend event processing to search the view's event table
|
|
|
|
virtual bool ProcessEvent(wxEvent& event);
|
|
|
|
|
|
|
|
void OnActivate(wxActivateEvent& event);
|
|
|
|
void OnCloseWindow(wxCloseEvent& event);
|
|
|
|
|
|
|
|
wxDocument *GetDocument() const { return m_childDocument; }
|
|
|
|
wxView *GetView() const { return m_childView; }
|
|
|
|
void SetDocument(wxDocument *doc) { m_childDocument = doc; }
|
|
|
|
void SetView(wxView *view) { m_childView = view; }
|
2001-06-09 13:51:20 -04:00
|
|
|
bool Destroy() { m_childView = (wxView *)NULL; return wxFrame::Destroy(); }
|
1999-05-10 12:19:09 -04:00
|
|
|
|
|
|
|
protected:
|
|
|
|
wxDocument* m_childDocument;
|
|
|
|
wxView* m_childView;
|
|
|
|
|
2002-12-04 09:11:26 -05:00
|
|
|
private:
|
|
|
|
DECLARE_CLASS(wxDocChildFrame)
|
1999-05-10 12:19:09 -04:00
|
|
|
DECLARE_EVENT_TABLE()
|
2003-01-02 18:38:11 -05:00
|
|
|
DECLARE_NO_COPY_CLASS(wxDocChildFrame)
|
1999-05-10 12:19:09 -04:00
|
|
|
};
|
1998-05-20 10:01:55 -04:00
|
|
|
|
1999-05-10 12:19:09 -04:00
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// A default parent frame
|
|
|
|
// ----------------------------------------------------------------------------
|
1998-05-20 10:01:55 -04:00
|
|
|
|
1999-05-10 12:19:09 -04:00
|
|
|
class WXDLLEXPORT wxDocParentFrame : public wxFrame
|
|
|
|
{
|
|
|
|
public:
|
2006-09-14 13:53:06 -04:00
|
|
|
wxDocParentFrame();
|
1999-05-10 12:19:09 -04:00
|
|
|
wxDocParentFrame(wxDocManager *manager,
|
|
|
|
wxFrame *frame,
|
|
|
|
wxWindowID id,
|
|
|
|
const wxString& title,
|
|
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
|
|
const wxSize& size = wxDefaultSize,
|
2006-09-14 13:53:06 -04:00
|
|
|
long style = wxDEFAULT_FRAME_STYLE,
|
|
|
|
const wxString& name = wxFrameNameStr);
|
|
|
|
|
|
|
|
bool Create(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);
|
1998-05-20 10:01:55 -04:00
|
|
|
|
1999-05-10 12:19:09 -04:00
|
|
|
// Extend event processing to search the document manager's event table
|
|
|
|
virtual bool ProcessEvent(wxEvent& event);
|
1998-05-20 10:01:55 -04:00
|
|
|
|
1999-05-10 12:19:09 -04:00
|
|
|
wxDocManager *GetDocumentManager() const { return m_docManager; }
|
1998-05-20 10:01:55 -04:00
|
|
|
|
1999-05-10 12:19:09 -04:00
|
|
|
void OnExit(wxCommandEvent& event);
|
|
|
|
void OnMRUFile(wxCommandEvent& event);
|
|
|
|
void OnCloseWindow(wxCloseEvent& event);
|
1998-05-20 10:01:55 -04:00
|
|
|
|
1999-05-10 12:19:09 -04:00
|
|
|
protected:
|
|
|
|
wxDocManager *m_docManager;
|
|
|
|
|
2002-12-04 09:11:26 -05:00
|
|
|
private:
|
2006-09-14 13:53:06 -04:00
|
|
|
typedef wxFrame base_type;
|
2002-12-04 09:11:26 -05:00
|
|
|
DECLARE_CLASS(wxDocParentFrame)
|
1999-05-10 12:19:09 -04:00
|
|
|
DECLARE_EVENT_TABLE()
|
2003-01-02 18:38:11 -05:00
|
|
|
DECLARE_NO_COPY_CLASS(wxDocParentFrame)
|
1999-05-10 12:19:09 -04:00
|
|
|
};
|
1998-05-20 10:01:55 -04:00
|
|
|
|
1999-05-10 12:19:09 -04:00
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// Provide simple default printing facilities
|
|
|
|
// ----------------------------------------------------------------------------
|
1998-05-20 10:01:55 -04:00
|
|
|
|
1999-05-10 12:19:09 -04:00
|
|
|
#if wxUSE_PRINTING_ARCHITECTURE
|
|
|
|
class WXDLLEXPORT wxDocPrintout : public wxPrintout
|
|
|
|
{
|
|
|
|
public:
|
2002-12-04 09:11:26 -05:00
|
|
|
wxDocPrintout(wxView *view = (wxView *) NULL, const wxString& title = wxT("Printout"));
|
1999-05-10 12:19:09 -04:00
|
|
|
bool OnPrintPage(int page);
|
|
|
|
bool HasPage(int page);
|
|
|
|
bool OnBeginDocument(int startPage, int endPage);
|
|
|
|
void GetPageInfo(int *minPage, int *maxPage, int *selPageFrom, int *selPageTo);
|
1998-05-20 10:01:55 -04:00
|
|
|
|
1999-05-10 12:19:09 -04:00
|
|
|
virtual wxView *GetView() { return m_printoutView; }
|
1998-05-20 10:01:55 -04:00
|
|
|
|
1999-05-10 12:19:09 -04:00
|
|
|
protected:
|
|
|
|
wxView* m_printoutView;
|
2002-12-04 09:11:26 -05:00
|
|
|
|
|
|
|
private:
|
|
|
|
DECLARE_DYNAMIC_CLASS(wxDocPrintout)
|
2003-01-02 18:38:11 -05:00
|
|
|
DECLARE_NO_COPY_CLASS(wxDocPrintout)
|
1998-05-20 10:01:55 -04:00
|
|
|
};
|
1999-05-10 12:19:09 -04:00
|
|
|
#endif // wxUSE_PRINTING_ARCHITECTURE
|
1998-05-20 10:01:55 -04:00
|
|
|
|
1999-05-10 12:19:09 -04:00
|
|
|
// ----------------------------------------------------------------------------
|
1998-09-16 17:52:23 -04:00
|
|
|
// File history management
|
1999-05-10 12:19:09 -04:00
|
|
|
// ----------------------------------------------------------------------------
|
1998-09-16 17:52:23 -04:00
|
|
|
|
1999-05-10 12:19:09 -04:00
|
|
|
class WXDLLEXPORT wxFileHistory : public wxObject
|
1998-05-20 10:01:55 -04:00
|
|
|
{
|
1999-05-10 12:19:09 -04:00
|
|
|
public:
|
2003-03-02 18:35:17 -05:00
|
|
|
wxFileHistory(size_t maxFiles = 9, wxWindowID idBase = wxID_FILE1);
|
2006-09-05 16:47:48 -04:00
|
|
|
virtual ~wxFileHistory();
|
1998-09-16 17:52:23 -04:00
|
|
|
|
1999-05-10 12:19:09 -04:00
|
|
|
// Operations
|
|
|
|
virtual void AddFileToHistory(const wxString& file);
|
2003-03-02 18:35:17 -05:00
|
|
|
virtual void RemoveFileFromHistory(size_t i);
|
2004-10-23 09:55:20 -04:00
|
|
|
virtual int GetMaxFiles() const { return (int)m_fileMaxFiles; }
|
1999-05-10 12:19:09 -04:00
|
|
|
virtual void UseMenu(wxMenu *menu);
|
1998-09-16 17:52:23 -04:00
|
|
|
|
1999-05-10 12:19:09 -04:00
|
|
|
// Remove menu from the list (MDI child may be closing)
|
|
|
|
virtual void RemoveMenu(wxMenu *menu);
|
1998-09-16 17:52:23 -04:00
|
|
|
|
1999-05-10 12:19:09 -04:00
|
|
|
#if wxUSE_CONFIG
|
|
|
|
virtual void Load(wxConfigBase& config);
|
|
|
|
virtual void Save(wxConfigBase& config);
|
|
|
|
#endif // wxUSE_CONFIG
|
|
|
|
|
|
|
|
virtual void AddFilesToMenu();
|
|
|
|
virtual void AddFilesToMenu(wxMenu* menu); // Single menu
|
|
|
|
|
|
|
|
// Accessors
|
2007-04-10 20:23:19 -04:00
|
|
|
virtual wxString GetHistoryFile(size_t i) const { return m_fileHistory[i]; }
|
|
|
|
virtual size_t GetCount() const { return m_fileHistory.GetCount(); }
|
1999-05-10 12:19:09 -04:00
|
|
|
|
2003-06-26 09:15:12 -04:00
|
|
|
const wxList& GetMenus() const { return m_fileMenus; }
|
1999-05-10 12:19:09 -04:00
|
|
|
|
2007-01-14 11:38:53 -05:00
|
|
|
// Set/get base id
|
2007-01-14 07:43:01 -05:00
|
|
|
void SetBaseId(wxWindowID baseId) { m_idBase = baseId; }
|
|
|
|
wxWindowID GetBaseId() const { return m_idBase; }
|
|
|
|
|
2006-03-30 09:04:17 -05:00
|
|
|
#if WXWIN_COMPATIBILITY_2_6
|
2003-05-09 08:04:01 -04:00
|
|
|
// deprecated, use GetCount() instead
|
|
|
|
wxDEPRECATED( size_t GetNoHistoryFiles() const );
|
2006-03-30 09:04:17 -05:00
|
|
|
#endif // WXWIN_COMPATIBILITY_2_6
|
2003-05-08 20:02:58 -04:00
|
|
|
|
1999-05-10 12:19:09 -04:00
|
|
|
protected:
|
|
|
|
// Last n files
|
2007-04-10 20:23:19 -04:00
|
|
|
wxArrayString m_fileHistory;
|
|
|
|
|
1999-05-10 12:19:09 -04:00
|
|
|
// Menus to maintain (may need several for an MDI app)
|
|
|
|
wxList m_fileMenus;
|
2007-04-10 20:23:19 -04:00
|
|
|
|
1999-05-10 12:19:09 -04:00
|
|
|
// Max files to maintain
|
2003-03-02 18:35:17 -05:00
|
|
|
size_t m_fileMaxFiles;
|
2003-05-09 08:04:01 -04:00
|
|
|
|
2002-12-04 09:11:26 -05:00
|
|
|
private:
|
2003-03-02 18:35:17 -05:00
|
|
|
// The ID of the first history menu item (Doesn't have to be wxID_FILE1)
|
|
|
|
wxWindowID m_idBase;
|
|
|
|
|
2002-12-04 09:11:26 -05:00
|
|
|
DECLARE_DYNAMIC_CLASS(wxFileHistory)
|
2003-01-02 18:38:11 -05:00
|
|
|
DECLARE_NO_COPY_CLASS(wxFileHistory)
|
1998-05-20 10:01:55 -04:00
|
|
|
};
|
|
|
|
|
2006-03-30 09:04:17 -05:00
|
|
|
#if WXWIN_COMPATIBILITY_2_6
|
2003-05-09 08:04:01 -04:00
|
|
|
inline size_t wxFileHistory::GetNoHistoryFiles() const
|
|
|
|
{
|
2007-04-10 20:26:09 -04:00
|
|
|
return m_fileHistory.GetCount();
|
2003-05-09 08:04:01 -04:00
|
|
|
}
|
2006-03-30 09:04:17 -05:00
|
|
|
#endif // WXWIN_COMPATIBILITY_2_6
|
2003-05-09 08:04:01 -04:00
|
|
|
|
1999-06-29 19:16:45 -04:00
|
|
|
#if wxUSE_STD_IOSTREAM
|
1998-05-20 10:01:55 -04:00
|
|
|
// For compatibility with existing file formats:
|
|
|
|
// converts from/to a stream to/from a temporary file.
|
2001-06-06 12:51:53 -04:00
|
|
|
bool WXDLLEXPORT wxTransferFileToStream(const wxString& filename, wxSTD ostream& stream);
|
|
|
|
bool WXDLLEXPORT wxTransferStreamToFile(wxSTD istream& stream, const wxString& filename);
|
2000-02-24 10:04:24 -05:00
|
|
|
#else
|
|
|
|
// For compatibility with existing file formats:
|
|
|
|
// converts from/to a stream to/from a temporary file.
|
|
|
|
bool WXDLLEXPORT wxTransferFileToStream(const wxString& filename, wxOutputStream& stream);
|
|
|
|
bool WXDLLEXPORT wxTransferStreamToFile(wxInputStream& stream, const wxString& filename);
|
2003-01-12 17:20:46 -05:00
|
|
|
#endif // wxUSE_STD_IOSTREAM
|
|
|
|
|
|
|
|
#endif // wxUSE_DOC_VIEW_ARCHITECTURE
|
1998-05-20 10:01:55 -04:00
|
|
|
|
1999-05-10 12:19:09 -04:00
|
|
|
#endif // _WX_DOCH__
|