ooodev.adapter.frame.desktop_partial module

class ooodev.adapter.frame.desktop_partial.DesktopPartial(component, interface=com.sun.star.frame.XDesktop)

Bases: object

Partial class for XDesktop.

Parameters:

• component (XDesktop) –

• interface (UnoInterface | None) –

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

Constructor

Parameters:

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

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

Return type:

None

add_terminate_listener(listener)

Registers an event listener to the desktop, which is called when the desktop is queried to terminate, and when it really terminates.

Return type:

None

Parameters:

listener (com.sun.star.frame.XTerminateListener) –

get_components()

Provides read access to collection of all currently loaded components inside the frame tree

The component is, by definition, the model of the control which is loaded into a frame, or if no model exists, into the control itself. The service Components which is available from this method is a collection of all components of the desktop which are open within a frame of the desktop.

Return type:

XEnumerationAccess

get_current_component()

Provides read access to the component inside the tree which has the UI focus

Normally, the component is the model part of the active component. If no model exists it is the active controller (view) itself.

Return type:

XComponent

get_current_frame()

provides read access to the frame which contains the current component

Return type:

XFrame

remove_terminate_listener(listener)

Un-registers an event listener for termination events.

Return type:

None

Parameters:

listener (com.sun.star.frame.XTerminateListener) –

terminate()

Tries to terminate the desktop.

First, every terminate listener is called by this XTerminateListener.queryTermination() method. Throwing of a TerminationVetoException can break the termination process and the listener how has done that will be the new controller of the desktop lifetime. Should try to terminate it by itself after his own processes will be finished. If nobody disagree with the termination request, every listener will be called by his XTerminateListener.notifyTermination() method.

Return type:

bool