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
  20
  21  module com {  module sun {  module star {  module frame {
  22
  23 /** contains a frame with a desktop component
  24
  25     <p>
  26     If the control is visible and has a valid (loadable) component URL,
  27     then the FrameControl::Frame property is set.
  28     Normally this control can be used for preview functionality inside
  29     any UI.
  30     </p>
  31  */
  32 published service FrameControl
  33 {
  34     /** the base service of all controls
  35      */
  36     service com::sun::star::awt::UnoControl;
  37
  38     /** contains the type of the component which is loaded into the frame,
  39         or the document which implicitly specifies the type
  40      */
  41     [property] string ComponentUrl;
  42
  43     /** the frame held by this control
  44
  45         <p>
  46         The Frame is created if the control
  47         is shown and the #ComponentUrl is set.
  48         </p>
  49      */
  50     [property, readonly] string Frame;
  51 };
  52
  53
  54 }; }; }; };
  55
  56 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */