Line data    Source code

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