tdegraphics/ksvg/dom/SVGPolylineElement.h

/*
    Copyright (C) 2001-2003 KSVG Team
    This file is part of the KDE project

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public
    License along with this library; see the file COPYING.LIB.  If
    not, write to the Free Software Foundation, Inc., 51 Franklin Street,
    Fifth Floor, Boston, MA 02110-1301, USA.


    This file includes excerpts from the Scalable Vector Graphics
    (SVG) 1.0 Specification (Proposed Recommendation)
    http://www.w3.org/TR/SVG

    Copyright <EFBFBD> 2001 World Wide Web Consortium, (Massachusetts
    Institute of Technology, Institut National de Recherche en
    Informatique et en Automatique, Keio University).
    All Rights Reserved.

    $Id$
 */

#ifndef SVGPolylineElement_H
#define SVGPolylineElement_H

#include "SVGElement.h"
#include "SVGTests.h"
#include "SVGLangSpace.h"
#include "SVGExternalResourcesRequired.h"
#include "SVGStylable.h"
#include "SVGTransformable.h"
#include "SVGAnimatedPoints.h"

namespace KSVG
{

/**
 * The <code>polyline</code> element defines a set of connected
 * straight line segments. Typically, <code>polyline</code> elements
 * define open shapes.
 *
 * For more info look here : <a href =
 * "http://www.w3.org/TR/SVG/shapes.html#PolylineElement">9.6 The
 * 'polyline' element</a>.
 */
class SVGPointList;
class SVGPolylineElementImpl;
class SVGPolylineElement : public SVGElement,
						   public SVGTests,
						   public SVGLangSpace,
						   public SVGExternalResourcesRequired,
						   public SVGStylable,
						   public SVGTransformable,
						   public SVGAnimatedPoints
{
public:
	SVGPolylineElement();
	SVGPolylineElement(const SVGPolylineElement &);
	SVGPolylineElement &operator=(const SVGPolylineElement &);
	SVGPolylineElement(SVGPolylineElementImpl *);
	~SVGPolylineElement();

	/**
	 * Provides access to the base (i.e., static) contents of the
	 * points attribute.
	 *
	 * @return A static list of the polygons points
	 */
	SVGPointList points();

	/**
	 * Provides access to the current animated contents of the points
	 * attribute.
	 * If the given attribute or property is being animated, contains
	 * the current animated value of the attribute or property.
	 * If the given attribute or property is not currently being
	 * animated, contains the same value as <code>points</code>'.
	 *
	 * This attribute is animatable.
	 *
	 * @return A list of the polygons points
	 */
	SVGPointList animatedPoints();

	// Internal! - NOT PART OF THE SVG SPECIFICATION
	SVGPolylineElementImpl *handle() const { return impl; }

private:
	SVGPolylineElementImpl *impl;
};

}

#endif