How to stop Menu activation for a control?

vib · March 31, 2024, 1:12pm

I need to stop a control such as a TextEdit from displaying a popup (context) menu.
I have a few reason for this but the main one is:

I have a control that is displayed on a Calc sheet. When the control looses focus I remove the control.

The issue in this case is, when the user right clicks a popup menu appears, this causes the control to looses focus and removes itself from the sheet, this cause a crash because the control is gone but the menu was displayed.

I checked the event order and the focus lost event fires before the mouse down event.

mikekaganski · March 31, 2024, 1:35pm

Please file a bug about that crash. There must be no crash, so this needs to be fixed.

vib · March 31, 2024, 2:03pm

Filed a bug report 160446

vib · March 31, 2024, 2:04pm

Does anyone know a work around for this issue?

sokol92 · March 31, 2024, 2:15pm

See this description of the FocusEvent Struct, especially working with the Temporary attribute.

vib · March 31, 2024, 3:29pm

No Luck, Below is the output when right mouse button is clicked for the lost focus event.
There does not seem to be anything on the lost focus event that can be used for a right click menu.

def lost_focus(src: Any, event: EventArgs, control_src: Any):
    print("Lost Focus")
    fe = cast("FocusEvent", event.event_data)
    print("Temporary", fe.Temporary)
    # print("Source", fe.Source) # source control
    print("FocusFlags", fe.FocusFlags)
    print("NextFocus", fe.NextFocus)  # next control, same XWindow as Sheet

Lost Focus
Temporary False
FocusFlags 0
NextFocus pyuno object (com.sun.star.uno.XInterface)0x1a10e7db738{, supportedInterfaces={com.sun.star.awt.XTopWindow2 ...

sokol92 · March 31, 2024, 5:24pm

You can try this way:

Sub OnFocusLostEvent(oEvent)
   If oEvent.Temporary=False Then 
     If Not (oEvent.NextFocus Is Nothing) Then 
       If oEvent.NextFocus.PosSize.X<>oEvent.Source.PosSize.X Or _
          oEvent.NextFocus.PosSize.Y<>oEvent.Source.PosSize.Y Then
         Msgbox "The control can be deleted"
       End If        
     End If
   End If  
End Sub

vib · March 31, 2024, 6:45pm

I am not seeing a correlation.

Sorry for the messy lost_focus. I wanted you to see the debugging.
Because this is OooDev the callback event contains a control class that also includes the control shape. The control Anchor is the cell the control is in (‘B2’ in this case).

def lost_focus(src: Any, event: EventArgs, control_src: FormCtlTextField):
    print("Lost Focus")
    fe = cast("FocusEvent", event.event_data)
    print("Temporary", fe.Temporary)
    # print("Source", fe.Source) # source control
    print("FocusFlags", fe.FocusFlags)
    # print("NextFocus", fe.NextFocus)  # next control, same XWindow as Sheet
    if not fe.Temporary and not fe.NextFocus is None:
        next_rect = cast("Rectangle", fe.NextFocus.PosSize)
        curr_rect = cast("Rectangle", fe.Source.PosSize)
        print("NextFocus.PosSize", f"{next_rect.X}, {next_rect.Y}, {next_rect.Width}, {next_rect.Height}")
        print("Source.PosSize", f"{curr_rect.X}, {curr_rect.Y}, {curr_rect.Width}, {curr_rect.Height}")

        x_cell = cast("SheetCell", control_src.control_shape.Anchor)
        sz = x_cell.Size
        pos = x_cell.Position
        print("Cell PosSize", f"{pos.X}, {pos.Y}, {sz.Width}, {sz.Height}")

        shape_sz = control_src.control_shape.getSize()
        shape_pos = control_src.control_shape.getPosition()
        print("Shape PosSize", f"{shape_pos.X}, {shape_pos.Y}, {shape_sz.Width}, {shape_sz.Height}")

Control Right clicks (shows built in popup menu):

Lost Focus
Temporary False
FocusFlags 0
NextFocus.PosSize 209, 201, 230, 168
Source.PosSize 82, 17, 83, 18
Cell PosSize 2258, 452, 2259, 452
Shape PosSize 2258, 452, 2259, 452


Lost Focus
Temporary False
FocusFlags 0
NextFocus.PosSize 233, 198, 230, 168
Source.PosSize 82, 17, 83, 18
Cell PosSize 2258, 452, 2259, 452
Shape PosSize 2258, 452, 2259, 452

Non Control click ( other side of spreadsheet ):

Lost Focus
Temporary False
FocusFlags 0
NextFocus.PosSize 33, 19, 939, 417
Source.PosSize 82, 17, 83, 18
Cell PosSize 2258, 452, 2259, 452
Shape PosSize 2258, 452, 2259, 452

sokol92 · April 1, 2024, 11:00am

Let’s figure it out together using the attached example.
Open the file and click on the control element (with the text abcd).

If you click on any cell of the sheet or on the “blue” shape, the message “The control can be deleted” appears.
If you right-click (or type Shift+F10), a context menu appears, but no message is displayed.

Comment. There is no short circuiting in Basic, so we have to write nested Ifs.

OnFocusLostEvent.ods (10.9 KB)

vib · April 1, 2024, 3:17pm

Ok I put together a python example. Requires OOO Development Tools extension to run.

I am getting a different result then basic Not sure why just yet.

focus_test.ods (9.6 KB)

Could not attach the focus_test.py so here is the source.

from __future__ import annotations
from typing import Any, cast, TYPE_CHECKING
import os
from datetime import datetime
from ooo.dyn.style.vertical_alignment import VerticalAlignment
from ooodev.calc import CalcDoc
from ooodev.events.args.event_args import EventArgs
from ooodev.form.controls.form_ctl_text_field import FormCtlTextField

if TYPE_CHECKING:
    from com.sun.star.awt import FocusEvent
    from com.sun.star.awt import MouseEvent

_TEXT_OUTPUT = cast(FormCtlTextField, None)


def _write_line(msg: str):
    global _TEXT_OUTPUT
    if _TEXT_OUTPUT is not None:
        now = datetime.now()
        timestamp = now.strftime("%H:%M:%S")
        _TEXT_OUTPUT.write_line(f"{timestamp}: {msg}")


def on_lost_focus(src: Any, event: EventArgs, control_src: FormCtlTextField, *args, **kwargs):
    _write_line("Lost Focus")
    fe = cast("FocusEvent", event.event_data)
    if fe.Temporary is False:
        if fe.NextFocus is not None:
            if fe.NextFocus.PosSize.X != fe.Source.PosSize.X or fe.NextFocus.PosSize.Y != fe.Source.PosSize.Y:
                _write_line("  The control can be deleted")
                return
    _write_line("  The control cannot be deleted:")


def on_mouse_event(src: Any, event: EventArgs, *args, **kwargs):
    _write_line("on_mouse_event")
    me = cast("MouseEvent", event.event_data)
    _write_line(f"  PopupTrigger: {me.PopupTrigger}")


def on_load(*args):
    global _TEXT_OUTPUT
    doc = CalcDoc.from_current_doc()
    sheet = doc.sheets[0]

    cell = sheet[1, 1]
    ctl = cell.control.insert_control_text_field()
    ctl.add_event_mouse_pressed(on_mouse_event)
    ctl.add_event_focus_lost(on_lost_focus)
    rng = sheet.get_range(range_name="F2:K10")
    ctl_text = rng.control.insert_control_text_field()
    ps = ctl_text.get_property_set()
    ctl_text.view.setDesignMode(True)
    ps.setPropertyValue("VerticalAlign", VerticalAlignment.TOP)
    ps.setPropertyValue("VScroll", True)
    ps.setPropertyValue("ReadOnly", True)
    ps.setPropertyValue("MultiLine", True)
    ps.setPropertyValue("LineEndFormat", 2 if os.name == "nt" else 1)
    ctl_text.view.setDesignMode(False)
    _TEXT_OUTPUT = ctl_text
    doc.toggle_design_mode()

vib · April 1, 2024, 3:35pm

I am curioius about:

Function OnMouseEvent(oEvent) As Boolean
  If oEvent.PopupTrigger Then
    OnMouseEvent=True
  End If  
End Function

Why do you return a boolean?
The XMouseListener events all return void.

sokol92 · April 1, 2024, 3:41pm

My mistake - I forgot to remove it.

vib · April 1, 2024, 6:18pm

Okay, learned someting new. The python example work fine in Linux. Does not work in Windows.
I have to test the Basic again in windows to see if it works.

I put together a temp codespace version for the python example.
on the calc_ctl_focus branch of Live LibreOffice Python UNO Examples
See Debug Macros in Vs Code · Amourspirit/live-libreoffice-python Wiki · GitHub for hints on how to open LibreOffice inside of the codespace.

Macro Source code

Start Calc in the code space.
Run the calc_ctl_focus -> focus -> on_load macro to load the controls into a calc doc.

Macro dialog

Seems to be working in Linux

vib · April 1, 2024, 6:55pm

Well I downloaded my odev_cell_with_controls.ods example to windows and test. I don’t think have tested it there until now.
The same result. When you right click on the dynamic control it crashes LibreOffice.