dom/html/nsIRadioVisitor.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 nsIRadioVisitor_h___
   8 #define nsIRadioVisitor_h___
   9
  10 #include "nsISupports.h"
  11
  12 namespace mozilla::dom {
  13 class HTMLInputElement;
  14 }  // namespace mozilla::dom
  15
  16 // IID for the nsIRadioControl interface
  17 #define NS_IRADIOVISITOR_IID                         \
  18   {                                                  \
  19     0xc6bed232, 0x1181, 0x4ab2, {                    \
  20       0xa1, 0xda, 0x55, 0xc2, 0x13, 0x6d, 0xea, 0x3d \
  21     }                                                \
  22   }
  23
  24 /**
  25  * This interface is used for the text control frame to store its value away
  26  * into the content.
  27  */
  28 class nsIRadioVisitor : public nsISupports {
  29  public:
  30   NS_DECLARE_STATIC_IID_ACCESSOR(NS_IRADIOVISITOR_IID)
  31
  32   /**
  33    * Visit a node in the tree.  This is meant to be called on all radios in a
  34    * group, sequentially.  (Each radio group implementor may define
  35    * sequentially in their own way, it just has to be the same every time.)
  36    * Currently all radio groups are ordered in the order they appear in the
  37    * document.  Radio group implementors should honor the return value of the
  38    * method and stop iterating if the return value is false.
  39    *
  40    * @param aRadio the radio button in question (must be nullptr and QI'able to
  41    *               nsIRadioControlElement)
  42    */
  43   virtual bool Visit(mozilla::dom::HTMLInputElement* aRadio) = 0;
  44 };
  45
  46 NS_DEFINE_STATIC_IID_ACCESSOR(nsIRadioVisitor, NS_IRADIOVISITOR_IID)
  47
  48 #endif  // nsIRadioVisitor_h___