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