Buttons

Classes and constructor functions for boxes and box styles

Usage

Button(...)

ButtonStyle(...)

Arguments

...

Arguments passed to the inializer

Functions

• Button(): A button constructor

• ButtonStyle(): A constructor for a button style

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DOMWidget -> Button

Public fields

_model_module

Name of the Javascript module with the model

_model_module_version

Version of the module where the model is defined

_model_name

Name of the Javascript model in the frontend

_view_module

Name of the module where the view is defined

_view_module_version

Version of the module where the view is defined

_view_name

Name of the Javascript model view in the frontend

description

A button description

disabled

Boolean, whether the button is disabled

icon

Name of an optional icon

button_style

The string that describes the button style

tooltip

An optional tooltip string

style

The button style, an object of class "ButtonStyleClass"

Methods

Public methods

• ButtonClass$on_click()

• ButtonClass$click()

• ButtonClass$clone()

Inherited methods

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

---

Method on_click()

Add or remove a click handler

Usage

ButtonClass$on_click(handler, remove = FALSE)

Arguments

handler

A function that is called when the button is clicked

remove

Logical value, whether the handler is to be removed

---

Method click()

Function that calls the click event handlers

Usage

ButtonClass$click()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ButtonClass$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Super classes

RKernel::HasTraits -> RKernel::Widget -> RKernel::DescriptionStyle -> ButtonStyle

Public fields

_model_name

Name of the Javascript model in the frontend

button_color

The colour of the button

font_family

The font family of the button label

font_size

The font size of the button label

font_style

The font style of the button label

font_variant

The font variant of the button label

font_weight

The font weight of the button label

text_color

The text colour of the button label

text_decoration

The text decoration of the button label

Methods

Public methods

• ButtonStyleClass$clone()

Inherited methods

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

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ButtonStyleClass$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.