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_embed_EmbedStates_idl__
24#define __com_sun_star_embed_EmbedStates_idl__
25
26
27//============================================================================
28
29module com { module sun { module star { module embed {
30
31//============================================================================
32/** This constant set contains possible states for
33<type>EmbeddedObject</type>.
34*/
35published constants EmbedStates
36{
37	//------------------------------------------------------------------------
38	/** "Loaded" - the persistent representation of the object is loaded in
39		memory.
40
41		<p>
42		The object is created and assigned with a persistent entry,
43		and a view representation ( metafile and etc. ) can be retrieved
44		( if there is any ).
45		</p>
46	 */
47	const long LOADED = 0;
48
49	//------------------------------------------------------------------------
50	/** "Running" - the object is connected and loaded.
51
52		<p>
53		The object has a connection to the container client and a component
54		loaded from persistent entry. In case of internal document it also
55		means existing of document model that implements
56		<type scope="com::sun::star::frame">XModel</type> interface.
57		</p>
58	 */
59	const long RUNNING = 1;
60
61	//------------------------------------------------------------------------
62	/** "Active" - the object is activated in separate window
63		( outplace activation ).
64	 */
65	const long ACTIVE = 2;
66
67	//------------------------------------------------------------------------
68	/** "Inplace active" - the object has own window in the container's
69		window.
70
71		<p>
72		The object is activated and has it's own window in the container's
73		window that allows object to process mouse events and control own
74		rendering.
75		</p>
76	 */
77	const long INPLACE_ACTIVE = 3;
78
79	//------------------------------------------------------------------------
80	/** "UI active" - the inplace active object that has user interface.
81
82		<p>
83		The object is inplace active, allowed to have menues, toolbars,
84		keyboard accelerators, and has the focus.
85		</p>
86	 */
87	const long UI_ACTIVE = 4;
88};
89
90//============================================================================
91
92}; }; }; };
93
94#endif
95
96