1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_frame_FrameControl_idl__
24#define __com_sun_star_frame_FrameControl_idl__
25
26#ifndef __com_sun_star_awt_UnoControl_idl__
27#include <com/sun/star/awt/UnoControl.idl>
28#endif
29
30#ifndef __com_sun_star_beans_XPropertySet_idl__
31#include <com/sun/star/beans/XPropertySet.idl>
32#endif
33
34//=============================================================================
35
36 module com {  module sun {  module star {  module frame {
37
38//=============================================================================
39/** contains a frame with a desktop component
40
41    <p>
42    If the control is visible and has a valid (loadable) component URL,
43    then the <member>FrameControl::Frame</member> property is set.
44    Normally this control can be used for preview functionality inside
45    any UI.
46    </p>
47 */
48published service FrameControl
49{
50	//-------------------------------------------------------------------------
51    /** the base service of all controls
52	 */
53	service com::sun::star::awt::UnoControl;
54
55	//-------------------------------------------------------------------------
56	/** contains the type of the component which is loaded into the frame,
57        or the document which implicitly specifies the type
58	 */
59	[property] string ComponentUrl;
60
61	//-------------------------------------------------------------------------
62    /** the frame held by this control
63
64        <p>
65        The <type>Frame</type> is created if the control
66        is shown and the <member>ComponentUrl</member> is set.
67        </p>
68	 */
69    [property, readonly] string Frame;
70};
71
72//=============================================================================
73
74}; }; }; };
75
76#endif
77