offapi/com/sun/star/frame/FrameControl.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: FrameControl.idl,v $
  10  * $Revision: 1.8 $
  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_FrameControl_idl__
  31 #define __com_sun_star_frame_FrameControl_idl__
  32
  33 #ifndef __com_sun_star_awt_UnoControl_idl__
  34 #include <com/sun/star/awt/UnoControl.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_beans_XPropertySet_idl__
  38 #include <com/sun/star/beans/XPropertySet.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43  module com {  module sun {  module star {  module frame {
  44
  45 //=============================================================================
  46 /** contains a frame with a desktop component
  47
  48     <p>
  49     If the control is visible and has a valid (loadable) component URL,
  50     then the <member>FrameControl::Frame</member> property is set.
  51     Normaly this control can be used for preview functionality inside
  52     any UI.
  53     </p>
  54  */
  55 published service FrameControl
  56 {
  57     //-------------------------------------------------------------------------
  58     /** the base service of all controls
  59      */
  60     service com::sun::star::awt::UnoControl;
  61
  62     //-------------------------------------------------------------------------
  63     /** contains the type of the component which is loaded into the frame,
  64         or the document which implicitly specifies the type
  65      */
  66     [property] string ComponentUrl;
  67
  68     //-------------------------------------------------------------------------
  69     /** the frame held by this control
  70
  71         <p>
  72         The <type>Frame</type> is created if the control
  73         is shown and the <member>ComponentUrl</member> is set.
  74         </p>
  75      */
  76     [property, readonly] string Frame;
  77 };
  78
  79 //=============================================================================
  80
  81 }; }; }; };
  82
  83 #endif