Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIComboboxControlFrame Class Reference

nsIComboboxControlFrame is the common interface for frames of form controls. More...

#include <nsIComboboxControlFrame.h>

Inheritance diagram for nsIComboboxControlFrame:
Inheritance graph
[legend]
Collaboration diagram for nsIComboboxControlFrame:
Collaboration graph
[legend]

List of all members.

Public Member Functions

NS_IMETHOD IsDroppedDown (PRBool *aDoDropDown)=0
 Indicates whether the list is dropped down.
NS_IMETHOD ShowDropDown (PRBool aDoDropDown)=0
 Shows or hides the drop down.
NS_IMETHOD GetDropDown (nsIFrame **aDropDownFrame)=0
 Gets the Drop Down List.
NS_IMETHOD SetDropDown (nsIFrame *aDropDownFrame)=0
 Sets the Drop Down List.
NS_IMETHOD RollupFromList (nsPresContext *aPresContext)=0
 Tells the combobox to roll up.
NS_IMETHOD RedisplaySelectedText ()=0
 Redisplay the selected text (will do nothing if text has not changed)
 NS_IMETHOD_ (PRInt32) UpdateRecentIndex(PRInt32 aIndex)=0
 Method for the listbox to set and get the recent index.
NS_IMETHOD AbsolutelyPositionDropDown ()=0
NS_IMETHOD GetAbsoluteRect (nsRect *aRect)=0
NS_IMETHOD GetIndexOfDisplayArea (PRInt32 *aSelectedIndex)=0
 This returns the index of the item that is currently being displayed in the display area.

Detailed Description

nsIComboboxControlFrame is the common interface for frames of form controls.

It provides a uniform way of creating widgets, resizing, and painting.

See also:
nsLeafFrame and its base classes for more info

Definition at line 61 of file nsIComboboxControlFrame.h.


Member Function Documentation

Implemented in nsComboboxControlFrame.

Here is the caller graph for this function:

Implemented in nsComboboxControlFrame.

NS_IMETHOD nsIComboboxControlFrame::GetDropDown ( nsIFrame **  aDropDownFrame) [pure virtual]

Gets the Drop Down List.

Implemented in nsComboboxControlFrame.

Here is the caller graph for this function:

This returns the index of the item that is currently being displayed in the display area.

It may differ from what the currently Selected index is in in the dropdown.

Detailed explanation: When the dropdown is dropped down via a mouse click and the user moves the mouse up and down without clicking, the currently selected item is being tracking inside the dropdown, but the combobox is not being updated. When the user selects items with the arrow keys, the combobox is being updated. So when the user clicks outside the dropdown and it needs to roll up it has to decide whether to keep the current selection or not. This method is used to get the current index in the combobox to compare it to the current index in the dropdown to see if the combox has been updated and that way it knows whether to "cancel" the the current selection residing in the dropdown. Or whether to leave the selection alone.

Implemented in nsComboboxControlFrame.

Here is the caller graph for this function:

NS_IMETHOD nsIComboboxControlFrame::IsDroppedDown ( PRBool aDoDropDown) [pure virtual]

Indicates whether the list is dropped down.

Implemented in nsComboboxControlFrame.

Here is the caller graph for this function:

Method for the listbox to set and get the recent index.

Implemented in nsComboboxControlFrame.

Redisplay the selected text (will do nothing if text has not changed)

Implemented in nsComboboxControlFrame.

Here is the caller graph for this function:

Tells the combobox to roll up.

Implemented in nsComboboxControlFrame.

Here is the caller graph for this function:

NS_IMETHOD nsIComboboxControlFrame::SetDropDown ( nsIFrame aDropDownFrame) [pure virtual]

Sets the Drop Down List.

Implemented in nsComboboxControlFrame.

Here is the caller graph for this function:

NS_IMETHOD nsIComboboxControlFrame::ShowDropDown ( PRBool  aDoDropDown) [pure virtual]

Shows or hides the drop down.

Implemented in nsComboboxControlFrame.

Here is the caller graph for this function:


The documentation for this class was generated from the following file: