Hi,

our API defines some document events that users can register macros or
event listeneners for.

One of these events is called "OnLoad". This is a very unfortunate name,
as this event is not triggered when a document is loaded, but when the
document is shown to the user, not before the document actually became
visible. This is the only way to make this event usable in the way as
many macro developers, especially those creating macros in templates,
want it. They want the document to be visible before they e.g. show the
user a dialog to add something to it.

Of course it turned out that the point in time where the document
finished loading (and before a view was created) also is interesting for
developers, so an event name for it was needed. As unfortunately
"OnLoad" was used already, we took "OnLoadFinished". While this is a
good name for this event, we now have the unfortunate situation that
"OnLoadFinished" is sent before "OnLoad". This is at least confusing.

So I would like to change "OnLoad" to "OnOpen". This describes the event
much better - it names an event that is triggered only if the document
is actually "opened", means: shown to the user.

For the time being we had to keep "OnLoad" for compatibility reasons
(both for registering as well as for sending), but the documentation
would be changed to suggest "OnOpen" instead. This can be changed (and
perhaps will be changed) in the first release that allows for
incompatible API changes (I assume this will be 4.0).

Alternatively, we can stay with "OnLoad" until the incompatible change
and then switch to "OnOpen" without any intermediate compatibility
arrangements.

Comments, anyone?

BTW: in case of new documents we fortunately don't have this problem, as
the old event "OnNew" (triggered when the document became visible)
doesn't conflict with the new event "OnCreate" (triggered when the
document actually was created, but before it got a view assigned).

Regards,
Mathias

-- 
Mathias Bauer (mba) - Project Lead OpenOffice.org Writer
OpenOffice.org Engineering at Sun: http://blogs.sun.com/GullFOSS
Please don't reply to "nospamfor...@gmx.de".
I use it for the OOo lists and only rarely read other mails sent to it.

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@api.openoffice.org
For additional commands, e-mail: dev-h...@api.openoffice.org

Reply via email to