xref: /trunk/main/offapi/com/sun/star/awt/FocusEvent.idl (revision cdf0e10c)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_awt_FocusEvent_idl__
28#define __com_sun_star_awt_FocusEvent_idl__
29
30#ifndef __com_sun_star_lang_EventObject_idl__
31#include <com/sun/star/lang/EventObject.idl>
32#endif
33
34#ifndef __com_sun_star_uno_XInterface_idl__
35#include <com/sun/star/uno/XInterface.idl>
36#endif
37
38
39//=============================================================================
40
41 module com {  module sun {  module star {  module awt {
42
43//=============================================================================
44
45/** specifies a keyboard focus event.
46
47	<p>There are two levels of focus change events: permanent and temporary.
48	Permanent focus change events occur when focus is directly moved
49	from one component to another, such as through calls to requestFocus()
50	or as the user uses the Tab key to traverse components.
51	Temporary focus change events occur when focus is
52	gained or lost for a component as the indirect result of another
53	operation, such as window deactivation or a scrollbar drag.  In this
54	case, the original focus state will automatically be restored once
55	that operation is finished, or for the case of window deactivation,
56	when the window is reactivated.  Both permanent and temporary focus
57	events are delivered using the FOCUS_GAINED and FOCUS_LOST event ids;
58	the levels may be distinguished in the event using the isTemporary()
59	method.</p>
60 */
61published struct FocusEvent: com::sun::star::lang::EventObject
62{
63	//-------------------------------------------------------------------------
64
65	/** specifies the reason for the focus change as an arithmentic-or
66		combination of <type>FocusChangeReason</type>.
67
68        @see FocusChangeReason
69	 */
70	short FocusFlags;
71
72	//-------------------------------------------------------------------------
73
74	/** contains the window which gets the focus on a lose focus event.
75	 */
76	com::sun::star::uno::XInterface NextFocus;
77
78	//-------------------------------------------------------------------------
79
80	/** specifies if this focus change event is a temporary change.
81	 */
82	boolean Temporary;
83
84};
85
86//=============================================================================
87
88}; }; }; };
89
90#endif
91