// Modified by:
// Created: 01/02/97
// RCS-ID: $Id$
-// Copyright: (c)
+// Copyright: (c) Julian Smart
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#ifndef _WX_DOCH__
#define _WX_DOCH__
-#if defined(__GNUG__) && !defined(__APPLE__)
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
#pragma interface "docview.h"
#endif
~wxDocument();
// accessors
- void SetFilename(const wxString& filename, bool notifyViews = FALSE);
+ void SetFilename(const wxString& filename, bool notifyViews = false);
wxString GetFilename() const { return m_documentFile; }
void SetTitle(const wxString& title) { m_documentTitle = title; };
wxString GetDocumentName() const { return m_documentTypeName; }
bool GetDocumentSaved() const { return m_savedYet; }
- void SetDocumentSaved(bool saved = TRUE) { m_savedYet = saved; }
+ void SetDocumentSaved(bool saved = true) { m_savedYet = saved; }
virtual bool Close();
virtual bool Save();
virtual wxInputStream& LoadObject(wxInputStream& stream);
#endif
- // Called by wxWindows
+ // Called by wxWidgets
virtual bool OnSaveDocument(const wxString& filename);
virtual bool OnOpenDocument(const wxString& filename);
virtual bool OnNewDocument();
virtual bool OnCloseDocument();
- // Prompts for saving if about to close a modified document. Returns TRUE
+ // Prompts for saving if about to close a modified document. Returns true
// if ok to close the document (may have saved in the meantime, or set
- // modified to FALSE)
+ // modified to false)
virtual bool OnSaveModified();
// Called by framework if created automatically by the default document
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.
+ virtual bool DoSaveDocument(const wxString& file);
+ virtual bool DoOpenDocument(const wxString& file);
+
private:
DECLARE_ABSTRACT_CLASS(wxDocument)
DECLARE_NO_COPY_CLASS(wxDocument)
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 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
- // TRUE.
- virtual bool Close(bool deleteWindow = TRUE);
+ // true.
+ virtual bool Close(bool deleteWindow = true);
// Override to do cleanup/veto close
virtual bool OnClose(bool deleteWindow);
-#if WXWIN_COMPATIBILITY
- // Defeat compiler warning
- bool OnClose() { return wxEvtHandler::OnClose(); }
-#endif
-
// Extend event processing to search the document's event table
virtual bool ProcessEvent(wxEvent& event);
virtual wxDocument *CreateDocument(const wxString& path, long flags = 0);
virtual wxView *CreateView(wxDocument *doc, long flags = 0);
+ // Helper method for CreateDocument; also allows you to do your own document
+ // creation
+ virtual bool InitDocument(wxDocument* doc, const wxString& path, long flags = 0);
+
wxString GetDefaultExtension() const { return m_defaultExt; };
wxString GetDescription() const { return m_description; }
wxString GetDirectory() const { return m_directory; };
bool IsVisible() const { return ((m_flags & wxTEMPLATE_VISIBLE) == wxTEMPLATE_VISIBLE); }
+ wxClassInfo* GetDocClassInfo() const { return m_docClassInfo; }
+ wxClassInfo* GetViewClassInfo() const { return m_viewClassInfo; }
+
virtual bool FileMatchesTemplate(const wxString& path);
protected:
// For dynamic creation of appropriate instances.
wxClassInfo* m_docClassInfo;
wxClassInfo* m_viewClassInfo;
-
+
+ // 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();
+
private:
DECLARE_CLASS(wxDocTemplate)
DECLARE_NO_COPY_CLASS(wxDocTemplate)
// the templates and documents.
class WXDLLEXPORT wxDocManager: public wxEvtHandler
{
- DECLARE_DYNAMIC_CLASS(wxDocManager)
-
public:
- wxDocManager(long flags = wxDEFAULT_DOCMAN_FLAGS, bool initialize = TRUE);
+ wxDocManager(long flags = wxDEFAULT_DOCMAN_FLAGS, bool initialize = true);
~wxDocManager();
virtual bool Initialize();
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 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
virtual bool FlushDoc(wxDocument *doc);
virtual wxDocTemplate *MatchTemplate(const wxString& path);
virtual wxDocTemplate *SelectDocumentPath(wxDocTemplate **templates,
- int noTemplates, wxString& path, long flags, bool save = FALSE);
+ int noTemplates, wxString& path, long flags, bool save = false);
virtual wxDocTemplate *SelectDocumentType(wxDocTemplate **templates,
- int noTemplates, bool sort = FALSE);
+ int noTemplates, bool sort = false);
virtual wxDocTemplate *SelectViewType(wxDocTemplate **templates,
- int noTemplates, bool sort = FALSE);
+ int noTemplates, bool sort = false);
virtual wxDocTemplate *FindTemplateForPath(const wxString& path);
void AssociateTemplate(wxDocTemplate *temp);
void RemoveDocument(wxDocument *doc);
// closes all currently open documents
- bool CloseDocuments(bool force = TRUE);
+ bool CloseDocuments(bool force = true);
// closes the specified document
- bool CloseDocument(wxDocument* doc, bool force = FALSE);
+ bool CloseDocument(wxDocument* doc, bool force = false);
// Clear remaining documents and templates
- bool Clear(bool force = TRUE);
+ bool Clear(bool force = true);
// Views or windows should inform the document manager
// when a view is going in or out of focus
- virtual void ActivateView(wxView *view, bool activate = TRUE, bool deleting = FALSE);
+ virtual void ActivateView(wxView *view, bool activate = true);
virtual wxView *GetCurrentView() const;
wxList& GetDocuments() { return m_docs; }
// File history management
virtual void AddFileToHistory(const wxString& file);
virtual void RemoveFileFromHistory(size_t i);
- virtual size_t GetNoHistoryFiles() const;
+ virtual size_t GetHistoryFilesCount() const;
virtual wxString GetHistoryFile(size_t i) const;
virtual void FileHistoryUseMenu(wxMenu *menu);
virtual void FileHistoryRemoveMenu(wxMenu *menu);
virtual void FileHistoryAddFilesToMenu();
virtual void FileHistoryAddFilesToMenu(wxMenu* menu);
- inline wxString GetLastDirectory() const { return m_lastDirectory; }
- inline void SetLastDirectory(const wxString& dir) { m_lastDirectory = dir; }
+ wxString GetLastDirectory() const { return m_lastDirectory; }
+ void SetLastDirectory(const wxString& dir) { m_lastDirectory = dir; }
// Get the current document manager
static wxDocManager* GetDocumentManager() { return sm_docManager; }
+ // deprecated, use GetHistoryFilesCount() instead
+ wxDEPRECATED( size_t GetNoHistoryFiles() const );
+
protected:
long m_flags;
int m_defaultDocumentNameCounter;
static wxDocManager* sm_docManager;
DECLARE_EVENT_TABLE()
+ DECLARE_DYNAMIC_CLASS(wxDocManager)
DECLARE_NO_COPY_CLASS(wxDocManager)
};
+inline size_t wxDocManager::GetNoHistoryFiles() const
+{
+ return GetHistoryFilesCount();
+}
+
// ----------------------------------------------------------------------------
// A default child frame
// ----------------------------------------------------------------------------
const wxSize& size = wxDefaultSize,
long type = wxDEFAULT_FRAME_STYLE,
const wxString& name = wxT("frame"));
- ~wxDocChildFrame();
+ ~wxDocChildFrame(){}
// Extend event processing to search the view's event table
virtual bool ProcessEvent(wxEvent& event);
// 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)
// Accessors
virtual wxString GetHistoryFile(size_t i) const;
-
- // A synonym for GetNoHistoryFiles
virtual size_t GetCount() const { return m_fileHistoryN; }
- size_t GetNoHistoryFiles() const { return m_fileHistoryN; }
- wxList& GetMenus() const { return (wxList&) m_fileMenus; }
+ const wxList& GetMenus() const { return m_fileMenus; }
+
+ // deprecated, use GetCount() instead
+ wxDEPRECATED( size_t GetNoHistoryFiles() const );
protected:
// Last n files
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_NO_COPY_CLASS(wxFileHistory)
};
+inline size_t wxFileHistory::GetNoHistoryFiles() const
+{
+ return m_fileHistoryN;
+}
+
#if wxUSE_STD_IOSTREAM
// For compatibility with existing file formats:
// converts from/to a stream to/from a temporary file.
projects / wxWidgets.git / blobdiff