offapi/com/sun/star/awt/FocusEvent.idl

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