// Name: docview.h
// Purpose: interface of various doc/view framework classes
// Author: wxWidgets team
-// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
+/**
+ A vector of wxDocument pointers.
+
+ @since 2.9.5
+*/
+typedef wxVector<wxDocument*> wxDocVector;
+
+/**
+ A vector of wxView pointers.
+
+ @since 2.9.5
+*/
+typedef wxVector<wxView*> wxViewVector;
+
+/**
+ A vector of wxDocTemplate pointers.
+
+ @since 2.9.5
+*/
+typedef wxVector<wxDocTemplate*> wxDocTemplateVector;
+
/**
@class wxDocTemplate
A name that should be unique for a given view.
@param docClassInfo
A pointer to the run-time document class information as returned by
- the CLASSINFO() macro, e.g. CLASSINFO(MyDocumentClass). If this is
+ the wxCLASSINFO() macro, e.g. wxCLASSINFO(MyDocumentClass). If this is
not supplied, you will need to derive a new wxDocTemplate class and
override the CreateDocument() member to return a new document
instance on demand.
@param viewClassInfo
A pointer to the run-time view class information as returned by the
- CLASSINFO() macro, e.g. CLASSINFO(MyViewClass). If this is not
+ wxCLASSINFO() macro, e.g. wxCLASSINFO(MyViewClass). If this is not
supplied, you will need to derive a new wxDocTemplate class and
override the CreateView() member to return a new view instance on
demand.
- wxTEMPLATE_INVISIBLE - The template may not be displayed to
the user in dialogs.
- wxDEFAULT_TEMPLATE_FLAGS - Defined as wxTEMPLATE_VISIBLE.
+
+ @beginWxPerlOnly
+
+ In wxPerl @a docClassInfo and @a viewClassInfo can be either
+ @c Wx::ClassInfo objects or strings containing the name of the
+ perl packages which are to be used as @c Wx::Document and
+ @c Wx::View classes (they must have a constructor named new);
+ as an example:
+
+ - Wx::DocTemplate->new(docmgr, descr, filter, dir, ext,
+ docTypeName, viewTypeName, docClassInfo, viewClassInfo,
+ flags): will construct document and view objects from the
+ class information.
+ - Wx::DocTemplate->new(docmgr, descr, filter, dir, ext,
+ docTypeName, viewTypeName, docClassName, viewClassName,
+ flags): will construct document and view objects from perl
+ packages.
+ - Wx::DocTemplate->new(docmgr, descr, filter, dir, ext,
+ docTypeName, viewTypeName):
+ in this case @c Wx::DocTemplate::CreateDocument() and
+ @c Wx::DocTemplate::CreateView() must be overridden
+ @endWxPerlOnly
*/
wxDocTemplate(wxDocManager* manager, const wxString& descr,
const wxString& filter, const wxString& dir,
virtual wxDocument* CreateDocument(const wxString& path, long flags = 0);
/**
- Creates a new instance of the associated view class. If you have not
- supplied a wxClassInfo parameter to the template constructor, you will
- need to override this function to return an appropriate view instance.
+ Creates a new instance of the associated view class.
+
+ If you have not supplied a wxClassInfo parameter to the template
+ constructor, you will need to override this function to return an
+ appropriate view instance.
+
+ If the new view initialization fails, it must call
+ wxDocument::RemoveView() for consistency with the default behaviour of
+ this function.
*/
virtual wxView* CreateView(wxDocument* doc, long flags = 0);
*/
long GetFlags() const;
+ /**
+ Returns a reference to the wxPageSetupDialogData associated with the
+ printing operations of this document manager.
+ */
+ //@{
+ wxPageSetupDialogData& GetPageSetupDialogData();
+ const wxPageSetupDialogData& GetPageSetupDialogData() const;
+ //@}
+
/**
Returns the run-time class information that allows view instances
to be constructed dynamically, as passed to the document template
virtual wxString GetViewName() const;
/**
- Initialises the document, calling wxDocument::OnCreate(). This is
- called from CreateDocument().
+ Initialises the document, calling wxDocument::OnCreate().
+
+ This is called from CreateDocument().
+
+ If you override this method, notice that you must @em delete the @a doc
+ if its initialization fails for consistency with the default behaviour.
+
+ @param doc
+ The document to initialize.
+ @param path
+ The associated file path.
+ @param flags
+ Flags passed to CreateDocument().
+ @return
+ @true if the initialization was successful or @false if it failed
+ in which case @a doc should be deleted by this function.
*/
- virtual bool InitDocument(wxDocument* doc, const wxString& path,
+ virtual bool InitDocument(wxDocument* doc,
+ const wxString& path,
long flags = 0);
/**
*/
void AssociateTemplate(wxDocTemplate* temp);
+ /**
+ Search for a particular document template.
+
+ Example:
+ @code
+ // creating a document instance of the specified document type:
+ m_doc = (MyDoc*)docManager->FindTemplate(CLASSINFO(MyDoc))->
+ CreateDocument(wxEmptyString, wxDOC_SILENT);
+ @endcode
+
+ @param classinfo
+ Class info of a document class for which a wxDocTemplate had been
+ previously created.
+
+ @return
+ Pointer to a wxDocTemplate, or @NULL if none found.
+
+ @since 2.9.2
+ */
+ wxDocTemplate* FindTemplate(const wxClassInfo* classinfo);
+
+
+ /**
+ Search for the document corresponding to the given file.
+
+ @param path
+ Document file path.
+ @return
+ Pointer to a wxDocument, or @NULL if none found.
+
+ @since 2.9.5
+ */
+ wxDocument* FindDocumentByPath(const wxString& path) const;
+
+ /**
+ Closes the specified document.
+
+ If @a force is @true, the document is closed even if it has unsaved
+ changes.
+
+ @param doc
+ The document to close, must be non-@NULL.
+ @param force
+ If @true, close the document even if wxDocument::Close() returns
+ @false.
+ @return
+ @true if the document was closed or @false if closing it was
+ cancelled by user (only in @a force = @false case).
+ */
+ bool CloseDocument(wxDocument *doc, bool force = false);
+
/**
Closes all currently opened documents.
+
+ @see CloseDocument()
*/
bool CloseDocuments(bool force = true);
*/
virtual wxDocTemplate* FindTemplateForPath(const wxString& path);
+ /**
+ Returns the view to apply a user command to.
+
+ This method tries to find the view that the user wants to interact
+ with. It returns the same view as GetCurrentDocument() if there is any
+ currently active view but falls back to the first view of the first
+ document if there is no active view.
+
+ @since 2.9.5
+ */
+ wxView* GetAnyUsableView() const;
+
/**
Returns the document associated with the currently active view (if
any).
wxDocument* GetCurrentDocument() const;
/**
- Returns the currently active view
+ Returns the currently active view.
+
+ This method can return @NULL if no view is currently active.
+
+ @see GetAnyUsableView()
*/
virtual wxView* GetCurrentView() const;
+ /**
+ Returns a vector of wxDocument pointers.
+
+ @since 2.9.5
+ */
+ wxDocVector GetDocumentsVector() const;
+
+ /**
+ Returns a vector of wxDocTemplate pointers.
+
+ @since 2.9.5
+ */
+ wxDocTemplateVector GetTemplatesVector() const;
+
/**
Returns a reference to the list of documents.
*/
choice list is popped up, followed by a file selector.
This function is used in CreateDocument().
+
+ @beginWxPerlOnly
+ In wxPerl @a templates is a reference to a list of templates.
+ If you override this method in your document manager it must
+ return two values, eg:
+
+ @code
+ (doctemplate, path) = My::DocManager->SelectDocumentPath(...);
+ @endcode
+ @endWxPerlOnly
*/
virtual wxDocTemplate* SelectDocumentPath(wxDocTemplate** templates,
int noTemplates, wxString& path,
@param noTemplates
Number of templates being pointed to by the templates pointer.
@param sort
- If more than one template is passed in in templates, then this
+ If more than one template is passed into templates, then this
parameter indicates whether the list of templates that the user
will have to choose from is sorted or not when shown the choice box
dialog. Default is @false.
+
+ @beginWxPerlOnly
+ In wxPerl @a templates is a reference to a list of templates.
+ @endWxPerlOnly
*/
virtual wxDocTemplate* SelectDocumentType(wxDocTemplate** templates,
int noTemplates,
@param noTemplates
Number of templates being pointed to by the templates pointer.
@param sort
- If more than one template is passed in in templates, then this
+ If more than one template is passed into templates, then this
parameter indicates whether the list of templates that the user
will have to choose from is sorted or not when shown the choice box
dialog. Default is @false.
+
+ @beginWxPerlOnly
+ In wxPerl @a templates is a reference to a list of templates.
+ @endWxPerlOnly
*/
virtual wxDocTemplate* SelectViewType(wxDocTemplate** templates,
int noTemplates, bool sort = false);
*/
void SetMaxDocsOpen(int n);
+
+protected:
+ /**
+ Called when a file selected from the MRU list doesn't exist any more.
+
+ The default behaviour is to remove the file from the MRU (most recently
+ used) files list and the corresponding menu and notify the user about
+ it but this method can be overridden to customize it.
+
+ For example, an application may want to just give an error about the
+ missing file @a filename but not remove it from the file history. Or it
+ could ask the user whether the file should be kept or removed.
+
+ Notice that this method is called only if the file selected by user
+ from the MRU files in the menu doesn't exist, but not if opening it
+ failed for any other reason because in the latter case the default
+ behaviour of removing the file from the MRU list is inappropriate.
+ If you still want to do it, you would need to do it by calling
+ RemoveFileFromHistory() explicitly in the part of the file opening code
+ that may fail.
+
+ @since 2.9.3
+
+ @param n
+ The index of the file in the MRU list, it can be passed to
+ RemoveFileFromHistory() to remove this file from the list.
+ @param filename
+ The full name of the file.
+ */
+ virtual void OnMRUFileNotExist(unsigned n, const wxString& filename);
+
+ /**
+ Create the frame used for print preview.
+
+ This method can be overridden if you need to change the behaviour or
+ appearance of the preview window. By default, a standard wxPreviewFrame
+ is created.
+
+ @since 2.9.1
+
+ @param preview The associated preview object.
+ @param parent The parent window for the frame.
+ @param title The suggested title for the print preview frame.
+ @return A new print preview frame, must not return @NULL.
+ */
+ virtual wxPreviewFrame* CreatePreviewFrame(wxPrintPreviewBase* preview,
+ wxWindow* parent,
+ const wxString& title);
+
/**
The currently active view.
*/
*/
wxFileHistory* m_fileHistory;
- /**
- Stores the flags passed to the constructor.
- */
- long m_flags;
-
/**
The directory last selected by the user when opening a file.
*/
- wxFileHistory* m_fileHistory;
+ wxString m_lastDirectory;
/**
Stores the maximum number of documents that can be opened before
- existing documents are closed. By default, this is 10,000.
+ existing documents are closed.
+
+ By default, this is @c INT_MAX i.e. practically unlimited.
*/
int m_maxDocsOpen;
};
/**
Called when the filename has changed. The default implementation
- constructs a suitable title and sets the title of the view frame (if
- any).
+ constructs a suitable title and sets the title of the view frame (if any).
*/
virtual void OnChangeFilename();
and cooperates with the wxView, wxDocument, wxDocManager and wxDocTemplate
classes.
+ Notice that this class handles ::wxEVT_ACTIVATE event and activates the
+ child view on receiving it. Don't intercept this event unless you want to
+ prevent from this happening.
+
+ The same remark applies to ::wxEVT_CLOSE_WINDOW, as wxDocParentFrame the
+ frame handles this event by trying to close the associated view.
+
@library{wxcore}
@category{docview}
*/
wxView* GetView() const;
- /**
- Sets the currently active view to be the frame's view. You may need to
- override (but still call) this function in order to set the keyboard
- focus for your subwindow.
- */
- void OnActivate(wxActivateEvent& event);
-
- /**
- Closes and deletes the current view and document.
- */
- void OnCloseWindow(wxCloseEvent& event);
-
/**
Sets the document for this frame.
*/
It cooperates with the wxView, wxDocument, wxDocManager and wxDocTemplate
classes.
+ Notice that this class processes ::wxEVT_CLOSE_WINDOW event and tries to
+ close all open views from its handler. If all the views can be closed, i.e.
+ if none of them contains unsaved changes or the user decides to not save
+ them, the window is destroyed. Don't intercept this event in your code
+ unless you want to replace this logic.
+
@library{wxcore}
@category{docview}
Returns the associated document manager object.
*/
wxDocManager* GetDocumentManager() const;
-
- /**
- Deletes all views and documents. If no user input cancelled the
- operation, the frame will be destroyed and the application will exit.
- Since understanding how document/view clean-up takes place can be
- difficult, the implementation of this function is shown below:
-
- @code
- void wxDocParentFrame::OnCloseWindow(wxCloseEvent& event)
- {
- if (m_docManager->Clear(!event.CanVeto()))
- {
- this->Destroy();
- }
- else
- event.Veto();
- }
- @endcode
- */
- void OnCloseWindow(wxCloseEvent& event);
};
@class wxDocument
The document class can be used to model an application's file-based data.
+
It is part of the document/view framework supported by wxWidgets, and
cooperates with the wxView, wxDocTemplate and wxDocManager classes.
+ A normal document is the one created without parent document and is
+ associated with a disk file. Since version 2.9.2 wxWidgets also supports a
+ special kind of documents called <em>child documents</em> which are virtual
+ in the sense that they do not correspond to a file but rather to a part of
+ their parent document. Because of this, the child documents can't be
+ created directly by user but can only be created by the parent document
+ (usually when it's being created itself). They also can't be independently
+ saved. A child document has its own view with the corresponding window.
+ This view can be closed by user but, importantly, is also automatically
+ closed when its parent document is closed. Thus, child documents may be
+ convenient for creating additional windows which need to be closed when the
+ main document is. The docview sample demonstrates this use of child
+ documents by creating a child document containing the information about the
+ parameters of the image opened in the main document.
+
@library{wxcore}
@category{docview}
/**
Constructor. Define your own default constructor to initialize
application-specific data.
+
+ @param parent
+ Specifying a non-@c NULL parent document here makes this document a
+ special <em>child document</em>, see their description in the class
+ documentation. Notice that this parameter exists but is ignored in
+ wxWidgets versions prior to 2.9.1.
*/
- wxDocument(wxDocument* parent = 0);
+ wxDocument(wxDocument* parent = NULL);
/**
Destructor. Removes itself from the document manager.
*/
bool AlreadySaved() const;
+ /**
+ Activate the first view of the document if any.
+
+ This function simply calls the Raise() method of the frame of the first
+ view. You may need to override the Raise() method to get the desired
+ effect if you are not using a standard wxFrame for your view. For
+ instance, if your document is inside its own notebook tab you could
+ implement Raise() like this:
+
+ @code
+ void MyNotebookPage::Raise()
+ {
+ wxNotebook* notebook = wxStaticCast(GetParent(), wxNotebook);
+ notebook->SetSelection(notebook->FindPage(this));
+ }
+ @endcode
+
+ @see GetFirstView()
+
+ @since 2.9.5
+ */
+ void Activate() const;
+
/**
Closes the document, by calling OnSaveModified() and then (if this
returned @true) OnCloseDocument(). This does not normally delete the
*/
virtual bool DeleteAllViews();
+ /**
+ Virtual method called from OnCloseDocument().
+
+ This method may be overridden to perform any additional cleanup which
+ might be needed when the document is closed.
+
+ The return value of this method is currently ignored.
+
+ The default version does nothing and simply returns @true.
+ */
+ virtual bool DeleteContents();
+
/**
Returns a pointer to the command processor associated with this
document.
*/
virtual wxString GetUserReadableName() const;
+ /**
+ Returns a vector of wxView pointers.
+
+ @since 2.9.5
+ */
+ wxViewVector GetViewsVector() const;
+
//@{
/**
Returns the list whose elements are the views on the document.
@see GetFirstView()
*/
- wxList& GetViews() const;
+ wxList& GetViews();
const wxList& GetViews() const;
//@}
+ /**
+ Returns true if this document is a child document corresponding to a
+ part of the parent document and not a disk file as usual.
+
+ This method can be used to check whether file-related operations make
+ sense for this document as they only apply to top-level documents and
+ not child ones.
+
+ @since 2.9.2
+ */
+ bool IsChildDocument() const;
+
/**
Returns @true if the document has been modified since the last save,
@false otherwise. You may need to override this if your document view
/**
This virtual function is called when the document is being closed.
- The default implementation calls DeleteContents() (an empty
- implementation) and sets the modified flag to @false. You can override
- it to supply additional behaviour when the document is closed with
- Close().
+ The default implementation calls DeleteContents() (which may be
+ overridden to perform additional cleanup) and sets the modified flag to
+ @false. You can override it to supply additional behaviour when the
+ document is closed with Close().
Notice that previous wxWidgets versions used to call this function also
from OnNewDocument(), rather counter-intuitively. This is no longer the
/**
Called just after the document object is created to give it a chance to
- initialize itself. The default implementation uses the template
- associated with the document to create an initial view. If this
- function returns @false, the document is deleted.
+ initialize itself.
+
+ The default implementation uses the template associated with the
+ document to create an initial view.
+
+ For compatibility reasons, this method may either delete the document
+ itself if its initialization fails or not do it in which case it is
+ deleted by caller. It is recommended to delete the document explicitly
+ in this function if it can't be initialized.
+
+ @param path
+ The associated file path.
+ @param flags
+ Flags passed to CreateDocument().
+ @return
+ @true if the initialization was successful or @false if it failed.
*/
virtual bool OnCreate(const wxString& path, long flags);
/**
If the document has been modified, prompts the user to ask if the
- changes should be changed. If the user replies Yes, the Save() function
+ changes should be saved. If the user replies Yes, the Save() function
is called. If No, the document is marked as unmodified and the function
succeeds. If Cancel, the function fails.
*/
*/
virtual bool SaveAs();
+ /**
+ Discard changes and load last saved version.
+
+ Prompts the user first, and then calls DoOpenDocument() to reload the
+ current file.
+ */
+ virtual bool Revert();
+
//@{
/**
Override this function and call it from your own SaveObject() before
*/
virtual void SetDocumentTemplate(wxDocTemplate* templ);
+ /**
+ Sets if this document has been already saved or not.
+
+ Normally there is no need to call this function as the document-view
+ framework does it itself as the documents are loaded from and saved to
+ the files. However it may be useful in some particular cases, for
+ example it may be called with @false argument to prevent the user
+ from saving the just opened document into the same file if this
+ shouldn't be done for some reason (e.g. file format version changes and
+ a new extension should be used for saving).
+
+ @see GetDocumentSaved(), AlreadySaved()
+ */
+ void SetDocumentSaved(bool saved = true);
+
/**
Sets the filename for this document. Usually called by the framework.
+ Calls OnChangeFilename() which in turn calls wxView::OnChangeFilename() for
+ all views if @a notifyViews is @true.
+ */
+ void SetFilename(const wxString& filename, bool notifyViews = false);
+
+ /**
If @a notifyViews is @true, wxView::OnChangeFilename() is called for
all views.
+
+ @since 2.9.0
*/
- void SetFilename(const wxString& filename, bool notifyViews = false);
+ virtual void OnChangeFilename(bool notifyViews);
/**
Sets the title for this document. The document title is used for an
};
-
-/**
- @class wxFileHistory
-
- The wxFileHistory encapsulates a user interface convenience, the list of
- most recently visited files as shown on a menu (usually the File menu).
-
- wxFileHistory can manage one or more file menus. More than one menu may be
- required in an MDI application, where the file history should appear on
- each MDI child menu as well as the MDI parent frame.
-
- @library{wxcore}
- @category{docview}
-
- @see @ref overview_docview, wxDocManager
-*/
-class wxFileHistory : public wxObject
-{
-public:
- /**
- Constructor. Pass the maximum number of files that should be stored and
- displayed.
-
- @a idBase defaults to wxID_FILE1 and represents the id given to the
- first history menu item. Since menu items can't share the same ID you
- should change @a idBase (to one of your own defined IDs) when using
- more than one wxFileHistory in your application.
- */
- wxFileHistory(size_t maxFiles = 9, wxWindowID idBase = wxID_FILE1);
-
- /**
- Destructor.
- */
- virtual ~wxFileHistory();
-
- /**
- Adds a file to the file history list, if the object has a pointer to an
- appropriate file menu.
- */
- virtual void AddFileToHistory(const wxString& filename);
-
- /**
- Appends the files in the history list, to all menus managed by the file
- history object.
- */
- virtual void AddFilesToMenu();
- /**
- Appends the files in the history list, to the given menu only.
- */
- virtual void AddFilesToMenu(wxMenu* menu);
-
- /**
- Returns the base identifier for the range used for appending items.
- */
- wxWindowID GetBaseId() const;
-
- /**
- Returns the number of files currently stored in the file history.
- */
- virtual size_t GetCount() const;
-
- /**
- Returns the file at this index (zero-based).
- */
- virtual wxString GetHistoryFile(size_t index) const;
-
- /**
- Returns the maximum number of files that can be stored.
- */
- virtual int GetMaxFiles() const;
-
- /**
- Returns the list of menus that are managed by this file history object.
-
- @see UseMenu()
- */
- const wxList& GetMenus() const;
-
- /**
- Loads the file history from the given config object. This function
- should be called explicitly by the application.
-
- @see wxConfigBase
- */
- virtual void Load(const wxConfigBase& config);
-
- /**
- Removes the specified file from the history.
- */
- virtual void RemoveFileFromHistory(size_t i);
-
- /**
- Removes this menu from the list of those managed by this object.
- */
- virtual void RemoveMenu(wxMenu* menu);
-
- /**
- Saves the file history into the given config object. This must be
- called explicitly by the application.
-
- @see wxConfigBase
- */
- virtual void Save(wxConfigBase& config);
-
- /**
- Sets the base identifier for the range used for appending items.
- */
- void SetBaseId(wxWindowID baseId);
-
- /**
- Adds this menu to the list of those menus that are managed by this file
- history object. Also see AddFilesToMenu() for initializing the menu
- with filenames that are already in the history when this function is
- called, as this is not done automatically.
- */
- virtual void UseMenu(wxMenu* menu);
-};
-
-
-
// ============================================================================
// Global functions/macros
// ============================================================================
-/** @ingroup group_funcmacro_file */
+/** @addtogroup group_funcmacro_file */
//@{
/**
projects / wxWidgets.git / blobdiff