layout/forms/nsISelectControlFrame.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #ifndef nsISelectControlFrame_h___
   7 #define nsISelectControlFrame_h___
   8
   9 #include "nsQueryFrame.h"
  10
  11 class nsIDOMHTMLOptionElement;
  12
  13 /**
  14   * nsISelectControlFrame is the interface for combo boxes and listboxes
  15   */
  16 class nsISelectControlFrame : public nsQueryFrame
  17 {
  18 public:
  19   NS_DECL_QUERYFRAME_TARGET(nsISelectControlFrame)
  20
  21   /**
  22    * Adds an option to the list at index
  23    */
  24
  25   NS_IMETHOD AddOption(int32_t index) = 0;
  26
  27   /**
  28    * Removes the option at index.  The caller must have a live script
  29    * blocker while calling this method.
  30    */
  31   NS_IMETHOD RemoveOption(int32_t index) = 0;
  32
  33   /**
  34    * Sets whether the parser is done adding children
  35    * @param aIsDone whether the parser is done adding children
  36    */
  37   NS_IMETHOD DoneAddingChildren(bool aIsDone) = 0;
  38
  39   /**
  40    * Notify the frame when an option is selected
  41    */
  42   NS_IMETHOD OnOptionSelected(int32_t aIndex, bool aSelected) = 0;
  43
  44   /**
  45    * Notify the frame when selectedIndex was changed.  This might
  46    * destroy the frame.
  47    */
  48   NS_IMETHOD OnSetSelectedIndex(int32_t aOldIndex, int32_t aNewIndex) = 0;
  49
  50 };
  51
  52 #endif