offapi/com/sun/star/frame/Desktop.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: Desktop.idl,v $
  10  * $Revision: 1.12 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_frame_Desktop_idl__
  31 #define __com_sun_star_frame_Desktop_idl__
  32
  33 #ifndef __com_sun_star_frame_Frame_idl__
  34 #include <com/sun/star/frame/Frame.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_frame_XDesktop_idl__
  38 #include <com/sun/star/frame/XDesktop.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_frame_XComponentLoader_idl__
  42 #include <com/sun/star/frame/XComponentLoader.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_document_XEventBroadcaster_idl__
  46 #include <com/sun/star/document/XEventBroadcaster.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_beans_XPropertySet_idl__
  50 #include <com/sun/star/beans/XPropertySet.idl>
  51 #endif
  52
  53 //=============================================================================
  54
  55  module com {  module sun {  module star {  module frame {
  56
  57 //=============================================================================
  58 /** is the environment for components which can instantiate within frames
  59
  60     <p>
  61     A desktop environment contains tasks with one or more frames
  62     in which components can be loaded. The term "task" or naming a frame as a
  63     "task frame" is not in any way related to any additional implemented
  64     interfaces, it's  just because these frames use task windows.
  65     </p>
  66  */
  67 published service Desktop
  68 {
  69     //-------------------------------------------------------------------------
  70     /** make it possible to be the global root of different seperated frame trees
  71
  72         <p>
  73         It's not a must for a frame (neither a frame tree) to be a part of this
  74         global tree. But such outstanding frames won't be accessible by the normal
  75         frame api.
  76         </p>
  77      */
  78     service Frame;
  79
  80     //-------------------------------------------------------------------------
  81     /** regulate life time of desktop environment and support high level
  82         access to components of sub frame tree
  83      */
  84     interface XDesktop;
  85
  86     //-------------------------------------------------------------------------
  87     /** supports simple api for loading components into the frame environment
  88      */
  89     interface XComponentLoader;
  90
  91     //-------------------------------------------------------------------------
  92     /** @deprecated This interface is a documentation error. It was never thought to be supported
  93                     by this service. Please use the service <type cope="com::sun::star::frame">GlobalEventBroadcaster</type>
  94                     instead of this interface.
  95      */
  96     interface com::sun::star::document::XEventBroadcaster;
  97 };
  98
  99 //=============================================================================
 100
 101 }; }; }; };
 102
 103 #endif