← Back to branch summary

~ubuntu-branches/ubuntu/precise/kompozer/precise

« back to all changes in this revision

Viewing changes to mozilla/layout/svg/renderer/public/nsISVGRendererPathGeometry.idl

  • Committer: Bazaar Package Importer
  • Author(s): Anthony Yarusso
  • Date: 2007-08-27 01:11:03 UTC
  • Revision ID: james.westby@ubuntu.com-20070827011103-2jgf4s6532gqu2ka
Tags: upstream-0.7.10
Import upstream version 0.7.10

Show diffs side-by-side

added added

removed removed

Lines of Context:
mozilla/layout/svg/renderer/public/nsISVGRendererPathGeometry.idl
 
1
/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
 
2
/* ----- BEGIN LICENSE BLOCK -----
 
3
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 
4
 *
 
5
 * The contents of this file are subject to the Mozilla Public License
 
6
 * Version 1.1 (the "License"); you may not use this file except in
 
7
 * compliance with the License. You may obtain a copy of the License at
 
8
 * http://www.mozilla.org/MPL/
 
9
 *
 
10
 * Software distributed under the License is distributed on an "AS IS" basis,
 
11
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 
12
 * for the specific language governing rights and limitations under the
 
13
 * License.
 
14
 *
 
15
 * The Original Code is the Mozilla SVG project.
 
16
 *
 
17
 * The Initial Developer of the Original Code is 
 
18
 * Crocodile Clips Ltd.
 
19
 * Portions created by the Initial Developer are Copyright (C) 2002
 
20
 * the Initial Developer. All Rights Reserved.
 
21
 *
 
22
 * Contributor(s):
 
23
 *    Alex Fritze <alex.fritze@crocodile-clips.com> (original author)
 
24
 *
 
25
 * Alternatively, the contents of this file may be used under the terms of
 
26
 * either the GNU General Public License Version 2 or later (the "GPL"), or 
 
27
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 
28
 * in which case the provisions of the GPL or the LGPL are applicable instead
 
29
 * of those above. If you wish to allow use of your version of this file only
 
30
 * under the terms of either the GPL or the LGPL, and not to allow others to
 
31
 * use your version of this file under the terms of the NPL, indicate your
 
32
 * decision by deleting the provisions above and replace them with the notice
 
33
 * and other provisions required by the GPL or the LGPL. If you do not delete
 
34
 * the provisions above, a recipient may use your version of this file under
 
35
 * the terms of any one of the MPL, the GPL or the LGPL.
 
36
 *
 
37
 * ----- END LICENSE BLOCK ----- */
 
38
 
 
39
#include "nsISupports.idl"
 
40
 
 
41
interface nsISVGRendererRegion;
 
42
interface nsISVGRendererCanvas;
 
43
 
 
44
/**
 
45
 * \addtogroup renderer_interfaces Rendering Engine Interfaces
 
46
 * @{
 
47
 */
 
48
 
 
49
/**
 
50
 * One of a number of interfaces (all starting with nsISVGRenderer*)
 
51
 * to be implemented by an SVG rendering engine. See nsISVGRenderer
 
52
 * for more details.
 
53
 *
 
54
 * The SVG rendering backend uses this interface to communicate to the
 
55
 * rendering engine-native path objects.
 
56
 *
 
57
 * A path geometry object is instantiated by the rendering backend for
 
58
 * a given nsISVGPathGeometrySource object with a call to
 
59
 * nsISVGRenderer::createPathGeometry(). The path geometry object is
 
60
 * assumed to store a reference to its associated source object and
 
61
 * provide rendering, hit-testing and metrics for the path described
 
62
 * by the nsISVGPathGeometrySource members.
 
63
 */
 
64
[scriptable, uuid(86edbfce-7ed8-4ca5-a88e-68447bdac4e9)]
 
65
interface nsISVGRendererPathGeometry : nsISupports
 
66
{
 
67
  /**
 
68
   * Paint this object.
 
69
   *
 
70
   * @param canvas The canvas to render to.
 
71
   */
 
72
  void render(in nsISVGRendererCanvas canvas);
 
73
  
 
74
  /**
 
75
   * Called by this object's corresponding nsISVGPathGeometrySource as
 
76
   * a notification that some of the source's data (identified by
 
77
   * paramter 'updatemask') has changed.
 
78
   *
 
79
   * @param updatemask An OR-ed combination of the UPDATEMASK_*
 
80
   * constants defined in nsISVGPathGeometrySource.
 
81
   * @return Region that needs to be redrawn.
 
82
   */
 
83
  nsISVGRendererRegion update(in unsigned long updatemask);
 
84
  
 
85
  /**
 
86
   * Get a region object describing the area covered with paint by
 
87
   * this path geometry.
 
88
   *
 
89
   * @return Covered region.
 
90
   */
 
91
  nsISVGRendererRegion getCoveredRegion();
 
92
 
 
93
  /**
 
94
   * Hit-testing method. Does this path geometry (with all relevant
 
95
   * transformations applied) contain the point x,y? Mode of operation
 
96
   * (e.g. whether to test fill or stroke) is determined by
 
97
   * nsISVGPathGeometrySource::hittestMask.
 
98
   *
 
99
   * @param x X-coordinate of test point.  @param y Y-coordinate of
 
100
   * test point.
 
101
   * @return PR_TRUE if the path geometry contains the point,
 
102
   * PR_FALSE otherwise.
 
103
   */
 
104
  boolean containsPoint(in float x, in float y);
 
105
  
 
106
  /* XXX segment at length, point at length */
 
107
};
 
108
 
 
109
/** @} */