1/************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22#ifndef __com_sun_star_frame_FrameAction_idl__ 23#define __com_sun_star_frame_FrameAction_idl__ 24 25//============================================================================= 26 27 module com { module sun { module star { module frame { 28 29//============================================================================= 30/** these are the events which can happen to the components in frames 31 of the desktop 32 33 <p> 34 Interest listener can get information about loaded/reloaded or unloaded 35 components into a <type>Frame</type>. 36 </p> 37 38 @see XFrame 39 @see XFrameActionListener 40 @see FrameActionEvent 41 */ 42published enum FrameAction 43{ 44 //------------------------------------------------------------------------- 45 /** an event of this kind is broadcast whenever a component is 46 attached to a frame 47 48 <p> 49 This is almost the same as the instantiation of the component 50 within that frame. The component is attached to the frame 51 immediately before this event is broadcast. 52 </p> 53 54 @see XFrame::setComponent() 55 */ 56 COMPONENT_ATTACHED, 57 58 //------------------------------------------------------------------------- 59 /** an event of this kind is broadcast whenever a component is 60 detaching from a frame 61 62 <p> 63 This is quite the same as the destruction of the component 64 which was in that frame. At the moment when the event is broadcast 65 the component is still attached to the frame but in the next 66 moment it won't. 67 </p> 68 69 @see XFrame::setComponent() 70 */ 71 COMPONENT_DETACHING, 72 73 //------------------------------------------------------------------------- 74 /** an event of this kind is broadcast whenever a component is 75 attached to a new model. 76 77 <p> 78 In this case the component remains the same but operates 79 on a new model component. 80 </p> 81 */ 82 COMPONENT_REATTACHED, 83 84 //------------------------------------------------------------------------- 85 /** an event of this kind is broadcast whenever a component gets 86 activated 87 88 <p> 89 Activations are broadcast from the top component which was 90 not active before, down to the inner most component. 91 </p> 92 93 @see XFrame::activate() 94 */ 95 FRAME_ACTIVATED, 96 97 //------------------------------------------------------------------------- 98 /** an event of this kind is broadcasted immediately before the 99 component is deactivated 100 101 <p> 102 Deactivations are broadcast from the innermost component which 103 does not stay active up to the outer most component which does not 104 stay active. 105 </p> 106 107 @see XFrame::deactivate() 108 */ 109 FRAME_DEACTIVATING, 110 111 //------------------------------------------------------------------------- 112 /** an event of this kind is broadcast whenever a component changes 113 its internal context (i.e., the selection). 114 115 <p> 116 If the activation status within a frame changes, this counts as 117 a context change too. 118 </p> 119 120 @see XFrame::contextChanged() 121 */ 122 CONTEXT_CHANGED, 123 124 //------------------------------------------------------------------------- 125 /** an event of this kind is broadcast by an active frame when it 126 is getting UI control (tool control). 127 128 @see XFrame::activate() 129 */ 130 FRAME_UI_ACTIVATED, 131 132 //------------------------------------------------------------------------- 133 /** an event of this kind is broadcast by an active frame when it 134 is losing UI control (tool control). 135 136 @see XFrame::deactivate() 137 */ 138 FRAME_UI_DEACTIVATING 139}; 140 141//============================================================================= 142 143}; }; }; }; 144 145#endif 146