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 #include "wx/cmndata.h"
22 #include "wx/string.h"
25 #if wxUSE_PRINTING_ARCHITECTURE
29 class WXDLLEXPORT wxWindow
;
30 class WXDLLEXPORT wxDocument
;
31 class WXDLLEXPORT wxView
;
32 class WXDLLEXPORT wxDocTemplate
;
33 class WXDLLEXPORT wxDocManager
;
34 class WXDLLEXPORT wxPrintInfo
;
35 class WXDLLEXPORT wxCommandProcessor
;
36 class WXDLLEXPORT wxFileHistory
;
37 class WXDLLEXPORT wxConfigBase
;
39 #if wxUSE_STD_IOSTREAM
40 #include "wx/ioswrap.h"
42 #include "wx/stream.h"
45 // Document manager flags
52 wxDEFAULT_DOCMAN_FLAGS
= wxDOC_SDI
55 // Document template flags
58 wxTEMPLATE_VISIBLE
= 1,
60 wxDEFAULT_TEMPLATE_FLAGS
= wxTEMPLATE_VISIBLE
63 #define wxMAX_FILE_HISTORY 9
65 class WXDLLEXPORT wxDocument
: public wxEvtHandler
68 wxDocument(wxDocument
*parent
= (wxDocument
*) NULL
);
72 void SetFilename(const wxString
& filename
, bool notifyViews
= FALSE
);
73 wxString
GetFilename() const { return m_documentFile
; }
75 void SetTitle(const wxString
& title
) { m_documentTitle
= title
; };
76 wxString
GetTitle() const { return m_documentTitle
; }
78 void SetDocumentName(const wxString
& name
) { m_documentTypeName
= name
; };
79 wxString
GetDocumentName() const { return m_documentTypeName
; }
81 bool GetDocumentSaved() const { return m_savedYet
; }
82 void SetDocumentSaved(bool saved
= TRUE
) { m_savedYet
= saved
; }
86 virtual bool SaveAs();
87 virtual bool Revert();
89 #if wxUSE_STD_IOSTREAM
90 virtual wxSTD ostream
& SaveObject(wxSTD ostream
& stream
);
91 virtual wxSTD istream
& LoadObject(wxSTD istream
& stream
);
93 virtual wxOutputStream
& SaveObject(wxOutputStream
& stream
);
94 virtual wxInputStream
& LoadObject(wxInputStream
& stream
);
97 // Called by wxWindows
98 virtual bool OnSaveDocument(const wxString
& filename
);
99 virtual bool OnOpenDocument(const wxString
& filename
);
100 virtual bool OnNewDocument();
101 virtual bool OnCloseDocument();
103 // Prompts for saving if about to close a modified document. Returns TRUE
104 // if ok to close the document (may have saved in the meantime, or set
105 // modified to FALSE)
106 virtual bool OnSaveModified();
108 // Called by framework if created automatically by the default document
109 // manager: gives document a chance to initialise and (usually) create a
111 virtual bool OnCreate(const wxString
& path
, long flags
);
113 // By default, creates a base wxCommandProcessor.
114 virtual wxCommandProcessor
*OnCreateCommandProcessor();
115 virtual wxCommandProcessor
*GetCommandProcessor() const { return m_commandProcessor
; }
116 virtual void SetCommandProcessor(wxCommandProcessor
*proc
) { m_commandProcessor
= proc
; }
118 // Called after a view is added or removed. The default implementation
119 // deletes the document if this is there are no more views.
120 virtual void OnChangedViewList();
122 virtual bool DeleteContents();
124 virtual bool Draw(wxDC
&);
125 virtual bool IsModified() const { return m_documentModified
; }
126 virtual void Modify(bool mod
) { m_documentModified
= mod
; }
128 virtual bool AddView(wxView
*view
);
129 virtual bool RemoveView(wxView
*view
);
130 wxList
& GetViews() const { return (wxList
&) m_documentViews
; }
131 wxView
*GetFirstView() const;
133 virtual void UpdateAllViews(wxView
*sender
= (wxView
*) NULL
, wxObject
*hint
= (wxObject
*) NULL
);
134 virtual void NotifyClosing();
136 // Remove all views (because we're closing the document)
137 virtual bool DeleteAllViews();
140 virtual wxDocManager
*GetDocumentManager() const;
141 virtual wxDocTemplate
*GetDocumentTemplate() const { return m_documentTemplate
; }
142 virtual void SetDocumentTemplate(wxDocTemplate
*temp
) { m_documentTemplate
= temp
; }
144 // Get title, or filename if no title, else [unnamed]
145 virtual bool GetPrintableName(wxString
& buf
) const;
147 // Returns a window that can be used as a parent for document-related
148 // dialogs. Override if necessary.
149 virtual wxWindow
*GetDocumentWindow() const;
152 wxList m_documentViews
;
153 wxString m_documentFile
;
154 wxString m_documentTitle
;
155 wxString m_documentTypeName
;
156 wxDocTemplate
* m_documentTemplate
;
157 bool m_documentModified
;
158 wxDocument
* m_documentParent
;
159 wxCommandProcessor
* m_commandProcessor
;
163 DECLARE_ABSTRACT_CLASS(wxDocument
)
164 DECLARE_NO_COPY_CLASS(wxDocument
)
167 class WXDLLEXPORT wxView
: public wxEvtHandler
170 // wxView(wxDocument *doc = (wxDocument *) NULL);
174 wxDocument
*GetDocument() const { return m_viewDocument
; }
175 virtual void SetDocument(wxDocument
*doc
);
177 wxString
GetViewName() const { return m_viewTypeName
; }
178 void SetViewName(const wxString
& name
) { m_viewTypeName
= name
; };
180 wxWindow
*GetFrame() const { return m_viewFrame
; }
181 void SetFrame(wxWindow
*frame
) { m_viewFrame
= frame
; }
183 virtual void OnActivateView(bool activate
, wxView
*activeView
, wxView
*deactiveView
);
184 virtual void OnDraw(wxDC
*dc
) = 0;
185 virtual void OnPrint(wxDC
*dc
, wxObject
*info
);
186 virtual void OnUpdate(wxView
*sender
, wxObject
*hint
= (wxObject
*) NULL
);
187 virtual void OnClosingDocument() {};
188 virtual void OnChangeFilename();
190 // Called by framework if created automatically by the default document
191 // manager class: gives view a chance to initialise
192 virtual bool OnCreate(wxDocument
*WXUNUSED(doc
), long WXUNUSED(flags
)) { return TRUE
; };
194 // Checks if the view is the last one for the document; if so, asks user
195 // to confirm save data (if modified). If ok, deletes itself and returns
197 virtual bool Close(bool deleteWindow
= TRUE
);
199 // Override to do cleanup/veto close
200 virtual bool OnClose(bool deleteWindow
);
202 #if WXWIN_COMPATIBILITY
203 // Defeat compiler warning
204 bool OnClose() { return wxEvtHandler::OnClose(); }
207 // Extend event processing to search the document's event table
208 virtual bool ProcessEvent(wxEvent
& event
);
210 // A view's window can call this to notify the view it is (in)active.
211 // The function then notifies the document manager.
212 virtual void Activate(bool activate
);
214 wxDocManager
*GetDocumentManager() const
215 { return m_viewDocument
->GetDocumentManager(); }
217 #if wxUSE_PRINTING_ARCHITECTURE
218 virtual wxPrintout
*OnCreatePrintout();
222 wxDocument
* m_viewDocument
;
223 wxString m_viewTypeName
;
224 wxWindow
* m_viewFrame
;
227 DECLARE_ABSTRACT_CLASS(wxView
)
228 DECLARE_NO_COPY_CLASS(wxView
)
231 // Represents user interface (and other) properties of documents and views
232 class WXDLLEXPORT wxDocTemplate
: public wxObject
235 friend class WXDLLEXPORT wxDocManager
;
238 // Associate document and view types. They're for identifying what view is
239 // associated with what template/document type
240 wxDocTemplate(wxDocManager
*manager
,
241 const wxString
& descr
,
242 const wxString
& filter
,
245 const wxString
& docTypeName
,
246 const wxString
& viewTypeName
,
247 wxClassInfo
*docClassInfo
= (wxClassInfo
*) NULL
,
248 wxClassInfo
*viewClassInfo
= (wxClassInfo
*)NULL
,
249 long flags
= wxDEFAULT_TEMPLATE_FLAGS
);
253 // By default, these two member functions dynamically creates document and
254 // view using dynamic instance construction. Override these if you need a
255 // different method of construction.
256 virtual wxDocument
*CreateDocument(const wxString
& path
, long flags
= 0);
257 virtual wxView
*CreateView(wxDocument
*doc
, long flags
= 0);
259 wxString
GetDefaultExtension() const { return m_defaultExt
; };
260 wxString
GetDescription() const { return m_description
; }
261 wxString
GetDirectory() const { return m_directory
; };
262 wxDocManager
*GetDocumentManager() const { return m_documentManager
; }
263 void SetDocumentManager(wxDocManager
*manager
) { m_documentManager
= manager
; }
264 wxString
GetFileFilter() const { return m_fileFilter
; };
265 long GetFlags() const { return m_flags
; };
266 virtual wxString
GetViewName() const { return m_viewTypeName
; }
267 virtual wxString
GetDocumentName() const { return m_docTypeName
; }
269 void SetFileFilter(const wxString
& filter
) { m_fileFilter
= filter
; };
270 void SetDirectory(const wxString
& dir
) { m_directory
= dir
; };
271 void SetDescription(const wxString
& descr
) { m_description
= descr
; };
272 void SetDefaultExtension(const wxString
& ext
) { m_defaultExt
= ext
; };
273 void SetFlags(long flags
) { m_flags
= flags
; };
275 bool IsVisible() const { return ((m_flags
& wxTEMPLATE_VISIBLE
) == wxTEMPLATE_VISIBLE
); }
277 virtual bool FileMatchesTemplate(const wxString
& path
);
281 wxString m_fileFilter
;
282 wxString m_directory
;
283 wxString m_description
;
284 wxString m_defaultExt
;
285 wxString m_docTypeName
;
286 wxString m_viewTypeName
;
287 wxDocManager
* m_documentManager
;
289 // For dynamic creation of appropriate instances.
290 wxClassInfo
* m_docClassInfo
;
291 wxClassInfo
* m_viewClassInfo
;
294 DECLARE_CLASS(wxDocTemplate
)
295 DECLARE_NO_COPY_CLASS(wxDocTemplate
)
298 // One object of this class may be created in an application, to manage all
299 // the templates and documents.
300 class WXDLLEXPORT wxDocManager
: public wxEvtHandler
302 DECLARE_DYNAMIC_CLASS(wxDocManager
)
305 wxDocManager(long flags
= wxDEFAULT_DOCMAN_FLAGS
, bool initialize
= TRUE
);
308 virtual bool Initialize();
310 // Handlers for common user commands
311 void OnFileClose(wxCommandEvent
& event
);
312 void OnFileCloseAll(wxCommandEvent
& event
);
313 void OnFileNew(wxCommandEvent
& event
);
314 void OnFileOpen(wxCommandEvent
& event
);
315 void OnFileRevert(wxCommandEvent
& event
);
316 void OnFileSave(wxCommandEvent
& event
);
317 void OnFileSaveAs(wxCommandEvent
& event
);
318 void OnPrint(wxCommandEvent
& event
);
319 void OnPrintSetup(wxCommandEvent
& event
);
320 void OnPreview(wxCommandEvent
& event
);
321 void OnUndo(wxCommandEvent
& event
);
322 void OnRedo(wxCommandEvent
& event
);
324 // Handlers for UI update commands
325 void OnUpdateFileOpen(wxUpdateUIEvent
& event
);
326 void OnUpdateFileClose(wxUpdateUIEvent
& event
);
327 void OnUpdateFileRevert(wxUpdateUIEvent
& event
);
328 void OnUpdateFileNew(wxUpdateUIEvent
& event
);
329 void OnUpdateFileSave(wxUpdateUIEvent
& event
);
330 void OnUpdateFileSaveAs(wxUpdateUIEvent
& event
);
331 void OnUpdateUndo(wxUpdateUIEvent
& event
);
332 void OnUpdateRedo(wxUpdateUIEvent
& event
);
334 void OnUpdatePrint(wxUpdateUIEvent
& event
);
335 void OnUpdatePrintSetup(wxUpdateUIEvent
& event
);
336 void OnUpdatePreview(wxUpdateUIEvent
& event
);
338 // Extend event processing to search the view's event table
339 virtual bool ProcessEvent(wxEvent
& event
);
341 // called when file format detection didn't work, can be overridden to do
342 // something in this case
343 virtual void OnOpenFileFailure() { }
345 virtual wxDocument
*CreateDocument(const wxString
& path
, long flags
= 0);
346 virtual wxView
*CreateView(wxDocument
*doc
, long flags
= 0);
347 virtual void DeleteTemplate(wxDocTemplate
*temp
, long flags
= 0);
348 virtual bool FlushDoc(wxDocument
*doc
);
349 virtual wxDocTemplate
*MatchTemplate(const wxString
& path
);
350 virtual wxDocTemplate
*SelectDocumentPath(wxDocTemplate
**templates
,
351 int noTemplates
, wxString
& path
, long flags
, bool save
= FALSE
);
352 virtual wxDocTemplate
*SelectDocumentType(wxDocTemplate
**templates
,
353 int noTemplates
, bool sort
= FALSE
);
354 virtual wxDocTemplate
*SelectViewType(wxDocTemplate
**templates
,
355 int noTemplates
, bool sort
= FALSE
);
356 virtual wxDocTemplate
*FindTemplateForPath(const wxString
& path
);
358 void AssociateTemplate(wxDocTemplate
*temp
);
359 void DisassociateTemplate(wxDocTemplate
*temp
);
361 wxDocument
*GetCurrentDocument() const;
363 void SetMaxDocsOpen(int n
) { m_maxDocsOpen
= n
; }
364 int GetMaxDocsOpen() const { return m_maxDocsOpen
; }
366 // Add and remove a document from the manager's list
367 void AddDocument(wxDocument
*doc
);
368 void RemoveDocument(wxDocument
*doc
);
370 // closes all currently open documents
371 bool CloseDocuments(bool force
= TRUE
);
373 // Clear remaining documents and templates
374 bool Clear(bool force
= TRUE
);
376 // Views or windows should inform the document manager
377 // when a view is going in or out of focus
378 virtual void ActivateView(wxView
*view
, bool activate
= TRUE
, bool deleting
= FALSE
);
379 virtual wxView
*GetCurrentView() const;
381 wxList
& GetDocuments() { return m_docs
; }
382 wxList
& GetTemplates() { return m_templates
; }
384 // Make a default document name
385 virtual bool MakeDefaultName(wxString
& buf
);
387 // Make a frame title (override this to do something different)
388 virtual wxString
MakeFrameTitle(wxDocument
* doc
);
390 virtual wxFileHistory
*OnCreateFileHistory();
391 virtual wxFileHistory
*GetFileHistory() const { return m_fileHistory
; }
393 // File history management
394 virtual void AddFileToHistory(const wxString
& file
);
395 virtual void RemoveFileFromHistory(int i
);
396 virtual int GetNoHistoryFiles() const;
397 virtual wxString
GetHistoryFile(int i
) const;
398 virtual void FileHistoryUseMenu(wxMenu
*menu
);
399 virtual void FileHistoryRemoveMenu(wxMenu
*menu
);
401 virtual void FileHistoryLoad(wxConfigBase
& config
);
402 virtual void FileHistorySave(wxConfigBase
& config
);
403 #endif // wxUSE_CONFIG
405 virtual void FileHistoryAddFilesToMenu();
406 virtual void FileHistoryAddFilesToMenu(wxMenu
* menu
);
408 inline wxString
GetLastDirectory() const { return m_lastDirectory
; }
409 inline void SetLastDirectory(const wxString
& dir
) { m_lastDirectory
= dir
; }
411 // Get the current document manager
412 static wxDocManager
* GetDocumentManager() { return sm_docManager
; }
416 int m_defaultDocumentNameCounter
;
420 wxView
* m_currentView
;
421 wxFileHistory
* m_fileHistory
;
422 wxString m_lastDirectory
;
423 static wxDocManager
* sm_docManager
;
425 DECLARE_EVENT_TABLE()
426 DECLARE_NO_COPY_CLASS(wxDocManager
)
429 // ----------------------------------------------------------------------------
430 // A default child frame
431 // ----------------------------------------------------------------------------
433 class WXDLLEXPORT wxDocChildFrame
: public wxFrame
436 wxDocChildFrame(wxDocument
*doc
,
440 const wxString
& title
,
441 const wxPoint
& pos
= wxDefaultPosition
,
442 const wxSize
& size
= wxDefaultSize
,
443 long type
= wxDEFAULT_FRAME_STYLE
,
444 const wxString
& name
= wxT("frame"));
447 // Extend event processing to search the view's event table
448 virtual bool ProcessEvent(wxEvent
& event
);
450 void OnActivate(wxActivateEvent
& event
);
451 void OnCloseWindow(wxCloseEvent
& event
);
453 wxDocument
*GetDocument() const { return m_childDocument
; }
454 wxView
*GetView() const { return m_childView
; }
455 void SetDocument(wxDocument
*doc
) { m_childDocument
= doc
; }
456 void SetView(wxView
*view
) { m_childView
= view
; }
457 bool Destroy() { m_childView
= (wxView
*)NULL
; return wxFrame::Destroy(); }
460 wxDocument
* m_childDocument
;
464 DECLARE_CLASS(wxDocChildFrame
)
465 DECLARE_EVENT_TABLE()
466 DECLARE_NO_COPY_CLASS(wxDocChildFrame
)
469 // ----------------------------------------------------------------------------
470 // A default parent frame
471 // ----------------------------------------------------------------------------
473 class WXDLLEXPORT wxDocParentFrame
: public wxFrame
476 wxDocParentFrame(wxDocManager
*manager
,
479 const wxString
& title
,
480 const wxPoint
& pos
= wxDefaultPosition
,
481 const wxSize
& size
= wxDefaultSize
,
482 long type
= wxDEFAULT_FRAME_STYLE
,
483 const wxString
& name
= wxT("frame"));
485 // Extend event processing to search the document manager's event table
486 virtual bool ProcessEvent(wxEvent
& event
);
488 wxDocManager
*GetDocumentManager() const { return m_docManager
; }
490 void OnExit(wxCommandEvent
& event
);
491 void OnMRUFile(wxCommandEvent
& event
);
492 void OnCloseWindow(wxCloseEvent
& event
);
495 wxDocManager
*m_docManager
;
498 DECLARE_CLASS(wxDocParentFrame
)
499 DECLARE_EVENT_TABLE()
500 DECLARE_NO_COPY_CLASS(wxDocParentFrame
)
503 // ----------------------------------------------------------------------------
504 // Provide simple default printing facilities
505 // ----------------------------------------------------------------------------
507 #if wxUSE_PRINTING_ARCHITECTURE
508 class WXDLLEXPORT wxDocPrintout
: public wxPrintout
511 wxDocPrintout(wxView
*view
= (wxView
*) NULL
, const wxString
& title
= wxT("Printout"));
512 bool OnPrintPage(int page
);
513 bool HasPage(int page
);
514 bool OnBeginDocument(int startPage
, int endPage
);
515 void GetPageInfo(int *minPage
, int *maxPage
, int *selPageFrom
, int *selPageTo
);
517 virtual wxView
*GetView() { return m_printoutView
; }
520 wxView
* m_printoutView
;
523 DECLARE_DYNAMIC_CLASS(wxDocPrintout
)
524 DECLARE_NO_COPY_CLASS(wxDocPrintout
)
526 #endif // wxUSE_PRINTING_ARCHITECTURE
528 // ----------------------------------------------------------------------------
529 // File history management
530 // ----------------------------------------------------------------------------
532 class WXDLLEXPORT wxFileHistory
: public wxObject
535 wxFileHistory(int maxFiles
= 9);
539 virtual void AddFileToHistory(const wxString
& file
);
540 virtual void RemoveFileFromHistory(int i
);
541 virtual int GetMaxFiles() const { return m_fileMaxFiles
; }
542 virtual void UseMenu(wxMenu
*menu
);
544 // Remove menu from the list (MDI child may be closing)
545 virtual void RemoveMenu(wxMenu
*menu
);
548 virtual void Load(wxConfigBase
& config
);
549 virtual void Save(wxConfigBase
& config
);
550 #endif // wxUSE_CONFIG
552 virtual void AddFilesToMenu();
553 virtual void AddFilesToMenu(wxMenu
* menu
); // Single menu
556 virtual wxString
GetHistoryFile(int i
) const;
558 // A synonym for GetNoHistoryFiles
559 virtual int GetCount() const { return m_fileHistoryN
; }
560 int GetNoHistoryFiles() const { return m_fileHistoryN
; }
562 wxList
& GetMenus() const { return (wxList
&) m_fileMenus
; }
566 wxChar
** m_fileHistory
;
567 // Number of files saved
569 // Menus to maintain (may need several for an MDI app)
571 // Max files to maintain
575 DECLARE_DYNAMIC_CLASS(wxFileHistory
)
576 DECLARE_NO_COPY_CLASS(wxFileHistory
)
579 #if wxUSE_STD_IOSTREAM
580 // For compatibility with existing file formats:
581 // converts from/to a stream to/from a temporary file.
582 bool WXDLLEXPORT
wxTransferFileToStream(const wxString
& filename
, wxSTD ostream
& stream
);
583 bool WXDLLEXPORT
wxTransferStreamToFile(wxSTD istream
& stream
, const wxString
& filename
);
585 // For compatibility with existing file formats:
586 // converts from/to a stream to/from a temporary file.
587 bool WXDLLEXPORT
wxTransferFileToStream(const wxString
& filename
, wxOutputStream
& stream
);
588 bool WXDLLEXPORT
wxTransferStreamToFile(wxInputStream
& stream
, const wxString
& filename
);