summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/frame/FrameControl.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/frame/FrameControl.idl')
-rw-r--r--offapi/com/sun/star/frame/FrameControl.idl80
1 files changed, 80 insertions, 0 deletions
diff --git a/offapi/com/sun/star/frame/FrameControl.idl b/offapi/com/sun/star/frame/FrameControl.idl
new file mode 100644
index 000000000000..d05819970559
--- /dev/null
+++ b/offapi/com/sun/star/frame/FrameControl.idl
@@ -0,0 +1,80 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2010 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org. If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+#ifndef __com_sun_star_frame_FrameControl_idl__
+#define __com_sun_star_frame_FrameControl_idl__
+
+#ifndef __com_sun_star_awt_UnoControl_idl__
+#include <com/sun/star/awt/UnoControl.idl>
+#endif
+
+#ifndef __com_sun_star_beans_XPropertySet_idl__
+#include <com/sun/star/beans/XPropertySet.idl>
+#endif
+
+//=============================================================================
+
+ module com { module sun { module star { module frame {
+
+//=============================================================================
+/** contains a frame with a desktop component
+
+ <p>
+ If the control is visible and has a valid (loadable) component URL,
+ then the <member>FrameControl::Frame</member> property is set.
+ Normaly this control can be used for preview functionality inside
+ any UI.
+ </p>
+ */
+published service FrameControl
+{
+ //-------------------------------------------------------------------------
+ /** the base service of all controls
+ */
+ service com::sun::star::awt::UnoControl;
+
+ //-------------------------------------------------------------------------
+ /** contains the type of the component which is loaded into the frame,
+ or the document which implicitly specifies the type
+ */
+ [property] string ComponentUrl;
+
+ //-------------------------------------------------------------------------
+ /** the frame held by this control
+
+ <p>
+ The <type>Frame</type> is created if the control
+ is shown and the <member>ComponentUrl</member> is set.
+ </p>
+ */
+ [property, readonly] string Frame;
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif