define wxHAS_RAW_BITMAP for wxDFB

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

diff --git a/include/wx/docview.h b/include/wx/docview.h
index 8c7213338f16c14e6b27cc842a5259f45bf1af36..da00c0f814c741de3dbabf45591592d4124bd8ae 100644 (file)
--- a/include/wx/docview.h
+++ b/include/wx/docview.h
@@ -24,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_BASE wxConfigBase;

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


@@ -60,7 +60,7 @@ enum
 
 #define wxMAX_FILE_HISTORY 9
 
 
 #define wxMAX_FILE_HISTORY 9
 

-class WXDLLEXPORT wxDocument : public wxEvtHandler
+class WXDLLIMPEXP_CORE wxDocument : public wxEvtHandler

 {
 public:
     wxDocument(wxDocument *parent = (wxDocument *) NULL);
 {
 public:
     wxDocument(wxDocument *parent = (wxDocument *) NULL);


@@ -70,10 +70,10 @@ public:
     void SetFilename(const wxString& filename, bool notifyViews = false);
     wxString GetFilename() const { return m_documentFile; }
 
     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; }


@@ -140,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.


@@ -164,12 +173,15 @@ 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)
 };
 

-class WXDLLEXPORT wxView: public wxEvtHandler
+class WXDLLIMPEXP_CORE wxView: public wxEvtHandler

 {
 public:
     //  wxView(wxDocument *doc = (wxDocument *) NULL);
 {
 public:
     //  wxView(wxDocument *doc = (wxDocument *) NULL);


@@ -180,7 +192,7 @@ public:
     virtual void SetDocument(wxDocument *doc);
 
     wxString GetViewName() const { return m_viewTypeName; }
     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; }


@@ -194,7 +206,7 @@ public:
 
     // Called by framework if created automatically by the default document
     // manager class: gives view a chance to initialise
 
     // 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


@@ -229,10 +241,10 @@ private:
 };
 
 // Represents user interface (and other) properties of documents and views
 };
 
 // Represents user interface (and other) properties of documents and views

-class WXDLLEXPORT wxDocTemplate: public wxObject
+class WXDLLIMPEXP_CORE 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


@@ -260,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); }
 


@@ -310,7 +322,7 @@ private:
 
 // One object of this class may be created in an application, to manage all
 // the templates and documents.
 
 // One object of this class may be created in an application, to manage all
 // the templates and documents.

-class WXDLLEXPORT wxDocManager: public wxEvtHandler
+class WXDLLIMPEXP_CORE wxDocManager: public wxEvtHandler

 {
 public:
     wxDocManager(long flags = wxDEFAULT_DOCMAN_FLAGS, bool initialize = true);
 {
 public:
     wxDocManager(long flags = wxDEFAULT_DOCMAN_FLAGS, bool initialize = true);


@@ -393,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);


@@ -410,7 +423,7 @@ public:
     virtual void FileHistoryUseMenu(wxMenu *menu);
     virtual void FileHistoryRemoveMenu(wxMenu *menu);
 #if wxUSE_CONFIG
     virtual void FileHistoryUseMenu(wxMenu *menu);
     virtual void FileHistoryRemoveMenu(wxMenu *menu);
 #if wxUSE_CONFIG

-    virtual void FileHistoryLoad(wxConfigBase& config);
+    virtual void FileHistoryLoad(const wxConfigBase& config);

     virtual void FileHistorySave(wxConfigBase& config);
 #endif // wxUSE_CONFIG
 
     virtual void FileHistorySave(wxConfigBase& config);
 #endif // wxUSE_CONFIG
 


@@ -423,6 +436,13 @@ 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 );
 #if WXWIN_COMPATIBILITY_2_6
     // deprecated, use GetHistoryFilesCount() instead
     wxDEPRECATED( size_t GetNoHistoryFiles() const );


@@ -455,7 +475,7 @@ inline size_t wxDocManager::GetNoHistoryFiles() const
 // A default child frame
 // ----------------------------------------------------------------------------
 
 // A default child frame
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxDocChildFrame : public wxFrame
+class WXDLLIMPEXP_CORE wxDocChildFrame : public wxFrame

 {
 public:
     wxDocChildFrame(wxDocument *doc,
 {
 public:
     wxDocChildFrame(wxDocument *doc,


@@ -495,7 +515,7 @@ private:
 // A default parent frame
 // ----------------------------------------------------------------------------
 
 // A default parent frame
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxDocParentFrame : public wxFrame
+class WXDLLIMPEXP_CORE wxDocParentFrame : public wxFrame

 {
 public:
     wxDocParentFrame();
 {
 public:
     wxDocParentFrame();


@@ -541,7 +561,7 @@ private:
 // ----------------------------------------------------------------------------
 
 #if wxUSE_PRINTING_ARCHITECTURE
 // ----------------------------------------------------------------------------
 
 #if wxUSE_PRINTING_ARCHITECTURE

-class WXDLLEXPORT wxDocPrintout : public wxPrintout
+class WXDLLIMPEXP_CORE wxDocPrintout : public wxPrintout

 {
 public:
     wxDocPrintout(wxView *view = (wxView *) NULL, const wxString& title = wxT("Printout"));
 {
 public:
     wxDocPrintout(wxView *view = (wxView *) NULL, const wxString& title = wxT("Printout"));


@@ -565,7 +585,7 @@ private:
 // File history management
 // ----------------------------------------------------------------------------
 
 // File history management
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxFileHistory : public wxObject
+class WXDLLIMPEXP_CORE wxFileHistory : public wxObject

 {
 public:
     wxFileHistory(size_t maxFiles = 9, wxWindowID idBase = wxID_FILE1);
 {
 public:
     wxFileHistory(size_t maxFiles = 9, wxWindowID idBase = wxID_FILE1);


@@ -581,7 +601,7 @@ public:
     virtual void RemoveMenu(wxMenu *menu);
 
 #if wxUSE_CONFIG
     virtual void RemoveMenu(wxMenu *menu);
 
 #if wxUSE_CONFIG

-    virtual void Load(wxConfigBase& config);
+    virtual void Load(const wxConfigBase& config);

     virtual void Save(wxConfigBase& config);
 #endif // wxUSE_CONFIG
 
     virtual void Save(wxConfigBase& config);
 #endif // wxUSE_CONFIG
 


@@ -624,20 +644,20 @@ private:
 #if WXWIN_COMPATIBILITY_2_6
 inline size_t wxFileHistory::GetNoHistoryFiles() const
 {
 #if WXWIN_COMPATIBILITY_2_6
 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:
 // converts from/to a stream to/from a temporary file.
 }
 #endif // WXWIN_COMPATIBILITY_2_6
 
 #if wxUSE_STD_IOSTREAM
 // For compatibility with existing file formats:
 // converts from/to a stream to/from a temporary file.

-bool WXDLLEXPORT wxTransferFileToStream(const wxString& filename, wxSTD ostream& stream);
-bool WXDLLEXPORT wxTransferStreamToFile(wxSTD istream& stream, const wxString& filename);
+bool WXDLLIMPEXP_CORE wxTransferFileToStream(const wxString& filename, wxSTD ostream& stream);
+bool WXDLLIMPEXP_CORE wxTransferStreamToFile(wxSTD istream& stream, const wxString& filename);

 #else
 // For compatibility with existing file formats:
 // converts from/to a stream to/from a temporary file.
 #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);
+bool WXDLLIMPEXP_CORE wxTransferFileToStream(const wxString& filename, wxOutputStream& stream);
+bool WXDLLIMPEXP_CORE wxTransferStreamToFile(wxInputStream& stream, const wxString& filename);

 #endif // wxUSE_STD_IOSTREAM
 
 #endif // wxUSE_DOC_VIEW_ARCHITECTURE
 #endif // wxUSE_STD_IOSTREAM
 
 #endif // wxUSE_DOC_VIEW_ARCHITECTURE