blob: 03c6ce8b36bca03a7df9f36a3ed227beb22a056f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef nsIListControlFrame_h___
#define nsIListControlFrame_h___
#include "nsQueryFrame.h"
class nsAString;
namespace mozilla {
namespace dom {
class HTMLOptionElement;
} // namespace dom
} // namespace mozilla
/**
* nsIListControlFrame is the interface for frame-based listboxes.
*/
class nsIListControlFrame : public nsQueryFrame
{
public:
NS_DECL_QUERYFRAME_TARGET(nsIListControlFrame)
/**
* Sets the ComboBoxFrame
*
*/
virtual void SetComboboxFrame(nsIFrame* aComboboxFrame) = 0;
/**
* Get the display string for an item
*/
virtual void GetOptionText(uint32_t aIndex, nsAString& aStr) = 0;
/**
* Get the Selected Item's index
*
*/
virtual int32_t GetSelectedIndex() = 0;
/**
* Return current option. The current option is the option displaying
* the focus ring when the listbox is focused.
*/
virtual mozilla::dom::HTMLOptionElement* GetCurrentOption() = 0;
/**
* Initiates mouse capture for the listbox
*
*/
virtual void CaptureMouseEvents(bool aGrabMouseEvents) = 0;
/**
* Returns the block size of a single row in the list. This is the
* maximum of the block sizes of all the options/optgroups.
*/
virtual nscoord GetBSizeOfARow() = 0;
/**
* Returns the number of options in the listbox
*/
virtual uint32_t GetNumberOfOptions() = 0;
/**
* Called by combobox when it's about to drop down
*/
virtual void AboutToDropDown() = 0;
/**
* Called by combobox when it's about to roll up
*/
virtual void AboutToRollup() = 0;
/**
* Fire on input and on change (used by combobox)
*/
virtual void FireOnInputAndOnChange() = 0;
/**
* Tell the selected list to roll up and ensure that the proper index is
* selected, possibly firing onChange if the index has changed
*
* @param aIndex the index to actually select
*/
virtual void ComboboxFinish(int32_t aIndex) = 0;
/**
* Notification that the content has been reset
*/
virtual void OnContentReset() = 0;
};
#endif
|
