layout/forms/nsIListControlFrame.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 nsIListControlFrame_h___
   7 #define nsIListControlFrame_h___
   8
   9 #include "nsQueryFrame.h"
  10 #include "nsFont.h"
  11
  12 class nsAString;
  13 class nsIContent;
  14
  15 namespace mozilla {
  16 namespace dom {
  17 class HTMLOptionElement;
  18 } // namespace dom
  19 } // namespace mozilla
  20
  21 /**
  22   * nsIListControlFrame is the interface for frame-based listboxes.
  23   */
  24 class nsIListControlFrame : public nsQueryFrame
  25 {
  26 public:
  27   NS_DECL_QUERYFRAME_TARGET(nsIListControlFrame)
  28
  29   /**
  30    * Sets the ComboBoxFrame
  31    *
  32    */
  33   virtual void SetComboboxFrame(nsIFrame* aComboboxFrame) = 0;
  34
  35   /**
  36    * Get the display string for an item
  37    */
  38   virtual void GetOptionText(uint32_t aIndex, nsAString& aStr) = 0;
  39
  40   /**
  41    * Get the Selected Item's index
  42    *
  43    */
  44   virtual int32_t GetSelectedIndex() = 0;
  45
  46   /**
  47    * Return current option. The current option is the option displaying
  48    * the focus ring when the listbox is focused.
  49    */
  50   virtual mozilla::dom::HTMLOptionElement* GetCurrentOption() = 0;
  51
  52   /**
  53    * Initiates mouse capture for the listbox
  54    *
  55    */
  56   virtual void CaptureMouseEvents(bool aGrabMouseEvents) = 0;
  57
  58   /**
  59    * Returns the height of a single row in the list.  This is the
  60    * maximum of the heights of all the options/optgroups.
  61    */
  62   virtual nscoord GetHeightOfARow() = 0;
  63
  64   /**
  65    * Returns the number of options in the listbox
  66    */
  67
  68   virtual uint32_t GetNumberOfOptions() = 0;
  69
  70   /**
  71    * Called by combobox when it's about to drop down
  72    */
  73   virtual void AboutToDropDown() = 0;
  74
  75   /**
  76    * Called by combobox when it's about to roll up
  77    */
  78   virtual void AboutToRollup() = 0;
  79
  80   /**
  81    * Fire on change (used by combobox)
  82    */
  83   virtual void FireOnChange() = 0;
  84
  85   /**
  86    * Tell the selected list to roll up and ensure that the proper index is
  87    * selected, possibly firing onChange if the index has changed
  88    *
  89    * @param aIndex the index to actually select
  90    */
  91   virtual void ComboboxFinish(int32_t aIndex) = 0;
  92
  93   /**
  94    * Notification that the content has been reset
  95    */
  96   virtual void OnContentReset() = 0;
  97 };
  98
  99 #endif
 100