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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_awt_FocusEvent_idl__
  20 #define __com_sun_star_awt_FocusEvent_idl__
  21
  22 #include <com/sun/star/lang/EventObject.idl>
  23
  24 #include <com/sun/star/uno/XInterface.idl>
  25
  26
  27
  28  module com {  module sun {  module star {  module awt {
  29
  30
  31 /** specifies a keyboard focus event.
  32
  33     <p>There are two levels of focus change events: permanent and temporary.
  34     Permanent focus change events occur when focus is directly moved
  35     from one component to another, such as through calls to requestFocus()
  36     or as the user uses the Tab key to traverse components.
  37     Temporary focus change events occur when focus is
  38     gained or lost for a component as the indirect result of another
  39     operation, such as window deactivation or a scrollbar drag.  In this
  40     case, the original focus state will automatically be restored once
  41     that operation is finished, or for the case of window deactivation,
  42     when the window is reactivated.  Both permanent and temporary focus
  43     events are delivered using the FOCUS_GAINED and FOCUS_LOST event ids;
  44     the levels may be distinguished in the event using the isTemporary()
  45     method.</p>
  46  */
  47 published struct FocusEvent: com::sun::star::lang::EventObject
  48 {
  49
  50     /** specifies the reason for the focus change as an arithmetic-or
  51         combination of FocusChangeReason.
  52
  53         @see FocusChangeReason
  54      */
  55     short FocusFlags;
  56
  57
  58     /** contains the window which gets the focus on a lose focus event.
  59      */
  60     com::sun::star::uno::XInterface NextFocus;
  61
  62
  63     /** specifies if this focus change event is a temporary change.
  64      */
  65     boolean Temporary;
  66
  67 };
  68
  69
  70 }; }; }; };
  71
  72 #endif
  73
  74 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */