summaryrefslogtreecommitdiffstats
path: root/helpcontent2/source/text/shared/02/01170103.xhp
blob: 5bd1d3b5e7ba237dede72e3020e57de827942c60 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
<?xml version="1.0" encoding="UTF-8"?>
<!--***********************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: 01170103.xhp,v $
 *
 *  $Revision: 1.3 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-07 21:11:37 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************-->
	
<helpdocument version="1.0">
<meta>
<topic id="textshared0201170103xml" indexer="include" status="PUBLISH">
<title id="tit" xml-lang="en-US">Events</title>
<filename>/text/shared/02/01170103.xhp</filename>
</topic>
<history>
<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created>
<lastedited date="2005-01-19T11:04:16">converted from old format - fpe</lastedited>
</history>
</meta>
<body>
<section id="ereignisse">
<bookmark xml-lang="en-US" branch="index" id="bm_id3148643"><bookmark_value>controls; events</bookmark_value>
<bookmark_value>events; controls</bookmark_value>
<bookmark_value>macros; controls</bookmark_value>
</bookmark>
<paragraph role="heading" id="hd_id3148643" xml-lang="en-US" level="1" l10n="U" oldref="1"><link href="text/shared/02/01170103.xhp" name="Events">Events</link></paragraph>
<paragraph role="paragraph" id="par_id3152350" xml-lang="en-US" 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>
</section>
<paragraph role="paragraph" id="par_id3155419" xml-lang="en-US" 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>
</caseinline><defaultinline>dialog</defaultinline></switchinline> opens.</paragraph>
<paragraph role="paragraph" id="par_id3151378" xml-lang="en-US" l10n="E" localize="false"><link href="text/shared/00/00040501.xhp#controleigenschaftenereignisse"><embedvar href="text/shared/00/00000004.xhp#wie"/></link></paragraph>
<paragraph role="paragraph" id="par_id3149732" xml-lang="en-US" 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>
<bookmark xml-lang="en-US" branch="hid/HID_EVT_APPROVEACTIONPERFORMED" id="bm_id3153252" localize="false"/>
<paragraph role="heading" id="hd_id3149191" xml-lang="en-US" level="2" l10n="U" oldref="12">Before commencing</paragraph>
<paragraph role="paragraph" id="par_id3153717" xml-lang="en-US" l10n="U" 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>Before commencing</emph> event allows you to kill the process. If the linked method sends back FALSE, <emph>When initiating</emph> will not be executed.</paragraph>
<bookmark xml-lang="en-US" branch="hid/HID_EVT_ACTIONPERFORMED" id="bm_id3155923" localize="false"/>
<paragraph role="heading" id="hd_id3156024" xml-lang="en-US" level="2" l10n="U" oldref="36">When initiating</paragraph>
<paragraph role="paragraph" id="par_id3145609" xml-lang="en-US" l10n="U" oldref="37"><ahelp hid="HID_EVT_ACTIONPERFORMED">The<emph> When initiating </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>
<bookmark xml-lang="en-US" branch="hid/HID_EVT_CHANGED" id="bm_id3154924" localize="false"/>
<paragraph role="heading" id="hd_id3156343" xml-lang="en-US" level="2" l10n="U" oldref="41">Changed</paragraph>
<paragraph role="paragraph" id="par_id3148755" xml-lang="en-US" 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>
<bookmark xml-lang="en-US" branch="hid/HID_EVT_TEXTCHANGED" id="bm_id3147084" localize="false"/>
<paragraph role="heading" id="hd_id3153524" xml-lang="en-US" level="2" l10n="U" oldref="10">Text modified</paragraph>
<paragraph role="paragraph" id="par_id3150495" xml-lang="en-US" 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>
<bookmark xml-lang="en-US" branch="hid/HID_EVT_ITEMSTATECHANGED" id="bm_id3154910" localize="false"/>
<paragraph role="heading" id="hd_id3154123" xml-lang="en-US" level="2" l10n="U" oldref="8">Item status changed</paragraph>
<paragraph role="paragraph" id="par_id3150870" xml-lang="en-US" 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>
<bookmark xml-lang="en-US" branch="hid/HID_EVT_FOCUSGAINED" id="bm_id3158407" localize="false"/>
<paragraph role="heading" id="hd_id3151176" xml-lang="en-US" level="2" l10n="U" oldref="16">When receiving focus</paragraph>
<paragraph role="paragraph" id="par_id3154218" xml-lang="en-US" 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>
<bookmark xml-lang="en-US" branch="hid/HID_EVT_FOCUSLOST" id="bm_id3154684" localize="false"/>
<paragraph role="heading" id="hd_id3150447" xml-lang="en-US" level="2" l10n="U" oldref="18">When losing focus</paragraph>
<paragraph role="paragraph" id="par_id3159252" xml-lang="en-US" 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>
<bookmark xml-lang="en-US" branch="hid/HID_EVT_KEYTYPED" id="bm_id3145787" localize="false"/>
<paragraph role="heading" id="hd_id3147287" xml-lang="en-US" level="2" l10n="U" oldref="20">Key pressed</paragraph>
<paragraph role="paragraph" id="par_id3152940" xml-lang="en-US" 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>
<bookmark xml-lang="en-US" branch="hid/HID_EVT_KEYUP" id="bm_id3145264" localize="false"/>
<paragraph role="heading" id="hd_id3154127" xml-lang="en-US" level="2" l10n="U" oldref="43">Key released</paragraph>
<paragraph role="paragraph" id="par_id3154150" xml-lang="en-US" l10n="U" oldref="44"><ahelp hid="HID_EVT_KEYUP">The<emph> Key release </emph>event occurs when the user releases any key while the control has the focus.</ahelp></paragraph>
<bookmark xml-lang="en-US" branch="hid/HID_EVT_MOUSEENTERED" id="bm_id3155368" localize="false"/>
<paragraph role="heading" id="hd_id3154921" xml-lang="en-US" level="2" l10n="U" oldref="26">Mouse inside</paragraph>
<paragraph role="paragraph" id="par_id3148618" xml-lang="en-US" 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>
<bookmark xml-lang="en-US" branch="hid/HID_EVT_MOUSEDRAGGED" id="bm_id3159180" localize="false"/>
<paragraph role="heading" id="hd_id3148576" xml-lang="en-US" level="2" l10n="U" oldref="30">Mouse moved while key pressed</paragraph>
<paragraph role="paragraph" id="par_id3155411" xml-lang="en-US" 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 at the same time.</ahelp> An example is when, during drag-and-drop, an additional key determines the mode (move or copy).</paragraph>
<bookmark xml-lang="en-US" branch="hid/HID_EVT_MOUSEMOVED" id="bm_id3147443" localize="false"/>
<paragraph role="heading" id="hd_id3149262" xml-lang="en-US" level="2" l10n="U" oldref="32">Mouse moved</paragraph>
<paragraph role="paragraph" id="par_id3146975" xml-lang="en-US" 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>
<bookmark xml-lang="en-US" branch="hid/HID_EVT_MOUSEPRESSED" id="bm_id3145366" localize="false"/>
<paragraph role="heading" id="hd_id3159197" xml-lang="en-US" level="2" l10n="U" oldref="22">Mouse button pressed</paragraph>
<paragraph role="paragraph" id="par_id3145271" xml-lang="en-US" 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>
<paragraph role="note" id="par_idN108BD" xml-lang="en-US" l10n="NEW">Note that this event is also used for notifying requests for a popup context menu on the control. If you are using this event by a program macro, you find more information in the "StarOffice 8 Programming Guide for BASIC".<comment>UFI: see #i40558#</comment></paragraph>
<bookmark xml-lang="en-US" branch="hid/HID_EVT_MOUSERELEASED" id="bm_id3144766" localize="false"/>
<paragraph role="heading" id="hd_id3148880" xml-lang="en-US" level="2" l10n="U" oldref="24">Mouse button released</paragraph>
<paragraph role="paragraph" id="par_id3150659" xml-lang="en-US" 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>
<bookmark xml-lang="en-US" branch="hid/HID_EVT_MOUSEEXITED" id="bm_id3150094" localize="false"/>
<paragraph role="heading" id="hd_id3156286" xml-lang="en-US" level="2" l10n="U" oldref="28">Mouse outside</paragraph>
<paragraph role="paragraph" id="par_id3149582" xml-lang="en-US" 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>
<embed href="text/shared/02/01170202.xhp#reset_update"/>
</body>
</helpdocument>