001/*
002 * ============================================================================
003 * Copyright © 2002-2023 by Thomas Thrien.
004 * All Rights Reserved.
005 * ============================================================================
006 * Licensed to the public under the agreements of the GNU Lesser General Public
007 * License, version 3.0 (the "License"). You may obtain a copy of the License at
008 *
009 *      http://www.gnu.org/licenses/lgpl.html
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
013 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
014 * License for the specific language governing permissions and limitations
015 * under the License.
016 */
017
018package org.tquadrat.foundation.svg;
019
020import static org.apiguardian.api.API.Status.STABLE;
021
022import org.apiguardian.api.API;
023import org.tquadrat.foundation.annotation.ClassVersion;
024import org.tquadrat.foundation.svg.internal.SVGClipPathImpl;
025
026/**
027 *  The definition of the SVG {@code <clipPath>} element.
028 *
029 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
030 *  @version $Id: SVGClipPath.java 1074 2023-10-02 12:05:06Z tquadrat $
031 *  @since 0.0.5
032 *
033 *  @UMLGraph.link
034 */
035@ClassVersion( sourceVersion = "$Id: SVGClipPath.java 1074 2023-10-02 12:05:06Z tquadrat $" )
036@API( status = STABLE, since = "0.0.5" )
037public sealed interface SVGClipPath extends AllowsConditionalProcessingAttributes, AllowsPresentationAttributes, SVGElementWithChildren
038    permits SVGElementAdapter, SVGClipPathImpl
039{
040        /*---------*\
041    ====** Methods **==========================================================
042        \*---------*/
043    /**
044     *  Sets the {@value SVGUtils#SVGATTRIBUTE_ClipPathUnits} attribute that
045     *  defines the coordinate system for the contents of this
046     *  {@code <clipPath>} element.
047     *
048     *  @param  flag    {@code true} if the user coordinate system for the
049     *      contents of the {@code <clipPath>} element is established using the
050     *      bounding box of the element to which the clipping path is applied,
051     *      {@code false} if the contents of the {@code <clipPath>} element
052     *      represents values in the current user coordinate system in place at
053     *      the time when the {@code <clipPath>} element is referenced.
054     */
055    public void setClipPathUnits( final boolean flag );
056}
057//  interface SVGClipPath
058
059/*
060 *  End of File
061 */