1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: Doc/View classes
4 // Author: Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
15 #if defined(__GNUG__) && !defined(__APPLE__)
16 #pragma interface "docview.h"
21 #if wxUSE_DOC_VIEW_ARCHITECTURE
24 #include "wx/cmndata.h"
25 #include "wx/string.h"
28 #if wxUSE_PRINTING_ARCHITECTURE
32 class WXDLLEXPORT wxWindow
;
33 class WXDLLEXPORT wxDocument
;
34 class WXDLLEXPORT wxView
;
35 class WXDLLEXPORT wxDocTemplate
;
36 class WXDLLEXPORT wxDocManager
;
37 class WXDLLEXPORT wxPrintInfo
;
38 class WXDLLEXPORT wxCommandProcessor
;
39 class WXDLLEXPORT wxFileHistory
;
40 class WXDLLEXPORT wxConfigBase
;
42 #if wxUSE_STD_IOSTREAM
43 #include "wx/iosfwrap.h"
45 #include "wx/stream.h"
48 // Document manager flags
55 wxDEFAULT_DOCMAN_FLAGS
= wxDOC_SDI
58 // Document template flags
61 wxTEMPLATE_VISIBLE
= 1,
63 wxDEFAULT_TEMPLATE_FLAGS
= wxTEMPLATE_VISIBLE
66 #define wxMAX_FILE_HISTORY 9
68 class WXDLLEXPORT wxDocument
: public wxEvtHandler
71 wxDocument(wxDocument
*parent
= (wxDocument
*) NULL
);
75 void SetFilename(const wxString
& filename
, bool notifyViews
= FALSE
);
76 wxString
GetFilename() const { return m_documentFile
; }
78 void SetTitle(const wxString
& title
) { m_documentTitle
= title
; };
79 wxString
GetTitle() const { return m_documentTitle
; }
81 void SetDocumentName(const wxString
& name
) { m_documentTypeName
= name
; };
82 wxString
GetDocumentName() const { return m_documentTypeName
; }
84 bool GetDocumentSaved() const { return m_savedYet
; }
85 void SetDocumentSaved(bool saved
= TRUE
) { m_savedYet
= saved
; }
89 virtual bool SaveAs();
90 virtual bool Revert();
92 #if wxUSE_STD_IOSTREAM
93 virtual wxSTD ostream
& SaveObject(wxSTD ostream
& stream
);
94 virtual wxSTD istream
& LoadObject(wxSTD istream
& stream
);
96 virtual wxOutputStream
& SaveObject(wxOutputStream
& stream
);
97 virtual wxInputStream
& LoadObject(wxInputStream
& stream
);
100 // Called by wxWindows
101 virtual bool OnSaveDocument(const wxString
& filename
);
102 virtual bool OnOpenDocument(const wxString
& filename
);
103 virtual bool OnNewDocument();
104 virtual bool OnCloseDocument();
106 // Prompts for saving if about to close a modified document. Returns TRUE
107 // if ok to close the document (may have saved in the meantime, or set
108 // modified to FALSE)
109 virtual bool OnSaveModified();
111 // Called by framework if created automatically by the default document
112 // manager: gives document a chance to initialise and (usually) create a
114 virtual bool OnCreate(const wxString
& path
, long flags
);
116 // By default, creates a base wxCommandProcessor.
117 virtual wxCommandProcessor
*OnCreateCommandProcessor();
118 virtual wxCommandProcessor
*GetCommandProcessor() const { return m_commandProcessor
; }
119 virtual void SetCommandProcessor(wxCommandProcessor
*proc
) { m_commandProcessor
= proc
; }
121 // Called after a view is added or removed. The default implementation
122 // deletes the document if this is there are no more views.
123 virtual void OnChangedViewList();
125 virtual bool DeleteContents();
127 virtual bool Draw(wxDC
&);
128 virtual bool IsModified() const { return m_documentModified
; }
129 virtual void Modify(bool mod
) { m_documentModified
= mod
; }
131 virtual bool AddView(wxView
*view
);
132 virtual bool RemoveView(wxView
*view
);
133 wxList
& GetViews() const { return (wxList
&) m_documentViews
; }
134 wxView
*GetFirstView() const;
136 virtual void UpdateAllViews(wxView
*sender
= (wxView
*) NULL
, wxObject
*hint
= (wxObject
*) NULL
);
137 virtual void NotifyClosing();
139 // Remove all views (because we're closing the document)
140 virtual bool DeleteAllViews();
143 virtual wxDocManager
*GetDocumentManager() const;
144 virtual wxDocTemplate
*GetDocumentTemplate() const { return m_documentTemplate
; }
145 virtual void SetDocumentTemplate(wxDocTemplate
*temp
) { m_documentTemplate
= temp
; }
147 // Get title, or filename if no title, else [unnamed]
148 virtual bool GetPrintableName(wxString
& buf
) const;
150 // Returns a window that can be used as a parent for document-related
151 // dialogs. Override if necessary.
152 virtual wxWindow
*GetDocumentWindow() const;
155 wxList m_documentViews
;
156 wxString m_documentFile
;
157 wxString m_documentTitle
;
158 wxString m_documentTypeName
;
159 wxDocTemplate
* m_documentTemplate
;
160 bool m_documentModified
;
161 wxDocument
* m_documentParent
;
162 wxCommandProcessor
* m_commandProcessor
;
166 DECLARE_ABSTRACT_CLASS(wxDocument
)
167 DECLARE_NO_COPY_CLASS(wxDocument
)
170 class WXDLLEXPORT wxView
: public wxEvtHandler
173 // wxView(wxDocument *doc = (wxDocument *) NULL);
177 wxDocument
*GetDocument() const { return m_viewDocument
; }
178 virtual void SetDocument(wxDocument
*doc
);
180 wxString
GetViewName() const { return m_viewTypeName
; }
181 void SetViewName(const wxString
& name
) { m_viewTypeName
= name
; };
183 wxWindow
*GetFrame() const { return m_viewFrame
; }
184 void SetFrame(wxWindow
*frame
) { m_viewFrame
= frame
; }
186 virtual void OnActivateView(bool activate
, wxView
*activeView
, wxView
*deactiveView
);
187 virtual void OnDraw(wxDC
*dc
) = 0;
188 virtual void OnPrint(wxDC
*dc
, wxObject
*info
);
189 virtual void OnUpdate(wxView
*sender
, wxObject
*hint
= (wxObject
*) NULL
);
190 virtual void OnClosingDocument() {};
191 virtual void OnChangeFilename();
193 // Called by framework if created automatically by the default document
194 // manager class: gives view a chance to initialise
195 virtual bool OnCreate(wxDocument
*WXUNUSED(doc
), long WXUNUSED(flags
)) { return TRUE
; };
197 // Checks if the view is the last one for the document; if so, asks user
198 // to confirm save data (if modified). If ok, deletes itself and returns
200 virtual bool Close(bool deleteWindow
= TRUE
);
202 // Override to do cleanup/veto close
203 virtual bool OnClose(bool deleteWindow
);
205 #if WXWIN_COMPATIBILITY
206 // Defeat compiler warning
207 bool OnClose() { return wxEvtHandler::OnClose(); }
210 // Extend event processing to search the document's event table
211 virtual bool ProcessEvent(wxEvent
& event
);
213 // A view's window can call this to notify the view it is (in)active.
214 // The function then notifies the document manager.
215 virtual void Activate(bool activate
);
217 wxDocManager
*GetDocumentManager() const
218 { return m_viewDocument
->GetDocumentManager(); }
220 #if wxUSE_PRINTING_ARCHITECTURE
221 virtual wxPrintout
*OnCreatePrintout();
225 wxDocument
* m_viewDocument
;
226 wxString m_viewTypeName
;
227 wxWindow
* m_viewFrame
;
230 DECLARE_ABSTRACT_CLASS(wxView
)
231 DECLARE_NO_COPY_CLASS(wxView
)
234 // Represents user interface (and other) properties of documents and views
235 class WXDLLEXPORT wxDocTemplate
: public wxObject
238 friend class WXDLLEXPORT wxDocManager
;
241 // Associate document and view types. They're for identifying what view is
242 // associated with what template/document type
243 wxDocTemplate(wxDocManager
*manager
,
244 const wxString
& descr
,
245 const wxString
& filter
,
248 const wxString
& docTypeName
,
249 const wxString
& viewTypeName
,
250 wxClassInfo
*docClassInfo
= (wxClassInfo
*) NULL
,
251 wxClassInfo
*viewClassInfo
= (wxClassInfo
*)NULL
,
252 long flags
= wxDEFAULT_TEMPLATE_FLAGS
);
256 // By default, these two member functions dynamically creates document and
257 // view using dynamic instance construction. Override these if you need a
258 // different method of construction.
259 virtual wxDocument
*CreateDocument(const wxString
& path
, long flags
= 0);
260 virtual wxView
*CreateView(wxDocument
*doc
, long flags
= 0);
262 wxString
GetDefaultExtension() const { return m_defaultExt
; };
263 wxString
GetDescription() const { return m_description
; }
264 wxString
GetDirectory() const { return m_directory
; };
265 wxDocManager
*GetDocumentManager() const { return m_documentManager
; }
266 void SetDocumentManager(wxDocManager
*manager
) { m_documentManager
= manager
; }
267 wxString
GetFileFilter() const { return m_fileFilter
; };
268 long GetFlags() const { return m_flags
; };
269 virtual wxString
GetViewName() const { return m_viewTypeName
; }
270 virtual wxString
GetDocumentName() const { return m_docTypeName
; }
272 void SetFileFilter(const wxString
& filter
) { m_fileFilter
= filter
; };
273 void SetDirectory(const wxString
& dir
) { m_directory
= dir
; };
274 void SetDescription(const wxString
& descr
) { m_description
= descr
; };
275 void SetDefaultExtension(const wxString
& ext
) { m_defaultExt
= ext
; };
276 void SetFlags(long flags
) { m_flags
= flags
; };
278 bool IsVisible() const { return ((m_flags
& wxTEMPLATE_VISIBLE
) == wxTEMPLATE_VISIBLE
); }
280 virtual bool FileMatchesTemplate(const wxString
& path
);
284 wxString m_fileFilter
;
285 wxString m_directory
;
286 wxString m_description
;
287 wxString m_defaultExt
;
288 wxString m_docTypeName
;
289 wxString m_viewTypeName
;
290 wxDocManager
* m_documentManager
;
292 // For dynamic creation of appropriate instances.
293 wxClassInfo
* m_docClassInfo
;
294 wxClassInfo
* m_viewClassInfo
;
297 DECLARE_CLASS(wxDocTemplate
)
298 DECLARE_NO_COPY_CLASS(wxDocTemplate
)
301 // One object of this class may be created in an application, to manage all
302 // the templates and documents.
303 class WXDLLEXPORT wxDocManager
: public wxEvtHandler
306 wxDocManager(long flags
= wxDEFAULT_DOCMAN_FLAGS
, bool initialize
= TRUE
);
309 virtual bool Initialize();
311 // Handlers for common user commands
312 void OnFileClose(wxCommandEvent
& event
);
313 void OnFileCloseAll(wxCommandEvent
& event
);
314 void OnFileNew(wxCommandEvent
& event
);
315 void OnFileOpen(wxCommandEvent
& event
);
316 void OnFileRevert(wxCommandEvent
& event
);
317 void OnFileSave(wxCommandEvent
& event
);
318 void OnFileSaveAs(wxCommandEvent
& event
);
319 void OnPrint(wxCommandEvent
& event
);
320 void OnPrintSetup(wxCommandEvent
& event
);
321 void OnPreview(wxCommandEvent
& event
);
322 void OnUndo(wxCommandEvent
& event
);
323 void OnRedo(wxCommandEvent
& event
);
325 // Handlers for UI update commands
326 void OnUpdateFileOpen(wxUpdateUIEvent
& event
);
327 void OnUpdateFileClose(wxUpdateUIEvent
& event
);
328 void OnUpdateFileRevert(wxUpdateUIEvent
& event
);
329 void OnUpdateFileNew(wxUpdateUIEvent
& event
);
330 void OnUpdateFileSave(wxUpdateUIEvent
& event
);
331 void OnUpdateFileSaveAs(wxUpdateUIEvent
& event
);
332 void OnUpdateUndo(wxUpdateUIEvent
& event
);
333 void OnUpdateRedo(wxUpdateUIEvent
& event
);
335 void OnUpdatePrint(wxUpdateUIEvent
& event
);
336 void OnUpdatePrintSetup(wxUpdateUIEvent
& event
);
337 void OnUpdatePreview(wxUpdateUIEvent
& event
);
339 // Extend event processing to search the view's event table
340 virtual bool ProcessEvent(wxEvent
& event
);
342 // called when file format detection didn't work, can be overridden to do
343 // something in this case
344 virtual void OnOpenFileFailure() { }
346 virtual wxDocument
*CreateDocument(const wxString
& path
, long flags
= 0);
347 virtual wxView
*CreateView(wxDocument
*doc
, long flags
= 0);
348 virtual void DeleteTemplate(wxDocTemplate
*temp
, long flags
= 0);
349 virtual bool FlushDoc(wxDocument
*doc
);
350 virtual wxDocTemplate
*MatchTemplate(const wxString
& path
);
351 virtual wxDocTemplate
*SelectDocumentPath(wxDocTemplate
**templates
,
352 int noTemplates
, wxString
& path
, long flags
, bool save
= FALSE
);
353 virtual wxDocTemplate
*SelectDocumentType(wxDocTemplate
**templates
,
354 int noTemplates
, bool sort
= FALSE
);
355 virtual wxDocTemplate
*SelectViewType(wxDocTemplate
**templates
,
356 int noTemplates
, bool sort
= FALSE
);
357 virtual wxDocTemplate
*FindTemplateForPath(const wxString
& path
);
359 void AssociateTemplate(wxDocTemplate
*temp
);
360 void DisassociateTemplate(wxDocTemplate
*temp
);
362 wxDocument
*GetCurrentDocument() const;
364 void SetMaxDocsOpen(int n
) { m_maxDocsOpen
= n
; }
365 int GetMaxDocsOpen() const { return m_maxDocsOpen
; }
367 // Add and remove a document from the manager's list
368 void AddDocument(wxDocument
*doc
);
369 void RemoveDocument(wxDocument
*doc
);
371 // closes all currently open documents
372 bool CloseDocuments(bool force
= TRUE
);
374 // closes the specified document
375 bool CloseDocument(wxDocument
* doc
, bool force
= FALSE
);
377 // Clear remaining documents and templates
378 bool Clear(bool force
= TRUE
);
380 // Views or windows should inform the document manager
381 // when a view is going in or out of focus
382 virtual void ActivateView(wxView
*view
, bool activate
= TRUE
);
383 virtual wxView
*GetCurrentView() const;
385 wxList
& GetDocuments() { return m_docs
; }
386 wxList
& GetTemplates() { return m_templates
; }
388 // Make a default document name
389 virtual bool MakeDefaultName(wxString
& buf
);
391 // Make a frame title (override this to do something different)
392 virtual wxString
MakeFrameTitle(wxDocument
* doc
);
394 virtual wxFileHistory
*OnCreateFileHistory();
395 virtual wxFileHistory
*GetFileHistory() const { return m_fileHistory
; }
397 // File history management
398 virtual void AddFileToHistory(const wxString
& file
);
399 virtual void RemoveFileFromHistory(size_t i
);
400 virtual size_t GetHistoryFilesCount() const;
401 virtual wxString
GetHistoryFile(size_t i
) const;
402 virtual void FileHistoryUseMenu(wxMenu
*menu
);
403 virtual void FileHistoryRemoveMenu(wxMenu
*menu
);
405 virtual void FileHistoryLoad(wxConfigBase
& config
);
406 virtual void FileHistorySave(wxConfigBase
& config
);
407 #endif // wxUSE_CONFIG
409 virtual void FileHistoryAddFilesToMenu();
410 virtual void FileHistoryAddFilesToMenu(wxMenu
* menu
);
412 wxString
GetLastDirectory() const { return m_lastDirectory
; }
413 void SetLastDirectory(const wxString
& dir
) { m_lastDirectory
= dir
; }
415 // Get the current document manager
416 static wxDocManager
* GetDocumentManager() { return sm_docManager
; }
418 // deprecated, use GetHistoryFilesCount() instead
419 wxDEPRECATED( size_t GetNoHistoryFiles() const );
423 int m_defaultDocumentNameCounter
;
427 wxView
* m_currentView
;
428 wxFileHistory
* m_fileHistory
;
429 wxString m_lastDirectory
;
430 static wxDocManager
* sm_docManager
;
432 DECLARE_EVENT_TABLE()
433 DECLARE_DYNAMIC_CLASS(wxDocManager
)
434 DECLARE_NO_COPY_CLASS(wxDocManager
)
437 inline size_t wxDocManager::GetNoHistoryFiles() const
439 return GetHistoryFilesCount();
442 // ----------------------------------------------------------------------------
443 // A default child frame
444 // ----------------------------------------------------------------------------
446 class WXDLLEXPORT wxDocChildFrame
: public wxFrame
449 wxDocChildFrame(wxDocument
*doc
,
453 const wxString
& title
,
454 const wxPoint
& pos
= wxDefaultPosition
,
455 const wxSize
& size
= wxDefaultSize
,
456 long type
= wxDEFAULT_FRAME_STYLE
,
457 const wxString
& name
= wxT("frame"));
460 // Extend event processing to search the view's event table
461 virtual bool ProcessEvent(wxEvent
& event
);
463 void OnActivate(wxActivateEvent
& event
);
464 void OnCloseWindow(wxCloseEvent
& event
);
466 wxDocument
*GetDocument() const { return m_childDocument
; }
467 wxView
*GetView() const { return m_childView
; }
468 void SetDocument(wxDocument
*doc
) { m_childDocument
= doc
; }
469 void SetView(wxView
*view
) { m_childView
= view
; }
470 bool Destroy() { m_childView
= (wxView
*)NULL
; return wxFrame::Destroy(); }
473 wxDocument
* m_childDocument
;
477 DECLARE_CLASS(wxDocChildFrame
)
478 DECLARE_EVENT_TABLE()
479 DECLARE_NO_COPY_CLASS(wxDocChildFrame
)
482 // ----------------------------------------------------------------------------
483 // A default parent frame
484 // ----------------------------------------------------------------------------
486 class WXDLLEXPORT wxDocParentFrame
: public wxFrame
489 wxDocParentFrame(wxDocManager
*manager
,
492 const wxString
& title
,
493 const wxPoint
& pos
= wxDefaultPosition
,
494 const wxSize
& size
= wxDefaultSize
,
495 long type
= wxDEFAULT_FRAME_STYLE
,
496 const wxString
& name
= wxT("frame"));
498 // Extend event processing to search the document manager's event table
499 virtual bool ProcessEvent(wxEvent
& event
);
501 wxDocManager
*GetDocumentManager() const { return m_docManager
; }
503 void OnExit(wxCommandEvent
& event
);
504 void OnMRUFile(wxCommandEvent
& event
);
505 void OnCloseWindow(wxCloseEvent
& event
);
508 wxDocManager
*m_docManager
;
511 DECLARE_CLASS(wxDocParentFrame
)
512 DECLARE_EVENT_TABLE()
513 DECLARE_NO_COPY_CLASS(wxDocParentFrame
)
516 // ----------------------------------------------------------------------------
517 // Provide simple default printing facilities
518 // ----------------------------------------------------------------------------
520 #if wxUSE_PRINTING_ARCHITECTURE
521 class WXDLLEXPORT wxDocPrintout
: public wxPrintout
524 wxDocPrintout(wxView
*view
= (wxView
*) NULL
, const wxString
& title
= wxT("Printout"));
525 bool OnPrintPage(int page
);
526 bool HasPage(int page
);
527 bool OnBeginDocument(int startPage
, int endPage
);
528 void GetPageInfo(int *minPage
, int *maxPage
, int *selPageFrom
, int *selPageTo
);
530 virtual wxView
*GetView() { return m_printoutView
; }
533 wxView
* m_printoutView
;
536 DECLARE_DYNAMIC_CLASS(wxDocPrintout
)
537 DECLARE_NO_COPY_CLASS(wxDocPrintout
)
539 #endif // wxUSE_PRINTING_ARCHITECTURE
541 // ----------------------------------------------------------------------------
542 // File history management
543 // ----------------------------------------------------------------------------
545 class WXDLLEXPORT wxFileHistory
: public wxObject
548 wxFileHistory(size_t maxFiles
= 9, wxWindowID idBase
= wxID_FILE1
);
552 virtual void AddFileToHistory(const wxString
& file
);
553 virtual void RemoveFileFromHistory(size_t i
);
554 virtual int GetMaxFiles() const { return m_fileMaxFiles
; }
555 virtual void UseMenu(wxMenu
*menu
);
557 // Remove menu from the list (MDI child may be closing)
558 virtual void RemoveMenu(wxMenu
*menu
);
561 virtual void Load(wxConfigBase
& config
);
562 virtual void Save(wxConfigBase
& config
);
563 #endif // wxUSE_CONFIG
565 virtual void AddFilesToMenu();
566 virtual void AddFilesToMenu(wxMenu
* menu
); // Single menu
569 virtual wxString
GetHistoryFile(size_t i
) const;
570 virtual size_t GetCount() const { return m_fileHistoryN
; }
572 const wxList
& GetMenus() const { return m_fileMenus
; }
574 // deprecated, use GetCount() instead
575 wxDEPRECATED( size_t GetNoHistoryFiles() const );
579 wxChar
** m_fileHistory
;
580 // Number of files saved
581 size_t m_fileHistoryN
;
582 // Menus to maintain (may need several for an MDI app)
584 // Max files to maintain
585 size_t m_fileMaxFiles
;
588 // The ID of the first history menu item (Doesn't have to be wxID_FILE1)
591 DECLARE_DYNAMIC_CLASS(wxFileHistory
)
592 DECLARE_NO_COPY_CLASS(wxFileHistory
)
595 inline size_t wxFileHistory::GetNoHistoryFiles() const
597 return m_fileHistoryN
;
600 #if wxUSE_STD_IOSTREAM
601 // For compatibility with existing file formats:
602 // converts from/to a stream to/from a temporary file.
603 bool WXDLLEXPORT
wxTransferFileToStream(const wxString
& filename
, wxSTD ostream
& stream
);
604 bool WXDLLEXPORT
wxTransferStreamToFile(wxSTD istream
& stream
, const wxString
& filename
);
606 // For compatibility with existing file formats:
607 // converts from/to a stream to/from a temporary file.
608 bool WXDLLEXPORT
wxTransferFileToStream(const wxString
& filename
, wxOutputStream
& stream
);
609 bool WXDLLEXPORT
wxTransferStreamToFile(wxInputStream
& stream
, const wxString
& filename
);
610 #endif // wxUSE_STD_IOSTREAM
612 #endif // wxUSE_DOC_VIEW_ARCHITECTURE