1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_frame_FrameControl_idl__
28#define __com_sun_star_frame_FrameControl_idl__
29
30#ifndef __com_sun_star_awt_UnoControl_idl__
31#include <com/sun/star/awt/UnoControl.idl>
32#endif
33
34#ifndef __com_sun_star_beans_XPropertySet_idl__
35#include <com/sun/star/beans/XPropertySet.idl>
36#endif
37
38//=============================================================================
39
40 module com {  module sun {  module star {  module frame {
41
42//=============================================================================
43/** contains a frame with a desktop component
44
45    <p>
46    If the control is visible and has a valid (loadable) component URL,
47    then the <member>FrameControl::Frame</member> property is set.
48    Normaly this control can be used for preview functionality inside
49    any UI.
50    </p>
51 */
52published service FrameControl
53{
54	//-------------------------------------------------------------------------
55    /** the base service of all controls
56	 */
57	service com::sun::star::awt::UnoControl;
58
59	//-------------------------------------------------------------------------
60	/** contains the type of the component which is loaded into the frame,
61        or the document which implicitly specifies the type
62	 */
63	[property] string ComponentUrl;
64
65	//-------------------------------------------------------------------------
66    /** the frame held by this control
67
68        <p>
69        The <type>Frame</type> is created if the control
70        is shown and the <member>ComponentUrl</member> is set.
71        </p>
72	 */
73    [property, readonly] string Frame;
74};
75
76//=============================================================================
77
78}; }; }; };
79
80#endif
81