[sc-features] new/OOO330/m2 : Attach scripts to Calc sheet events

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

[sc-features] new/OOO330/m2 : Attach scripts to Calc sheet events

daniel.rentz


       Product: Spreadsheet
          Type: new
         Title: Attach scripts to Calc sheet events
     Posted by: [hidden email]
      Affected: sc
         TaskId: i109199
<http://www.openoffice.org/issues/show_bug.cgi?id=109199>
Effective from: OOO330/m2 CWS SRX644/soberfilterteam06,SRX645/soberfilterteam06


*Flags*
-------
API/ BASIC [x]
Configuration [ ]
File format change [x]
Help/ Guide [x]
Performance test [ ]
Translation [x]
UI relevant [x]


*Description*
-------------
In Calc, it is now possible to attach scripts (e.g. Basic macros) to
sheet events.

UI access:
- New entry "Sheet E~vents..." in the context menu of the sheet tab.
- New entry "~Events..." in the Edit -> Sheet submenu.


The following events are supported. The programmatic name will be used
in the OpenOffice.org API (see below).


UI name: "Activate Document".
Description: Called when a sheet has been activated in any view.
Programmatic name: "OnFocus".

UI name: "Deactivate Document".
Description: Called when a sheet is deactivated (because another sheet
is about to be activated) in any view.
Programmatic name: "OnUnfocus".

See http://www.openoffice.org/issues/show_bug.cgi?id=115181 for the
misleading UI names.


UI name: "Selection changed".
Description: Called when cell selection has been changed (keyboard or
mouse).
Programmatic name: "OnSelect".

UI name: "Content changed".
Description: Called when a cell value has been changed.
Programmatic name: "OnChange".

UI name: "Formulas calculated".
Description: Called when calculated cell values have been changed,
e.g. after changing some cells formulas depend on, or when using
volatile functions such as RANDOM or NOW are recalculated.
Programmatic name: "OnCalculate".

UI name: "Double click".
Description: Called before the sheet reacts on a double mouse click
into a cell. If the script returns the value FALSE, the double click
will be ignored (usually this means that Calc does not start the cell
edit mode).
Programmatic name: "OnDoubleClick".

UI name: "Right click".
Description: Called before the sheet reacts on a right mouse click
into a cell. If the script returns the value FALSE, the right click
will be ignored (usually this means that Calc does not show the cell
context menu).
Programmatic name: "OnRightClick".


API usage: The com.sun.star.sheet.Spreadsheet service now optionally
supports the com.sun.star.document.XEventsSupplier interface. Its
method getEvents() returns a name container supporting all sheet
events via the programmatic names mentioned above.



Send feedback to [hidden email]



---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]