mirror of
https://bitbucket.org/chromiumembedded/cef
synced 2025-06-05 21:39:12 +02:00
Update include/ comments to Doxygen formatting (see issue #3384)
See related guidelines in the issue.
This commit is contained in:
Marshall Greenblatt
@ -42,177 +42,178 @@
|
||||
#include "include/views/cef_view.h"
|
||||
|
||||
///
|
||||
// A Textfield supports editing of text. This control is custom rendered with no
|
||||
// platform-specific code. Methods must be called on the browser process UI
|
||||
// thread unless otherwise indicated.
|
||||
/// A Textfield supports editing of text. This control is custom rendered with
|
||||
/// no platform-specific code. Methods must be called on the browser process UI
|
||||
/// thread unless otherwise indicated.
|
||||
///
|
||||
/*--cef(source=library)--*/
|
||||
class CefTextfield : public CefView {
|
||||
public:
|
||||
///
|
||||
// Create a new Textfield.
|
||||
/// Create a new Textfield.
|
||||
///
|
||||
/*--cef(optional_param=delegate)--*/
|
||||
static CefRefPtr<CefTextfield> CreateTextfield(
|
||||
CefRefPtr<CefTextfieldDelegate> delegate);
|
||||
|
||||
///
|
||||
// Sets whether the text will be displayed as asterisks.
|
||||
/// Sets whether the text will be displayed as asterisks.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void SetPasswordInput(bool password_input) = 0;
|
||||
|
||||
///
|
||||
// Returns true if the text will be displayed as asterisks.
|
||||
/// Returns true if the text will be displayed as asterisks.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual bool IsPasswordInput() = 0;
|
||||
|
||||
///
|
||||
// Sets whether the text will read-only.
|
||||
/// Sets whether the text will read-only.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void SetReadOnly(bool read_only) = 0;
|
||||
|
||||
///
|
||||
// Returns true if the text is read-only.
|
||||
/// Returns true if the text is read-only.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual bool IsReadOnly() = 0;
|
||||
|
||||
///
|
||||
// Returns the currently displayed text.
|
||||
/// Returns the currently displayed text.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual CefString GetText() = 0;
|
||||
|
||||
///
|
||||
// Sets the contents to |text|. The cursor will be moved to end of the text if
|
||||
// the current position is outside of the text range.
|
||||
/// Sets the contents to |text|. The cursor will be moved to end of the text
|
||||
/// if the current position is outside of the text range.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void SetText(const CefString& text) = 0;
|
||||
|
||||
///
|
||||
// Appends |text| to the previously-existing text.
|
||||
/// Appends |text| to the previously-existing text.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void AppendText(const CefString& text) = 0;
|
||||
|
||||
///
|
||||
// Inserts |text| at the current cursor position replacing any selected text.
|
||||
/// Inserts |text| at the current cursor position replacing any selected text.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void InsertOrReplaceText(const CefString& text) = 0;
|
||||
|
||||
///
|
||||
// Returns true if there is any selected text.
|
||||
/// Returns true if there is any selected text.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual bool HasSelection() = 0;
|
||||
|
||||
///
|
||||
// Returns the currently selected text.
|
||||
/// Returns the currently selected text.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual CefString GetSelectedText() = 0;
|
||||
|
||||
///
|
||||
// Selects all text. If |reversed| is true the range will end at the logical
|
||||
// beginning of the text; this generally shows the leading portion of text
|
||||
// that overflows its display area.
|
||||
/// Selects all text. If |reversed| is true the range will end at the logical
|
||||
/// beginning of the text; this generally shows the leading portion of text
|
||||
/// that overflows its display area.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void SelectAll(bool reversed) = 0;
|
||||
|
||||
///
|
||||
// Clears the text selection and sets the caret to the end.
|
||||
/// Clears the text selection and sets the caret to the end.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void ClearSelection() = 0;
|
||||
|
||||
///
|
||||
// Returns the selected logical text range.
|
||||
/// Returns the selected logical text range.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual CefRange GetSelectedRange() = 0;
|
||||
|
||||
///
|
||||
// Selects the specified logical text range.
|
||||
/// Selects the specified logical text range.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void SelectRange(const CefRange& range) = 0;
|
||||
|
||||
///
|
||||
// Returns the current cursor position.
|
||||
/// Returns the current cursor position.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual size_t GetCursorPosition() = 0;
|
||||
|
||||
///
|
||||
// Sets the text color.
|
||||
/// Sets the text color.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void SetTextColor(cef_color_t color) = 0;
|
||||
|
||||
///
|
||||
// Returns the text color.
|
||||
/// Returns the text color.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual cef_color_t GetTextColor() = 0;
|
||||
|
||||
///
|
||||
// Sets the selection text color.
|
||||
/// Sets the selection text color.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void SetSelectionTextColor(cef_color_t color) = 0;
|
||||
|
||||
///
|
||||
// Returns the selection text color.
|
||||
/// Returns the selection text color.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual cef_color_t GetSelectionTextColor() = 0;
|
||||
|
||||
///
|
||||
// Sets the selection background color.
|
||||
/// Sets the selection background color.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void SetSelectionBackgroundColor(cef_color_t color) = 0;
|
||||
|
||||
///
|
||||
// Returns the selection background color.
|
||||
/// Returns the selection background color.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual cef_color_t GetSelectionBackgroundColor() = 0;
|
||||
|
||||
///
|
||||
// Sets the font list. The format is "<FONT_FAMILY_LIST>,[STYLES] <SIZE>",
|
||||
// where:
|
||||
// - FONT_FAMILY_LIST is a comma-separated list of font family names,
|
||||
// - STYLES is an optional space-separated list of style names (case-sensitive
|
||||
// "Bold" and "Italic" are supported), and
|
||||
// - SIZE is an integer font size in pixels with the suffix "px".
|
||||
//
|
||||
// Here are examples of valid font description strings:
|
||||
// - "Arial, Helvetica, Bold Italic 14px"
|
||||
// - "Arial, 14px"
|
||||
/// Sets the font list. The format is "<FONT_FAMILY_LIST>,[STYLES] <SIZE>",
|
||||
/// where:
|
||||
/// - FONT_FAMILY_LIST is a comma-separated list of font family names,
|
||||
/// - STYLES is an optional space-separated list of style names
|
||||
/// (case-sensitive
|
||||
/// "Bold" and "Italic" are supported), and
|
||||
/// - SIZE is an integer font size in pixels with the suffix "px".
|
||||
///
|
||||
/// Here are examples of valid font description strings:
|
||||
/// - "Arial, Helvetica, Bold Italic 14px"
|
||||
/// - "Arial, 14px"
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void SetFontList(const CefString& font_list) = 0;
|
||||
|
||||
///
|
||||
// Applies |color| to the specified |range| without changing the default
|
||||
// color. If |range| is empty the color will be set on the complete text
|
||||
// contents.
|
||||
/// Applies |color| to the specified |range| without changing the default
|
||||
/// color. If |range| is empty the color will be set on the complete text
|
||||
/// contents.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void ApplyTextColor(cef_color_t color, const CefRange& range) = 0;
|
||||
|
||||
///
|
||||
// Applies |style| to the specified |range| without changing the default
|
||||
// style. If |add| is true the style will be added, otherwise the style will
|
||||
// be removed. If |range| is empty the style will be set on the complete text
|
||||
// contents.
|
||||
/// Applies |style| to the specified |range| without changing the default
|
||||
/// style. If |add| is true the style will be added, otherwise the style will
|
||||
/// be removed. If |range| is empty the style will be set on the complete text
|
||||
/// contents.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void ApplyTextStyle(cef_text_style_t style,
|
||||
@ -220,46 +221,46 @@ class CefTextfield : public CefView {
|
||||
const CefRange& range) = 0;
|
||||
|
||||
///
|
||||
// Returns true if the action associated with the specified command id is
|
||||
// enabled. See additional comments on ExecuteCommand().
|
||||
/// Returns true if the action associated with the specified command id is
|
||||
/// enabled. See additional comments on ExecuteCommand().
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual bool IsCommandEnabled(cef_text_field_commands_t command_id) = 0;
|
||||
|
||||
///
|
||||
// Performs the action associated with the specified command id.
|
||||
/// Performs the action associated with the specified command id.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void ExecuteCommand(cef_text_field_commands_t command_id) = 0;
|
||||
|
||||
///
|
||||
// Clears Edit history.
|
||||
/// Clears Edit history.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void ClearEditHistory() = 0;
|
||||
|
||||
///
|
||||
// Sets the placeholder text that will be displayed when the Textfield is
|
||||
// empty.
|
||||
/// Sets the placeholder text that will be displayed when the Textfield is
|
||||
/// empty.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void SetPlaceholderText(const CefString& text) = 0;
|
||||
|
||||
///
|
||||
// Returns the placeholder text that will be displayed when the Textfield is
|
||||
// empty.
|
||||
/// Returns the placeholder text that will be displayed when the Textfield is
|
||||
/// empty.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual CefString GetPlaceholderText() = 0;
|
||||
|
||||
///
|
||||
// Sets the placeholder text color.
|
||||
/// Sets the placeholder text color.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void SetPlaceholderTextColor(cef_color_t color) = 0;
|
||||
|
||||
///
|
||||
// Set the accessible name that will be exposed to assistive technology (AT).
|
||||
/// Set the accessible name that will be exposed to assistive technology (AT).
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void SetAccessibleName(const CefString& name) = 0;
|
||||
|
||||
Reference in New Issue
Block a user