1<?xml version="1.0" encoding="UTF-8"?> 2 3<!--*********************************************************** 4 * 5 * Licensed to the Apache Software Foundation (ASF) under one 6 * or more contributor license agreements. See the NOTICE file 7 * distributed with this work for additional information 8 * regarding copyright ownership. The ASF licenses this file 9 * to you under the Apache License, Version 2.0 (the 10 * "License"); you may not use this file except in compliance 11 * with the License. You may obtain a copy of the License at 12 * 13 * http://www.apache.org/licenses/LICENSE-2.0 14 * 15 * Unless required by applicable law or agreed to in writing, 16 * software distributed under the License is distributed on an 17 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 18 * KIND, either express or implied. See the License for the 19 * specific language governing permissions and limitations 20 * under the License. 21 * 22 ***********************************************************--> 23 24<helpdocument version="1.0"> 25<meta> 26<topic id="textshared0201170103xml" indexer="include" status="PUBLISH"> 27<title xml-lang="en-US" id="tit">Events</title> 28<filename>/text/shared/02/01170103.xhp</filename> 29</topic> 30</meta> 31<body> 32<section id="ereignisse"> 33<bookmark xml-lang="en-US" branch="index" id="bm_id3148643"> 34<bookmark_value>controls; events</bookmark_value> 35<bookmark_value>events; controls</bookmark_value> 36<bookmark_value>macros; assigning to events in forms</bookmark_value> 37</bookmark> 38<paragraph xml-lang="en-US" id="hd_id3148643" role="heading" level="1" l10n="U" oldref="1"><link href="text/shared/02/01170103.xhp" name="Events">Events</link></paragraph> 39<paragraph xml-lang="en-US" id="par_id3152350" role="paragraph" l10n="U" oldref="2">On the <emph>Events</emph> tab page you can link macros to events that occur in a form's control fields.</paragraph> 40</section> 41<paragraph xml-lang="en-US" id="par_id3155419" role="paragraph" l10n="U" oldref="40">When the event occurs, the linked macro will be called. To assign a macro to an event, press the <emph>...</emph> button. An <switchinline select="appl"><caseinline select="WRITER"><link href="text/swriter/01/05060700.xhp" name="Assign Macro">Assign Macro</link> 42</caseinline><defaultinline>dialog</defaultinline></switchinline> opens.</paragraph> 43<section id="howtoget"> 44<embed href="text/shared/00/00040501.xhp#controleigenschaftenereignisse"/> 45</section> 46<paragraph xml-lang="en-US" id="par_id3149732" role="paragraph" l10n="U" oldref="3">Depending on the control, different events are available. Only the available events for the selected control and context are listed on the <emph>Events</emph> tab page. The following events are defined:</paragraph> 47<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_EVT_APPROVEACTIONPERFORMED" id="bm_id3153252" localize="false"/> 48<paragraph xml-lang="en-US" id="hd_id3149191" role="heading" level="2" l10n="CHG" 49oldref="12">Approve action<comment>renamed from Before commencing, issue 97356</comment></paragraph> 50<paragraph xml-lang="en-US" id="par_id3153717" role="paragraph" l10n="CHG" oldref="13"><ahelp hid="HID_EVT_APPROVEACTIONPERFORMED">This event takes place before an action is triggered by clicking the control.</ahelp> For example, clicking a "Submit" button initiates a send action; however, the actual "send" process is started only when the <emph>When initiating</emph> event occurs. The <emph>Approve action</emph> event allows you to kill the process. If the linked method sends back FALSE, <emph>When initiating</emph> will not be executed.</paragraph> 51<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_EVT_ACTIONPERFORMED" id="bm_id3155923" localize="false"/> 52<paragraph xml-lang="en-US" id="hd_id3156024" role="heading" level="2" l10n="CHG" 53oldref="36">Execute action<comment>renamed from When initiated, issue 97356</comment></paragraph> 54<paragraph xml-lang="en-US" id="par_id3145609" role="paragraph" l10n="CHG" oldref="37"><ahelp hid="HID_EVT_ACTIONPERFORMED">The <emph>Execute action</emph> event occurs when an action is started.</ahelp> For example, if you have a "Submit" button in your form, the send process represents the action to be initiated.</paragraph> 55<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_EVT_CHANGED" id="bm_id3154924" localize="false"/> 56<paragraph xml-lang="en-US" id="hd_id3156343" role="heading" level="2" l10n="U" 57oldref="41">Changed</paragraph> 58<paragraph xml-lang="en-US" id="par_id3148755" role="paragraph" l10n="U" oldref="42"><ahelp hid="HID_EVT_CHANGED">The <emph>Changed</emph> event takes place when the control loses the focus and the content of the control has changed since it lost the focus.</ahelp></paragraph> 59<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_EVT_TEXTCHANGED" id="bm_id3147084" localize="false"/> 60<paragraph xml-lang="en-US" id="hd_id3153524" role="heading" level="2" l10n="U" 61oldref="10">Text modified</paragraph> 62<paragraph xml-lang="en-US" id="par_id3150495" role="paragraph" l10n="U" oldref="11"><ahelp hid="HID_EVT_TEXTCHANGED">The <emph>Text modified</emph> event takes place if you enter or modify a text in an input field.</ahelp></paragraph> 63<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_EVT_ITEMSTATECHANGED" id="bm_id3154910" localize="false"/> 64<paragraph xml-lang="en-US" id="hd_id3154123" role="heading" level="2" l10n="U" oldref="8">Item status changed</paragraph> 65<paragraph xml-lang="en-US" id="par_id3150870" role="paragraph" l10n="U" oldref="9"><ahelp hid="HID_EVT_ITEMSTATECHANGED" visibility="hidden">The <emph>Item status changed</emph> event takes place if the status of the control field has changed.</ahelp> The <emph>Item status changed</emph> event takes place if he status of the control field has changed.</paragraph> 66<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_EVT_FOCUSGAINED" id="bm_id3158407" localize="false"/> 67<paragraph xml-lang="en-US" id="hd_id3151176" role="heading" level="2" l10n="U" 68oldref="16">When receiving focus</paragraph> 69<paragraph xml-lang="en-US" id="par_id3154218" role="paragraph" l10n="U" oldref="17"><ahelp hid="HID_EVT_FOCUSGAINED">The <emph>When receiving focus</emph> event takes place if a control field receives the focus.</ahelp></paragraph> 70<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_EVT_FOCUSLOST" id="bm_id3154684" localize="false"/> 71<paragraph xml-lang="en-US" id="hd_id3150447" role="heading" level="2" l10n="U" 72oldref="18">When losing focus</paragraph> 73<paragraph xml-lang="en-US" id="par_id3159252" role="paragraph" l10n="U" oldref="19"><ahelp hid="HID_EVT_FOCUSLOST">The <emph>When losing focus</emph> event takes place if a control field looses the focus.</ahelp></paragraph> 74<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_EVT_KEYTYPED" id="bm_id3145787" localize="false"/> 75<paragraph xml-lang="en-US" id="hd_id3147287" role="heading" level="2" l10n="U" 76oldref="20">Key pressed</paragraph> 77<paragraph xml-lang="en-US" id="par_id3152940" role="paragraph" l10n="U" oldref="21"><ahelp hid="HID_EVT_KEYTYPED">The <emph>Key pressed</emph> event occurs when the user presses any key while the control has the focus.</ahelp> This event may be linked to a macro for checking entries.</paragraph> 78<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_EVT_KEYUP" id="bm_id3145264" localize="false"/> 79<paragraph xml-lang="en-US" id="hd_id3154127" role="heading" level="2" l10n="U" 80oldref="43">Key released</paragraph> 81<paragraph xml-lang="en-US" id="par_id3154150" role="paragraph" l10n="U" oldref="44"><ahelp hid="HID_EVT_KEYUP">The <emph>Key released</emph> event occurs when the user releases any key while the control has the focus.</ahelp></paragraph> 82<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_EVT_MOUSEENTERED" id="bm_id3155368" localize="false"/> 83<paragraph xml-lang="en-US" id="hd_id3154921" role="heading" level="2" l10n="U" 84oldref="26">Mouse inside</paragraph> 85<paragraph xml-lang="en-US" id="par_id3148618" role="paragraph" l10n="U" oldref="27"><ahelp hid="HID_EVT_MOUSEENTERED">The <emph>Mouse inside</emph> event takes place if the mouse is inside the control field.</ahelp></paragraph> 86<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_EVT_MOUSEDRAGGED" id="bm_id3159180" localize="false"/> 87<paragraph xml-lang="en-US" id="hd_id3148576" role="heading" level="2" l10n="U" 88oldref="30">Mouse moved while key pressed</paragraph> 89<paragraph xml-lang="en-US" id="par_id3155411" role="paragraph" l10n="U" oldref="31"><ahelp hid="HID_EVT_MOUSEDRAGGED">The <emph>Mouse moved while key pressed</emph> event takes place when the mouse is dragged while a key is pressed.</ahelp> An example is when, during drag-and-drop, an additional key determines the mode (move or copy).</paragraph> 90<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_EVT_MOUSEMOVED" id="bm_id3147443" localize="false"/> 91<paragraph xml-lang="en-US" id="hd_id3149262" role="heading" level="2" l10n="U" 92oldref="32">Mouse moved</paragraph> 93<paragraph xml-lang="en-US" id="par_id3146975" role="paragraph" l10n="U" oldref="33"><ahelp hid="HID_EVT_MOUSEMOVED">The <emph>Mouse moved</emph> event occurs if the mouse moves over the control.</ahelp></paragraph> 94<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_EVT_MOUSEPRESSED" id="bm_id3145366" localize="false"/> 95<paragraph xml-lang="en-US" id="hd_id3159197" role="heading" level="2" l10n="U" 96oldref="22">Mouse button pressed</paragraph> 97<paragraph xml-lang="en-US" id="par_id3145271" role="paragraph" l10n="U" oldref="23"><ahelp hid="HID_EVT_MOUSEPRESSED">The <emph>Mouse button pressed</emph> event occurs if the mouse button is pressed while the mouse pointer is on the control.</ahelp></paragraph> 98<paragraph xml-lang="en-US" id="par_idN108BD" role="note" l10n="NEW">Note that this event is also used for notifying requests for a popup context menu on the control.</paragraph> 99<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_EVT_MOUSERELEASED" id="bm_id3144766" localize="false"/> 100<paragraph xml-lang="en-US" id="hd_id3148880" role="heading" level="2" l10n="U" 101oldref="24">Mouse button released</paragraph> 102<paragraph xml-lang="en-US" id="par_id3150659" role="paragraph" l10n="U" oldref="25"><ahelp hid="HID_EVT_MOUSERELEASED">The <emph>Mouse button released</emph> event occurs if the mouse button is released while the mouse pointer is on the control.</ahelp></paragraph> 103<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_EVT_MOUSEEXITED" id="bm_id3150094" localize="false"/> 104<paragraph xml-lang="en-US" id="hd_id3156286" role="heading" level="2" l10n="U" 105oldref="28">Mouse outside</paragraph> 106<paragraph xml-lang="en-US" id="par_id3149582" role="paragraph" l10n="U" oldref="29"><ahelp hid="HID_EVT_MOUSEEXITED">The <emph>Mouse outside</emph> event takes place when the mouse is outside the control field.</ahelp></paragraph> 107<embed href="text/shared/02/01170202.xhp#reset_update"/> 108</body> 109</helpdocument> 110