ooodev.adapter.frame.frame2_partial module

class ooodev.adapter.frame.frame2_partial.Frame2Partial(component, interface=com.sun.star.frame.XFrame2)

Bases: DispatchProviderPartial, DispatchInformationProviderPartial, DispatchProviderInterceptionPartial, FramesSupplierPartial, StatusIndicatorSupplierPartial

Partial class for XFrame2.

Parameters:

• component (XFrame2) –

• interface (UnoInterface | None) –

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

Constructor

Parameters:

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

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

Return type:

None

property dispatch_recorder_supplier: XDispatchRecorderSupplier | None

Provides access to the dispatch recorder of the frame.

Such recorder can be used to record dispatch requests. The supplier contains a dispatch recorder and provide the functionality to use it for any dispatch object from outside which supports the interface XDispatch. A supplier is available only, if recording was enabled. That means: if someone wishes to enable recoding on a frame he must set a supplier with a recorder object inside of it. Every user of dispatches has to check then if such supplier is available at this frame property. If value of this property is None they must call XDispatch.dispatch() on the original dispatch object. If it’s a valid value he must use the supplier by calling the method XDispatchRecorderSupplier.dispatchAndRecord() with the original dispatch object as argument.

Note

It’s not recommended to cache an already gotten supplier. Because there exist no possibility to check for enabled/disabled recording then.

since

OOo 1.1.2

Return type:

XDispatchRecorderSupplier | None

property layout_manager: LayoutManagerComp

Provides access to the LayoutManager of the frame.

When setting can be instance of XLayoutManager2 or LayoutManagerComp.

Return type:

LayoutManagerComp

property title: str

If possible it sets/gets the UI title on/from the frame container window

It depends from the type of the frame container window. If it is a system task window all will be OK. Otherwise the title can’t be set. Setting/getting of the pure value of this property must be possible in every case. Only showing on the UI can be fail.

Return type:

str

property user_defined_attributes: NameContainerComp | None

Contains user defined attributes.

When setting can be instance of XNameContainer or NameContainerComp.

Returns:

User defined attributes.

Return type:

NameContainerComp

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

Get the builder for the component.

Parameters:

component (Any) – The component.

Returns:

Builder instance.

Return type:

DefaultBuilder