#include <docviewref.h>
Public Member Functions | |
| a2dCloseViewEvent (int id=0) | |
| Constructor for view event of type ::wxEVT_CLOSE_VIEW. | |
| a2dCloseViewEvent (const a2dCloseViewEvent &event) | |
| constructor | |
| virtual wxEvent * | Clone () const |
| clone the event. | |
| void | Veto (bool veto=true) |
| use to veto event when the closing of the view needs to be refused in a handler. | |
| void | SetCanVeto (bool canVeto) |
| If the event can not be vetod this is set to false. | |
| bool | CanVeto () const |
| If the event can be vetod this is set. | |
| bool | GetVeto () const |
| If the event can be vetod this return true. | |
 Public Member Functions inherited from a2dEvent | |
| a2dEvent (int id=0, wxEventType eventType=wxEVT_NULL) | |
| void | SetIntTimeStamp () |
Protected Attributes | |
| bool | m_veto |
| veto flags. | |
| bool | m_canVeto |
Additional Inherited Members | |
| Static Public Attributes inherited from a2dEvent | |
| static long | ms_timestamp = 0 |
| initialize timestamp | |
Detailed Description
see a2dDocumentEvent
see a2dDocumentEvent see a2dDocumentEvent see a2dDocumentEvent see a2dDocumentEvent see a2dDocumentEvent see a2dDocumentEvent see a2dDocumentEvent see a2dDocumentEvent see a2dDocumentEvent see a2dDocumentEvent see a2dDocumentEvent see a2dDocumentEvent see a2dDocumentEvent see a2dDocumentEvent see a2dDocumentEvent see a2dDocumentEvent see a2dDocumentEvent see a2dViewEvent see a2dViewEvent see a2dViewEvent see a2dViewEvent see a2dViewEvent see a2dViewEvent see a2dViewEvent see a2dTemplateEvent see a2dTemplateEvent see a2dTemplateEvent see a2dTemplateEvent a2dView close event
Sent when a view needs to be closed. The event can be vetod. The event travels up to the parent window, when it is sent to a wxWindow and not processed or skipped. Therefore if the event is sent to the Display Window (m_display) of a view, the event can eventually arrive in a wxFrame class containing the wxWindow. At any place in this hierachy of wxWindows , one will take care of detaching the view from the windows.
When via the a2dDocumentCommandProcessor a view is closed, one is able to also cleanup wxWindow and wxFrames which use the particular a2dView, this is via a2dDocument.
The a2dView sents this event to the display window, and this window should might directly sent it back to the a2dView. In case it does, this is not a problem, since the a2dView disables itself while sending those events.
The event Object is a a2dView. The type of the event is ::wxEVT_CLOSE_VIEW, and only generated in a2dView::Close(). The event is first sent to the a2dDocument of the a2dView. If not vetod, it is next sent to the m_display of the a2dView. And if not vetod, it will be sent to the a2dView itself. If not vetod there, the a2dView will be removed from the a2dDocument its view list, and released.
Definition at line 356 of file docviewref.h.
The documentation for this class was generated from the following file: