mirror of
https://gitlab.winehq.org/wine/wine-gecko.git
synced 2024-09-13 09:24:08 -07:00
427 lines
14 KiB
HTML
427 lines
14 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
|
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
|
||
|
|
<title>Midas Specification</title>
|
||
|
|
<meta name="author" content="Kathleen Brade">
|
||
|
|
<style type="text/css">
|
||
|
|
td { vertical-align: top; }
|
||
|
|
</style>
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
Last revised: August 23, 2005<br>
|
||
|
|
<br>
|
||
|
|
This document describes the rich text editing controls for web pages
|
||
|
|
available in recent mozilla browsers.<br>
|
||
|
|
<br>
|
||
|
|
<h1> Enabling Rich Text Editing in your web page:</h1>
|
||
|
|
<div style="margin-left: 40px;">Given a document, you can add the
|
||
|
|
attribute "designMode" and set it to "on" to get an editable document.
|
||
|
|
For example, in JavaScript, if you have an iframe with an id of 'edit', you
|
||
|
|
can get its contentDocument and set designMode to "on" like this:<br>
|
||
|
|
<div style="margin-left: 40px;"><code>document.getElementById("edit").contentDocument.designMode="on";</code></div>
|
||
|
|
<br>
|
||
|
|
Right now, you can't completely turn off editing by setting designMode
|
||
|
|
to "off." Setting designMode to "off" will prevent certain operations
|
||
|
|
from being handled but typing and other actions are still possible.<br>
|
||
|
|
</div>
|
||
|
|
<br>
|
||
|
|
<h1>Invoking Commands:</h1>
|
||
|
|
<h2>execCommand</h2>
|
||
|
|
<div style="margin-left: 40px;">Given a document that has rich text
|
||
|
|
editing enabled (see above), you can invoke specific commands on the
|
||
|
|
document by calling execCommand with 3 parameters. For example,
|
||
|
|
in JavaScript, if you have an editable document,
|
||
|
|
you can invoke the bold command by calling this:<br>
|
||
|
|
<div style="margin-left: 40px;"><code>editableDocument.execCommand("Bold",
|
||
|
|
false, null);</code></div><br>
|
||
|
|
Notes: If you haven't set designMode to "On", you will get an
|
||
|
|
error. This could also happen if you call execCommand with the wrong
|
||
|
|
document.<br>
|
||
|
|
<br>
|
||
|
|
There are 3 required parameters for execCommand:<br>
|
||
|
|
<ol>
|
||
|
|
<li>command string</li>
|
||
|
|
<li>boolean flag for showing UI</li>
|
||
|
|
<li>value string</li>
|
||
|
|
</ol>
|
||
|
|
The first parameter is a string which contains the command. The
|
||
|
|
second parameter is a boolean flag. If it is set to true, you will
|
||
|
|
get an error (NS_ERROR_NOT_IMPLEMENTED). The third parameter is a
|
||
|
|
string which is the value. Some commands will require details such
|
||
|
|
as the particular size you want to set when setting a font size.<br>
|
||
|
|
<br>
|
||
|
|
The section on Supported Commands will document each command and any
|
||
|
|
corresponding values needed.<br>
|
||
|
|
</div>
|
||
|
|
<div style="margin-left: 40px;"> </div>
|
||
|
|
<br>
|
||
|
|
<h2>queryCommandEnabled</h2>
|
||
|
|
<blockquote>This command operates on the editable document. There
|
||
|
|
is one required parameter (the command string). The result is a
|
||
|
|
boolean which is true if the command is can be done given the current
|
||
|
|
selection and/or caret position. The result is false if the command
|
||
|
|
should not be invoked (execCommand) given the current selection and/or
|
||
|
|
caret position.<br>
|
||
|
|
</blockquote>
|
||
|
|
<br>
|
||
|
|
<h2>queryCommandState</h2>
|
||
|
|
<blockquote>This section needs to be written. It can be called
|
||
|
|
similarly to IE implementation.<br>
|
||
|
|
</blockquote>
|
||
|
|
<br>
|
||
|
|
<h2>queryCommandValue</h2>
|
||
|
|
<blockquote> This section needs to be written. It can be called
|
||
|
|
similarly to IE implementation.
|
||
|
|
</blockquote>
|
||
|
|
<br>
|
||
|
|
<h1>Supported Commands:</h1>
|
||
|
|
<div style="margin-left: 40px;">The following list of commands is
|
||
|
|
presented in alphabetical order. The commands may be mixed case
|
||
|
|
or whatever makes your code more readable.<br>
|
||
|
|
<br>
|
||
|
|
<table cellpadding="4" cellspacing="0" border="1"
|
||
|
|
style="text-align: left; width: 100%;">
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td>command</td>
|
||
|
|
<td>value</td>
|
||
|
|
<td>explanation / behavior</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>backcolor</td>
|
||
|
|
<td>????</td>
|
||
|
|
<td>This command will set the background color of the document.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>bold</td>
|
||
|
|
<td>none</td>
|
||
|
|
<td>If there is no selection, the insertion
|
||
|
|
point will set bold for subsequently typed characters.<br>
|
||
|
|
<br>
|
||
|
|
If there is a selection and all of the characters are already bold, the
|
||
|
|
bold will be removed. Otherwise, all selected characters will become
|
||
|
|
bold.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>contentReadOnly</td>
|
||
|
|
<td>true<br>false</td>
|
||
|
|
<td>This command will make the editor readonly (true) or editable
|
||
|
|
(false). Anticipated usage is for temporarily disabling input while
|
||
|
|
something else is occurring elsewhere in the web page.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>copy</td>
|
||
|
|
<td>none</td>
|
||
|
|
<td>If there is a selection, this command will copy the selection
|
||
|
|
to the clipboard. If there isn't a selection, nothing will happen.<br>
|
||
|
|
<br>
|
||
|
|
note: this command won't work without setting a pref or using signed
|
||
|
|
JS. See: http://www.mozilla.org/editor/midasdemo/securityprefs.html<br>
|
||
|
|
<br>
|
||
|
|
note: the shortcut key will automatically trigger this command
|
||
|
|
(typically accel-C) with or without the signed JS or any code on the page to
|
||
|
|
handle it.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>createlink</td>
|
||
|
|
<td>url (href)</td>
|
||
|
|
<td>This command will not do anything if no selection
|
||
|
|
is made. If there is a selection, a link will be inserted around
|
||
|
|
the selection with the url parameter as the href of the link.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>cut</td>
|
||
|
|
<td>none</td>
|
||
|
|
<td>If there is a selection, this command will copy the selection
|
||
|
|
to the clipboard and remove the selection from the edit control.
|
||
|
|
If there isn't a selection, nothing will happen.<br>
|
||
|
|
<br>
|
||
|
|
note: this command won't work without setting a pref or using signed
|
||
|
|
JS. See: http://www.mozilla.org/editor/midasdemo/securityprefs.html<br>
|
||
|
|
<br>
|
||
|
|
note: the shortcut key will automatically trigger this command
|
||
|
|
(typically accel-X) with or without the signed JS or any code on the page to
|
||
|
|
handle it.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>decreasefontsize</td>
|
||
|
|
<td>none</td>
|
||
|
|
<td>This command will add a <small> tag around selection or
|
||
|
|
at insertion point.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>delete</td>
|
||
|
|
<td>none</td>
|
||
|
|
<td>This command will delete all text and objects that
|
||
|
|
are selected.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>fontname</td>
|
||
|
|
<td>????</td>
|
||
|
|
<td>This command will set the fontface for a selection
|
||
|
|
or at the insertion point if there is no selection.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>fontsize</td>
|
||
|
|
<td>????</td>
|
||
|
|
<td>This command will set the fontsize for a selection
|
||
|
|
or at the insertion point if there is no selection.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>forecolor</td>
|
||
|
|
<td>????</td>
|
||
|
|
<td>This command will set the text color of the
|
||
|
|
selection or at the insertion point.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>formatblock</td>
|
||
|
|
<td><h1><br>
|
||
|
|
<h2><br>
|
||
|
|
<h3><br>
|
||
|
|
<h4><br>
|
||
|
|
<h5><br>
|
||
|
|
<h6><br>
|
||
|
|
<pre><br>
|
||
|
|
<address><br>
|
||
|
|
<p><br>
|
||
|
|
p<br>
|
||
|
|
[this list may not be complete]</td>
|
||
|
|
<td><br></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>heading</td>
|
||
|
|
<td><h1><br>
|
||
|
|
<h2><br>
|
||
|
|
<h3><br>
|
||
|
|
<h4><br>
|
||
|
|
<h5><br>
|
||
|
|
<h6></td>
|
||
|
|
<td><br></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>hilitecolor</td>
|
||
|
|
<td>????</td>
|
||
|
|
<td>This command will set the hilite color of the selection or at
|
||
|
|
the insertion point. It only works with usecss enabled.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>increasefontsize</td>
|
||
|
|
<td>none</td>
|
||
|
|
<td>This command will add a
|
||
|
|
<big> tag around selection or at insertion point.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>indent</td>
|
||
|
|
<td>none</td>
|
||
|
|
<td>Indent the block where the caret is located.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>inserthorizontalrule</td>
|
||
|
|
<td>none</td>
|
||
|
|
<td>This command will insert a horizontal rule
|
||
|
|
(line) at the insertion point.<br>
|
||
|
|
<br>
|
||
|
|
Does it delete the selection?</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>inserthtml</td>
|
||
|
|
<td>valid html string</td>
|
||
|
|
<td>This command will insert the given html into the <body>
|
||
|
|
in place of the current selection or at the caret location.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>insertimage</td>
|
||
|
|
<td>url (src)</td>
|
||
|
|
<td>This command will insert an image (referenced by
|
||
|
|
url) at the insertion point.<br>
|
||
|
|
<br>
|
||
|
|
Does it delete the selection?</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>insertorderedlist</td>
|
||
|
|
<td>none</td>
|
||
|
|
<td><br></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>insertunorderedlist</td>
|
||
|
|
<td>none</td>
|
||
|
|
<td><br></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>insertparagraph</td>
|
||
|
|
<td>none</td>
|
||
|
|
<td><br></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>italic</td>
|
||
|
|
<td>none</td>
|
||
|
|
<td>If there is no selection, the insertion
|
||
|
|
point will set italic for subsequently typed characters. <br>
|
||
|
|
<br>
|
||
|
|
If there is a selection and all of the characters are already italic,
|
||
|
|
the italic will be removed. Otherwise, all selected characters will
|
||
|
|
become italic.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>justifycenter</td>
|
||
|
|
<td>none</td>
|
||
|
|
<td><br></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>justifyfull</td>
|
||
|
|
<td>none</td>
|
||
|
|
<td><br></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>justifyleft</td>
|
||
|
|
<td>none</td>
|
||
|
|
<td><br></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>justifyright</td>
|
||
|
|
<td>none</td>
|
||
|
|
<td><br></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>outdent</td>
|
||
|
|
<td>none</td>
|
||
|
|
<td>Outdent the block where the caret is located. If the
|
||
|
|
block is not indented prior to calling outdent, nothing will happen.<br>
|
||
|
|
<br>
|
||
|
|
note: is an error thrown if no outdenting is done?</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>paste</td>
|
||
|
|
<td>none</td>
|
||
|
|
<td>This command will paste the contents of the clipboard at the
|
||
|
|
location of the caret. If there is a selection, it will be deleted
|
||
|
|
prior to the insertion of the clipboard's contents.<br>
|
||
|
|
<br>
|
||
|
|
note: this command won't work without setting a pref or using signed
|
||
|
|
JS.<br>
|
||
|
|
<tt>user_pref("capability.policy.policynames", "allowclipboard");</tt><tt>
|
||
|
|
user_pref("capability.policy.allowclipboard.Clipboard.paste",
|
||
|
|
"allAccess");</tt><br>
|
||
|
|
See: http://www.mozilla.org/editor/midasdemo/securityprefs.html<br>
|
||
|
|
<br>
|
||
|
|
note: the shortcut key will automatically trigger this command
|
||
|
|
(typically accel-V) with or without the signed JS or any code on the page to
|
||
|
|
handle it.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>redo</td>
|
||
|
|
<td>none</td>
|
||
|
|
<td>This command will redo the previous undo action. If undo
|
||
|
|
was not the most recent action, this command will have no effect.<br>
|
||
|
|
<br>
|
||
|
|
note: the shortcut key will automatically trigger this command
|
||
|
|
(typically accel-shift-Z)</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>removeformat</td>
|
||
|
|
<td>none</td>
|
||
|
|
<td><br></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>selectall</td>
|
||
|
|
<td>none</td>
|
||
|
|
<td>This command will select all of the contents within the
|
||
|
|
editable area.<br>
|
||
|
|
<br>
|
||
|
|
note: the shortcut key will automatically trigger this command
|
||
|
|
(typically accel-A)</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>strikethrough</td>
|
||
|
|
<td>none</td>
|
||
|
|
<td>If there is no selection, the insertion point
|
||
|
|
will set strikethrough for subsequently typed characters.<br>
|
||
|
|
<br>
|
||
|
|
If there is a selection and all of the characters are already striked,
|
||
|
|
the strikethrough will be removed. Otherwise, all selected characters
|
||
|
|
will have a line drawn through them.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>styleWithCSS</td>
|
||
|
|
<td>true<br>false</td>
|
||
|
|
<td>This command is used for
|
||
|
|
toggling the format of generated content. By default (at least
|
||
|
|
today), this is true. An example of the differences is that the
|
||
|
|
"bold" command will generate <b> if the styleWithCSS command is false
|
||
|
|
and generate css style attribute if the styleWithCSS command is true.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>subscript</td>
|
||
|
|
<td>none</td>
|
||
|
|
<td>If there is no selection, the insertion point
|
||
|
|
will set subscript for subsequently typed characters. <br>
|
||
|
|
<br>
|
||
|
|
If there is a selection and all of the characters are already
|
||
|
|
subscripted, the subscript will be removed. Otherwise, all
|
||
|
|
selected characters will be drawn slightly lower than normal text.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>superscript</td>
|
||
|
|
<td>none</td>
|
||
|
|
<td>If there is no selection, the insertion point
|
||
|
|
will set superscript for subsequently typed characters.<br>
|
||
|
|
<br>
|
||
|
|
If there is a selection and all of the characters are already
|
||
|
|
superscripted, the superscript will be removed. Otherwise, all
|
||
|
|
selected characters will be drawn slightly higher than normal text.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>underline</td>
|
||
|
|
<td>none</td>
|
||
|
|
<td>If there is no selection, the insertion
|
||
|
|
point will set underline for subsequently typed characters.<br>
|
||
|
|
<br>
|
||
|
|
If there is a selection and all of the characters are already
|
||
|
|
underlined, the underline will be removed. Otherwise, all
|
||
|
|
selected characters will become underlined.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>undo</td>
|
||
|
|
<td>none</td>
|
||
|
|
<td>This command will undo the previous action. If no action
|
||
|
|
has occurred in the document, then this command will have no effect.<br>
|
||
|
|
<br>
|
||
|
|
note: the shortcut key will automatically trigger this command
|
||
|
|
(typically accel-Z)</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>unlink</td>
|
||
|
|
<td>none</td>
|
||
|
|
<td><br></td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<br>
|
||
|
|
<table cellpadding="4" cellspacing="0" border="1"
|
||
|
|
style="text-align: left; width: 100%;">
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td colspan="3">DEPRECATED COMMANDS</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>readonly</td>
|
||
|
|
<td>true<br>false</td>
|
||
|
|
<td>This command has been replaced with contentReadOnly. It
|
||
|
|
takes the same values as contentReadOnly, but the meaning of true and
|
||
|
|
false are inversed.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>useCSS</td>
|
||
|
|
<td>truefalse</td>
|
||
|
|
<td>This command has been replaced with styleWithCSS. It takes
|
||
|
|
the same values as styleWithCSS, but the meaning of true and false are
|
||
|
|
inversed.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<br>
|
||
|
|
</body>
|
||
|
|
</html>
|