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 "nsQueryFrame.h"
42 : #include "nsFont.h"
43 :
44 : class nsAString;
45 : class nsIContent;
46 :
47 : /**
48 : * nsIListControlFrame is the interface for frame-based listboxes.
49 : */
50 : class nsIListControlFrame : public nsQueryFrame
51 0 : {
52 : public:
53 : NS_DECL_QUERYFRAME_TARGET(nsIListControlFrame)
54 :
55 : /**
56 : * Sets the ComboBoxFrame
57 : *
58 : */
59 : virtual void SetComboboxFrame(nsIFrame* aComboboxFrame) = 0;
60 :
61 : /**
62 : * Get the display string for an item
63 : */
64 : virtual void GetOptionText(PRInt32 aIndex, nsAString & aStr) = 0;
65 :
66 : /**
67 : * Get the Selected Item's index
68 : *
69 : */
70 : virtual PRInt32 GetSelectedIndex() = 0;
71 :
72 : /**
73 : * Return current option. The current option is the option displaying
74 : * the focus ring when the listbox is focused.
75 : */
76 : virtual already_AddRefed<nsIContent> GetCurrentOption() = 0;
77 :
78 : /**
79 : * Initiates mouse capture for the listbox
80 : *
81 : */
82 : virtual void CaptureMouseEvents(bool aGrabMouseEvents) = 0;
83 :
84 : /**
85 : * Returns the height of a single row in the list. This is the
86 : * maximum of the heights of all the options/optgroups.
87 : */
88 : virtual nscoord GetHeightOfARow() = 0;
89 :
90 : /**
91 : * Returns the number of options in the listbox
92 : */
93 :
94 : virtual PRInt32 GetNumberOfOptions() = 0;
95 :
96 : /**
97 : *
98 : */
99 : virtual void SyncViewWithFrame() = 0;
100 :
101 : /**
102 : * Called by combobox when it's about to drop down
103 : */
104 : virtual void AboutToDropDown() = 0;
105 :
106 : /**
107 : * Called by combobox when it's about to roll up
108 : */
109 : virtual void AboutToRollup() = 0;
110 :
111 : /**
112 : * Fire on change (used by combobox)
113 : */
114 : virtual void FireOnChange() = 0;
115 :
116 : /**
117 : * Tell the selected list to roll up and ensure that the proper index is
118 : * selected, possibly firing onChange if the index has changed
119 : *
120 : * @param aIndex the index to actually select
121 : */
122 : virtual void ComboboxFinish(PRInt32 aIndex) = 0;
123 :
124 : /**
125 : * Notification that the content has been reset
126 : */
127 : virtual void OnContentReset() = 0;
128 : };
129 :
130 : #endif
131 :
|