Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous

Overview Module Use Devguide Index
Methods' Summary Attributes' Summary Methods' Details Attributes' Details

:: com :: sun :: star :: io ::

interface XActiveDataControl
Description
makes it possible to control an active data source.

This interface should be supported by objects which implement XActiveDataSource or XActiveDataSink.
Methods' Summary
addListener registers an object to receive events from this data source.  
removeListener unregisters an object to receive events from this data source.  
start starts I/O.  
terminate does a weak abort.  
Methods' Details
addListener
void
addListener( [in] XStreamListener  aListener );
Description
registers an object to receive events from this data source.

It is suggested to allow multiple registration of the same listener, thus for each time a listener is added, it has to be removed.

removeListener
void
removeListener( [in] XStreamListener  aListener );
Description
unregisters an object to receive events from this data source.

It is suggested to allow multiple registration of the same listener, thus for each time a listener is added, it has to be removed.

start
void
start();
Description
starts I/O.

Either XActiveDataControl::setInputStream() or XActiveDataControl::setOutputStream() must be called beforehand.

This method does not block the thread, so reading is generally not finished when the method returns.

terminate
void
terminate();
Description
does a weak abort.

It closes all connected resources and calls XInputStream::close or XOutputStream::close and fires the XStreamListener::terminated-event.
Top of Page

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

Apache Software Foundation

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

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