dom/html/HTMLOutputElement.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_HTMLOutputElement_h
   8 #define mozilla_dom_HTMLOutputElement_h
   9
  10 #include "mozilla/Attributes.h"
  11 #include "mozilla/dom/ConstraintValidation.h"
  12 #include "nsGenericHTMLElement.h"
  13 #include "nsStubMutationObserver.h"
  14
  15 namespace mozilla::dom {
  16
  17 class FormData;
  18
  19 class HTMLOutputElement final : public nsGenericHTMLFormControlElement,
  20                                 public nsStubMutationObserver,
  21                                 public ConstraintValidation {
  22  public:
  23   using ConstraintValidation::GetValidationMessage;
  24
  25   explicit HTMLOutputElement(
  26       already_AddRefed<mozilla::dom::NodeInfo>&& aNodeInfo,
  27       FromParser aFromParser = NOT_FROM_PARSER);
  28
  29   // nsISupports
  30   NS_DECL_ISUPPORTS_INHERITED
  31
  32   // nsIFormControl
  33   NS_IMETHOD Reset() override;
  34   // The output element is not submittable.
  35   NS_IMETHOD SubmitNamesValues(FormData* aFormData) override { return NS_OK; }
  36
  37   nsresult Clone(dom::NodeInfo*, nsINode** aResult) const override;
  38
  39   bool ParseAttribute(int32_t aNamespaceID, nsAtom* aAttribute,
  40                       const nsAString& aValue,
  41                       nsIPrincipal* aMaybeScriptedPrincipal,
  42                       nsAttrValue& aResult) override;
  43
  44   void DoneAddingChildren(bool aHaveNotified) override;
  45
  46   // This function is called when a callback function from nsIMutationObserver
  47   // has to be used to update the defaultValue attribute.
  48   void DescendantsChanged();
  49
  50   // nsIMutationObserver
  51   NS_DECL_NSIMUTATIONOBSERVER_CHARACTERDATACHANGED
  52   NS_DECL_NSIMUTATIONOBSERVER_CONTENTAPPENDED
  53   NS_DECL_NSIMUTATIONOBSERVER_CONTENTINSERTED
  54   NS_DECL_NSIMUTATIONOBSERVER_CONTENTREMOVED
  55
  56   NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(HTMLOutputElement,
  57                                            nsGenericHTMLFormControlElement)
  58
  59   JSObject* WrapNode(JSContext*, JS::Handle<JSObject*> aGivenProto) override;
  60
  61   // WebIDL
  62   nsDOMTokenList* HtmlFor();
  63
  64   void GetName(nsAString& aName) { GetHTMLAttr(nsGkAtoms::name, aName); }
  65
  66   void SetName(const nsAString& aName, ErrorResult& aRv) {
  67     SetHTMLAttr(nsGkAtoms::name, aName, aRv);
  68   }
  69
  70   void GetType(nsAString& aType) { aType.AssignLiteral("output"); }
  71
  72   void GetDefaultValue(nsAString& aDefaultValue) {
  73     aDefaultValue = mDefaultValue;
  74   }
  75
  76   void SetDefaultValue(const nsAString& aDefaultValue, ErrorResult& aRv);
  77
  78   void GetValue(nsAString& aValue) const;
  79   void SetValue(const nsAString& aValue, ErrorResult& aRv);
  80
  81   // nsIConstraintValidation::WillValidate is fine.
  82   // nsIConstraintValidation::Validity() is fine.
  83   // nsIConstraintValidation::GetValidationMessage() is fine.
  84   // nsIConstraintValidation::CheckValidity() is fine.
  85   void SetCustomValidity(const nsAString& aError);
  86
  87  protected:
  88   virtual ~HTMLOutputElement();
  89
  90   enum ValueModeFlag { eModeDefault, eModeValue };
  91
  92   ValueModeFlag mValueModeFlag;
  93   bool mIsDoneAddingChildren;
  94   nsString mDefaultValue;
  95   RefPtr<nsDOMTokenList> mTokenList;
  96 };
  97
  98 }  // namespace mozilla::dom
  99
 100 #endif  // mozilla_dom_HTMLOutputElement_h