Keyboard Maestro Wiki

User Tools

Site Tools

Trace:
Clipboards

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
Clipboards [2017/07/15 03:26] – [Clipboard Actions] Add set var to text action JMichaelTXClipboards [2024/09/29 02:42] (current) – peternlewis
Line 1: Line 1:
-{{:clipboards-sm-icon.png?nolink|}} 
 ====== Clipboards ====== ====== Clipboards ======
  
 **Keyboard Maestro supports several different types of clipboards** **Keyboard Maestro supports several different types of clipboards**
-  * **System Clipboard** -- the standard [[https://en.wikipedia.org/wiki/Clipboard_%28computing%29|Mac OS X Clipboard]] used by all Mac apps +  * [[#System Clipboard]] — the standard [[https://en.wikipedia.org/wiki/Clipboard_%28computing%29|Mac OS X Clipboard]] used by all Mac apps 
-      * The alternate name "**[[token:CurrentClipboard|Current Clipboard]]**" is used in some Macro Actions +      * The alternate name "[[token:CurrentClipboard|Current Clipboard]]" is used in some Macro Actions 
-  * **Named Clipboards** -- Copy of System Clipboard, or other Named Clipboard, created by user for future use+  * [[#Named Clipboards]] — Copy of System Clipboard, or other Named Clipboard, created by user for future use
       * There is usually a default *Named Clipboard* named "Default Clipboard", do not confuse this with the Mac’s *System Clipboard*.       * There is usually a default *Named Clipboard* named "Default Clipboard", do not confuse this with the Mac’s *System Clipboard*.
-  * **Past Clipboards** -- Prior Versions of the *System Clipboard* stored in the Keyboard Maestro [[#Clipboard_History]]+  * **Past Clipboards** — Prior Versions of the *System Clipboard* stored in the Keyboard Maestro [[#Clipboard_History]] 
 +  * [[#Trigger Clipboard]] — The clipboard referenced by a [[trigger:Clipboard Filter]] menu selection (or the System Clipboard otherwise). 
 ===== System Clipboard ===== ===== System Clipboard =====
  
-The System Clipboard is the clipboard that you will use and work with the most.\\+The System Clipboard is the clipboard that you will use and work with the most. 
 + 
 +==== Actions That Use The Clipboard ==== 
  
 (!) Keep in mind that **the System Clipboard is involved in all operations (Actions)** that transfer data between the user interface (documents, menus, web pages,etc) and Keyboard Maestro. (!) Keep in mind that **the System Clipboard is involved in all operations (Actions)** that transfer data between the user interface (documents, menus, web pages,etc) and Keyboard Maestro.
Line 19: Line 23:
   * [[action:Paste_from_Named_Clipboard]]   * [[action:Paste_from_Named_Clipboard]]
   * and many others   * and many others
 +
 +==== Pause Until Clipboard Changes ====
 +
 +
 +Sometimes you will need to wait until the app has completed setting the Clipboard.  You can use the [[function:CLIPBOARDSEED|]], in a calculation (`CBSeedBefore ≠ CLIPBOARDSEED()`) condition in the [[action:Pause_Until|Pause Until Action]] to achieve this.  Of course you will need to set the Keyboard Maestro Variable `CBSeedBefore` in an Action _before_ the Action to set the Clipboard.
 +
 +==== Discussion ====
 +
  
 The System Clipboard is a complicated entity, and often contains many different flavors of the same data last copied from an app.  To better understand how Keyboard Maestro processes the System Clipboard, see [[https://forum.keyboardmaestro.com/t/ulysses-no-text-in-clipboard/6742/23?u=jmichaeltx | this Forum post by @PeterNLewis]].  In particular, this post deals with getting plain text from the System Clipboard. The System Clipboard is a complicated entity, and often contains many different flavors of the same data last copied from an app.  To better understand how Keyboard Maestro processes the System Clipboard, see [[https://forum.keyboardmaestro.com/t/ulysses-no-text-in-clipboard/6742/23?u=jmichaeltx | this Forum post by @PeterNLewis]].  In particular, this post deals with getting plain text from the System Clipboard.
Line 34: Line 46:
 ==== Display History ==== ==== Display History ====
  
-The Clipboard History Switcher is a built-in Macro, which you can find in the Keyboard Maestro Editor, in the //Switcher Group// in the [[Macro_Groups|Macro Groups]].+The Clipboard History Switcher is a built-in Macro, which you can find in the Keyboard Maestro editor, in the //Switcher Group// in the [[Macro_Groups|Macro Groups]].
  
 To trigger the Clipboard History Switcher, press the default hotkey of <key>⌘</key><key>⌃</key><key>⇧</key><key>V</key> (or a hot key of your choosing). To trigger the Clipboard History Switcher, press the default hotkey of <key>⌘</key><key>⌃</key><key>⇧</key><key>V</key> (or a hot key of your choosing).
  
-{{:km-clipboard-switcher.png?nolink|}}+{{ manual:clipboardhistoryswitcher.png?nolink&674 | Clipboard History Switcher Window }}
  
 You can also use the [[collection:Clipboard_History]] within the [For Each action](/action/For_Each). You can also use the [[collection:Clipboard_History]] within the [For Each action](/action/For_Each).
  
 For more info, see [Clipboard History Switcher documentation](/manual/Clipboard_History_Switcher). For more info, see [Clipboard History Switcher documentation](/manual/Clipboard_History_Switcher).
- 
  
  
Line 55: Line 66:
  
 For more discussion on this, see [[https://forum.keyboardmaestro.com/t/how-can-i-get-the-second-to-last-item-in-clipboard/6615/6?u=jmichaeltx | this Keyboard Maestro Forum post]]   . For more discussion on this, see [[https://forum.keyboardmaestro.com/t/how-can-i-get-the-second-to-last-item-in-clipboard/6615/6?u=jmichaeltx | this Keyboard Maestro Forum post]]   .
- 
  
  
Line 72: Line 82:
       * To restore at end of your Macro.       * To restore at end of your Macro.
       * To use in other Macros.       * To use in other Macros.
- 
  
 (!) Note that Keyboard Maestro provides a named clipboard with the name of "Default Clipboard".  It is nothing special, and acts like any other named clipboard.  The "Default" in the name means nothing more than that it was provided by default.  Do not mistake this for the System Clipboard. (!) Note that Keyboard Maestro provides a named clipboard with the name of "Default Clipboard".  It is nothing special, and acts like any other named clipboard.  The "Default" in the name means nothing more than that it was provided by default.  Do not mistake this for the System Clipboard.
  
 +Named Clipboards are located in the Keyboard Maestro Preferences in their own “Clipboards” panel.
 +
 +{{:keyboard_maestro_named_clipboard_prefs.png?direct&400|}}
 +
 +Use the [+] button to create a new named clipboard.
 +
 +The one-line field at the top-right is the name field.
 +
 +The big field on the lower-right is the content field.
 +
 +You can add plain text, styled text, and images simply by pasting into the content field, but if you want to add something like a Keyboard Maestro action you need to use a Copy to Named Clipboard action to get it in there.
 +===== Trigger Clipboard =====
 +
 +The Trigger Clipboard is not a clipboard per se, instead it is a reference to a selected clipboard. Usually it will be the selected clipboard in the Clipboard History Switcher or Named Clipboard Switcher window that you wish to act on with a [[trigger:Clipboard Filter]]. It will be either a past clipboard in the Clipboard History Switcher, or a Named Clipboard in the Named Clipboard Switcher, or if none of them are selected it will refer to the System Clipboard.
 +
 +For example, if you are viewing the Clipboard History Switcher, and select the third last clipboard entry and then choose a Clipboard Filter from the Gear menu, the Trigger Clipboard will refer to the selected clipboard.
 ===== Clipboard Actions ===== ===== Clipboard Actions =====
  
Line 92: Line 117:
     * [[action:Copy_Clipboard_to_Clipboard]]     * [[action:Copy_Clipboard_to_Clipboard]]
     * [[action:Apply_Style_to_Clipboard]]     * [[action:Apply_Style_to_Clipboard]]
-    * [[action:Filter_Clipboard]]+    * [[action:Filter]]
     * [[action:Search_and_Replace_Clipboard]]     * [[action:Search_and_Replace_Clipboard]]
     * [[action:Search_Clipboard]]     * [[action:Search_Clipboard]]
Line 106: Line 131:
 ===== Clipboard Tokens ===== ===== Clipboard Tokens =====
  
-In addition to the above Actions that use Clipboards, there are several Clipboard Tokens that can be used in any Action which has a field for Clipboards, Variables, or text.\\+In addition to the above Actions that use Clipboards, there are several Clipboard Tokens that can be used in any Action which has a field for Clipboards, Variables, or text. 
 These Include: These Include:
 +
   * [[token:CurrentClipboard|%CurrentClipboard%]] (same as System Clipboard)   * [[token:CurrentClipboard|%CurrentClipboard%]] (same as System Clipboard)
   * [[token:NamedClipboard|%NamedClipboard%]]   * [[token:NamedClipboard|%NamedClipboard%]]
   * [[token:PastClipboard|%PastClipboard%]]   * [[token:PastClipboard|%PastClipboard%]]
  
-===== See Also =====+===== Clipboard Condition =====
  
-----+The [[condition:Clipboard|Clipboard Condition]] may be used with [[Actions|Macro Actions]] like [[action:If_Then_Else|IF/THEN]] to branch control based on criteria concerning the data on the Clipboard.  For details see: [[condition:Clipboard|Clipboard Condition]] 
 + 
 + 
 +===== See Also =====
  
 === Actions === === Actions ===
Line 124: Line 154:
 * [[:Actions|See all Actions]] * [[:Actions|See all Actions]]
  
-----+=== Functions === 
 + 
 +* [[function:CLIPBOARDSEED|]] -- used to determine when Clipboard has changed 
 + 
 +=== Triggers === 
 + 
 +* [[trigger:Clipboard Filter]] trigger
  
 ==== Forum ==== ==== Forum ====
Clipboards.1500089216.txt.gz · Last modified: by JMichaelTX
Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki