layout/forms/nsITextControlFrame.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #ifndef nsITextControlFrame_h___
   7 #define nsITextControlFrame_h___
   8
   9 #include "nsIFormControlFrame.h"
  10
  11 class nsIEditor;
  12 class nsIDocShell;
  13 class nsISelectionController;
  14 class nsFrameSelection;
  15
  16 class nsITextControlFrame : public nsIFormControlFrame
  17 {
  18 public:
  19   NS_DECL_QUERYFRAME_TARGET(nsITextControlFrame)
  20
  21   enum SelectionDirection {
  22     eNone,
  23     eForward,
  24     eBackward
  25   };
  26
  27   NS_IMETHOD    GetEditor(nsIEditor **aEditor) = 0;
  28
  29   NS_IMETHOD    SetSelectionStart(int32_t aSelectionStart) = 0;
  30   NS_IMETHOD    SetSelectionEnd(int32_t aSelectionEnd) = 0;
  31
  32   NS_IMETHOD    SetSelectionRange(int32_t aSelectionStart,
  33                                   int32_t aSelectionEnd,
  34                                   SelectionDirection aDirection = eNone) = 0;
  35   NS_IMETHOD    GetSelectionRange(int32_t* aSelectionStart,
  36                                   int32_t* aSelectionEnd,
  37                                   SelectionDirection* aDirection = nullptr) = 0;
  38
  39   NS_IMETHOD    GetOwnedSelectionController(nsISelectionController** aSelCon) = 0;
  40   virtual nsFrameSelection* GetOwnedFrameSelection() = 0;
  41
  42   virtual nsresult GetPhonetic(nsAString& aPhonetic) = 0;
  43
  44   /**
  45    * Ensure editor is initialized with the proper flags and the default value.
  46    * @throws NS_ERROR_NOT_INITIALIZED if mEditor has not been created
  47    * @throws various and sundry other things
  48    */
  49   virtual nsresult EnsureEditorInitialized() = 0;
  50
  51   virtual nsresult ScrollSelectionIntoView() = 0;
  52 };
  53
  54 #endif