Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: document ::

struct DocumentEvent
Base Hierarchy
DocumentEvent
 ┗ ::com::sun::star::lang::EventObject
Description
describes an event happening in an OfficeDocument

The ::com::sun::star::lang::EventObject::Source member of the base type refers to the document which broadcasts the event.

This type is the successor of the EventObject type, which should not be used anymore.

Since
OOo 3.1
See also
XDocumentEventBroadcaster

Elements' Summary
EventName specifies the name of the event.  
ViewController denotes the view respectively controller which the event applies to.  
Supplement contains supplemental information about the even which is being notified  
Elements' Details
EventName
string EventName;
Description
specifies the name of the event.

It's the responsibility of the component supporting the XDocumentEventBroadcaster interface to specify which events it supports.

ViewController
::com::sun::star::frame::XController2 ViewController;
Description
denotes the view respectively controller which the event applies to.

Might be NULL if the event is not related to a concrete view of the document.

Supplement
any Supplement;
Description
contains supplemental information about the even which is being notified

The semantics of this additional information needs to be specified by the broadcaster of the event.

Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.