a2dCloseDocumentEvent Class Reference
[Objects in docview frame work.Events used in docview frame work.events in the wxDocview library]

sent to document before closing More...

#include <docviewref.h>

List of all members.

Public Member Functions

 a2dCloseDocumentEvent (int id=0)
 constructor
 a2dCloseDocumentEvent (const a2dCloseDocumentEvent &event)
 constructor
virtual wxEvent * Clone () const
 clone the event


Detailed Description

sent to document before closing

The event Object is a a2dDocument. The type of the event is wxEVT_CLOSE_DOCUMENT. This event is sent form bool a2dDocument::Close( bool force ) to the a2dDocument itself.

The default handler is a2dDocument::OnCloseDocument(). Which, if not vetod, disconnects ( and maybe closes ) the views on the document using a2dDocument::DisconnectAllViews(). This will generate a wxEVT_DISCONNECT_ALLVIEWS event for the a2dDocument, and the same event is sent to the a2dEventDistributer for distribution. Views should either close or detach themselfs from the document.

Definition at line 683 of file docviewref.h.


The documentation for this class was generated from the following file:
a2dCloseDocumentEvent Class Reference -- Tue Aug 31 18:15:02 2010 -- 31 Aug 2010 -- 1.5.5 -- wxArt2D -- . -- Main Page Reference Documentation