From WikiChip
Difference between revisions of "mirc/identifiers/$inpaste"
< mirc‎ | identifiers

m
(See also)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{mirc title|$inpaste Identifier}}'''$inpaste''' returns $true if a user typed Control+V or Shift+Insert to paste text into an editbox, mainly useful when processing an {{mIRC|on events/on input|on input}} event.
+
{{mirc title|$inpaste Identifier}}'''$inpaste''' returns $true if a user triggered the {{mIRC|on events/on input|ON INPUT}} event by pressing Control+V or Shift+Insert to paste text into an editbox or using the 'Paste' choice from the editbox's right-click menu.
  
 +
It appears that $inpaste is mostly $false, and can be $true only when:
  
 +
# In channel editbox where Options/Display/Other/'Editbox Lines' is set to 'Single'
 +
# In @window editbox created with /window -e0 or -e, or created with -e3 while Editbox Lines is set to single
 +
# Clipboard contains at least one of $cr $lf $crlf
 +
# Paste from the clipboard triggers the ON INPUT event
 +
# $inpaste is used within the ON INPUT or ON PARSELINE:out event
 +
*Note: If you paste text into the editbox which doesn't trigger the INPUT event, pressing <enter> later messaging the pasted text to #channel does not set $inpaste to $true.
 
== Synopsis ==
 
== Synopsis ==
 
<pre>$inpaste</pre>
 
<pre>$inpaste</pre>
 
 
== Paramters ==
 
== Paramters ==
 
 
None
 
None
 
 
== Properties ==
 
== Properties ==
 +
None
 +
== Example ==
 +
<source lang="mIRC">
 +
on *:INPUT:*:{ if ( ($istok(/ $comchar,$left($strip($1),1),32)) && (!$ctrlenter) && ($inpaste)) { echo -g Preventing this pasted /command from being executed: $1- | halt } }</source>
  
None
+
<source lang="mIRC">
 +
on *:PARSELINE:out:*:{ echo -s debug $scriptline $event : $inpaste is $true only if this line was triggered by pasting from the clipboard : $parseline }
 +
</source>
  
== Example ==
 
 
<source lang="mIRC">
 
<source lang="mIRC">
on *:input:*:{
+
if ($inpaste) echo -a INPUT event triggered by paste from clipboard
echo -a $inpaste
+
elseif ($ctrlenter) echo -a INPUT event triggered by pressing <enter> and <Ctrl> keys together
}</source>
+
else echo -a INPUT event triggered by pressing <enter>
 +
</source>
  
 
== Compatibility ==
 
== Compatibility ==
 
{{mIRC compatibility|5.8}}
 
{{mIRC compatibility|5.8}}
 
 
== See also ==
 
== See also ==
{{mIRC|on events/on input|on input}}
+
* {{mIRC|on events/on input|ON INPUT}}
{{mIRC|$ctrlenter}}
+
* {{mIRC|on events/on parseline|ON PARSELINE}}
[[Category:mIRC identifiers|inpaste]]
+
* {{mIRC|$ctrlenter}}
 +
* {{mIRC|$comchar}}

Latest revision as of 17:16, 10 January 2020

$inpaste returns $true if a user triggered the ON INPUT event by pressing Control+V or Shift+Insert to paste text into an editbox or using the 'Paste' choice from the editbox's right-click menu.

It appears that $inpaste is mostly $false, and can be $true only when:

  1. In channel editbox where Options/Display/Other/'Editbox Lines' is set to 'Single'
  2. In @window editbox created with /window -e0 or -e, or created with -e3 while Editbox Lines is set to single
  3. Clipboard contains at least one of $cr $lf $crlf
  4. Paste from the clipboard triggers the ON INPUT event
  5. $inpaste is used within the ON INPUT or ON PARSELINE:out event
  • Note: If you paste text into the editbox which doesn't trigger the INPUT event, pressing <enter> later messaging the pasted text to #channel does not set $inpaste to $true.

Synopsis[edit]

$inpaste

Paramters[edit]

None

Properties[edit]

None

Example[edit]

on *:INPUT:*:{ if ( ($istok(/ $comchar,$left($strip($1),1),32)) && (!$ctrlenter) && ($inpaste)) { echo -g Preventing this pasted /command from being executed: $1- | halt } }
on *:PARSELINE:out:*:{ echo -s debug $scriptline $event : $inpaste is $true only if this line was triggered by pasting from the clipboard : $parseline }
if ($inpaste) echo -a INPUT event triggered by paste from clipboard
elseif ($ctrlenter) echo -a INPUT event triggered by pressing <enter> and <Ctrl> keys together
else echo -a INPUT event triggered by pressing <enter>

Compatibility[edit]

Added: mIRC v5.8
Added on: 05 Sep 2000
Note: Unless otherwise stated, this was the date of original functionality.
Further enhancements may have been made in later versions.

See also[edit]