ibm-information-center/dist/eclipse/plugins/i5OS.ic.rzakc_5.4.0.1/rzakcmstdfmoubt.htm

213 lines
12 KiB
HTML
Raw Permalink Normal View History

2024-04-02 14:02:31 +00:00
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html lang="en-us" xml:lang="en-us">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="security" content="public" />
<meta name="Robots" content="index,follow" />
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
<meta name="DC.Type" content="reference" />
<meta name="DC.Title" content="MOUBTN (Mouse Buttons) keyword for display files" />
<meta name="abstract" content="Use this file- or record-level keyword to associate a Command key or EVENT-ID parameter with one or two pointer-device events." />
<meta name="description" content="Use this file- or record-level keyword to associate a Command key or EVENT-ID parameter with one or two pointer-device events." />
<meta name="DC.subject" content="MOUBTN (Mouse Buttons) keyword, Mouse Buttons (MOUBTN) keyword" />
<meta name="keywords" content="MOUBTN (Mouse Buttons) keyword, Mouse Buttons (MOUBTN) keyword" />
<meta name="DC.Relation" scheme="URI" content="rzakcmstkeyent.htm" />
<meta name="copyright" content="(C) Copyright IBM Corporation 2001, 2006" />
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 2001, 2006" />
<meta name="DC.Format" content="XHTML" />
<meta name="DC.Identifier" content="rzakcmstdfmoubt" />
<meta name="DC.Language" content="en-us" />
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
<link rel="stylesheet" type="text/css" href="./ic.css" />
<title>MOUBTN (Mouse Buttons) keyword for display files</title>
</head>
<body id="rzakcmstdfmoubt"><a name="rzakcmstdfmoubt"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1">MOUBTN (Mouse Buttons) keyword for display files</h1>
<div><p>Use this file- or record-level keyword to associate a Command key
or EVENT-ID parameter with one or two pointer-device events.</p>
<div class="section"><p>When a specified pointer device single event is performed and
no other function has a higher priority, the keyboard is locked, the cursor
is moved to the pointer device cursor location, and the specified Command
key or EVENT-ID is returned to the application. If the Command key or EVENT-ID
normally results in entry field data validation, the data validation is performed
first. If the specified Command key or EVENT-ID normally returns entry field
data, inbound entry field data is included.</p>
<p>For pointer device double
events, inbound data is not returned until the trailing edge event also occurs.
When the leading edge event is detected, a programmable-two-event state is
entered, a marker box is drawn around the location of the pointer device cursor
(4 blue lines around the character), the pointer device cursor color is changed
to white on a color nonprogrammable workstations (NWS) and the trailing edge
event is looked for. Keystrokes and host data streams will cancel the programmable-two-event
state. Some pointer device events are ignored while waiting for the trailing
edge event. When the trailing edge event is received, the marker box is erased,
the pointer device cursor color is changed to input inhibited, then keyboard
is locked, the text cursor is moved to the location of the pointer device
cursor, and the inbound data is returned to the host.</p>
<div class="note"><span class="notetitle">Note:</span> Although it
is permitted, it is not be advisable to program some combinations of pointer
device events on the same mouse button and shift state. For example, if the
right button is programmed, right button double click should not be programmed
because it cannot be detected due to the keyboard being locked from the right
button pressed event. Using the *QUEUE parameter will allow the application
to handle this situation.</div>
<div class="p">The format of this keyword is: <pre>MOUBTN(EVENT [TRAILING-EVENT] {Command key | EVENT-ID}
[*QUEUE | *NOQUEUE])</pre>
</div>
<p>The EVENT parameter is required and
indicates the pointer device event that will be associated with the Command
key or EVENT-ID parameter. Valid values for the EVENT parameter are:</p>
<dl><dt><strong>Value</strong></dt>
<dd><strong>Meaning</strong></dd>
<dt class="dlterm">*ULP</dt>
<dd>Unshifted Left button Pressed</dd>
<dt class="dlterm">*ULR</dt>
<dd>Unshifted Left button Released</dd>
<dt class="dlterm">*ULD</dt>
<dd>Unshifted Left button Double click</dd>
<dt class="dlterm">*UMP</dt>
<dd>Unshifted Middle button Pressed</dd>
<dt class="dlterm">*UMR</dt>
<dd>Unshifted Middle button Released</dd>
<dt class="dlterm">*UMD</dt>
<dd>Unshifted Middle button Double click</dd>
<dt class="dlterm">*URP</dt>
<dd>Unshifted Right button Pressed</dd>
<dt class="dlterm">*URR</dt>
<dd>Unshifted Right button Released</dd>
<dt class="dlterm">*URD</dt>
<dd>Unshifted Right button Double click</dd>
<dt class="dlterm">*SLP</dt>
<dd>Shifted Left button Pressed</dd>
<dt class="dlterm">*SLR</dt>
<dd>Shifted Left button Released</dd>
<dt class="dlterm">*SLD</dt>
<dd>Shifted Left button Double click</dd>
<dt class="dlterm">*SMP</dt>
<dd>Shifted Middle button Pressed</dd>
<dt class="dlterm">*SMR</dt>
<dd>Shifted Middle button Released</dd>
<dt class="dlterm">*SMD</dt>
<dd>Shifted Middle button Double click</dd>
<dt class="dlterm">*SRP</dt>
<dd>Shifted Right button Pressed</dd>
<dt class="dlterm">*SRR</dt>
<dd>Shifted Right button Released</dd>
<dt class="dlterm">*SRD</dt>
<dd>Shifted Right button Double click</dd>
</dl>
<p>The TRAILING-EVENT parameter is optional. If specified,
this parameter defines the trailing event of a two event pointer device definition.
This parameter has the same valid values as the EVENT parameter. A TRAILING-EVENT
is be the trailing edge event for multiple leading edge events and have different
Command key or EVENT-ID associations for each one. An event is be a trailing
edge event and also defined as a single event (with a different Command key
or EVENT-ID association).</p>
<div class="note"><span class="notetitle">Note:</span> There are some restrictions to the Event
definitions. <ul><li>An event cannot be both a single event and a leading edge of a two event
sequence.</li>
<li>A leading edge event can have only one trailing edge event associated
with it.</li>
</ul>
</div>
<p>If you use the same event as a single or leading edge event
with multiple mouse button definitions, only the first definition is used.</p>
<p>Either
the Command key or EVENT-ID parameter must be specified and associates a Command
key or EVENT-ID value with the pointer device event indicated by the first
(and second, if provided) parameters. Valid values for a Command key are CA01
through CA24, CF01 through CF24, ENTER, ROLLUP, ROLLDOWN, HELP, HOME, PRINT
and CLEAR. Valid EVENT-IDs are E00 through E15. EVENT-IDs are similar to CAxx
keys in that no input data is transmitted from the device.</p>
<p>The QUEUE
parameter is optional and specifies if the single event being defined should
be queued by the controller if received while the keyboard is locked. This
feature is primarily used to allow a double-click to be defined for a mouse
button that also has either the pressing or releasing of the same button defined.
If the queueing is not enabled for the double click, the application will
probably not know that the double-click has occurred since the keyboard will
still be locked from processing the pressing/releasing of the button. The
default is *NOQUEUE.</p>
<p>The following keywords cannot be specified when
the listed Command key has been used on the MOUBTN keyword:</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" width="100%" frame="void" border="0" rules="none"><thead align="left"><tr><th align="left" valign="top" width="30.05050505050505%" id="d0e149">Command key</th>
<th align="left" valign="top" width="69.94949494949495%" id="d0e151">Mutually exclusive keyword</th>
</tr>
</thead>
<tbody><tr><td align="left" valign="top" width="30.05050505050505%" headers="d0e149 ">CFxx</td>
<td align="left" valign="top" width="69.94949494949495%" headers="d0e151 "><p>ALTHELP(CAyy),  CAxx<br />
where xx=yy.</p>
</td>
</tr>
<tr><td align="left" valign="top" width="30.05050505050505%" headers="d0e149 ">CAxx</td>
<td align="left" valign="top" width="69.94949494949495%" headers="d0e151 "><p>ALTPAGEDWN(CFyy), ALTPAGEUP(CFyy), CFxx<br />
where xx=yy.</p>
</td>
</tr>
<tr><td align="left" valign="top" width="30.05050505050505%" headers="d0e149 ">CF01</td>
<td align="left" valign="top" width="69.94949494949495%" headers="d0e151 ">ALTHELP with no parameter</td>
</tr>
<tr><td align="left" valign="top" width="30.05050505050505%" headers="d0e149 ">CA07</td>
<td align="left" valign="top" width="69.94949494949495%" headers="d0e151 ">ALTPAGEUP with no parameter</td>
</tr>
<tr><td align="left" valign="top" width="30.05050505050505%" headers="d0e149 ">CA08</td>
<td align="left" valign="top" width="69.94949494949495%" headers="d0e151 ">ALTPAGEDWN with no parameter</td>
</tr>
</tbody>
</table>
</div>
<p>Although not required, it is valid to specify the CA01-CA24, CF01-CF24,
ROLLUP, ROLLDOWN, PAGEUP, PAGEDOWN, CLEAR and HLPRTN keywords even though
the associated function key is defined as a command key to a single or double
mouse event. Associating a Command key to a mouse event will automatically
enable the corresponding Command key from the keyboard. If you want to associate
a response indicator with the function key, you must use one of the listed
keywords to do this. In that case, the response indicator will be set on regardless
if the Command key originates from the keyboard or from a mouse event.</p>
<p>Option
Indicators are valid for this keyword.</p>
</div>
<div class="example"><h4 class="sectiontitle">Example</h4><p>The following example
shows how to specify the MOUBTN keyword.</p>
<pre>|...+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....8
A MOUBTN(*URP CF03)
A MOUBTN(*SRP CF12)
A CF12(12 'CANCEL')
A R RECORD1
A MOUBTN(*ULP *UMP ROLLUP)
A MOUBTN(*UMP *ULP ROLLDOWN)
A 1 10'ONE--:'
A FIELD1 10A I 1 17TEXT('ONE')
A 2 10'TWO--:'
A FIELD2 10A I 2 17TEXT('TWO')
A</pre>
<p>In this example, 2 Programmable Mouse Button events have
been defined that will be in effect for all records within this file (unless
overridden at the record level). These definitions associate the unshifted
right mouse button pressed event with the CF03 key and the shifted right mouse
button pressed event with the CF12 key. The CF03 key has no response indicator
associated with it while the CF12 key has response indicator 12 associated
with it.</p>
<p>Within RECORD1, two two-event mouse button events have been
defined. The first associates the unshifted left mouse button pressed followed
by the unshifted middle mouse button pressed with the ROLLUP key. The second
associates the unshifted middle mouse button pressed followed by the unshifted
left mouse button pressed with the ROLLDOWN key. These definitions are only
valid when RECORD1 is the last record to be written to the display.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzakcmstkeyent.htm" title="You type the keyword entries that define display files in positions 45 through 80 (functions).">DDS keyword entries for display files (positions 45 through 80)</a></div>
</div>
</div>
</body>
</html>