summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/drawing/framework/XPane.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/drawing/framework/XPane.idl')
-rw-r--r--offapi/com/sun/star/drawing/framework/XPane.idl60
1 files changed, 60 insertions, 0 deletions
diff --git a/offapi/com/sun/star/drawing/framework/XPane.idl b/offapi/com/sun/star/drawing/framework/XPane.idl
new file mode 100644
index 000000000..04b7cd137
--- /dev/null
+++ b/offapi/com/sun/star/drawing/framework/XPane.idl
@@ -0,0 +1,60 @@
+/* -*- 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_drawing_framework_XPane_idl__
+#define __com_sun_star_drawing_framework_XPane_idl__
+
+#include <com/sun/star/awt/XWindow.idl>
+#include <com/sun/star/rendering/XCanvas.idl>
+#include <com/sun/star/drawing/framework/XResource.idl>
+#include <com/sun/star/drawing/framework/XRelocatableResource.idl>
+
+module com { module sun { module star { module drawing { module framework {
+
+/** A pane is an abstraction of a window and is one of the resources managed
+ by the drawing framework.
+ <p>Apart from the area that displays a view a pane may contain other
+ parts like title, menu, closer button.</p>
+ <p>The URL prefix of panes is <code>private:resource/floater</code></p>
+*/
+interface XPane
+{
+ interface XResource;
+
+ /** Return the com::sun::star::awt::XWindow of the
+ pane that is used to display a view.
+ */
+ ::com::sun::star::awt::XWindow getWindow ();
+
+ /** Return the com::sun::star::awt::XCanvas of the pane. The
+ com::sun::star::rendering::XCanvas object is expected to
+ be associated with the com::sun::star::awt::XWindow object returned by
+ getWindow().
+ @return
+ When the com::sun::star::rendering::XCanvas
+ interface is not supported then an empty reference is returned.
+ */
+ ::com::sun::star::rendering::XCanvas getCanvas ();
+};
+
+}; }; }; }; }; // ::com::sun::star::drawing::framework
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */