String widgets

Classes and constructor functions for string-related widgets (text areas etc.)

Usage

LabelStyle(...)

TextStyle(...)

HTMLStyle(...)

HTMLMathStyle(...)

StringWidget(value = character(0), ...)

HTML(value = character(0), ...)

HTMLMath(value = character(0), ...)

Label(value = character(0), ...)

Textarea(value = character(0), ...)

TextWidget(value = character(0), ...)

PasswordWidget(value = character(0), ...)

Combobox(value = character(0), ...)

Arguments

...

Arguments passed to the inializer

value

A character vector

Functions

• LabelStyle(): The constructor for Label styles

• TextStyle(): The constructor for Text styles

• HTMLStyle(): The constructor for HTML styles

• HTMLMathStyle(): The constructor for HTMLMath styles

• StringWidget(): A constructor for string widgets

• HTML(): A constructor for HTML widgets

• HTMLMath(): A constructor for HTML widgets with math

• Label(): A constructor for label widgets

• Textarea(): A constructor for text area widgets

• TextWidget(): A constructor for text field widgets

• PasswordWidget(): A constructor for password entry widgets

• Combobox(): A constructor for combo boxes

Super classes

HasTraits -> Widget -> DescriptionStyle -> StringStyle

Public fields

_model_name

Name of the Javascript model in the frontend

background

The background color

font_size

The font size

text_color

The text color

required_version

Minimum required ipywidgets version in which the current widget class is supported.

Methods

Public methods

• StringStyle$clone()

Inherited methods

• HasTraits$notify()
• HasTraits$observe()
• HasTraits$validate()
• Widget$_send()
• Widget$check_version()
• Widget$close()
• Widget$display_data()
• Widget$get_state()
• Widget$handle_buffers()
• Widget$handle_comm_msg()
• Widget$handle_comm_opened()
• Widget$handle_custom_msg()
• Widget$handle_displayed()
• Widget$handle_event()
• Widget$initialize()
• Widget$on_displayed()
• Widget$on_event()
• Widget$on_msg()
• Widget$open()
• Widget$send()
• Widget$send_state()
• Widget$set_state()

---

StringStyle$clone()

The objects of this class are cloneable with this method.

Usage

StringStyle$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Super classes

HasTraits -> Widget -> DescriptionStyle -> StringStyle -> LabelStyle

Public fields

_model_name

Name of the Javascript model in the frontend

font_family

The font family

font_style

The font style

font_variant

The font variant

font_weight

The font weight

text_decoration

The text decoration

required_version

Minimum required ipywidgets version in which the current widget class is supported.

Methods

Public methods

• LabelStyle$clone()

Inherited methods

• HasTraits$notify()
• HasTraits$observe()
• HasTraits$validate()
• Widget$_send()
• Widget$check_version()
• Widget$close()
• Widget$display_data()
• Widget$get_state()
• Widget$handle_buffers()
• Widget$handle_comm_msg()
• Widget$handle_comm_opened()
• Widget$handle_custom_msg()
• Widget$handle_displayed()
• Widget$handle_event()
• Widget$initialize()
• Widget$on_displayed()
• Widget$on_event()
• Widget$on_msg()
• Widget$open()
• Widget$send()
• Widget$send_state()
• Widget$set_state()

---

LabelStyle$clone()

The objects of this class are cloneable with this method.

Usage

LabelStyle$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Super classes

HasTraits -> Widget -> DescriptionStyle -> StringStyle -> TextStyle

Public fields

_model_name

Name of the Javascript model in the frontend

required_version

Minimum required ipywidgets version in which the current widget class is supported.

Methods

Public methods

• TextStyle$clone()

Inherited methods

• HasTraits$notify()
• HasTraits$observe()
• HasTraits$validate()
• Widget$_send()
• Widget$check_version()
• Widget$close()
• Widget$display_data()
• Widget$get_state()
• Widget$handle_buffers()
• Widget$handle_comm_msg()
• Widget$handle_comm_opened()
• Widget$handle_custom_msg()
• Widget$handle_displayed()
• Widget$handle_event()
• Widget$initialize()
• Widget$on_displayed()
• Widget$on_event()
• Widget$on_msg()
• Widget$open()
• Widget$send()
• Widget$send_state()
• Widget$set_state()

---

TextStyle$clone()

The objects of this class are cloneable with this method.

Usage

TextStyle$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Super classes

HasTraits -> Widget -> DescriptionStyle -> StringStyle -> HTMLStyle

Public fields

_model_name

Name of the Javascript model in the frontend

required_version

Minimum required ipywidgets version in which the current widget class is supported.

Methods

Public methods

• HTMLStyle$clone()

Inherited methods

• HasTraits$notify()
• HasTraits$observe()
• HasTraits$validate()
• Widget$_send()
• Widget$check_version()
• Widget$close()
• Widget$display_data()
• Widget$get_state()
• Widget$handle_buffers()
• Widget$handle_comm_msg()
• Widget$handle_comm_opened()
• Widget$handle_custom_msg()
• Widget$handle_displayed()
• Widget$handle_event()
• Widget$initialize()
• Widget$on_displayed()
• Widget$on_event()
• Widget$on_msg()
• Widget$open()
• Widget$send()
• Widget$send_state()
• Widget$set_state()

---

HTMLStyle$clone()

The objects of this class are cloneable with this method.

Usage

HTMLStyle$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Super classes

HasTraits -> Widget -> DescriptionStyle -> StringStyle -> HTMLMathStyle

Public fields

_model_name

Name of the Javascript model in the frontend

required_version

Minimum required ipywidgets version in which the current widget class is supported.

Methods

Public methods

• HTMLMathStyle$clone()

Inherited methods

• HasTraits$notify()
• HasTraits$observe()
• HasTraits$validate()
• Widget$_send()
• Widget$check_version()
• Widget$close()
• Widget$display_data()
• Widget$get_state()
• Widget$handle_buffers()
• Widget$handle_comm_msg()
• Widget$handle_comm_opened()
• Widget$handle_custom_msg()
• Widget$handle_displayed()
• Widget$handle_event()
• Widget$initialize()
• Widget$on_displayed()
• Widget$on_event()
• Widget$on_msg()
• Widget$open()
• Widget$send()
• Widget$send_state()
• Widget$set_state()

---

HTMLMathStyle$clone()

The objects of this class are cloneable with this method.

Usage

HTMLMathStyle$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Super classes

HasTraits -> Widget -> DOMWidget -> DescriptionWidget -> ValueWidget -> StringWidget

Public fields

_model_name

Name of the Javascript model in the frontend

value

A unicode vector

placeholder

A placeholder character

Methods

Public methods

• StringWidget$clone()

Inherited methods

• HasTraits$notify()
• HasTraits$observe()
• HasTraits$validate()
• Widget$_send()
• Widget$check_version()
• Widget$close()
• Widget$display_data()
• Widget$get_state()
• Widget$handle_buffers()
• Widget$handle_comm_msg()
• Widget$handle_comm_opened()
• Widget$handle_custom_msg()
• Widget$handle_displayed()
• Widget$handle_event()
• Widget$on_displayed()
• Widget$on_event()
• Widget$on_msg()
• Widget$open()
• Widget$send()
• Widget$send_state()
• Widget$set_state()
• DOMWidget$add_class()
• DOMWidget$has_class()
• DOMWidget$remove_class()
• ValueWidget$initialize()
• ValueWidget$on_change()

---

StringWidget$clone()

The objects of this class are cloneable with this method.

Usage

StringWidget$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Super classes

HasTraits -> Widget -> DOMWidget -> DescriptionWidget -> ValueWidget -> StringWidget -> HTML

Public fields

_model_name

Name of the Javascript model in the frontend

_view_name

Name of the Javascript view in the frontend

style

The HTML style, an object of class "HTMLStyleClass"

Methods

Public methods

• HTML$clone()

Inherited methods

• HasTraits$notify()
• HasTraits$observe()
• HasTraits$validate()
• Widget$_send()
• Widget$check_version()
• Widget$close()
• Widget$display_data()
• Widget$get_state()
• Widget$handle_buffers()
• Widget$handle_comm_msg()
• Widget$handle_comm_opened()
• Widget$handle_custom_msg()
• Widget$handle_displayed()
• Widget$handle_event()
• Widget$on_displayed()
• Widget$on_event()
• Widget$on_msg()
• Widget$open()
• Widget$send()
• Widget$send_state()
• Widget$set_state()
• DOMWidget$add_class()
• DOMWidget$has_class()
• DOMWidget$remove_class()
• ValueWidget$initialize()
• ValueWidget$on_change()

---

HTML$clone()

The objects of this class are cloneable with this method.

Usage

HTML$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Super classes

HasTraits -> Widget -> DOMWidget -> DescriptionWidget -> ValueWidget -> StringWidget -> HTMLMath

Public fields

_model_name

Name of the Javascript model in the frontend

_view_name

Name of the Javascript view in the frontend

style

The HTMLMath style, an object of class "HTMLMathStyleClass"

Methods

Public methods

• HTMLMath$clone()

Inherited methods

• HasTraits$notify()
• HasTraits$observe()
• HasTraits$validate()
• Widget$_send()
• Widget$check_version()
• Widget$close()
• Widget$display_data()
• Widget$get_state()
• Widget$handle_buffers()
• Widget$handle_comm_msg()
• Widget$handle_comm_opened()
• Widget$handle_custom_msg()
• Widget$handle_displayed()
• Widget$handle_event()
• Widget$on_displayed()
• Widget$on_event()
• Widget$on_msg()
• Widget$open()
• Widget$send()
• Widget$send_state()
• Widget$set_state()
• DOMWidget$add_class()
• DOMWidget$has_class()
• DOMWidget$remove_class()
• ValueWidget$initialize()
• ValueWidget$on_change()

---

HTMLMath$clone()

The objects of this class are cloneable with this method.

Usage

HTMLMath$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Super classes

HasTraits -> Widget -> DOMWidget -> DescriptionWidget -> ValueWidget -> StringWidget -> Label

Public fields

_model_name

Name of the Javascript model in the frontend

_view_name

Name of the Javascript view in the frontend

style

The Label style, an object of class "LabelStyleClass"

Methods

Public methods

• Label$clone()

Inherited methods

• HasTraits$notify()
• HasTraits$observe()
• HasTraits$validate()
• Widget$_send()
• Widget$check_version()
• Widget$close()
• Widget$display_data()
• Widget$get_state()
• Widget$handle_buffers()
• Widget$handle_comm_msg()
• Widget$handle_comm_opened()
• Widget$handle_custom_msg()
• Widget$handle_displayed()
• Widget$handle_event()
• Widget$on_displayed()
• Widget$on_event()
• Widget$on_msg()
• Widget$open()
• Widget$send()
• Widget$send_state()
• Widget$set_state()
• DOMWidget$add_class()
• DOMWidget$has_class()
• DOMWidget$remove_class()
• ValueWidget$initialize()
• ValueWidget$on_change()

---

Label$clone()

The objects of this class are cloneable with this method.

Usage

Label$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Super classes

HasTraits -> Widget -> DOMWidget -> DescriptionWidget -> ValueWidget -> StringWidget -> Textarea

Public fields

_model_name

Name of the Javascript model in the frontend

_view_name

Name of the Javascript view in the frontend

disabled

A logical value, whether the slider is disabled

continuous_update

A logical value, whether values should be updated as the slider is moved by the user

rows

An integer, the number of rows

style

The Text style, an object of class "TextStyleClass"

Methods

Public methods

• Textarea$on_submit()

• Textarea$clone()

Inherited methods

• HasTraits$notify()
• HasTraits$observe()
• HasTraits$validate()
• Widget$_send()
• Widget$check_version()
• Widget$close()
• Widget$display_data()
• Widget$get_state()
• Widget$handle_buffers()
• Widget$handle_comm_msg()
• Widget$handle_comm_opened()
• Widget$handle_custom_msg()
• Widget$handle_displayed()
• Widget$handle_event()
• Widget$on_displayed()
• Widget$on_event()
• Widget$on_msg()
• Widget$open()
• Widget$send()
• Widget$send_state()
• Widget$set_state()
• DOMWidget$add_class()
• DOMWidget$has_class()
• DOMWidget$remove_class()
• ValueWidget$initialize()
• ValueWidget$on_change()

---

Textarea$on_submit()

Add or remove a handler for submit events.

Usage

Textarea$on_submit(handler, remove = FALSE)

Arguments

handler

A function that is called when content is submitted by the user hitting 'enter'.

remove

Logical value, whether the handler is to be removed

---

Textarea$clone()

The objects of this class are cloneable with this method.

Usage

Textarea$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Super classes

HasTraits -> Widget -> DOMWidget -> DescriptionWidget -> ValueWidget -> StringWidget -> TextWidget

Public fields

_model_name

Name of the Javascript model in the frontend

_view_name

Name of the Javascript view in the frontend

disabled

A logical value, whether the slider is disabled

continuous_update

A logical value, whether values should be updated as the slider is moved by the user

style

The Text style, an object of class "TextStyleClass"

Methods

Public methods

• TextWidget$clear()

• TextWidget$on_submit()

• TextWidget$clone()

Inherited methods

• HasTraits$notify()
• HasTraits$observe()
• HasTraits$validate()
• Widget$_send()
• Widget$check_version()
• Widget$close()
• Widget$display_data()
• Widget$get_state()
• Widget$handle_buffers()
• Widget$handle_comm_msg()
• Widget$handle_comm_opened()
• Widget$handle_custom_msg()
• Widget$handle_displayed()
• Widget$handle_event()
• Widget$on_displayed()
• Widget$on_event()
• Widget$on_msg()
• Widget$open()
• Widget$send()
• Widget$send_state()
• Widget$set_state()
• DOMWidget$add_class()
• DOMWidget$has_class()
• DOMWidget$remove_class()
• ValueWidget$initialize()
• ValueWidget$on_change()

---

TextWidget$clear()

Clear the text area

Usage

TextWidget$clear()

---

TextWidget$on_submit()

Add or remove a handler for submit events.

Usage

TextWidget$on_submit(handler, remove = FALSE)

Arguments

handler

A function that is called when content is submitted by the user hitting 'enter'.

remove

Logical value, whether the handler is to be removed

---

TextWidget$clone()

The objects of this class are cloneable with this method.

Usage

TextWidget$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Super classes

HasTraits -> Widget -> DOMWidget -> DescriptionWidget -> ValueWidget -> StringWidget -> TextWidget -> PasswordWidget

Public fields

_model_name

Name of the Javascript model in the frontend

_view_name

Name of the Javascript view in the frontend

Methods

Public methods

• PasswordWidget$clone()

Inherited methods

• HasTraits$notify()
• HasTraits$observe()
• HasTraits$validate()
• Widget$_send()
• Widget$check_version()
• Widget$close()
• Widget$display_data()
• Widget$get_state()
• Widget$handle_buffers()
• Widget$handle_comm_msg()
• Widget$handle_comm_opened()
• Widget$handle_custom_msg()
• Widget$handle_displayed()
• Widget$handle_event()
• Widget$on_displayed()
• Widget$on_event()
• Widget$on_msg()
• Widget$open()
• Widget$send()
• Widget$send_state()
• Widget$set_state()
• DOMWidget$add_class()
• DOMWidget$has_class()
• DOMWidget$remove_class()
• ValueWidget$initialize()
• ValueWidget$on_change()
• TextWidget$clear()
• TextWidget$on_submit()

---

PasswordWidget$clone()

The objects of this class are cloneable with this method.

Usage

PasswordWidget$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Super classes

HasTraits -> Widget -> DOMWidget -> DescriptionWidget -> ValueWidget -> StringWidget -> TextWidget -> Combobox

Public fields

_model_name

Name of the Javascript model in the frontend

_view_name

Name of the Javascript view in the frontend

options

A unicode vector, the available options

ensure_option

A boolean (logical) value, whether at least one option has to be activated

Methods

Public methods

• Combobox$clone()

Inherited methods

• HasTraits$notify()
• HasTraits$observe()
• HasTraits$validate()
• Widget$_send()
• Widget$check_version()
• Widget$close()
• Widget$display_data()
• Widget$get_state()
• Widget$handle_buffers()
• Widget$handle_comm_msg()
• Widget$handle_comm_opened()
• Widget$handle_custom_msg()
• Widget$handle_displayed()
• Widget$handle_event()
• Widget$on_displayed()
• Widget$on_event()
• Widget$on_msg()
• Widget$open()
• Widget$send()
• Widget$send_state()
• Widget$set_state()
• DOMWidget$add_class()
• DOMWidget$has_class()
• DOMWidget$remove_class()
• ValueWidget$initialize()
• ValueWidget$on_change()
• TextWidget$clear()
• TextWidget$on_submit()

---

Combobox$clone()

The objects of this class are cloneable with this method.

Usage

Combobox$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.