Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

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

interface XDesktop

Base Interface
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


Known Services which Export this Interface

com::sun::star::frame::Desktop is the environment for components which can instantiate within frames.

Methods' 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

Methods' Details

terminate
 
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
com::sun::star::frame::TerminationVetoException
See also
XTerminateListener
addTerminateListener
 
[ oneway ] void
addTerminateListener(
[ in ] 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
 
[ oneway ] void
removeTerminateListener(
[ in ] com::sun::star::frame::XTerminateListener xListener );

Description
unregisters an event listener which was registered with XDesktop::addTerminateListener .
getComponents
 
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
 
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
 
com::sun::star::frame::XFrame
getCurrentFrame();
Returns
the frame of the component which has the UI focus within this desktop enviroment.

Top of Page