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 child documents 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.
<>< =''>:</>&;&;< =''>\ </></>
- See also
- Document/View Framework, wxView, wxDocTemplate, wxDocManager
|
| wxDocument (wxDocument *parent=NULL) |
| Constructor. More...
|
|
virtual | ~wxDocument () |
| Destructor. More...
|
|
virtual bool | AddView (wxView *view) |
| If the view is not already in the list of views, adds the view and calls OnChangedViewList(). More...
|
|
bool | AlreadySaved () const |
| Returns true if the document hasn't been modified since the last time it had been saved. More...
|
|
void | Activate () const |
| Activate the first view of the document if any. More...
|
|
virtual bool | Close () |
| Closes the document, by calling OnSaveModified() and then (if this returned true) OnCloseDocument(). More...
|
|
virtual bool | DeleteAllViews () |
| Calls wxView::Close() and deletes each view. More...
|
|
virtual bool | DeleteContents () |
| Virtual method called from OnCloseDocument(). More...
|
|
virtual wxCommandProcessor * | GetCommandProcessor () const |
| Returns a pointer to the command processor associated with this document. More...
|
|
virtual wxDocManager * | GetDocumentManager () const |
| Gets a pointer to the associated document manager. More...
|
|
wxString | GetDocumentName () const |
| Gets the document type name for this document. More...
|
|
bool | GetDocumentSaved () const |
| Return true if this document had been already saved. More...
|
|
virtual wxDocTemplate * | GetDocumentTemplate () const |
| Gets a pointer to the template that created the document. More...
|
|
virtual wxWindow * | GetDocumentWindow () const |
| Intended to return a suitable window for using as a parent for document-related dialog boxes. More...
|
|
wxString | GetFilename () const |
| Gets the filename associated with this document, or "" if none is associated. More...
|
|
wxView * | GetFirstView () const |
| A convenience function to get the first view for a document, because in many cases a document will only have a single view. More...
|
|
wxString | GetTitle () const |
| Gets the title for this document. More...
|
|
virtual wxString | GetUserReadableName () const |
| Return the document name suitable to be shown to the user. More...
|
|
wxViewVector | GetViewsVector () const |
| Returns a vector of wxView pointers. More...
|
|
wxList & | GetViews () |
| Returns the list whose elements are the views on the document. More...
|
|
const wxList & | GetViews () const |
|
bool | IsChildDocument () 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. More...
|
|
virtual bool | IsModified () const |
| Returns true if the document has been modified since the last save, false otherwise. More...
|
|
virtual istream & | LoadObject (istream &stream) |
| Override this function and call it from your own LoadObject() before streaming your own data. More...
|
|
virtual wxInputStream & | LoadObject (wxInputStream &stream) |
|
virtual void | Modify (bool modify) |
| Call with true to mark the document as modified since the last save, false otherwise. More...
|
|
virtual void | OnChangedViewList () |
| Called when a view is added to or deleted from this document. More...
|
|
virtual bool | OnCloseDocument () |
| This virtual function is called when the document is being closed. More...
|
|
virtual bool | OnCreate (const wxString &path, long flags) |
| Called just after the document object is created to give it a chance to initialize itself. More...
|
|
virtual wxCommandProcessor * | OnCreateCommandProcessor () |
| Override this function if you want a different (or no) command processor to be created when the document is created. More...
|
|
virtual bool | OnNewDocument () |
| The default implementation calls OnSaveModified() and DeleteContents(), makes a default title for the document, and notifies the views that the filename (in fact, the title) has changed. More...
|
|
virtual bool | OnOpenDocument (const wxString &filename) |
| Constructs an input file stream for the given filename (which must not be empty), and calls LoadObject(). More...
|
|
virtual bool | OnSaveDocument (const wxString &filename) |
| Constructs an output file stream for the given filename (which must not be empty), and calls SaveObject(). More...
|
|
virtual bool | OnSaveModified () |
| If the document has been modified, prompts the user to ask if the changes should be saved. More...
|
|
virtual bool | RemoveView (wxView *view) |
| Removes the view from the document's list of views, and calls OnChangedViewList(). More...
|
|
virtual bool | Save () |
| Saves the document by calling OnSaveDocument() if there is an associated filename, or SaveAs() if there is no filename. More...
|
|
virtual bool | SaveAs () |
| Prompts the user for a file to save to, and then calls OnSaveDocument(). More...
|
|
virtual bool | Revert () |
| Discard changes and load last saved version. More...
|
|
virtual ostream & | SaveObject (ostream &stream) |
| Override this function and call it from your own SaveObject() before streaming your own data. More...
|
|
virtual wxOutputStream & | SaveObject (wxOutputStream &stream) |
|
virtual void | SetCommandProcessor (wxCommandProcessor *processor) |
| Sets the command processor to be used for this document. More...
|
|
void | SetDocumentName (const wxString &name) |
| Sets the document type name for this document. More...
|
|
virtual void | SetDocumentTemplate (wxDocTemplate *templ) |
| Sets the pointer to the template that created the document. More...
|
|
void | SetDocumentSaved (bool saved=true) |
| Sets if this document has been already saved or not. More...
|
|
void | SetFilename (const wxString &filename, bool notifyViews=false) |
| Sets the filename for this document. More...
|
|
virtual void | OnChangeFilename (bool notifyViews) |
| If notifyViews is true, wxView::OnChangeFilename() is called for all views. More...
|
|
void | SetTitle (const wxString &title) |
| Sets the title for this document. More...
|
|
virtual void | UpdateAllViews (wxView *sender=NULL, wxObject *hint=NULL) |
| Updates all views. More...
|
|
Public Member Functions inherited from wxEvtHandler |
| wxEvtHandler () |
| Constructor. More...
|
|
virtual | ~wxEvtHandler () |
| Destructor. More...
|
|
virtual void | QueueEvent (wxEvent *event) |
| Queue event for a later processing. More...
|
|
virtual void | AddPendingEvent (const wxEvent &event) |
| Post an event to be processed later. More...
|
|
template<typename T , typename T1 , ... > |
void | CallAfter (void(T::*method)(T1,...), T1 x1,...) |
| Asynchronously call the given method. More...
|
|
template<typename T > |
void | CallAfter (const T &functor) |
| Asynchronously call the given functor. More...
|
|
virtual bool | ProcessEvent (wxEvent &event) |
| Processes an event, searching event tables and calling zero or more suitable event handler function(s). More...
|
|
bool | ProcessEventLocally (wxEvent &event) |
| Try to process the event in this handler and all those chained to it. More...
|
|
bool | SafelyProcessEvent (wxEvent &event) |
| Processes an event by calling ProcessEvent() and handles any exceptions that occur in the process. More...
|
|
void | ProcessPendingEvents () |
| Processes the pending events previously queued using QueueEvent() or AddPendingEvent(); you must call this function only if you are sure there are pending events for this handler, otherwise a wxCHECK will fail. More...
|
|
void | DeletePendingEvents () |
| Deletes all events queued on this event handler using QueueEvent() or AddPendingEvent(). More...
|
|
virtual bool | SearchEventTable (wxEventTable &table, wxEvent &event) |
| Searches the event table, executing an event handler function if an appropriate one is found. More...
|
|
void | Connect (int id, int lastId, wxEventType eventType, wxObjectEventFunction function, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL) |
| Connects the given function dynamically with the event handler, id and event type. More...
|
|
void | Connect (int id, wxEventType eventType, wxObjectEventFunction function, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL) |
| See the Connect(int, int, wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*) overload for more info. More...
|
|
void | Connect (wxEventType eventType, wxObjectEventFunction function, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL) |
| See the Connect(int, int, wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*) overload for more info. More...
|
|
bool | Disconnect (wxEventType eventType, wxObjectEventFunction function, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL) |
| Disconnects the given function dynamically from the event handler, using the specified parameters as search criteria and returning true if a matching function has been found and removed. More...
|
|
bool | Disconnect (int id=wxID_ANY, wxEventType eventType=wxEVT_NULL, wxObjectEventFunction function=NULL, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL) |
| See the Disconnect(wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*) overload for more info. More...
|
|
bool | Disconnect (int id, int lastId, wxEventType eventType, wxObjectEventFunction function=NULL, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL) |
| See the Disconnect(wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*) overload for more info. More...
|
|
template<typename EventTag , typename Functor > |
void | Bind (const EventTag &eventType, Functor functor, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=NULL) |
| Binds the given function, functor or method dynamically with the event. More...
|
|
template<typename EventTag , typename Class , typename EventArg , typename EventHandler > |
void | Bind (const EventTag &eventType, void(Class::*method)(EventArg &), EventHandler *handler, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=NULL) |
| See the Bind<>(const EventTag&, Functor, int, int, wxObject*) overload for more info. More...
|
|
template<typename EventTag , typename Functor > |
bool | Unbind (const EventTag &eventType, Functor functor, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=NULL) |
| Unbinds the given function, functor or method dynamically from the event handler, using the specified parameters as search criteria and returning true if a matching function has been found and removed. More...
|
|
template<typename EventTag , typename Class , typename EventArg , typename EventHandler > |
bool | Unbind (const EventTag &eventType, void(Class::*method)(EventArg &), EventHandler *handler, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=NULL) |
| See the Unbind<>(const EventTag&, Functor, int, int, wxObject*) overload for more info. More...
|
|
void * | GetClientData () const |
| Returns user-supplied client data. More...
|
|
wxClientData * | GetClientObject () const |
| Returns a pointer to the user-supplied client data object. More...
|
|
void | SetClientData (void *data) |
| Sets user-supplied client data. More...
|
|
void | SetClientObject (wxClientData *data) |
| Set the client data object. More...
|
|
bool | GetEvtHandlerEnabled () const |
| Returns true if the event handler is enabled, false otherwise. More...
|
|
wxEvtHandler * | GetNextHandler () const |
| Returns the pointer to the next handler in the chain. More...
|
|
wxEvtHandler * | GetPreviousHandler () const |
| Returns the pointer to the previous handler in the chain. More...
|
|
void | SetEvtHandlerEnabled (bool enabled) |
| Enables or disables the event handler. More...
|
|
virtual void | SetNextHandler (wxEvtHandler *handler) |
| Sets the pointer to the next handler. More...
|
|
virtual void | SetPreviousHandler (wxEvtHandler *handler) |
| Sets the pointer to the previous handler. More...
|
|
void | Unlink () |
| Unlinks this event handler from the chain it's part of (if any); then links the "previous" event handler to the "next" one (so that the chain won't be interrupted). More...
|
|
bool | IsUnlinked () const |
| Returns true if the next and the previous handler pointers of this event handler instance are NULL. More...
|
|
| wxObject () |
| Default ctor; initializes to NULL the internal reference data. More...
|
|
| wxObject (const wxObject &other) |
| Copy ctor. More...
|
|
virtual | ~wxObject () |
| Destructor. More...
|
|
virtual wxClassInfo * | GetClassInfo () const |
| This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar). More...
|
|
wxObjectRefData * | GetRefData () const |
| Returns the wxObject::m_refData pointer, i.e. the data referenced by this object. More...
|
|
bool | IsKindOf (const wxClassInfo *info) const |
| Determines whether this class is a subclass of (or the same class as) the given class. More...
|
|
bool | IsSameAs (const wxObject &obj) const |
| Returns true if this object has the same data pointer as obj. More...
|
|
void | Ref (const wxObject &clone) |
| Makes this object refer to the data in clone. More...
|
|
void | SetRefData (wxObjectRefData *data) |
| Sets the wxObject::m_refData pointer. More...
|
|
void | UnRef () |
| Decrements the reference count in the associated data, and if it is zero, deletes the data. More...
|
|
void | UnShare () |
| This is the same of AllocExclusive() but this method is public. More...
|
|
void | operator delete (void *buf) |
| The delete operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined. More...
|
|
void * | operator new (size_t size, const wxString &filename=NULL, int lineNum=0) |
| The new operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined. More...
|
|