mozbrowsercaretstatechanged

Non-standard
This feature is non-standard and is not on a standards track. Do not use it on production sites facing the Web: it will not work for every user. There may also be large incompatibilities between implementations and the behavior may change in the future.

The mozbrowsercaretstatechanged event is fired when the user selects content in a page loaded in a browser <iframe>. This is used by the embedder to show a context menu for clipboard actions.

General info

Specification
Non standard
Interface
CustomEvent
Bubbles
Yes
Cancelable
Yes
Target
<iframe>
Default Action
None

Properties

Property Type Description
target Read only EventTarget The browser iframe
type Read only DOMString The type of event.
bubbles Read only Boolean Whether the event normally bubbles or not
cancelable Read only Boolean Whether the event is cancellable or not?
details Read only object A custom object

details

The details property returns an anonymous JavaScript object with the following properties:

rect
An object that defines information about the bounding rectangle of the current selection. Its properties are
  • width: The width of the bounding rectangle, in CSS pixels.
  • height: The height of the bounding rectangle, in CSS pixels.
  • top: The top position of the bounding rectangle, in CSS pixels.
  • bottom: The bottom position of the bounding rectangle, in CSS pixels.
  • left: The left position of the bounding rectangle, in CSS pixels.
  • right: The right position of the bounding rectangle, in CSS pixels.
commands
An object that defines what commands can currently be executed in the browser <iframe>. Its properties are
  • canSelectAll: A Boolean indicating whether the selectAll command is available (true) or not (false.)
  • canCut: A Boolean indicating whether the cut command is available (true) or not (false.)
  • canCopy: A Boolean indicating whether the copy command is available (true) or not (false.)
  • canPaste: A Boolean indicating whether the paste command is available (true) or not (false.)
reason
A DOMString that defines the reason for the state being changed. Possible values are visibilitychange, updateposition, longpressonemptycontent, taponcaret, presscaret, and releasecaret.
zoomFactor
A number defining the current zoom factor in the browser <iframe>.
collapsed
A Boolean indicating whether the current selection is collapsed (true) or not (false.)
caretVisible
A Boolean indicating whether the caret is currently visible (true) or not (false.)
selectionVisible
A Boolean indicating whether the current selection is visible (true) or not (false.)
selectionEditable
A Boolean indicating whether the current selection is editable (true) or not (false.)
selectedTextContext
A DOMString containing the currently-selected text content.
sendDoCommandMsg
A method allowing you to issue a command via an anonymouse function, i.e. function(command). Possible values are cut, copy, paste and selectAll.

Examples

var browser = document.querySelector("iframe");
browser.addEventListener("mozbrowsercaretstatechanged", function( event ) {
  // do stuff with event.details
});

See also

Document Tags and Contributors

Tags: 
 Contributors to this page: chrisdavidmills
 Last updated by: chrisdavidmills,