gecko-dev/layout/forms/nsIListControlFrame.h
Daniel Holbert 680815cd6e Bug 1412346 part 5: (automated patch) Switch a bunch of C++ files in layout to use our standard mode lines. r=jfkthame
This patch was generated automatically by the "modeline.py" script, available
here: https://github.com/amccreight/moz-source-tools/blob/master/modeline.py

For every file that is modified in this patch, the changes are as follows:
 (1) The patch changes the file to use the exact C++ mode lines from the
     Mozilla coding style guide, available here:
https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Coding_Style#Mode_Line

 (2) The patch deletes any blank lines between the mode line & the MPL
     boilerplate comment.

 (3) If the file previously had the mode lines and MPL boilerplate in a
     single contiguous C++ comment, then the patch splits them into
     separate C++ comments, to match the boilerplate in the coding style.

MozReview-Commit-ID: EuRsDue63tK

--HG--
extra : rebase_source : 3356d4b80ff6213935192e87cdbc9103fec6084c
2017-10-27 10:33:53 -07:00

99 lines
2.3 KiB
C++

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* 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"
#include "nsStringFwd.h"
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