Source code

Revision control

Copy as Markdown

Other Tools

/* -*- 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 */
#ifndef nsComboboxControlFrame_h___
#define nsComboboxControlFrame_h___
#ifdef DEBUG_evaughan
// #define DEBUG_rods
#ifdef DEBUG_rods
// #define DO_REFLOW_DEBUG
// #define DO_PIXELS
// #define DO_NEW_REFLOW
// Mark used to indicate when onchange has been fired for current combobox item
#include "mozilla/Attributes.h"
#include "nsBlockFrame.h"
#include "nsIFormControlFrame.h"
#include "nsIAnonymousContentCreator.h"
#include "nsISelectControlFrame.h"
#include "nsIRollupListener.h"
#include "nsThreadUtils.h"
class nsComboboxDisplayFrame;
class nsTextNode;
namespace mozilla {
class PresShell;
class HTMLSelectEventListener;
namespace dom {
class HTMLSelectElement;
namespace gfx {
class DrawTarget;
} // namespace gfx
} // namespace mozilla
class nsComboboxControlFrame final : public nsBlockFrame,
public nsIFormControlFrame,
public nsIAnonymousContentCreator,
public nsISelectControlFrame {
using DrawTarget = mozilla::gfx::DrawTarget;
using Element = mozilla::dom::Element;
friend nsComboboxControlFrame* NS_NewComboboxControlFrame(
mozilla::PresShell* aPresShell, ComputedStyle* aStyle,
nsFrameState aFlags);
friend class nsComboboxDisplayFrame;
explicit nsComboboxControlFrame(ComputedStyle* aStyle,
nsPresContext* aPresContext);
// nsIAnonymousContentCreator
nsresult CreateAnonymousContent(nsTArray<ContentInfo>& aElements) final;
void AppendAnonymousContentTo(nsTArray<nsIContent*>& aElements,
uint32_t aFilter) final;
nsIContent* GetDisplayNode() const;
nsIFrame* CreateFrameForDisplayNode();
mozilla::a11y::AccType AccessibleType() final;
nscoord GetMinISize(gfxContext* aRenderingContext) final;
nscoord GetPrefISize(gfxContext* aRenderingContext) final;
void Reflow(nsPresContext* aCX, ReflowOutput& aDesiredSize,
const ReflowInput& aReflowInput, nsReflowStatus& aStatus) final;
nsresult HandleEvent(nsPresContext* aPresContext,
mozilla::WidgetGUIEvent* aEvent,
nsEventStatus* aEventStatus) final;
void BuildDisplayList(nsDisplayListBuilder* aBuilder,
const nsDisplayListSet& aLists) final;
void PaintFocus(DrawTarget& aDrawTarget, nsPoint aPt);
bool IsFrameOfType(uint32_t aFlags) const final {
return nsBlockFrame::IsFrameOfType(
aFlags & ~(nsIFrame::eReplaced | nsIFrame::eReplacedContainsBlock));
void Init(nsIContent* aContent, nsContainerFrame* aParent,
nsIFrame* aPrevInFlow) final;
nsresult GetFrameName(nsAString& aResult) const final;
void DestroyFrom(nsIFrame* aDestructRoot,
PostDestroyData& aPostDestroyData) final;
void SetInitialChildList(ChildListID aListID, nsFrameList&& aChildList) final;
const nsFrameList& GetChildList(ChildListID aListID) const final;
void GetChildLists(nsTArray<ChildList>* aLists) const final;
nsContainerFrame* GetContentInsertionFrame() final;
// Return the dropdown and display frame.
void AppendDirectlyOwnedAnonBoxes(nsTArray<OwnedAnonBox>& aResult) final;
// nsIFormControlFrame
nsresult SetFormProperty(nsAtom* aName, const nsAString& aValue) final {
return NS_OK;
* Inform the control that it got (or lost) focus.
* If it lost focus, the dropdown menu will be rolled up if needed,
* and FireOnChange() will be called.
* @param aOn true if got focus, false if lost focus.
* @param aRepaint if true then force repaint (NOTE: we always force repaint
* currently)
* @note This method might destroy |this|.
void SetFocus(bool aOn, bool aRepaint) final;
* Return the available space before and after this frame for
* placing the drop-down list, and the current 2D translation.
* Note that either or both can be less than or equal to zero,
* if both are then the drop-down should be closed.
void GetAvailableDropdownSpace(mozilla::WritingMode aWM, nscoord* aBefore,
nscoord* aAfter,
mozilla::LogicalPoint* aTranslation);
int32_t GetIndexOfDisplayArea();
* @note This method might destroy |this|.
nsresult RedisplaySelectedText();
int32_t UpdateRecentIndex(int32_t aIndex);
bool IsDroppedDown() const;
// nsISelectControlFrame
NS_IMETHOD AddOption(int32_t index) final;
NS_IMETHOD RemoveOption(int32_t index) final;
NS_IMETHOD DoneAddingChildren(bool aIsDone) final;
NS_IMETHOD OnOptionSelected(int32_t aIndex, bool aSelected) final;
OnSetSelectedIndex(int32_t aOldIndex, int32_t aNewIndex) final;
int32_t CharCountOfLargestOptionForInflation() const;
friend class RedisplayTextEvent;
friend class nsAsyncResize;
friend class nsResizeDropdownAtFinalPosition;
// Return true if we should render a dropdown button.
bool HasDropDownButton() const;
nscoord DropDownButtonISize();
enum DropDownPositionState {
// can't show the dropdown at its current position
// a resize reflow is pending, don't show it yet
// the dropdown has its final size and position and can be displayed here
DropDownPositionState AbsolutelyPositionDropDown();
nscoord GetLongestOptionISize(gfxContext*) const;
// Helper for GetMinISize/GetPrefISize
nscoord GetIntrinsicISize(gfxContext* aRenderingContext,
mozilla::IntrinsicISizeType aType);
class RedisplayTextEvent : public mozilla::Runnable {
explicit RedisplayTextEvent(nsComboboxControlFrame* c)
: mozilla::Runnable("nsComboboxControlFrame::RedisplayTextEvent"),
mControlFrame(c) {}
void Revoke() { mControlFrame = nullptr; }
nsComboboxControlFrame* mControlFrame;
void CheckFireOnChange();
void FireValueChangeEvent();
nsresult RedisplayText();
void HandleRedisplayTextEvent();
void ActuallyDisplayText(bool aNotify);
// If our total transform to the root frame of the root document is only a 2d
// translation then return that translation, otherwise returns (0,0).
nsPoint GetCSSTransformTranslation();
mozilla::dom::HTMLSelectElement& Select() const;
void GetOptionText(uint32_t aIndex, nsAString& aText) const;
RefPtr<nsTextNode> mDisplayContent; // Anonymous content used to display the
// current selection
RefPtr<Element> mButtonContent; // Anonymous content for the button
nsContainerFrame* mDisplayFrame; // frame to display selection
nsIFrame* mButtonFrame; // button frame
// The inline size of our display area. Used by that frame's reflow
// to size to the full inline size except the drop-marker.
nscoord mDisplayISize;
// The maximum inline size of our display area, which is the
// nsComoboxControlFrame's border-box.
// Going over this would be observable via DOM APIs like client / scrollWidth.
nscoord mMaxDisplayISize;
nsRevocableEventPtr<RedisplayTextEvent> mRedisplayTextEvent;
int32_t mRecentSelectedIndex;
int32_t mDisplayedIndex;
nsString mDisplayedOptionTextOrPreview;
RefPtr<mozilla::HTMLSelectEventListener> mEventListener;
// See comment in HandleRedisplayTextEvent().
bool mInRedisplayText;
bool mIsOpenInParentProcess;
// static class data member for Bug 32920
// only one control can be focused at a time
static nsComboboxControlFrame* sFocused;
int32_t mReflowId;