Overview | Module | Use | Devguide | Index

Methods' Summary | Methods' Details | Attributes' Summary | Attributes' Details

:: com :: sun :: star :: frame ::
interface XDesktop
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-XDesktop
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 Developers Guide 6.1.2 Office Development - OpenOffice.org Application Environment - Using the Desktop

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 for termination events.
getComponents | provides read access to collection of all currently loaded components inside the frame tree
getCurrentComponent | provides read access to the component inside the tree which has the UI focus
getCurrentFrame | provides read access to the frame wich contains the current component

Methods' Details
terminate
boolean terminate(); |  |
Description tries to terminate the desktop. First, every terminate listener is called by his 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. He should try to terminate it by himself after his own processes will be finished. If nobody disagree with the termination request, every listener will be called by his XTerminateListener::notifyTermination() method. Returns true if all listener agree with this request false otherwise See also XTerminateListener See also TerminationVetoException
addTerminateListener
[oneway] void addTerminateListener( | [in] XTerminateListener | Listener );
Description registers an event listener to the desktop, which is called when the desktop is queried to terminate, and when it really terminates. Parameter Listener listener for termination events See also XDesktop::removeTerminateListener()
removeTerminateListener
[oneway] void removeTerminateListener( | [in] XTerminateListener | Listener );
Description unregisters an event listener for termination events. Parameter Listener listener which wish to be deregistered See also XDesktop::addTerminateListener()
getComponents
::com::sun::star::container::XEnumerationAccess getComponents(); |  |
Description 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. Returns the collection of all components See also Components
getCurrentComponent
::com::sun::star::lang::XComponent getCurrentComponent(); |  |
Description 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. Returns the component within the desktop environment which has the UI focus. See also XDesktop::getCurrentFrame()
getCurrentFrame
XFrame getCurrentFrame(); |  |
Description provides read access to the frame wich contains the current component Returns the frame of the component which has the UI focus within this desktop enviroment See also XDesktop::getCurrentComponent()

Top of Page

Copyright © 2003 Sun Microsystems, Inc.