summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/rendering/XLinePolyPolygon2D.idl
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:06:44 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:06:44 +0000
commited5640d8b587fbcfed7dd7967f3de04b37a76f26 (patch)
tree7a5f7c6c9d02226d7471cb3cc8fbbf631b415303 /offapi/com/sun/star/rendering/XLinePolyPolygon2D.idl
parentInitial commit. (diff)
downloadlibreoffice-ed5640d8b587fbcfed7dd7967f3de04b37a76f26.tar.xz
libreoffice-ed5640d8b587fbcfed7dd7967f3de04b37a76f26.zip
Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'offapi/com/sun/star/rendering/XLinePolyPolygon2D.idl')
-rw-r--r--offapi/com/sun/star/rendering/XLinePolyPolygon2D.idl108
1 files changed, 108 insertions, 0 deletions
diff --git a/offapi/com/sun/star/rendering/XLinePolyPolygon2D.idl b/offapi/com/sun/star/rendering/XLinePolyPolygon2D.idl
new file mode 100644
index 000000000..578747949
--- /dev/null
+++ b/offapi/com/sun/star/rendering/XLinePolyPolygon2D.idl
@@ -0,0 +1,108 @@
+/* -*- 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_rendering_XLinePolyPolygon2D_idl__
+#define __com_sun_star_rendering_XLinePolyPolygon2D_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+#include <com/sun/star/lang/IndexOutOfBoundsException.idl>
+#include <com/sun/star/geometry/RealPoint2D.idl>
+#include <com/sun/star/rendering/XPolyPolygon2D.idl>
+
+module com { module sun { module star { module rendering {
+
+/** Specialized interface for a 2D poly-polygon containing only straight line segments.
+
+ @since OOo 2.0
+ */
+interface XLinePolyPolygon2D : XPolyPolygon2D
+{
+ /** Query subset of this poly-polygon, starting at the given
+ polygon and the given point within that polygon, and
+ containing the specified number of polygons and points in the
+ last polygon.
+
+ @param nPolygonIndex
+ The index number of the polygon to start with extracting
+ points. Set to 0 to start with the first polygon.
+
+ @param nNumberOfPolygons
+ The number of polygons, starting with nPolygonIndex, to
+ extract points from. Set to -1 to extract all polygons,
+ starting with nPolygonIndex (i.e. a total of
+ getNumberOfPolygons() - nPolygonIndex polygons is extracted).
+
+ @param nPointIndex
+ The index of the point within the first polygon (that with the
+ index number nPolygonIndex) to start extraction with. Set to 0
+ to start with the first point in this polygon.
+
+ @param nNumberOfPoints
+ The number of points in the last polygon of the extraction
+ sequence, to be extracted. Set to -1 to extract all points
+ from the last polygon.
+ */
+ sequence< sequence< ::com::sun::star::geometry::RealPoint2D > > getPoints( [in] long nPolygonIndex, [in] long nNumberOfPolygons, [in] long nPointIndex, [in] long nNumberOfPoints )
+ raises (com::sun::star::lang::IndexOutOfBoundsException);
+
+
+ /** Set the specified sequence of points to the poly-polygon.
+
+ This method can either set the whole poly-polygon to the new
+ data, or insert the points at the given index
+
+ @param points the points.
+
+ @param nPolygonIndex
+ The index of the polygon to start point insertion with. This
+ index must be in the range [0,numPolygons], and the insertion
+ will take place <em>before</em> this position (i.e. when
+ specifying 0 here, the given point sequence will precede all
+ existing polygons already within the poly-polygon). To append
+ to a poly-polygon, call setPoints() with
+ XLinePolyPolygon2D::getNumberOfPolygons()
+ as the polygon index. If nPolygonIndex is -1, the given
+ sequence of points <em>replaces</em> the poly-polygon content,
+ such that after this method completes, it contains exactly the
+ specified point data.
+
+ @throws com::sun::star::lang::IndexOutOfBoundsException
+ if one of the given values exceed the permissible range.
+ */
+ void setPoints( [in] sequence< sequence< ::com::sun::star::geometry::RealPoint2D > > points, [in] long nPolygonIndex )
+ raises (com::sun::star::lang::IndexOutOfBoundsException);
+
+
+ /** Get a single point from the poly-polygon
+ */
+ ::com::sun::star::geometry::RealPoint2D getPoint( [in] long nPolygonIndex, [in] long nPointIndex )
+ raises (com::sun::star::lang::IndexOutOfBoundsException);
+
+
+ /** Set a single point on the poly-polygon. The remaining points of
+ the poly-polygon will not be changed by this method.
+ */
+ void setPoint( [in] ::com::sun::star::geometry::RealPoint2D point, [in] long nPolygonIndex, [in] long nPointIndex )
+ raises (com::sun::star::lang::IndexOutOfBoundsException);
+};
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */