dom/html/nsRadioVisitor.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 _nsRadioVisitor_h__
   8 #define _nsRadioVisitor_h__
   9
  10 #include "mozilla/Attributes.h"
  11 #include "nsIRadioVisitor.h"
  12
  13 class nsIFormControl;
  14
  15 /**
  16  * nsRadioVisitor is the base class implementing nsIRadioVisitor and inherited
  17  * by all radio visitors.
  18  */
  19 class nsRadioVisitor : public nsIRadioVisitor {
  20  protected:
  21   virtual ~nsRadioVisitor() {}
  22
  23  public:
  24   nsRadioVisitor() {}
  25
  26   NS_DECL_ISUPPORTS
  27
  28   virtual bool Visit(nsIFormControl* aRadio) override = 0;
  29 };
  30
  31 /**
  32  * The following declarations are radio visitors inheriting from nsRadioVisitor.
  33  */
  34
  35 /**
  36  * nsRadioSetCheckedChangedVisitor is calling SetCheckedChanged with the given
  37  * parameter to all radio elements in the group.
  38  */
  39 class nsRadioSetCheckedChangedVisitor : public nsRadioVisitor {
  40  public:
  41   explicit nsRadioSetCheckedChangedVisitor(bool aCheckedChanged)
  42       : mCheckedChanged(aCheckedChanged) {}
  43
  44   virtual bool Visit(nsIFormControl* aRadio) override;
  45
  46  protected:
  47   bool mCheckedChanged;
  48 };
  49
  50 /**
  51  * nsRadioGetCheckedChangedVisitor is getting the current checked changed value.
  52  * Getting it from one radio element is the group is enough given that all
  53  * elements should have the same value.
  54  */
  55 class nsRadioGetCheckedChangedVisitor : public nsRadioVisitor {
  56  public:
  57   nsRadioGetCheckedChangedVisitor(bool* aCheckedChanged,
  58                                   nsIFormControl* aExcludeElement)
  59       : mCheckedChanged(aCheckedChanged), mExcludeElement(aExcludeElement) {}
  60
  61   virtual bool Visit(nsIFormControl* aRadio) override;
  62
  63  protected:
  64   bool* mCheckedChanged;
  65   nsIFormControl* mExcludeElement;
  66 };
  67
  68 /**
  69  * nsRadioSetValueMissingState is calling SetValueMissingState with the given
  70  * parameter to all radio elements in the group.
  71  * It is also calling ContentStatesChanged if needed.
  72  */
  73 class nsRadioSetValueMissingState : public nsRadioVisitor {
  74  public:
  75   nsRadioSetValueMissingState(nsIFormControl* aExcludeElement, bool aValidity,
  76                               bool aNotify)
  77       : mExcludeElement(aExcludeElement),
  78         mValidity(aValidity),
  79         mNotify(aNotify) {}
  80
  81   virtual bool Visit(nsIFormControl* aRadio) override;
  82
  83  protected:
  84   nsIFormControl* mExcludeElement;
  85   bool mValidity;
  86   bool mNotify;
  87 };
  88
  89 class nsRadioUpdateStateVisitor : public nsRadioVisitor {
  90  public:
  91   explicit nsRadioUpdateStateVisitor(nsIFormControl* aExcludeElement)
  92       : mExcludeElement(aExcludeElement) {}
  93
  94   virtual bool Visit(nsIFormControl* aRadio) override;
  95
  96  protected:
  97   nsIFormControl* mExcludeElement;
  98 };
  99
 100 #endif  // _nsRadioVisitor_h__