author Kevin Atkinson <>
Tue, 28 Apr 2015 18:52:16 -0400
changeset 271575 efdb01d21f4d53287e71c3114d304df701f8fc58
parent 265121 8bc7561d75577b08ae0c5449104378144a6fc9e0
child 318784 064969357fc94da487ada47c08249995b28cc560
permissions -rw-r--r--
Bug 1137544 - Upgrade en-US.dic dictionary to upstream version 2015.02.15; r=ehsan

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* 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 */

/* code for HTML client-side image maps */

#ifndef nsImageMap_h
#define nsImageMap_h

#include "mozilla/gfx/2D.h"
#include "nsCOMPtr.h"
#include "nsCoord.h"
#include "nsTArray.h"
#include "nsStubMutationObserver.h"
#include "nsIDOMEventListener.h"

class Area;
class nsImageFrame;
class nsIFrame;
class nsIContent;
struct nsRect;

class nsImageMap final : public nsStubMutationObserver,
                         public nsIDOMEventListener
  typedef mozilla::gfx::DrawTarget DrawTarget;
  typedef mozilla::gfx::ColorPattern ColorPattern;
  typedef mozilla::gfx::StrokeOptions StrokeOptions;


  nsresult Init(nsImageFrame* aImageFrame, nsIContent* aMap);

   * Return the first area element (in content order) for the given aX,aY pixel
   * coordinate or nullptr if the coordinate is outside all areas.
  nsIContent* GetArea(nscoord aX, nscoord aY) const;

   * Return area elements count associated with the image map.
  uint32_t AreaCount() const { return mAreas.Length(); }

   * Return area element at the given index.
  nsIContent* GetAreaAt(uint32_t aIndex) const;

  void Draw(nsIFrame* aFrame, DrawTarget& aDrawTarget,
            const ColorPattern& aColor,
            const StrokeOptions& aStrokeOptions = StrokeOptions());
   * Called just before the nsImageFrame releases us. 
   * Used to break the cycle caused by the DOM listener.
  void Destroy();
  // nsISupports

  // nsIMutationObserver


  nsresult GetBoundsForAreaContent(nsIContent *aContent,
                                   nsRect& aBounds);

  virtual ~nsImageMap();

  void FreeAreas();

  nsresult UpdateAreas();
  nsresult SearchForAreas(nsIContent* aParent, bool& aFoundArea,
                          bool& aFoundAnchor);

  nsresult AddArea(nsIContent* aArea);
  void MaybeUpdateAreas(nsIContent *aContent);

  nsImageFrame* mImageFrame;  // the frame that owns us
  nsCOMPtr<nsIContent> mMap;
  nsAutoTArray<Area*, 8> mAreas; // almost always has some entries
  bool mContainsBlockContents;

#endif /* nsImageMap_h */