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