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.SVGSymbolImpl;
025import org.tquadrat.foundation.svg.type.SVGNumber;
026import org.tquadrat.foundation.svg.type.SVGPreserveAspectRatio;
027
028/**
029 *  The definition of the SVG element {@code <symbol>}. <br>
030 *  <br>A {@code <symbol>} element is useless without the attribute {@code id}
031 *  set; therefore it is required already on creation and will not appear in
032 *  this interface.
033 *
034 *  @see SVGUtils#createSymbol(String)
035 *  @see SVGUtils#createSymbol(String,SVG)
036 *
037 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
038 *  @version $Id: SVGSymbol.java 1074 2023-10-02 12:05:06Z tquadrat $
039 *  @since 0.0.5
040 *
041 *  @see "https://www.w3.org/TR/SVG/single-page.html#struct-SVGElement"
042 *
043 *  @UMLGraph.link
044 */
045@ClassVersion( sourceVersion = "$Id: SVGSymbol.java 1074 2023-10-02 12:05:06Z tquadrat $" )
046@API( status = STABLE, since = "0.0.5" )
047public sealed interface SVGSymbol extends SVGElementWithChildren, AllowsGraphicalEventAttributes, AllowsPresentationAttributes, AllowsStyleAttributes
048    permits SVGElementAdapter, SVGSymbolImpl
049{
050        /*---------*\
051    ====** Methods **==========================================================
052        \*---------*/
053    /**
054     *  Sets the attribute that indicates whether external resources are
055     *  required to render this {@code <symbol>} element.
056     *
057     *  @param  flag    {@code true} if external resources are needed,
058     *      {@code false} if all required resources are local to the current
059     *      context.
060     */
061    public void setExternalResourcesRequired( final boolean flag );
062
063    /**
064     *  Sets the mode for the aspect ratio preservation for this
065     *  {@code <symbol>} element.
066     *
067     *  @param  value   The type; if {@code null} the
068     *      attribute will be removed.
069     */
070    public void setPreserveAspectRatio( final SVGPreserveAspectRatio value );
071
072    /**
073     *  Defines the visible area for this {@code <symbol>} element.
074     *
075     *  @param  x   The x coordinate of top left corner of the area.
076     *  @param  y   The y coordinate of top left corner of the area.
077     *  @param  width   The width of the area.
078     *  @param  height  The height of the area.
079     */
080    @SuppressWarnings( "UseOfConcreteClass" )
081    public void setViewBox( final SVGNumber x, final SVGNumber y, final SVGNumber width, final SVGNumber height );
082}
083//  interface SVGSymbol
084
085/*
086 *  End of File
087 */