offapi/com/sun/star/frame/FrameAction.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: FrameAction.idl,v $
  10  * $Revision: 1.9 $
  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_frame_FrameAction_idl__
  31 #define __com_sun_star_frame_FrameAction_idl__
  32
  33
  34 //=============================================================================
  35
  36  module com {  module sun {  module star {  module frame {
  37
  38 //=============================================================================
  39 /** these are the events which can happen to the components in frames
  40     of the desktop
  41
  42     <p>
  43     Interest listener can get informations about loaded/realoed or unloaded
  44     components into a <type>Frame</type>.
  45     </p>
  46
  47     @see XFrame
  48     @see XFrameActionListener
  49     @see FrameActionEvent
  50  */
  51 published enum FrameAction
  52 {
  53     //-------------------------------------------------------------------------
  54     /** an event of this kind is broadcast whenever a component is
  55         attached to a frame
  56
  57         <p>
  58         This is almost the same as the instantiation of the component
  59         within that frame. The component is attached to the frame
  60         immediately before this event is broadcast.
  61         </p>
  62
  63         @see XFrame::setComponent()
  64      */
  65     COMPONENT_ATTACHED,
  66
  67     //-------------------------------------------------------------------------
  68     /** an event of this kind is broadcast whenever a component is
  69         detaching from a frame
  70
  71         <p>
  72         This is quite the same as the destruction of the component
  73         which was in that frame. At the moment when the event is broadcast
  74         the component is still attached to the frame but in the next
  75         moment it won't.
  76         </p>
  77
  78         @see XFrame::setComponent()
  79      */
  80     COMPONENT_DETACHING,
  81
  82     //-------------------------------------------------------------------------
  83     /** an event of this kind is broadcast whenever a component is
  84         attached to a new model.
  85
  86         <p>
  87         In this case the component remains the same but operates
  88         on a new model component.
  89         </p>
  90      */
  91     COMPONENT_REATTACHED,
  92
  93     //-------------------------------------------------------------------------
  94     /** an event of this kind is broadcast whenever a component gets
  95         activated
  96
  97         <p>
  98         Activations are broacast from the top component which was
  99         not active before, down to the inner most component.
 100         </p>
 101
 102         @see XFrame::activate()
 103      */
 104     FRAME_ACTIVATED,
 105
 106     //-------------------------------------------------------------------------
 107     /** an event of this kind is broadcasted immediately before the
 108         component is deactivated
 109
 110         <p>
 111         Deactivations are broadcast from the innermost component which
 112         does not stay active up to the outer most component which does not
 113         stay active.
 114         </p>
 115
 116         @see XFrame::deactivate()
 117      */
 118     FRAME_DEACTIVATING,
 119
 120     //-------------------------------------------------------------------------
 121     /** an event of this kind is broadcast whenever a component changes
 122         its internal context (i.e., the selection).
 123
 124         <p>
 125         If the activation status within a frame changes, this counts as
 126         a context change too.
 127         </p>
 128
 129         @see XFrame::contextChanged()
 130      */
 131     CONTEXT_CHANGED,
 132
 133     //-------------------------------------------------------------------------
 134     /** an event of this kind is broadcast by an active frame when it
 135         is getting UI control (tool control).
 136
 137         @see XFrame::activate()
 138      */
 139     FRAME_UI_ACTIVATED,
 140
 141     //-------------------------------------------------------------------------
 142     /** an event of this kind is broadcast by an active frame when it
 143         is losing UI control (tool control).
 144
 145         @see XFrame::deactivate()
 146      */
 147     FRAME_UI_DEACTIVATING
 148 };
 149
 150 //=============================================================================
 151
 152 }; }; }; };
 153
 154 #endif