interface XDesktop in module com::sun::star::frame::

(Global Index)

Syntax

interface XDesktop : com::sun::star::uno::XInterface ;

Description

This is the main interface of a desktop service.

A desktop is an environment for components which can be viewed in frames. Frames are like frames in HTML framesets. This does not imply that a desktop can handle framesets; the frames may be top frames only.

See also

Desktop

Method Summary

terminate tries to terminate the desktop.

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

removeTerminateListener unregisters an event listener which was registered with XDesktop::addTerminateListener .

getComponents

getCurrentComponent

getCurrentFrame

Known Services Which Export this Interface

com::sun::star::frame::Desktop

Method Details



terminate

Syntax

boolean terminate ();

Description

tries to terminate the desktop.

First, a vetoable queryTermination-event is broadcast. If no TerminationVetoException was thrown, a notifyTermination-event is broadcast and true will be returned; otherwise an abortTermination-event is broadcast and false will be returned.

See also

TerminationVetoException

See also

XTerminateListener

addTerminateListener

Syntax

oneway void addTerminateListener (
com::sun::star::frame::XTerminateListener xListener );

Description

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


removeTerminateListener

Syntax

oneway void removeTerminateListener (
com::sun::star::frame::XTerminateListener xListener );

Description

unregisters an event listener which was registered with XDesktop::addTerminateListener .


getComponents

Syntax

com::sun::star::container::XEnumerationAccess getComponents ();

Returns

a collection of all components which are loaded into a frame.

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.

See also

Components

getCurrentComponent

Syntax

com::sun::star::lang::XComponent getCurrentComponent ();

Returns

the component within the desktop environment 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.


getCurrentFrame

Syntax

com::sun::star::frame::XFrame getCurrentFrame ();

Returns

the frame of the component which has the UI focus within this desktop enviroment.
Top of Page