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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_frame_FrameControl_idl__
  20 #define __com_sun_star_frame_FrameControl_idl__
  21
  22 #include <com/sun/star/awt/UnoControl.idl>
  23 #include <com/sun/star/beans/XPropertySet.idl>
  24
  25
  26  module com {  module sun {  module star {  module frame {
  27
  28 /** contains a frame with a desktop component
  29
  30     <p>
  31     If the control is visible and has a valid (loadable) component URL,
  32     then the FrameControl::Frame property is set.
  33     Normally this control can be used for preview functionality inside
  34     any UI.
  35     </p>
  36  */
  37 published service FrameControl
  38 {
  39     /** the base service of all controls
  40      */
  41     service com::sun::star::awt::UnoControl;
  42
  43     /** contains the type of the component which is loaded into the frame,
  44         or the document which implicitly specifies the type
  45      */
  46     [property] string ComponentUrl;
  47
  48     /** the frame held by this control
  49
  50         <p>
  51         The Frame is created if the control
  52         is shown and the #ComponentUrl is set.
  53         </p>
  54      */
  55     [property, readonly] string Frame;
  56 };
  57
  58
  59 }; }; }; };
  60
  61 #endif
  62
  63 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */