dom/html/HTMLOptionElement.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef mozilla_dom_HTMLOptionElement_h__
   8 #define mozilla_dom_HTMLOptionElement_h__
   9
  10 #include "mozilla/Attributes.h"
  11 #include "nsGenericHTMLElement.h"
  12 #include "mozilla/dom/HTMLFormElement.h"
  13
  14 namespace mozilla {
  15 namespace dom {
  16
  17 class HTMLSelectElement;
  18
  19 class HTMLOptionElement final : public nsGenericHTMLElement {
  20  public:
  21   explicit HTMLOptionElement(
  22       already_AddRefed<mozilla::dom::NodeInfo>&& aNodeInfo);
  23
  24   static already_AddRefed<HTMLOptionElement> Option(
  25       const GlobalObject& aGlobal, const nsAString& aText,
  26       const Optional<nsAString>& aValue, bool aDefaultSelected, bool aSelected,
  27       ErrorResult& aError);
  28
  29   NS_IMPL_FROMNODE_HTML_WITH_TAG(HTMLOptionElement, option)
  30
  31   // nsISupports
  32   NS_INLINE_DECL_REFCOUNTING_INHERITED(HTMLOptionElement, nsGenericHTMLElement)
  33
  34   using mozilla::dom::Element::GetText;
  35
  36   bool Selected() const { return mIsSelected; }
  37   void SetSelected(bool aValue);
  38
  39   void SetSelectedChanged(bool aValue) { mSelectedChanged = aValue; }
  40
  41   virtual nsChangeHint GetAttributeChangeHint(const nsAtom* aAttribute,
  42                                               int32_t aModType) const override;
  43
  44   virtual nsresult BeforeSetAttr(int32_t aNamespaceID, nsAtom* aName,
  45                                  const nsAttrValueOrString* aValue,
  46                                  bool aNotify) override;
  47   virtual nsresult AfterSetAttr(int32_t aNameSpaceID, nsAtom* aName,
  48                                 const nsAttrValue* aValue,
  49                                 const nsAttrValue* aOldValue,
  50                                 nsIPrincipal* aSubjectPrincipal,
  51                                 bool aNotify) override;
  52
  53   void SetSelectedInternal(bool aValue, bool aNotify);
  54
  55   /**
  56    * This callback is called by an optgroup on all its option elements whenever
  57    * its disabled state is changed so that option elements can know their
  58    * disabled state might have changed.
  59    */
  60   void OptGroupDisabledChanged(bool aNotify);
  61
  62   /**
  63    * Check our disabled content attribute and optgroup's (if it exists) disabled
  64    * state to decide whether our disabled flag should be toggled.
  65    */
  66   void UpdateDisabledState(bool aNotify);
  67
  68   virtual nsresult BindToTree(BindContext&, nsINode& aParent) override;
  69   virtual void UnbindFromTree(bool aNullParent = true) override;
  70
  71   // nsIContent
  72   virtual EventStates IntrinsicState() const override;
  73
  74   virtual nsresult Clone(dom::NodeInfo*, nsINode** aResult) const override;
  75
  76   nsresult CopyInnerTo(mozilla::dom::Element* aDest);
  77
  78   bool Disabled() const { return GetBoolAttr(nsGkAtoms::disabled); }
  79
  80   void SetDisabled(bool aValue, ErrorResult& aRv) {
  81     SetHTMLBoolAttr(nsGkAtoms::disabled, aValue, aRv);
  82   }
  83
  84   HTMLFormElement* GetForm();
  85
  86   void GetRenderedLabel(nsAString& aLabel) {
  87     if (!GetAttr(kNameSpaceID_None, nsGkAtoms::label, aLabel) ||
  88         aLabel.IsEmpty()) {
  89       GetText(aLabel);
  90     }
  91   }
  92
  93   void GetLabel(DOMString& aLabel) {
  94     if (!GetAttr(kNameSpaceID_None, nsGkAtoms::label, aLabel)) {
  95       GetText(aLabel);
  96     }
  97   }
  98   void SetLabel(const nsAString& aLabel, ErrorResult& aError) {
  99     SetHTMLAttr(nsGkAtoms::label, aLabel, aError);
 100   }
 101
 102   bool DefaultSelected() const {
 103     return HasAttr(kNameSpaceID_None, nsGkAtoms::selected);
 104   }
 105   void SetDefaultSelected(bool aValue, ErrorResult& aRv) {
 106     SetHTMLBoolAttr(nsGkAtoms::selected, aValue, aRv);
 107   }
 108
 109   void GetValue(nsAString& aValue) {
 110     if (!GetAttr(kNameSpaceID_None, nsGkAtoms::value, aValue)) {
 111       GetText(aValue);
 112     }
 113   }
 114   void SetValue(const nsAString& aValue, ErrorResult& aRv) {
 115     SetHTMLAttr(nsGkAtoms::value, aValue, aRv);
 116   }
 117
 118   void GetText(nsAString& aText);
 119   void SetText(const nsAString& aText, ErrorResult& aRv);
 120
 121   int32_t Index();
 122
 123  protected:
 124   virtual ~HTMLOptionElement();
 125
 126   virtual JSObject* WrapNode(JSContext* aCx,
 127                              JS::Handle<JSObject*> aGivenProto) override;
 128
 129   /**
 130    * Get the select content element that contains this option, this
 131    * intentionally does not return nsresult, all we care about is if
 132    * there's a select associated with this option or not.
 133    */
 134   HTMLSelectElement* GetSelect();
 135
 136   bool mSelectedChanged;
 137   bool mIsSelected;
 138
 139   // True only while we're under the SetOptionsSelectedByIndex call when our
 140   // "selected" attribute is changing and mSelectedChanged is false.
 141   bool mIsInSetDefaultSelected;
 142 };
 143
 144 }  // namespace dom
 145 }  // namespace mozilla
 146
 147 #endif  // mozilla_dom_HTMLOptionElement_h__