nsComboboxControlFrame.h

Enable keyboard shortcuts

/* -*- 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 nsComboboxControlFrame_h___

#define nsComboboxControlFrame_h___

#include "mozilla/Attributes.h"

#include "nsIFormControlFrame.h"

#include "nsIAnonymousContentCreator.h"

#include "nsISelectControlFrame.h"

#include "nsIRollupListener.h"

#include "nsThreadUtils.h"

#include "nsHTMLButtonControlFrame.h"

namespace mozilla {

class PresShell;

class HTMLSelectEventListener;

class ComboboxLabelFrame;

namespace dom {

class HTMLSelectElement;

}  // namespace mozilla

class nsComboboxControlFrame final : public nsHTMLButtonControlFrame,

                                     public nsIAnonymousContentCreator,

                                     public nsISelectControlFrame {

  using Element = mozilla::dom::Element;

 public:

  friend class mozilla::ComboboxLabelFrame;

  explicit nsComboboxControlFrame(ComputedStyle* aStyle,

                                  nsPresContext* aPresContext);

  ~nsComboboxControlFrame();

  NS_DECL_QUERYFRAME

  NS_DECL_FRAMEARENA_HELPERS(nsComboboxControlFrame)

  // nsIAnonymousContentCreator

  nsresult CreateAnonymousContent(nsTArray<ContentInfo>& aElements) final;

  void AppendAnonymousContentTo(nsTArray<nsIContent*>& aElements,

                                uint32_t aFilter) final;

#ifdef ACCESSIBILITY

  mozilla::a11y::AccType AccessibleType() final;

#endif

  nscoord GetMinISize(gfxContext* aRenderingContext) final;

  nscoord GetPrefISize(gfxContext* aRenderingContext) final;

  // We're a leaf, so we need to report ourselves as the content insertion

  // frame.

  nsContainerFrame* GetContentInsertionFrame() override { return this; }

  void Reflow(nsPresContext* aCX, ReflowOutput& aDesiredSize,

              const ReflowInput& aReflowInput, nsReflowStatus& aStatus) final;

  MOZ_CAN_RUN_SCRIPT_BOUNDARY

  nsresult HandleEvent(nsPresContext* aPresContext,

                       mozilla::WidgetGUIEvent* aEvent,

                       nsEventStatus* aEventStatus) final;

  void Init(nsIContent* aContent, nsContainerFrame* aParent,

            nsIFrame* aPrevInFlow) final;

  void Destroy(DestroyContext&) final;

#ifdef DEBUG_FRAME_DUMP

  nsresult GetFrameName(nsAString& aResult) const final {

    return MakeFrameName(u"ComboboxControl"_ns, aResult);

#endif

  // nsIFormControlFrame

  nsresult SetFormProperty(nsAtom* aName, const nsAString& aValue) final {

    return NS_OK;

/**

   * @note This method might destroy |this|.

*/

  void FireValueChangeEvent();

  nsresult RedisplaySelectedText();

  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;

  NS_IMETHOD_(void)

  OnSetSelectedIndex(int32_t aOldIndex, int32_t aNewIndex) final;

  int32_t CharCountOfLargestOptionForInflation() const;

 protected:

  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

    eDropDownPositionSuppressed,

    // a resize reflow is pending, don't show it yet

    eDropDownPositionPendingResize,

    // the dropdown has its final size and position and can be displayed here

    eDropDownPositionFinal

};

  DropDownPositionState AbsolutelyPositionDropDown();

  nscoord GetLongestOptionISize(gfxContext*) const;

  // Helper for GetMinISize/GetPrefISize

  nscoord GetIntrinsicISize(gfxContext* aRenderingContext,

                            mozilla::IntrinsicISizeType aType);

  class RedisplayTextEvent : public mozilla::Runnable {

   public:

    NS_DECL_NSIRUNNABLE

    explicit RedisplayTextEvent(nsComboboxControlFrame* c)

        : mozilla::Runnable("nsComboboxControlFrame::RedisplayTextEvent"),

          mControlFrame(c) {}

    void Revoke() { mControlFrame = nullptr; }

   private:

    nsComboboxControlFrame* mControlFrame;

};

  nsresult RedisplayText();

  void HandleRedisplayTextEvent();

  void ActuallyDisplayText(bool aNotify);

  mozilla::dom::HTMLSelectElement& Select() const;

  void GetOptionText(uint32_t aIndex, nsAString& aText) const;

  RefPtr<Element> mDisplayLabel;   // Anonymous content for the label

  RefPtr<Element> mButtonContent;  // Anonymous content for the button

  nsRevocableEventPtr<RedisplayTextEvent> mRedisplayTextEvent;

  // 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 = 0;

  int32_t mDisplayedIndex = -1;

  nsString mDisplayedOptionTextOrPreview;

  RefPtr<mozilla::HTMLSelectEventListener> mEventListener;

};

#endif