<!DOCTYPE html>
<html lang="en">
  <head>
    <title>EditorCommand Protocol Reference</title>
    <link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
    <link rel="stylesheet" type="text/css" href="../css/highlight.css" />
    <meta charset='utf-8'>
    <script src="../js/jquery.min.js" defer></script>
    <script src="../js/jazzy.js" defer></script>
    
  </head>
  <body>
    <a name="//apple_ref/swift/Protocol/EditorCommand" class="dashAnchor"></a>
    <a title="EditorCommand Protocol Reference"></a>
    <header>
      <div class="content-wrapper">
        <p><a href="../index.html">Proton Docs</a> (78% documented)</p>
        <p class="header-right"><a href="https://github.com/rajdeep/proton"><img src="../img/gh.png"/>View on GitHub</a></p>
      </div>
    </header>
    <div class="content-wrapper">
      <p id="breadcrumbs">
        <a href="../index.html">Proton Reference</a>
        <img id="carat" src="../img/carat.png" />
        EditorCommand Protocol Reference
      </p>
    </div>
    <div class="content-wrapper">
      <nav class="sidebar">
        <ul class="nav-groups">
          <li class="nav-group-name">
            <a href="../Classes.html">Classes</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="../Classes/Attachment.html">Attachment</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/BackgroundStyle.html">BackgroundStyle</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/BorderStyle.html">BorderStyle</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/EditorCommandExecutor.html">EditorCommandExecutor</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/EditorView.html">EditorView</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/EditorViewContext.html">EditorViewContext</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/ListCommand.html">ListCommand</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/ListTextProcessor.html">ListTextProcessor</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/RendererCommandExecutor.html">RendererCommandExecutor</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/RendererView.html">RendererView</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/RendererViewContext.html">RendererViewContext</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/ShadowStyle.html">ShadowStyle</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="../Enums.html">Enumerations</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="../Enums/AttachmentSize.html">AttachmentSize</a>
              </li>
              <li class="nav-group-task">
                <a href="../Enums/AttachmentType.html">AttachmentType</a>
              </li>
              <li class="nav-group-task">
                <a href="../Enums/EditorContentMode.html">EditorContentMode</a>
              </li>
              <li class="nav-group-task">
                <a href="../Enums/EditorContentType.html">EditorContentType</a>
              </li>
              <li class="nav-group-task">
                <a href="../Enums/EditorHeight.html">EditorHeight</a>
              </li>
              <li class="nav-group-task">
                <a href="../Enums/EditorKey.html">EditorKey</a>
              </li>
              <li class="nav-group-task">
                <a href="../Enums/ListLineMarker.html">ListLineMarker</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="../Extensions.html">Extensions</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="../Extensions/NSAttributedString.html">NSAttributedString</a>
              </li>
              <li class="nav-group-task">
                <a href="../Extensions/NSAttributedString/Key.html">– Key</a>
              </li>
              <li class="nav-group-task">
                <a href="../Extensions/NSParagraphStyle.html">NSParagraphStyle</a>
              </li>
              <li class="nav-group-task">
                <a href="../Extensions/NSRange.html">NSRange</a>
              </li>
              <li class="nav-group-task">
                <a href="../Extensions/String.html">String</a>
              </li>
              <li class="nav-group-task">
                <a href="../Extensions/TextProcessingPriority.html">TextProcessingPriority</a>
              </li>
              <li class="nav-group-task">
                <a href="../Extensions/UIFont.html">UIFont</a>
              </li>
              <li class="nav-group-task">
                <a href="../Extensions/UITextRange.html">UITextRange</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="../Protocols.html">Protocols</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="../Protocols/AttachmentEncoding.html">AttachmentEncoding</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/AttachmentOffsetProviding.html">AttachmentOffsetProviding</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/AttributesDecoding.html">AttributesDecoding</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols.html#/s:6Proton12BlockContentP">BlockContent</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/BoundsObserving.html">BoundsObserving</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/DynamicBoundsProviding.html">DynamicBoundsProviding</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/EditorCommand.html">EditorCommand</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/EditorContentDecoding.html">EditorContentDecoding</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/EditorContentEncoder.html">EditorContentEncoder</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/EditorContentEncoding.html">EditorContentEncoding</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/EditorContentIdentifying.html">EditorContentIdentifying</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/EditorContentView.html">EditorContentView</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/EditorListFormattingProvider.html">EditorListFormattingProvider</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/EditorTextEncoding.html">EditorTextEncoding</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/EditorViewDelegate.html">EditorViewDelegate</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/Focusable.html">Focusable</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols.html#/s:6Proton13InlineContentP">InlineContent</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/RendererCommand.html">RendererCommand</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/RendererListFormattingProvider.html">RendererListFormattingProvider</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/RendererViewDelegate.html">RendererViewDelegate</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/SequenceGenerator.html">SequenceGenerator</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/TextProcessing.html">TextProcessing</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="../Structs.html">Structures</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="../Structs/AnyAttributeDecoding.html">AnyAttributeDecoding</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/AnyEditorContentAttachmentEncoding.html">AnyEditorContentAttachmentEncoding</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/AnyEditorContentDecoding.html">AnyEditorContentDecoding</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/AnyEditorTextEncoding.html">AnyEditorTextEncoding</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/CommandName.html">CommandName</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/DiamondBulletSequenceGenerator.html">DiamondBulletSequenceGenerator</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/EditorContent.html">EditorContent</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/EditorLine.html">EditorLine</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/LineFormatting.html">LineFormatting</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/NumericSequenceGenerator.html">NumericSequenceGenerator</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/SquareBulletSequenceGenerator.html">SquareBulletSequenceGenerator</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="../Typealiases.html">Type Aliases</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="../Typealiases.html#/s:6Proton10Attributesa">Attributes</a>
              </li>
              <li class="nav-group-task">
                <a href="../Typealiases.html#/s:6Proton9Processeda">Processed</a>
              </li>
              <li class="nav-group-task">
                <a href="../Typealiases.html#/s:6Proton22TextProcessingPrioritya">TextProcessingPriority</a>
              </li>
            </ul>
          </li>
        </ul>
      </nav>
      <article class="main-content">
        <section>
          <section class="section">
            <h1>EditorCommand</h1>
              <div class="declaration">
                <div class="language">
                  <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">EditorCommand</span> <span class="p">:</span> <span class="kt">AnyObject</span></code></pre>

                </div>
              </div>
            <p>Describes a command that can be executed on <code><a href="../Classes/EditorView.html">EditorView</a></code>. A command may be invoked directly on the <code>editor</code> by providing an instance.
However, in a typical usage scenario, these should be invoked via <code><a href="../Classes/EditorCommandExecutor.html">EditorCommandExecutor</a></code> which manages all the <code><a href="../Classes/EditorView.html">EditorView</a></code>s in the
view including the ones that are contained in the attachments.</p>

          </section>
          <section class="section task-group-section">
            <div class="task-group">
              <ul>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:6Proton13EditorCommandP4nameAA0C4NameVvp"></a>
                    <a name="//apple_ref/swift/Property/name" class="dashAnchor"></a>
                    <a class="token" href="#/s:6Proton13EditorCommandP4nameAA0C4NameVvp">name</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Identifies a command. This value is used to maintain unique registrations of commands in an Editor. Adding a command with the same name
as one registered already would end up replacing the previously registered command with the same name.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">name</span><span class="p">:</span> <span class="kt"><a href="../Structs/CommandName.html">CommandName</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:6Proton13EditorCommandP10canExecute2onSbAA0B4ViewC_tF"></a>
                    <a name="//apple_ref/swift/Method/canExecute(on:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:6Proton13EditorCommandP10canExecute2onSbAA0B4ViewC_tF">canExecute(on:<wbr>)</a>
                    </code>
                      <span class="declaration-note">
                        Default implementation
                      </span>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Determines if the current command can be executed on the given <code><a href="../Classes/EditorView.html">EditorView</a></code>. When a command is executed using <code><a href="../Classes/EditorCommandExecutor.html">EditorCommandExecutor</a></code>, it ensures
that only the commands returning <code>true</code> for the active <code><a href="../Classes/EditorView.html">EditorView</a></code> are executed when invoked. Defaults to <code>true</code>.</p>

                      </div>
                      <h4>Default Implementation</h4>
                      <div class="default_impl abstract">
                        
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">canExecute</span><span class="p">(</span><span class="n">on</span> <span class="nv">editor</span><span class="p">:</span> <span class="kt"><a href="../Classes/EditorView.html">EditorView</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Bool</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>editor</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p><code><a href="../Classes/EditorView.html">EditorView</a></code> to execute the command on.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:6Proton13EditorCommandP7execute2onyAA0B4ViewC_tF"></a>
                    <a name="//apple_ref/swift/Method/execute(on:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:6Proton13EditorCommandP7execute2onyAA0B4ViewC_tF">execute(on:<wbr>)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Execute the command on the given <code><a href="../Classes/EditorView.html">EditorView</a></code>. You may use <code>selectedRange</code> property of <code><a href="../Classes/EditorView.html">EditorView</a></code> if the command operates on
the selected text only. for e.g. a command to make selected text bold.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">execute</span><span class="p">(</span><span class="n">on</span> <span class="nv">editor</span><span class="p">:</span> <span class="kt"><a href="../Classes/EditorView.html">EditorView</a></span><span class="p">)</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>editor</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p><code><a href="../Classes/EditorView.html">EditorView</a></code> to execute the command on.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
          </section>
        </section>
        <section id="footer">
          <p>&copy; 2020 <a class="link" href="" target="_blank" rel="external">Rajdeep</a>. All rights reserved. (Last updated: 2020-09-20)</p>
          <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
        </section>
      </article>
    </div>
  </body>
</div>
</html>
