Lomse library. API documentation  0.30.0
EventDoc Class Reference

#include <lomse_events.h>

Inheritance diagram for EventDoc:
EventInfo

Detailed Description

An event generated by the Document, not related to any specific View.

The only type for this event is k_doc_modified_event that is generated when the Document is modified. This event is observed by the Interactor in order to generate EvenPaint events when necessary. Therefore, your application normally will not have to handle this event.

For handling it in your application, you will have to register a handler function at the Document:

pDoc->add_event_handler(k_doc_modified_event, MyHandler);

You can always check if a Document has been modified by invoking method Document::is_dirty().

See Events and how to handle them

Public Member Functions

 EventDoc (EEventType type, Document *pDoc)
 
virtual ~EventDoc ()
 
Document * get_document ()
 
- Public Member Functions inherited from EventInfo
virtual ~EventInfo ()
 
virtual Observableget_source ()
 
EEventType get_event_type ()
 
bool is_doc_modified_event ()
 
bool is_update_window_event ()
 
bool is_mouse_in_event ()
 
bool is_mouse_out_event ()
 
bool is_on_click_event ()
 
bool is_link_clicked_event ()
 
bool is_show_contextual_menu_event ()
 
bool is_control_point_moved_event ()
 
bool is_selection_set_change ()
 
bool is_pointed_object_change ()
 
bool is_do_play_score_event ()
 
bool is_pause_score_event ()
 
bool is_stop_playback_event ()
 
bool is_tracking_event ()
 
bool is_update_viewport_event ()
 
bool is_end_of_playback_event ()
 

Constructor & Destructor Documentation

◆ EventDoc()

EventDoc::EventDoc ( EEventType  type,
Document *  pDoc 
)
inline

Constructor.

◆ ~EventDoc()

virtual EventDoc::~EventDoc ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ get_document()

Document* EventDoc::get_document ( )
inline

Returns a ptr. to the Document object in which the event is generated.