xref: /aoo41x/main/offapi/com/sun/star/awt/FocusEvent.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_FocusEvent_idl__
24#define __com_sun_star_awt_FocusEvent_idl__
25
26#ifndef __com_sun_star_lang_EventObject_idl__
27#include <com/sun/star/lang/EventObject.idl>
28#endif
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34
35//=============================================================================
36
37 module com {  module sun {  module star {  module awt {
38
39//=============================================================================
40
41/** specifies a keyboard focus event.
42
43	<p>There are two levels of focus change events: permanent and temporary.
44	Permanent focus change events occur when focus is directly moved
45	from one component to another, such as through calls to requestFocus()
46	or as the user uses the Tab key to traverse components.
47	Temporary focus change events occur when focus is
48	gained or lost for a component as the indirect result of another
49	operation, such as window deactivation or a scrollbar drag.  In this
50	case, the original focus state will automatically be restored once
51	that operation is finished, or for the case of window deactivation,
52	when the window is reactivated.  Both permanent and temporary focus
53	events are delivered using the FOCUS_GAINED and FOCUS_LOST event ids;
54	the levels may be distinguished in the event using the isTemporary()
55	method.</p>
56 */
57published struct FocusEvent: com::sun::star::lang::EventObject
58{
59	//-------------------------------------------------------------------------
60
61	/** specifies the reason for the focus change as an arithmentic-or
62		combination of <type>FocusChangeReason</type>.
63
64        @see FocusChangeReason
65	 */
66	short FocusFlags;
67
68	//-------------------------------------------------------------------------
69
70	/** contains the window which gets the focus on a lose focus event.
71	 */
72	com::sun::star::uno::XInterface NextFocus;
73
74	//-------------------------------------------------------------------------
75
76	/** specifies if this focus change event is a temporary change.
77	 */
78	boolean Temporary;
79
80};
81
82//=============================================================================
83
84}; }; }; };
85
86#endif
87