layout/forms/nsITextControlFrame.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef nsITextControlFrame_h___
   8 #define nsITextControlFrame_h___
   9
  10 #include "nsIFormControlFrame.h"
  11 #include "mozilla/AlreadyAddRefed.h"
  12
  13 class nsISelectionController;
  14 class nsFrameSelection;
  15
  16 namespace mozilla {
  17 class TextEditor;
  18 }  // namespace mozilla
  19
  20 // FIXME(emilio): This has only one implementation, seems it could be removed...
  21 class nsITextControlFrame : public nsIFormControlFrame {
  22  public:
  23   NS_DECL_QUERYFRAME_TARGET(nsITextControlFrame)
  24
  25   enum class SelectionDirection : uint8_t { None, Forward, Backward };
  26
  27   virtual already_AddRefed<mozilla::TextEditor> GetTextEditor() = 0;
  28
  29   MOZ_CAN_RUN_SCRIPT NS_IMETHOD
  30   SetSelectionRange(uint32_t aSelectionStart, uint32_t aSelectionEnd,
  31                     SelectionDirection = SelectionDirection::None) = 0;
  32
  33   NS_IMETHOD GetOwnedSelectionController(nsISelectionController** aSelCon) = 0;
  34   virtual nsFrameSelection* GetOwnedFrameSelection() = 0;
  35
  36   /**
  37    * Ensure editor is initialized with the proper flags and the default value.
  38    * @throws NS_ERROR_NOT_INITIALIZED if mEditor has not been created
  39    * @throws various and sundry other things
  40    */
  41   virtual nsresult EnsureEditorInitialized() = 0;
  42 };
  43
  44 #endif