layout/forms/nsImageControlFrame.cpp

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #include "nsImageFrame.h"
   7 #include "nsIFormControlFrame.h"
   8 #include "nsPresContext.h"
   9 #include "nsGkAtoms.h"
  10 #include "nsStyleConsts.h"
  11 #include "nsFormControlFrame.h"
  12 #include "nsLayoutUtils.h"
  13 #include "mozilla/MouseEvents.h"
  14 #include "nsIContent.h"
  15
  16 using namespace mozilla;
  17
  18 typedef nsImageFrame nsImageControlFrameSuper;
  19 class nsImageControlFrame : public nsImageControlFrameSuper,
  20                             public nsIFormControlFrame
  21 {
  22 public:
  23   explicit nsImageControlFrame(nsStyleContext* aContext);
  24   ~nsImageControlFrame();
  25
  26   virtual void DestroyFrom(nsIFrame* aDestructRoot) MOZ_OVERRIDE;
  27   virtual void Init(nsIContent*       aContent,
  28                     nsContainerFrame* aParent,
  29                     nsIFrame*         aPrevInFlow) MOZ_OVERRIDE;
  30
  31   NS_DECL_QUERYFRAME
  32   NS_DECL_FRAMEARENA_HELPERS
  33
  34   virtual void Reflow(nsPresContext*           aPresContext,
  35                           nsHTMLReflowMetrics&     aDesiredSize,
  36                           const nsHTMLReflowState& aReflowState,
  37                           nsReflowStatus&          aStatus) MOZ_OVERRIDE;
  38
  39   virtual nsresult HandleEvent(nsPresContext* aPresContext,
  40                                WidgetGUIEvent* aEvent,
  41                                nsEventStatus* aEventStatus) MOZ_OVERRIDE;
  42
  43   virtual nsIAtom* GetType() const MOZ_OVERRIDE;
  44
  45 #ifdef ACCESSIBILITY
  46   virtual mozilla::a11y::AccType AccessibleType() MOZ_OVERRIDE;
  47 #endif
  48
  49 #ifdef DEBUG_FRAME_DUMP
  50   virtual nsresult GetFrameName(nsAString& aResult) const MOZ_OVERRIDE {
  51     return MakeFrameName(NS_LITERAL_STRING("ImageControl"), aResult);
  52   }
  53 #endif
  54
  55   virtual nsresult GetCursor(const nsPoint&    aPoint,
  56                              nsIFrame::Cursor& aCursor) MOZ_OVERRIDE;
  57   // nsIFormContromFrame
  58   virtual void SetFocus(bool aOn, bool aRepaint) MOZ_OVERRIDE;
  59   virtual nsresult SetFormProperty(nsIAtom* aName,
  60                                    const nsAString& aValue) MOZ_OVERRIDE;
  61 };
  62
  63
  64 nsImageControlFrame::nsImageControlFrame(nsStyleContext* aContext):
  65   nsImageControlFrameSuper(aContext)
  66 {
  67 }
  68
  69 nsImageControlFrame::~nsImageControlFrame()
  70 {
  71 }
  72
  73 void
  74 nsImageControlFrame::DestroyFrom(nsIFrame* aDestructRoot)
  75 {
  76   if (!GetPrevInFlow()) {
  77     nsFormControlFrame::RegUnRegAccessKey(this, false);
  78   }
  79   nsImageControlFrameSuper::DestroyFrom(aDestructRoot);
  80 }
  81
  82 nsIFrame*
  83 NS_NewImageControlFrame(nsIPresShell* aPresShell, nsStyleContext* aContext)
  84 {
  85   return new (aPresShell) nsImageControlFrame(aContext);
  86 }
  87
  88 NS_IMPL_FRAMEARENA_HELPERS(nsImageControlFrame)
  89
  90 void
  91 nsImageControlFrame::Init(nsIContent*       aContent,
  92                           nsContainerFrame* aParent,
  93                           nsIFrame*         aPrevInFlow)
  94 {
  95   nsImageControlFrameSuper::Init(aContent, aParent, aPrevInFlow);
  96
  97   if (aPrevInFlow) {
  98     return;
  99   }
 100
 101   mContent->SetProperty(nsGkAtoms::imageClickedPoint,
 102                         new nsIntPoint(0, 0),
 103                         nsINode::DeleteProperty<nsIntPoint>);
 104 }
 105
 106 NS_QUERYFRAME_HEAD(nsImageControlFrame)
 107   NS_QUERYFRAME_ENTRY(nsIFormControlFrame)
 108 NS_QUERYFRAME_TAIL_INHERITING(nsImageControlFrameSuper)
 109
 110 #ifdef ACCESSIBILITY
 111 a11y::AccType
 112 nsImageControlFrame::AccessibleType()
 113 {
 114   if (mContent->Tag() == nsGkAtoms::button ||
 115       mContent->Tag() == nsGkAtoms::input) {
 116     return a11y::eHTMLButtonType;
 117   }
 118
 119   return a11y::eNoType;
 120 }
 121 #endif
 122
 123 nsIAtom*
 124 nsImageControlFrame::GetType() const
 125 {
 126   return nsGkAtoms::imageControlFrame;
 127 }
 128
 129 void
 130 nsImageControlFrame::Reflow(nsPresContext*         aPresContext,
 131                            nsHTMLReflowMetrics&     aDesiredSize,
 132                            const nsHTMLReflowState& aReflowState,
 133                            nsReflowStatus&          aStatus)
 134 {
 135   DO_GLOBAL_REFLOW_COUNT("nsImageControlFrame");
 136   DISPLAY_REFLOW(aPresContext, this, aReflowState, aDesiredSize, aStatus);
 137   if (!GetPrevInFlow() && (mState & NS_FRAME_FIRST_REFLOW)) {
 138     nsFormControlFrame::RegUnRegAccessKey(this, true);
 139   }
 140   return nsImageControlFrameSuper::Reflow(aPresContext, aDesiredSize, aReflowState, aStatus);
 141 }
 142
 143 nsresult
 144 nsImageControlFrame::HandleEvent(nsPresContext* aPresContext,
 145                                  WidgetGUIEvent* aEvent,
 146                                  nsEventStatus* aEventStatus)
 147 {
 148   NS_ENSURE_ARG_POINTER(aEventStatus);
 149
 150   // Don't do anything if the event has already been handled by someone
 151   if (nsEventStatus_eConsumeNoDefault == *aEventStatus) {
 152     return NS_OK;
 153   }
 154
 155   // do we have user-input style?
 156   const nsStyleUserInterface* uiStyle = StyleUserInterface();
 157   if (uiStyle->mUserInput == NS_STYLE_USER_INPUT_NONE || uiStyle->mUserInput == NS_STYLE_USER_INPUT_DISABLED)
 158     return nsFrame::HandleEvent(aPresContext, aEvent, aEventStatus);
 159
 160   if (mContent->HasAttr(kNameSpaceID_None, nsGkAtoms::disabled)) { // XXX cache disabled
 161     return NS_OK;
 162   }
 163
 164   *aEventStatus = nsEventStatus_eIgnore;
 165
 166   if (aEvent->message == NS_MOUSE_BUTTON_UP &&
 167       aEvent->AsMouseEvent()->button == WidgetMouseEvent::eLeftButton) {
 168     // Store click point for HTMLInputElement::SubmitNamesValues
 169     // Do this on MouseUp because the specs don't say and that's what IE does
 170     nsIntPoint* lastClickPoint =
 171       static_cast<nsIntPoint*>
 172                  (mContent->GetProperty(nsGkAtoms::imageClickedPoint));
 173     if (lastClickPoint) {
 174       // normally lastClickedPoint is not null, as it's allocated in Init()
 175       nsPoint pt = nsLayoutUtils::GetEventCoordinatesRelativeTo(aEvent, this);
 176       TranslateEventCoords(pt, *lastClickPoint);
 177     }
 178   }
 179   return nsImageControlFrameSuper::HandleEvent(aPresContext, aEvent,
 180                                                aEventStatus);
 181 }
 182
 183 void
 184 nsImageControlFrame::SetFocus(bool aOn, bool aRepaint)
 185 {
 186 }
 187
 188 nsresult
 189 nsImageControlFrame::GetCursor(const nsPoint&    aPoint,
 190                                nsIFrame::Cursor& aCursor)
 191 {
 192   // Use style defined cursor if one is provided, otherwise when
 193   // the cursor style is "auto" we use the pointer cursor.
 194   FillCursorInformationFromStyle(StyleUserInterface(), aCursor);
 195
 196   if (NS_STYLE_CURSOR_AUTO == aCursor.mCursor) {
 197     aCursor.mCursor = NS_STYLE_CURSOR_POINTER;
 198   }
 199
 200   return NS_OK;
 201 }
 202
 203 nsresult
 204 nsImageControlFrame::SetFormProperty(nsIAtom* aName,
 205                                      const nsAString& aValue)
 206 {
 207   return NS_OK;
 208 }