1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_frame_FrameAction_idl__
28#define __com_sun_star_frame_FrameAction_idl__
29
30
31//=============================================================================
32
33 module com {  module sun {  module star {  module frame {
34
35//=============================================================================
36/** these are the events which can happen to the components in frames
37    of the desktop
38
39    <p>
40    Interest listener can get informations about loaded/realoed or unloaded
41    components into a <type>Frame</type>.
42    </p>
43
44    @see XFrame
45    @see XFrameActionListener
46    @see FrameActionEvent
47 */
48published enum FrameAction
49{
50	//-------------------------------------------------------------------------
51    /** an event of this kind is broadcast whenever a component is
52        attached to a frame
53
54        <p>
55        This is almost the same as the instantiation of the component
56		within that frame. The component is attached to the frame
57        immediately before this event is broadcast.
58        </p>
59
60        @see XFrame::setComponent()
61	 */
62	COMPONENT_ATTACHED,
63
64	//-------------------------------------------------------------------------
65    /** an event of this kind is broadcast whenever a component is
66        detaching from a frame
67
68        <p>
69        This is quite the same as the destruction of the component
70		which was in that frame. At the moment when the event is broadcast
71		the component is still attached to the frame but in the next
72		moment it won't.
73		</p>
74
75        @see XFrame::setComponent()
76	 */
77	COMPONENT_DETACHING,
78
79	//-------------------------------------------------------------------------
80    /** an event of this kind is broadcast whenever a component is
81		attached to a new model.
82
83        <p>
84        In this case the component remains the same but operates
85        on a new model component.
86        </p>
87	 */
88	COMPONENT_REATTACHED,
89
90	//-------------------------------------------------------------------------
91    /** an event of this kind is broadcast whenever a component gets
92        activated
93
94        <p>
95        Activations are broacast from the top component which was
96        not active before, down to the inner most component.
97        </p>
98
99        @see XFrame::activate()
100	 */
101	FRAME_ACTIVATED,
102
103	//-------------------------------------------------------------------------
104    /** an event of this kind is broadcasted immediately before the
105        component is deactivated
106
107        <p>
108        Deactivations are broadcast from the innermost component which
109		does not stay active up to the outer most component which does not
110        stay active.
111        </p>
112
113        @see XFrame::deactivate()
114	 */
115	FRAME_DEACTIVATING,
116
117	//-------------------------------------------------------------------------
118    /** an event of this kind is broadcast whenever a component changes
119		its internal context (i.e., the selection).
120
121        <p>
122        If the activation status within a frame changes, this counts as
123		a context change too.
124		</p>
125
126        @see XFrame::contextChanged()
127	 */
128	CONTEXT_CHANGED,
129
130	//-------------------------------------------------------------------------
131    /** an event of this kind is broadcast by an active frame when it
132		is getting UI control (tool control).
133
134        @see XFrame::activate()
135	 */
136	FRAME_UI_ACTIVATED,
137
138	//-------------------------------------------------------------------------
139    /** an event of this kind is broadcast by an active frame when it
140		is losing UI control (tool control).
141
142        @see XFrame::deactivate()
143	 */
144	FRAME_UI_DEACTIVATING
145};
146
147//=============================================================================
148
149}; }; }; };
150
151#endif
152