editor_atto/events

Description:
  • Javascript events for the editor_atto plugin.

Source:
Since:
  • 3.10.5
License:
  • http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Javascript events for the editor_atto plugin.

Members

(static, constant) eventTypes

Description:
  • Events for the editor_atto plugin.

Source:
Properties:
Name Type Description
attoButtonHighlightToggled String

See event:attoButtonHighlightToggled

Events for the editor_atto plugin.

Methods

(inner) notifyButtonHighlightToggled(attoButton, buttonName, highlight) → {CustomEvent}

Description:
  • Trigger an event to indicate that a button's highlight was toggled.

Source:
Parameters:
Name Type Description
attoButton HTMLElement

The button object.

buttonName String

The button name.

highlight Boolean

True when the button was highlighted. False, otherwise.

Fires:
Returns:
Type
CustomEvent

Events

attoButtonHighlightToggled

Description:
  • An event triggered when a toolbar button's highlight gets toggled.

Source:
Properties:
Name Type Description
target HTMLElement

The button which had its highlight toggled.

detail object
Properties
Name Type Description
buttonName String

The name of the Atto button that has had its highlight toggled.

highlight Boolean

True when the button was highlighted. False, otherwise.

Type:
  • CustomEvent