summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/frame/XController2.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/frame/XController2.idl')
-rw-r--r--offapi/com/sun/star/frame/XController2.idl77
1 files changed, 77 insertions, 0 deletions
diff --git a/offapi/com/sun/star/frame/XController2.idl b/offapi/com/sun/star/frame/XController2.idl
new file mode 100644
index 000000000..23c64f1a1
--- /dev/null
+++ b/offapi/com/sun/star/frame/XController2.idl
@@ -0,0 +1,77 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#ifndef __com_sun_star_frame_XController2_idl__
+#define __com_sun_star_frame_XController2_idl__
+
+#include <com/sun/star/frame/XController.idl>
+#include <com/sun/star/awt/XWindow.idl>
+#include <com/sun/star/beans/PropertyValue.idl>
+#include <com/sun/star/ui/XSidebarProvider.idl>
+
+
+module com { module sun { module star { module frame {
+
+
+/** extends the XController interface
+
+ @since OOo 3.0
+*/
+interface XController2 : XController
+{
+ /** denotes the &quot;root window&quot; of the controller.
+
+ <p>If the controller is plugged into a frame, this window acts as the
+ frame's <code>ComponentWindow</code>.</p>
+
+ @see XFrame
+ */
+ [readonly, attribute] ::com::sun::star::awt::XWindow ComponentWindow;
+
+ /** specifies the view name of the controller.
+
+ <p>A view name is a logical name, which can be used to create views of the same
+ type. The name is meaningful only in conjunction with XModel2::createViewController()
+ - if it's passed there, a view/controller pair of the same type will be created.</p>
+ */
+ [readonly, attribute] string ViewControllerName;
+
+ /** denotes the arguments used to create the instance.
+
+ <p>Usually, controllers are created via XModel2::createViewController(), where the
+ caller can pass not only a controller name, but also arguments parameterizing the to-be-created instance.
+ Those arguments used at creation time can subsequently be retrieved using the <code>CreationArguments</code>
+ member.</p>
+ */
+ [readonly, attribute] sequence< ::com::sun::star::beans::PropertyValue >
+ CreationArguments;
+
+ /** get the sidebar if exists
+ @since LibreOffice 5.1
+ */
+ ::com::sun::star::ui::XSidebarProvider getSidebar();
+};
+
+
+}; }; }; };
+
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */