xref: /aoo4110/main/offapi/com/sun/star/awt/FocusEvent.idl (revision b1cdbd2c)
1*b1cdbd2cSJim Jagielski/**************************************************************
2*b1cdbd2cSJim Jagielski *
3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski * or more contributor license agreements.  See the NOTICE file
5*b1cdbd2cSJim Jagielski * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski * regarding copyright ownership.  The ASF licenses this file
7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski * with the License.  You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski *
11*b1cdbd2cSJim Jagielski *   http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski *
13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski * KIND, either express or implied.  See the License for the
17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski * under the License.
19*b1cdbd2cSJim Jagielski *
20*b1cdbd2cSJim Jagielski *************************************************************/
21*b1cdbd2cSJim Jagielski
22*b1cdbd2cSJim Jagielski
23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_awt_FocusEvent_idl__
24*b1cdbd2cSJim Jagielski#define __com_sun_star_awt_FocusEvent_idl__
25*b1cdbd2cSJim Jagielski
26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_EventObject_idl__
27*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/EventObject.idl>
28*b1cdbd2cSJim Jagielski#endif
29*b1cdbd2cSJim Jagielski
30*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_uno_XInterface_idl__
31*b1cdbd2cSJim Jagielski#include <com/sun/star/uno/XInterface.idl>
32*b1cdbd2cSJim Jagielski#endif
33*b1cdbd2cSJim Jagielski
34*b1cdbd2cSJim Jagielski
35*b1cdbd2cSJim Jagielski//=============================================================================
36*b1cdbd2cSJim Jagielski
37*b1cdbd2cSJim Jagielski module com {  module sun {  module star {  module awt {
38*b1cdbd2cSJim Jagielski
39*b1cdbd2cSJim Jagielski//=============================================================================
40*b1cdbd2cSJim Jagielski
41*b1cdbd2cSJim Jagielski/** specifies a keyboard focus event.
42*b1cdbd2cSJim Jagielski
43*b1cdbd2cSJim Jagielski	<p>There are two levels of focus change events: permanent and temporary.
44*b1cdbd2cSJim Jagielski	Permanent focus change events occur when focus is directly moved
45*b1cdbd2cSJim Jagielski	from one component to another, such as through calls to requestFocus()
46*b1cdbd2cSJim Jagielski	or as the user uses the Tab key to traverse components.
47*b1cdbd2cSJim Jagielski	Temporary focus change events occur when focus is
48*b1cdbd2cSJim Jagielski	gained or lost for a component as the indirect result of another
49*b1cdbd2cSJim Jagielski	operation, such as window deactivation or a scrollbar drag.  In this
50*b1cdbd2cSJim Jagielski	case, the original focus state will automatically be restored once
51*b1cdbd2cSJim Jagielski	that operation is finished, or for the case of window deactivation,
52*b1cdbd2cSJim Jagielski	when the window is reactivated.  Both permanent and temporary focus
53*b1cdbd2cSJim Jagielski	events are delivered using the FOCUS_GAINED and FOCUS_LOST event ids;
54*b1cdbd2cSJim Jagielski	the levels may be distinguished in the event using the isTemporary()
55*b1cdbd2cSJim Jagielski	method.</p>
56*b1cdbd2cSJim Jagielski */
57*b1cdbd2cSJim Jagielskipublished struct FocusEvent: com::sun::star::lang::EventObject
58*b1cdbd2cSJim Jagielski{
59*b1cdbd2cSJim Jagielski	//-------------------------------------------------------------------------
60*b1cdbd2cSJim Jagielski
61*b1cdbd2cSJim Jagielski	/** specifies the reason for the focus change as an arithmentic-or
62*b1cdbd2cSJim Jagielski		combination of <type>FocusChangeReason</type>.
63*b1cdbd2cSJim Jagielski
64*b1cdbd2cSJim Jagielski        @see FocusChangeReason
65*b1cdbd2cSJim Jagielski	 */
66*b1cdbd2cSJim Jagielski	short FocusFlags;
67*b1cdbd2cSJim Jagielski
68*b1cdbd2cSJim Jagielski	//-------------------------------------------------------------------------
69*b1cdbd2cSJim Jagielski
70*b1cdbd2cSJim Jagielski	/** contains the window which gets the focus on a lose focus event.
71*b1cdbd2cSJim Jagielski	 */
72*b1cdbd2cSJim Jagielski	com::sun::star::uno::XInterface NextFocus;
73*b1cdbd2cSJim Jagielski
74*b1cdbd2cSJim Jagielski	//-------------------------------------------------------------------------
75*b1cdbd2cSJim Jagielski
76*b1cdbd2cSJim Jagielski	/** specifies if this focus change event is a temporary change.
77*b1cdbd2cSJim Jagielski	 */
78*b1cdbd2cSJim Jagielski	boolean Temporary;
79*b1cdbd2cSJim Jagielski
80*b1cdbd2cSJim Jagielski};
81*b1cdbd2cSJim Jagielski
82*b1cdbd2cSJim Jagielski//=============================================================================
83*b1cdbd2cSJim Jagielski
84*b1cdbd2cSJim Jagielski}; }; }; };
85*b1cdbd2cSJim Jagielski
86*b1cdbd2cSJim Jagielski#endif
87