flutter::TextInputModel Class Reference

#include <text_input_model.h>

Public Member Functions
	TextInputModel ()
virtual	~TextInputModel ()
bool	SetText (const std::string &text, const TextRange &selection=TextRange(0), const TextRange &composing_range=TextRange(0))
bool	SetSelection (const TextRange &range)
bool	SetComposingRange (const TextRange &range, size_t cursor_offset)
void	BeginComposing ()
void	UpdateComposingText (const std::u16string &text, const TextRange &selection)
void	UpdateComposingText (const std::u16string &text)
void	UpdateComposingText (const std::string &text)
void	CommitComposing ()
void	EndComposing ()
void	AddCodePoint (char32_t c)
void	AddText (const std::u16string &text)
void	AddText (const std::string &text)
bool	Delete ()
bool	DeleteSurrounding (int offset_from_cursor, int count)
bool	Backspace ()
bool	MoveCursorBack ()
bool	MoveCursorForward ()
bool	MoveCursorToBeginning ()
bool	MoveCursorToEnd ()
bool	SelectToBeginning ()
bool	SelectToEnd ()
std::string	GetText () const
int	GetCursorOffset () const
TextRange	text_range () const
TextRange	selection () const
TextRange	composing_range () const
bool	composing () const

Detailed Description

Definition at line 18 of file text_input_model.h.

Constructor & Destructor Documentation

TextInputModel()

flutter::TextInputModel::TextInputModel ( )

default

~TextInputModel()

flutter::TextInputModel::~TextInputModel ( )

virtualdefault

Member Function Documentation

AddCodePoint()

void flutter::TextInputModel::AddCodePoint

(

char32_t

c

)

Definition at line 122 of file text_input_model.cc.

                                            {
  if (c <= 0xFFFF) {
    AddText(std::u16string({static_cast<char16_t>(c)}));
  } else {
    char32_t to_decompose = c - 0x10000;
    AddText(std::u16string({
        // High surrogate.
        static_cast<char16_t>((to_decompose >> 10) + 0xd800),
        // Low surrogate.
        static_cast<char16_t>((to_decompose % 0x400) + 0xdc00),
    }));
  }
}

AddText() [1/2]

void flutter::TextInputModel::AddText

(

const std::string &

text

)

Definition at line 149 of file text_input_model.cc.

                                                  {
  AddText(fml::Utf8ToUtf16(text));
}

AddText() [2/2]

void flutter::TextInputModel::AddText

(

const std::u16string &

text

)

Definition at line 136 of file text_input_model.cc.

                                                     {
  DeleteSelected();
  if (composing_) {
    // Delete the current composing text, set the cursor to composing start.
    text_.erase(composing_range_.start(), composing_range_.length());
    selection_ = TextRange(composing_range_.start());
    composing_range_.set_end(composing_range_.start() + text.length());
  }
  size_t position = selection_.position();
  text_.insert(position, text);
  selection_ = TextRange(position + text.length());
}

Backspace()

bool flutter::TextInputModel::Backspace

(

)

Definition at line 153 of file text_input_model.cc.

                               {
  if (DeleteSelected()) {
    return true;
  }
  // There is no selection. Delete the preceding codepoint.
  size_t position = selection_.position();
  if (position != editable_range().start()) {
    int count = IsTrailingSurrogate(text_.at(position - 1)) ? 2 : 1;
    text_.erase(position - count, count);
    selection_ = TextRange(position - count);
    if (composing_) {
      composing_range_.set_end(composing_range_.end() - count);
    }
    return true;
  }
  return false;
}

BeginComposing()

void flutter::TextInputModel::BeginComposing

(

)

Definition at line 67 of file text_input_model.cc.

                                    {
  composing_ = true;
  composing_range_ = TextRange(selection_.start());
}

CommitComposing()

void flutter::TextInputModel::CommitComposing

(

)

Definition at line 94 of file text_input_model.cc.

                                     {
  // Preserve selection if no composing text was entered.
  if (composing_range_.collapsed()) {
    return;
  }
  composing_range_ = TextRange(composing_range_.end());
  selection_ = composing_range_;
}

composing()

bool flutter::TextInputModel::composing ( ) const

inline

Definition at line 209 of file text_input_model.h.

{ return composing_; }

composing_range()

TextRange flutter::TextInputModel::composing_range ( ) const

inline

Definition at line 206 of file text_input_model.h.

{ return composing_range_; }

Delete()

bool flutter::TextInputModel::Delete

(

)

Definition at line 171 of file text_input_model.cc.

                            {
  if (DeleteSelected()) {
    return true;
  }
  // There is no selection. Delete the preceding codepoint.
  size_t position = selection_.position();
  if (position < editable_range().end()) {
    int count = IsLeadingSurrogate(text_.at(position)) ? 2 : 1;
    text_.erase(position, count);
    if (composing_) {
      composing_range_.set_end(composing_range_.end() - count);
    }
    return true;
  }
  return false;
}

DeleteSurrounding()

bool flutter::TextInputModel::DeleteSurrounding	(	int	offset_from_cursor,
		int	count
	)

Definition at line 188 of file text_input_model.cc.

                                                                        {
  size_t max_pos = editable_range().end();
  size_t start = selection_.extent();
  if (offset_from_cursor < 0) {
    for (int i = 0; i < -offset_from_cursor; i++) {
      // If requested start is before the available text then reduce the
      // number of characters to delete.
      if (start == editable_range().start()) {
        count = i;
        break;
      }
      start -= IsTrailingSurrogate(text_.at(start - 1)) ? 2 : 1;
    }
  } else {
    for (int i = 0; i < offset_from_cursor && start != max_pos; i++) {
      start += IsLeadingSurrogate(text_.at(start)) ? 2 : 1;
    }
  }
 
  auto end = start;
  for (int i = 0; i < count && end != max_pos; i++) {
    end += IsLeadingSurrogate(text_.at(start)) ? 2 : 1;
  }
 
  if (start == end) {
    return false;
  }
 
  auto deleted_length = end - start;
  text_.erase(start, deleted_length);
 
  // Cursor moves only if deleted area is before it.
  selection_ = TextRange(offset_from_cursor <= 0 ? start : selection_.start());
 
  // Adjust composing range.
  if (composing_) {
    composing_range_.set_end(composing_range_.end() - deleted_length);
  }
  return true;
}

EndComposing()

void flutter::TextInputModel::EndComposing

(

)

Definition at line 103 of file text_input_model.cc.

                                  {
  composing_ = false;
  composing_range_ = TextRange(0);
}

GetCursorOffset()

int flutter::TextInputModel::GetCursorOffset

(

)

const

Definition at line 301 of file text_input_model.cc.

                                          {
  // Measure the length of the current text up to the selection extent.
  // There is probably a much more efficient way of doing this.
  auto leading_text = text_.substr(0, selection_.extent());
  return fml::Utf16ToUtf8(leading_text).size();
}

GetText()

std::string flutter::TextInputModel::GetText

(

)

const

Definition at line 297 of file text_input_model.cc.

                                        {
  return fml::Utf16ToUtf8(text_);
}

MoveCursorBack()

bool flutter::TextInputModel::MoveCursorBack

(

)

Definition at line 281 of file text_input_model.cc.

                                    {
  // If there's a selection, move to the beginning of the selection.
  if (!selection_.collapsed()) {
    selection_ = TextRange(selection_.start());
    return true;
  }
  // Otherwise, move the cursor backward.
  size_t position = selection_.position();
  if (position != editable_range().start()) {
    int count = IsTrailingSurrogate(text_.at(position - 1)) ? 2 : 1;
    selection_ = TextRange(position - count);
    return true;
  }
  return false;
}

MoveCursorForward()

bool flutter::TextInputModel::MoveCursorForward

(

)

Definition at line 265 of file text_input_model.cc.

                                       {
  // If there's a selection, move to the end of the selection.
  if (!selection_.collapsed()) {
    selection_ = TextRange(selection_.end());
    return true;
  }
  // Otherwise, move the cursor forward.
  size_t position = selection_.position();
  if (position != editable_range().end()) {
    int count = IsLeadingSurrogate(text_.at(position)) ? 2 : 1;
    selection_ = TextRange(position + count);
    return true;
  }
  return false;
}

MoveCursorToBeginning()

bool flutter::TextInputModel::MoveCursorToBeginning

(

)

Definition at line 229 of file text_input_model.cc.

                                           {
  size_t min_pos = editable_range().start();
  if (selection_.collapsed() && selection_.position() == min_pos) {
    return false;
  }
  selection_ = TextRange(min_pos);
  return true;
}

MoveCursorToEnd()

bool flutter::TextInputModel::MoveCursorToEnd

(

)

Definition at line 238 of file text_input_model.cc.

                                     {
  size_t max_pos = editable_range().end();
  if (selection_.collapsed() && selection_.position() == max_pos) {
    return false;
  }
  selection_ = TextRange(max_pos);
  return true;
}

selection()

TextRange flutter::TextInputModel::selection ( ) const

inline

Definition at line 201 of file text_input_model.h.

{ return selection_; }

SelectToBeginning()

bool flutter::TextInputModel::SelectToBeginning

(

)

Definition at line 247 of file text_input_model.cc.

                                       {
  size_t min_pos = editable_range().start();
  if (selection_.collapsed() && selection_.position() == min_pos) {
    return false;
  }
  selection_ = TextRange(selection_.base(), min_pos);
  return true;
}

SelectToEnd()

bool flutter::TextInputModel::SelectToEnd

(

)

Definition at line 256 of file text_input_model.cc.

                                 {
  size_t max_pos = editable_range().end();
  if (selection_.collapsed() && selection_.position() == max_pos) {
    return false;
  }
  selection_ = TextRange(selection_.base(), max_pos);
  return true;
}

SetComposingRange()

bool flutter::TextInputModel::SetComposingRange	(	const TextRange &	range,
		size_t	cursor_offset
	)

Definition at line 57 of file text_input_model.cc.

                                                             {
  if (!composing_ || !text_range().Contains(range)) {
    return false;
  }
  composing_range_ = range;
  selection_ = TextRange(range.start() + cursor_offset);
  return true;
}

SetSelection()

bool flutter::TextInputModel::SetSelection

(

const TextRange &

range

)

Definition at line 46 of file text_input_model.cc.

                                                        {
  if (composing_ && !range.collapsed()) {
    return false;
  }
  if (!editable_range().Contains(range)) {
    return false;
  }
  selection_ = range;
  return true;
}

SetText()

bool flutter::TextInputModel::SetText	(	const std::string &	text,
		const TextRange &	selection = TextRange(0),
		const TextRange &	composing_range = TextRange(0)
	)

Definition at line 31 of file text_input_model.cc.

                                                               {
  text_ = fml::Utf8ToUtf16(text);
  if (!text_range().Contains(selection) ||
      !text_range().Contains(composing_range)) {
    return false;
  }
 
  selection_ = selection;
  composing_range_ = composing_range;
  composing_ = !composing_range.collapsed();
  return true;
}

text_range()

TextRange flutter::TextInputModel::text_range ( ) const

inline

Definition at line 198 of file text_input_model.h.

{ return TextRange(0, text_.length()); }

UpdateComposingText() [1/3]

void flutter::TextInputModel::UpdateComposingText

(

const std::string &

text

)

Definition at line 90 of file text_input_model.cc.

                                                              {
  UpdateComposingText(fml::Utf8ToUtf16(text));
}

UpdateComposingText() [2/3]

void flutter::TextInputModel::UpdateComposingText

(

const std::u16string &

text

)

Definition at line 86 of file text_input_model.cc.

                                                                 {
  UpdateComposingText(text, TextRange(text.length()));
}

UpdateComposingText() [3/3]

void flutter::TextInputModel::UpdateComposingText	(	const std::u16string &	text,
		const TextRange &	selection
	)

Definition at line 72 of file text_input_model.cc.

                                                                     {
  // Preserve selection if we get a no-op update to the composing region.
  if (text.length() == 0 && composing_range_.collapsed()) {
    return;
  }
  const TextRange& rangeToDelete =
      composing_range_.collapsed() ? selection_ : composing_range_;
  text_.replace(rangeToDelete.start(), rangeToDelete.length(), text);
  composing_range_.set_end(composing_range_.start() + text.length());
  selection_ = TextRange(selection.start() + composing_range_.start(),
                         selection.extent() + composing_range_.start());
}

---

The documentation for this class was generated from the following files:

• shell/platform/common/text_input_model.h
• shell/platform/common/text_input_model.cc