added checks for more wxUSE_SVG dependencies: wxUSE_IMAGE and wxUSE_LIBPNG

[wxWidgets.git] / include / wx / docview.h

diff --git a/include/wx/docview.h b/include/wx/docview.h
index 2ea29e2bf90b99c7822b9f0466925feb555ba7b0..84697a7a7a5995c8bd9bfd8fe6a59c2b965872d7 100644 (file)
--- a/include/wx/docview.h
+++ b/include/wx/docview.h
@@ -1,27 +1,22 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        docview.h
+// Name:        wx/docview.h

 // Purpose:     Doc/View classes
 // Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Purpose:     Doc/View classes
 // Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$

-// Copyright:   (c)
+// Copyright:   (c) Julian Smart

 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_DOCH__
 #define _WX_DOCH__
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_DOCH__
 #define _WX_DOCH__
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma interface "docview.h"
-#endif
-

 #include "wx/defs.h"
 
 #if wxUSE_DOC_VIEW_ARCHITECTURE
 
 #include "wx/list.h"
 #include "wx/defs.h"
 
 #if wxUSE_DOC_VIEW_ARCHITECTURE
 
 #include "wx/list.h"

-#include "wx/cmndata.h"

 #include "wx/string.h"
 #include "wx/frame.h"
 
 #include "wx/string.h"
 #include "wx/frame.h"
 


@@ -29,15 +24,15 @@
     #include "wx/print.h"
 #endif
 
     #include "wx/print.h"
 #endif
 

-class WXDLLEXPORT wxWindow;
-class WXDLLEXPORT wxDocument;
-class WXDLLEXPORT wxView;
-class WXDLLEXPORT wxDocTemplate;
-class WXDLLEXPORT wxDocManager;
-class WXDLLEXPORT wxPrintInfo;
-class WXDLLEXPORT wxCommandProcessor;
-class WXDLLEXPORT wxFileHistory;
-class WXDLLEXPORT wxConfigBase;
+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;
+class WXDLLIMPEXP_FWD_CORE wxConfigBase;

 
 #if wxUSE_STD_IOSTREAM
   #include "wx/iosfwrap.h"
 
 #if wxUSE_STD_IOSTREAM
   #include "wx/iosfwrap.h"


@@ -69,16 +64,16 @@ class WXDLLEXPORT wxDocument : public wxEvtHandler
 {
 public:
     wxDocument(wxDocument *parent = (wxDocument *) NULL);
 {
 public:
     wxDocument(wxDocument *parent = (wxDocument *) NULL);

-    ~wxDocument();
+    virtual ~wxDocument();

 
     // accessors
     void SetFilename(const wxString& filename, bool notifyViews = false);
     wxString GetFilename() const { return m_documentFile; }
 
 
     // accessors
     void SetFilename(const wxString& filename, bool notifyViews = false);
     wxString GetFilename() const { return m_documentFile; }
 

-    void SetTitle(const wxString& title) { m_documentTitle = title; };
+    void SetTitle(const wxString& title) { m_documentTitle = title; }

     wxString GetTitle() const { return m_documentTitle; }
 
     wxString GetTitle() const { return m_documentTitle; }
 

-    void SetDocumentName(const wxString& name) { m_documentTypeName = name; };
+    void SetDocumentName(const wxString& name) { m_documentTypeName = name; }

     wxString GetDocumentName() const { return m_documentTypeName; }
 
     bool GetDocumentSaved() const { return m_savedYet; }
     wxString GetDocumentName() const { return m_documentTypeName; }
 
     bool GetDocumentSaved() const { return m_savedYet; }


@@ -130,7 +125,8 @@ public:
 
     virtual bool AddView(wxView *view);
     virtual bool RemoveView(wxView *view);
 
     virtual bool AddView(wxView *view);
     virtual bool RemoveView(wxView *view);

-    wxList& GetViews() const { return (wxList&) m_documentViews; }
+    wxList& GetViews() { return m_documentViews; }
+    const wxList& GetViews() const { return m_documentViews; }

     wxView *GetFirstView() const;
 
     virtual void UpdateAllViews(wxView *sender = (wxView *) NULL, wxObject *hint = (wxObject *) NULL);
     wxView *GetFirstView() const;
 
     virtual void UpdateAllViews(wxView *sender = (wxView *) NULL, wxObject *hint = (wxObject *) NULL);


@@ -144,8 +140,17 @@ public:
     virtual wxDocTemplate *GetDocumentTemplate() const { return m_documentTemplate; }
     virtual void SetDocumentTemplate(wxDocTemplate *temp) { m_documentTemplate = temp; }
 
     virtual wxDocTemplate *GetDocumentTemplate() const { return m_documentTemplate; }
     virtual void SetDocumentTemplate(wxDocTemplate *temp) { m_documentTemplate = temp; }
 

-    // Get title, or filename if no title, else [unnamed]
-    virtual bool GetPrintableName(wxString& buf) const;
+    // 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

 
     // Returns a window that can be used as a parent for document-related
     // dialogs. Override if necessary.
 
     // Returns a window that can be used as a parent for document-related
     // dialogs. Override if necessary.


@@ -168,6 +173,9 @@ protected:
     virtual bool DoSaveDocument(const wxString& file);
     virtual bool DoOpenDocument(const wxString& file);
 
     virtual bool DoSaveDocument(const wxString& file);
     virtual bool DoOpenDocument(const wxString& file);
 

+    // the default implementation of GetUserReadableName()
+    wxString DoGetUserReadableName() const;
+

 private:
     DECLARE_ABSTRACT_CLASS(wxDocument)
     DECLARE_NO_COPY_CLASS(wxDocument)
 private:
     DECLARE_ABSTRACT_CLASS(wxDocument)
     DECLARE_NO_COPY_CLASS(wxDocument)


@@ -178,13 +186,13 @@ class WXDLLEXPORT wxView: public wxEvtHandler
 public:
     //  wxView(wxDocument *doc = (wxDocument *) NULL);
     wxView();
 public:
     //  wxView(wxDocument *doc = (wxDocument *) NULL);
     wxView();

-    ~wxView();
+    virtual ~wxView();

 
     wxDocument *GetDocument() const { return m_viewDocument; }
     virtual void SetDocument(wxDocument *doc);
 
     wxString GetViewName() const { return m_viewTypeName; }
 
     wxDocument *GetDocument() const { return m_viewDocument; }
     virtual void SetDocument(wxDocument *doc);
 
     wxString GetViewName() const { return m_viewTypeName; }

-    void SetViewName(const wxString& name) { m_viewTypeName = name; };
+    void SetViewName(const wxString& name) { m_viewTypeName = name; }

 
     wxWindow *GetFrame() const { return m_viewFrame ; }
     void SetFrame(wxWindow *frame) { m_viewFrame = frame; }
 
     wxWindow *GetFrame() const { return m_viewFrame ; }
     void SetFrame(wxWindow *frame) { m_viewFrame = frame; }


@@ -193,12 +201,12 @@ public:
     virtual void OnDraw(wxDC *dc) = 0;
     virtual void OnPrint(wxDC *dc, wxObject *info);
     virtual void OnUpdate(wxView *sender, wxObject *hint = (wxObject *) NULL);
     virtual void OnDraw(wxDC *dc) = 0;
     virtual void OnPrint(wxDC *dc, wxObject *info);
     virtual void OnUpdate(wxView *sender, wxObject *hint = (wxObject *) NULL);

-    virtual void OnClosingDocument() {};
+    virtual void OnClosingDocument() {}

     virtual void OnChangeFilename();
 
     // Called by framework if created automatically by the default document
     // manager class: gives view a chance to initialise
     virtual void OnChangeFilename();
 
     // Called by framework if created automatically by the default document
     // manager class: gives view a chance to initialise

-    virtual bool OnCreate(wxDocument *WXUNUSED(doc), long WXUNUSED(flags)) { return true; };
+    virtual bool OnCreate(wxDocument *WXUNUSED(doc), long WXUNUSED(flags)) { return true; }

 
     // 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
 
     // 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


@@ -236,7 +244,7 @@ private:
 class WXDLLEXPORT wxDocTemplate: public wxObject
 {
 
 class WXDLLEXPORT wxDocTemplate: public wxObject
 {
 

-friend class WXDLLEXPORT wxDocManager;
+friend class WXDLLIMPEXP_FWD_CORE wxDocManager;

 
 public:
     // Associate document and view types. They're for identifying what view is
 
 public:
     // Associate document and view types. They're for identifying what view is


@@ -252,7 +260,7 @@ public:
                   wxClassInfo *viewClassInfo = (wxClassInfo *)NULL,
                   long flags = wxDEFAULT_TEMPLATE_FLAGS);
 
                   wxClassInfo *viewClassInfo = (wxClassInfo *)NULL,
                   long flags = wxDEFAULT_TEMPLATE_FLAGS);
 

-    ~wxDocTemplate();
+    virtual ~wxDocTemplate();

 
     // By default, these two member functions dynamically creates document and
     // view using dynamic instance construction. Override these if you need a
 
     // By default, these two member functions dynamically creates document and
     // view using dynamic instance construction. Override these if you need a


@@ -264,21 +272,21 @@ public:
     // creation
     virtual bool InitDocument(wxDocument* doc, const wxString& path, long flags = 0);
 
     // creation
     virtual bool InitDocument(wxDocument* doc, const wxString& path, long flags = 0);
 

-    wxString GetDefaultExtension() const { return m_defaultExt; };
+    wxString GetDefaultExtension() const { return m_defaultExt; }

     wxString GetDescription() const { return m_description; }
     wxString GetDescription() const { return m_description; }

-    wxString GetDirectory() const { return m_directory; };
+    wxString GetDirectory() const { return m_directory; }

     wxDocManager *GetDocumentManager() const { return m_documentManager; }
     void SetDocumentManager(wxDocManager *manager) { m_documentManager = manager; }
     wxDocManager *GetDocumentManager() const { return m_documentManager; }
     void SetDocumentManager(wxDocManager *manager) { m_documentManager = manager; }

-    wxString GetFileFilter() const { return m_fileFilter; };
-    long GetFlags() const { return m_flags; };
+    wxString GetFileFilter() const { return m_fileFilter; }
+    long GetFlags() const { return m_flags; }

     virtual wxString GetViewName() const { return m_viewTypeName; }
     virtual wxString GetDocumentName() const { return m_docTypeName; }
 
     virtual wxString GetViewName() const { return m_viewTypeName; }
     virtual wxString GetDocumentName() const { return m_docTypeName; }
 

-    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; };
+    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; }

 
     bool IsVisible() const { return ((m_flags & wxTEMPLATE_VISIBLE) == wxTEMPLATE_VISIBLE); }
 
 
     bool IsVisible() const { return ((m_flags & wxTEMPLATE_VISIBLE) == wxTEMPLATE_VISIBLE); }
 


@@ -318,7 +326,7 @@ class WXDLLEXPORT wxDocManager: public wxEvtHandler
 {
 public:
     wxDocManager(long flags = wxDEFAULT_DOCMAN_FLAGS, bool initialize = true);
 {
 public:
     wxDocManager(long flags = wxDEFAULT_DOCMAN_FLAGS, bool initialize = true);

-    ~wxDocManager();
+    virtual ~wxDocManager();

 
     virtual bool Initialize();
 
 
     virtual bool Initialize();
 


@@ -331,7 +339,6 @@ public:
     void OnFileSave(wxCommandEvent& event);
     void OnFileSaveAs(wxCommandEvent& event);
     void OnPrint(wxCommandEvent& event);
     void OnFileSave(wxCommandEvent& event);
     void OnFileSaveAs(wxCommandEvent& event);
     void OnPrint(wxCommandEvent& event);

-    void OnPrintSetup(wxCommandEvent& event);

     void OnPreview(wxCommandEvent& event);
     void OnUndo(wxCommandEvent& event);
     void OnRedo(wxCommandEvent& event);
     void OnPreview(wxCommandEvent& event);
     void OnUndo(wxCommandEvent& event);
     void OnRedo(wxCommandEvent& event);


@@ -347,7 +354,6 @@ public:
     void OnUpdateRedo(wxUpdateUIEvent& event);
 
     void OnUpdatePrint(wxUpdateUIEvent& event);
     void OnUpdateRedo(wxUpdateUIEvent& event);
 
     void OnUpdatePrint(wxUpdateUIEvent& event);

-    void OnUpdatePrintSetup(wxUpdateUIEvent& event);

     void OnUpdatePreview(wxUpdateUIEvent& event);
 
     // Extend event processing to search the view's event table
     void OnUpdatePreview(wxUpdateUIEvent& event);
 
     // Extend event processing to search the view's event table


@@ -399,8 +405,9 @@ public:
     wxList& GetDocuments() { return m_docs; }
     wxList& GetTemplates() { return m_templates; }
 
     wxList& GetDocuments() { return m_docs; }
     wxList& GetTemplates() { return m_templates; }
 

-    // Make a default document name
-    virtual bool MakeDefaultName(wxString& buf);
+    // Return the default name for a new document (by default returns strings
+    // in the form "unnamed <counter>" but can be overridden)
+    virtual wxString MakeNewDocumentName();

 
     // Make a frame title (override this to do something different)
     virtual wxString MakeFrameTitle(wxDocument* doc);
 
     // Make a frame title (override this to do something different)
     virtual wxString MakeFrameTitle(wxDocument* doc);


@@ -429,8 +436,17 @@ public:
     // Get the current document manager
     static wxDocManager* GetDocumentManager() { return sm_docManager; }
 
     // Get the current document manager
     static wxDocManager* GetDocumentManager() { return sm_docManager; }
 

+#if WXWIN_COMPATIBILITY_2_8
+    // deprecated, override GetDefaultName() instead
+    wxDEPRECATED_BUT_USED_INTERNALLY(
+        virtual bool MakeDefaultName(wxString& buf)
+    );
+#endif
+
+#if WXWIN_COMPATIBILITY_2_6

     // deprecated, use GetHistoryFilesCount() instead
     wxDEPRECATED( size_t GetNoHistoryFiles() const );
     // deprecated, use GetHistoryFilesCount() instead
     wxDEPRECATED( size_t GetNoHistoryFiles() const );

+#endif // WXWIN_COMPATIBILITY_2_6

 
 protected:
     long              m_flags;
 
 protected:
     long              m_flags;


@@ -448,10 +464,12 @@ protected:
     DECLARE_NO_COPY_CLASS(wxDocManager)
 };
 
     DECLARE_NO_COPY_CLASS(wxDocManager)
 };
 

+#if WXWIN_COMPATIBILITY_2_6

 inline size_t wxDocManager::GetNoHistoryFiles() const
 {
     return GetHistoryFilesCount();
 }
 inline size_t wxDocManager::GetNoHistoryFiles() const
 {
     return GetHistoryFilesCount();
 }

+#endif // WXWIN_COMPATIBILITY_2_6

 
 // ----------------------------------------------------------------------------
 // A default child frame
 
 // ----------------------------------------------------------------------------
 // A default child frame


@@ -469,7 +487,7 @@ public:
                     const wxSize& size = wxDefaultSize,
                     long type = wxDEFAULT_FRAME_STYLE,
                     const wxString& name = wxT("frame"));
                     const wxSize& size = wxDefaultSize,
                     long type = wxDEFAULT_FRAME_STYLE,
                     const wxString& name = wxT("frame"));

-    ~wxDocChildFrame();
+    virtual ~wxDocChildFrame(){}

 
     // Extend event processing to search the view's event table
     virtual bool ProcessEvent(wxEvent& event);
 
     // Extend event processing to search the view's event table
     virtual bool ProcessEvent(wxEvent& event);


@@ -500,14 +518,24 @@ private:
 class WXDLLEXPORT wxDocParentFrame : public wxFrame
 {
 public:
 class WXDLLEXPORT wxDocParentFrame : public wxFrame
 {
 public:

+    wxDocParentFrame();

     wxDocParentFrame(wxDocManager *manager,
                      wxFrame *frame,
                      wxWindowID id,
                      const wxString& title,
                      const wxPoint& pos = wxDefaultPosition,
                      const wxSize& size = wxDefaultSize,
     wxDocParentFrame(wxDocManager *manager,
                      wxFrame *frame,
                      wxWindowID id,
                      const wxString& title,
                      const wxPoint& pos = wxDefaultPosition,
                      const wxSize& size = wxDefaultSize,

-                     long type = wxDEFAULT_FRAME_STYLE,
-                     const wxString& name = wxT("frame"));
+                     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);

 
     // Extend event processing to search the document manager's event table
     virtual bool ProcessEvent(wxEvent& event);
 
     // Extend event processing to search the document manager's event table
     virtual bool ProcessEvent(wxEvent& event);


@@ -522,6 +550,7 @@ protected:
     wxDocManager *m_docManager;
 
 private:
     wxDocManager *m_docManager;
 
 private:

+    typedef wxFrame base_type;

     DECLARE_CLASS(wxDocParentFrame)
     DECLARE_EVENT_TABLE()
     DECLARE_NO_COPY_CLASS(wxDocParentFrame)
     DECLARE_CLASS(wxDocParentFrame)
     DECLARE_EVENT_TABLE()
     DECLARE_NO_COPY_CLASS(wxDocParentFrame)


@@ -560,12 +589,12 @@ class WXDLLEXPORT wxFileHistory : public wxObject
 {
 public:
     wxFileHistory(size_t maxFiles = 9, wxWindowID idBase = wxID_FILE1);
 {
 public:
     wxFileHistory(size_t maxFiles = 9, wxWindowID idBase = wxID_FILE1);

-    ~wxFileHistory();
+    virtual ~wxFileHistory();

 
     // Operations
     virtual void AddFileToHistory(const wxString& file);
     virtual void RemoveFileFromHistory(size_t i);
 
     // Operations
     virtual void AddFileToHistory(const wxString& file);
     virtual void RemoveFileFromHistory(size_t i);

-    virtual int GetMaxFiles() const { return m_fileMaxFiles; }
+    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 UseMenu(wxMenu *menu);
 
     // Remove menu from the list (MDI child may be closing)


@@ -580,21 +609,27 @@ public:
     virtual void AddFilesToMenu(wxMenu* menu); // Single menu
 
     // Accessors
     virtual void AddFilesToMenu(wxMenu* menu); // Single menu
 
     // Accessors

-    virtual wxString GetHistoryFile(size_t i) const;
-    virtual size_t GetCount() const { return m_fileHistoryN; }
+    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; }
 
 
     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 );
     // deprecated, use GetCount() instead
     wxDEPRECATED( size_t GetNoHistoryFiles() const );

+#endif // WXWIN_COMPATIBILITY_2_6

 
 protected:
     // Last n files
 
 protected:
     // Last n files

-    wxChar**          m_fileHistory;
-    // Number of files saved
-    size_t            m_fileHistoryN;
+    wxArrayString     m_fileHistory;
+

     // Menus to maintain (may need several for an MDI app)
     wxList            m_fileMenus;
     // Menus to maintain (may need several for an MDI app)
     wxList            m_fileMenus;

+

     // Max files to maintain
     size_t            m_fileMaxFiles;
 
     // Max files to maintain
     size_t            m_fileMaxFiles;
 


@@ -606,10 +641,12 @@ private:
     DECLARE_NO_COPY_CLASS(wxFileHistory)
 };
 
     DECLARE_NO_COPY_CLASS(wxFileHistory)
 };
 

+#if WXWIN_COMPATIBILITY_2_6

 inline size_t wxFileHistory::GetNoHistoryFiles() const
 {
 inline size_t wxFileHistory::GetNoHistoryFiles() const
 {

-    return m_fileHistoryN;
+    return m_fileHistory.GetCount();

 }
 }

+#endif // WXWIN_COMPATIBILITY_2_6

 
 #if wxUSE_STD_IOSTREAM
 // For compatibility with existing file formats:
 
 #if wxUSE_STD_IOSTREAM
 // For compatibility with existing file formats: