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