a2dViewEvent Class Reference
[Objects in docview frame work., Events used in docview frame work., events in the wxDocview library]
a2dView event, to report events in the a2dView class
More...
#include <docviewref.h>
Public Member Functions | |
| a2dViewEvent (wxEventType type, a2dDocumentFlagMask flags, int id) | |
| for event types | |
| a2dViewEvent (wxEventType type, bool value, int id) | |
| for event types | |
| a2dViewEvent (const a2dViewEvent &event) | |
| constructor | |
| void | Veto () |
| veto the operation (usually it's allowed by default) | |
| void | Allow () |
| allow the operation if it was disabled by default | |
| bool | IsAllowed () const |
| for implementation code only, testing result of handler: is the operation allowed? | |
| virtual wxEvent * | Clone () const |
| clone the event | |
| a2dDocumentFlagMask | GetFlags () |
| for following event types, get document flags of the event. | |
| bool | GetActive () |
| when wxEVT_ACTIVATE_VIEW get activation value of the event | |
| bool | GetEnable () |
| when wxEVT_ENABLE_VIEW get enable value of the event | |
Detailed Description
a2dView event, to report events in the a2dView classThe event Object is a a2dView.
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 arive in a wxFrame class containing the wxWindow.
If a2dView sents this event to the display window, this window 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 upwards.
Definition at line 549 of file docviewref.h.
Constructor & Destructor Documentation
| a2dViewEvent::a2dViewEvent | ( | wxEventType | type, | |
| a2dDocumentFlagMask | flags, | |||
| int | id | |||
| ) | [inline] |
for event types
- wxEVT_SET_DOCUMENT Is sent by the a2dView when a wxDocument is set for it. Intercepts this to initialize your ( new or existing ) view for that document.
- wxEVT_CREATE_VIEW Is sent by the a2dViewTemplate to the a2dView when the view was just created. But after the document was set. Intercepts this to initialize your new view.
Definition at line 566 of file docviewref.h.
| a2dViewEvent::a2dViewEvent | ( | wxEventType | type, | |
| bool | value, | |||
| int | id | |||
| ) | [inline] |
for event types
- wxEVT_ENABLE_VIEW Sent to a2dView and DisplayWindow from a2dView::Enable() or from the a2dDocument. The last functions is called from a2dView::SetDisplayWindow( wxWindow* display ) to disable the old display window, and enable the new display window.
- wxEVT_ACTIVATE_VIEW sent from a2dView::Activate() to the event distributer. ( intercepted at least by a2dDocumentCommandProcessor to set the view as the active view within the a2dDocumentCommandProcessor ) Only when the currently active a2dView within the docmanager is different from this one, it will FIRST sent a second wxEVT_ACTIVATE_VIEW to the old active view to disable it. This event is ignored in a2dDocumentCommandProcessor itself. The wxEVT_ACTIVATE_VIEW is sent to the a2dView itself to disable it. The wxEVT_ACTIVATE_VIEW is sent from the view when the view is set active.
- wxEVT_ACTIVATE_VIEW_SENT_FROM_CHILD event sent from view and its display up the parent chain. The main use is to set in a2dDocumentFrame the current view, so events from the frame arrive (via a window) at the (new) view when sent down there.
Definition at line 598 of file docviewref.h.
Member Function Documentation
| a2dDocumentFlagMask a2dViewEvent::GetFlags | ( | ) | [inline] |
for following event types, get document flags of the event.
- wxEVT_SET_DOCUMENT
- wxEVT_CREATE_VIEW
Definition at line 643 of file docviewref.h.
The documentation for this class was generated from the following file: