summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/drawing/XShapeGrouper.idl
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--offapi/com/sun/star/drawing/XShapeGrouper.idl75
1 files changed, 75 insertions, 0 deletions
diff --git a/offapi/com/sun/star/drawing/XShapeGrouper.idl b/offapi/com/sun/star/drawing/XShapeGrouper.idl
new file mode 100644
index 000000000..1fe63b1c5
--- /dev/null
+++ b/offapi/com/sun/star/drawing/XShapeGrouper.idl
@@ -0,0 +1,75 @@
+/* -*- 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_XShapeGrouper_idl__
+#define __com_sun_star_drawing_XShapeGrouper_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+
+#include <com/sun/star/drawing/XShapeGroup.idl>
+
+#include <com/sun/star/drawing/XShapes.idl>
+
+
+
+ module com { module sun { module star { module drawing {
+
+
+/** specifies the group/ungroup functionality.
+ */
+published interface XShapeGrouper: com::sun::star::uno::XInterface
+{
+
+ /** groups the Shapes inside a collection.
+
+ <p>Grouping of objects in text documents works only if none
+ of the objects has an anchor of type
+ com::sun::star::text::TextContentAnchorType::AS_CHARACTER .
+ </p>
+
+ @param xShapes
+ the Shapes that will be grouped. They
+ must all be inserted into the same GenericDrawPage.
+
+ @returns
+ a newly created GroupShape that contains all
+ Shapes from xShapes and is also added to the
+ GenericDrawPage of the Shapes
+ in xShapes.
+ */
+ com::sun::star::drawing::XShapeGroup group( [in] com::sun::star::drawing::XShapes xShapes );
+
+
+ /** ungroups a given GroupShape.
+
+ @param aGroup
+ moves all Shapes from this GroupShape
+ to the parent XShapes of the GroupShape.
+ The GroupShape is then removed from the
+ GenericDrawPage and disposed.
+ */
+ void ungroup( [in] com::sun::star::drawing::XShapeGroup aGroup );
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */