layout/forms/nsIListControlFrame.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #ifndef nsIListControlFrame_h___
  39 #define nsIListControlFrame_h___
  40
  41 #include "nsISupports.h"
  42 #include "nsFont.h"
  43 class nsPresContext;
  44 class nsAString;
  45 class nsIContent;
  46
  47 // IID for the nsIListControlFrame class
  48 #define NS_ILISTCONTROLFRAME_IID    \
  49 { 0x4de9ab73, 0x31b5, 0x4d92, \
  50  { 0xb7, 0xe4, 0x73, 0xb4, 0x4d, 0xcb, 0xfc, 0xda } }
  51
  52 /**
  53   * nsIListControlFrame is the interface for frame-based listboxes.
  54   */
  55 class nsIListControlFrame : public nsISupports {
  56
  57 public:
  58   NS_DECLARE_STATIC_IID_ACCESSOR(NS_ILISTCONTROLFRAME_IID)
  59
  60   /**
  61    * Sets the ComboBoxFrame
  62    *
  63    */
  64   virtual void SetComboboxFrame(nsIFrame* aComboboxFrame) = 0;
  65
  66   /**
  67    * Get the display string for an item
  68    */
  69   virtual void GetOptionText(PRInt32 aIndex, nsAString & aStr) = 0;
  70
  71   /**
  72    * Get the Selected Item's index
  73    *
  74    */
  75   virtual PRInt32 GetSelectedIndex() = 0;
  76
  77   /**
  78    * Initiates mouse capture for the listbox
  79    *
  80    */
  81   virtual void CaptureMouseEvents(PRBool aGrabMouseEvents) = 0;
  82
  83   /**
  84    * Returns the height of a single row in the list.  This is the
  85    * maximum of the heights of all the options/optgroups.
  86    */
  87   virtual nscoord GetHeightOfARow() = 0;
  88
  89   /**
  90    * Returns the number of options in the listbox
  91    */
  92
  93   virtual PRInt32 GetNumberOfOptions() = 0;
  94
  95   /**
  96    *
  97    */
  98   virtual void SyncViewWithFrame() = 0;
  99
 100   /**
 101    * Called by combobox when it's about to drop down
 102    */
 103   virtual void AboutToDropDown() = 0;
 104
 105   /**
 106    * Called by combobox when it's about to roll up
 107    */
 108   virtual void AboutToRollup() = 0;
 109
 110   /**
 111    * Fire on change (used by combobox)
 112    */
 113   virtual void FireOnChange() = 0;
 114
 115   /**
 116    * Tell the selected list to roll up and ensure that the proper index is
 117    * selected, possibly firing onChange if the index has changed
 118    *
 119    * @param aIndex the index to actually select
 120    */
 121   virtual void ComboboxFinish(PRInt32 aIndex) = 0;
 122
 123   /**
 124    * Notification that the content has been reset
 125    */
 126   virtual void OnContentReset() = 0;
 127 };
 128
 129 NS_DEFINE_STATIC_IID_ACCESSOR(nsIListControlFrame, NS_ILISTCONTROLFRAME_IID)
 130
 131 #endif
 132