ooodev.adapter.frame.frames_supplier_partial module

class ooodev.adapter.frame.frames_supplier_partial.FramesSupplierPartial(component, interface=com.sun.star.frame.XFramesSupplier)

Bases: FramePartial

Partial class for XFramesSupplier.

Parameters:

• component (XFramesSupplier) –

• interface (UnoInterface | None) –

__init__(component, interface=com.sun.star.frame.XFramesSupplier)

Constructor

Parameters:

• component (XFramesSupplier) – UNO Component that implements com.sun.star.frame.XFramesSupplier interface.

• interface (UnoInterface, optional) – The interface to be validated. Defaults to XFramesSupplier.

Return type:

None

get_active_frame()

Gets the current active frame of this container (not of any other available supplier)

This may be the frame itself. The active frame is defined as the frame which contains (recursively) the window with the focus. If no window within the frame contains the focus, this method returns the last frame which had the focus. If no containing window ever had the focus, the first frame within this frame is returned.

Return type:

XFrame

get_frames()

Provides access to this container and to all other XFramesSupplier which are available from this node of frame tree.

Return type:

XFrames

set_active_frame(frame)

Is called on activation of a direct sub-frame.

This method is only allowed to be called by a sub-frame according to XFrame.activate() or XFramesSupplier.setActiveFrame(). After this call XFramesSupplier.getActiveFrame() will return the frame specified by Frame.

In general this method first calls the method XFramesSupplier.setActiveFrame() at the creator frame with this as the current argument. Then it broadcasts the FrameActionEvent FrameAction.FRAME_ACTIVATED.

Note

Given parameter Frame must already exist inside the container (e.g., inserted by using XFrames.append())

Return type:

None

Parameters:

frame (XFrame) –

ooodev.adapter.frame.frames_supplier_partial.get_builder(component)

Get the builder for the component.

Parameters:

component (Any) – The component.

Returns:

Builder instance.

Return type:

DefaultBuilder