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