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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
/*************************************************************************
*
* $RCSfile: XKeyHandler.idl,v $
*
* $Revision: 1.4 $
*
* last change: $Author: obo $ $Date: 2004-06-03 17:37:41 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 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
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (the "License"); You may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at http://www.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef __com_sun_star_awt_XKeyHandler_idl__
#define __com_sun_star_awt_XKeyHandler_idl__
#ifndef __com_sun_star_lang_XEventListener_idl__
#include <com/sun/star/lang/XEventListener.idl>
#endif
#ifndef __com_sun_star_awt_KeyEvent_idl__
#include <com/sun/star/awt/KeyEvent.idl>
#endif
module com { module sun { module star { module awt {
/** This key handler is similar to <type
scope="::com::sun::star::awt">XKeyListener</type> but allows the
consumotion of key events. If a key event is consumed by one
handler both the following handlers, with respect to the list of key
handlers of the broadcaster, and a following handling by the
broadcaster will not take place.
@since #107627#
*/
published interface XKeyHandler : ::com::sun::star::lang::XEventListener
{
/** This function is called by the broadcaster, an <type
scope="::com::sun::star::awt">XExtendedToolkit</type> for
instance, after a key has been pressed but before it is released.
The return value decides about whether other handlers will be
called and a handling by the broadcaster will take place.
<p>Consume the event if the action performed by the implementation
is mutualy exclusive with the default action of the broadcaster or,
when known, with that of other handlers.</p>
<p>Consuming this event does not prevent the pending key-release
event of beeing broadcasted.</p>
@param aEvent
The key event informs about the pressed key.
@return
When <FALSE/> is returned the other handlers are called and a
following handling of the event by the broadcaster takes place.
Otherwise, when <TRUE/> is returned, no other handler will be
called and the broadcaster will take no further actions
regarding the event.
*/
boolean keyPressed ([in] com::sun::star::awt::KeyEvent aEvent);
/** This function is called by the broadcaster, an <type
scope="::com::sun::star::awt">XExtendedToolkit</type> for
instance, after a key has been pressed and released. The return
value decides about whether other handlers will be called and a
handling by the broadcaster will take place.
<p>Consume the event if the action performed by the implementation
is mutualy exclusive with the default action of the broadcaster or,
when known, with that of other handlers.</p>
@param aEvent
The key event informs about the pressed key.
@return
When <FALSE/> is returned the other handlers are called and a
following handling of the event by the broadcaster takes place.
Otherwise, when <TRUE/> is returned, no other handler will be
called and the broadcaster will take no further actions
regarding the event.
*/
boolean keyReleased ([in] com::sun::star::awt::KeyEvent aEvent);
};
}; }; }; };
#endif
|
