xref: /aoo42x/main/offapi/com/sun/star/awt/ActionEvent.idl (revision d1766043)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_awt_ActionEvent_idl__
24#define __com_sun_star_awt_ActionEvent_idl__
25
26#ifndef __com_sun_star_lang_EventObject_idl__
27#include <com/sun/star/lang/EventObject.idl>
28#endif
29
30
31//=============================================================================
32
33 module com {  module sun {  module star {  module awt {
34
35//=============================================================================
36
37/** a semantic event which indicates that a component-defined action occurred.
38
39	<p>This high-level event is generated by a component (such as a Button)
40	when the component-specific action occurs (such as being pressed).
41	The event is passed to every <type>XActionListener</type> object
42	that registered to receive such events using the component's
43	<code>addActionListener</code> method.</p>
44
45	<p>The object that implements the <type>XActionListener</type> interface
46	gets this ActionEvent when the event occurs. The listener is therefore
47	spared the details of processing individual mouse movements and mouse
48	clicks, and can instead process a "meaningful" (semantic) event like
49	"button pressed".</p>
50 */
51published struct ActionEvent: com::sun::star::lang::EventObject
52{
53	//-------------------------------------------------------------------------
54
55	/** contains the command string associated with this action.
56	 */
57	string ActionCommand;
58
59};
60
61//=============================================================================
62
63}; }; }; };
64
65#endif
66