(incubating) | The Free and Open Productivity Suite

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous

Content for OpenOffice.org version 3.3.
Overview Module Use Devguide Index
Elements' Summary Elements' Details

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

unpublished struct DocumentEvent
Base Hierarchy
DocumentEvent
 ┗ ::com::sun::star::lang::EventObject
Usage Restrictions
not published
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
OpenOffice.org 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

Copyright © 1995, 2010, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Apache OpenOffice is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.

Copyright & License
Apache and the Apache feather logos are trademarks of The Apache Software Foundation. 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.