xref: /trunk/main/offapi/com/sun/star/embed/EntryInitModes.idl (revision fc9fd3f14a55d77b35643a64034752a178b2a5b0)
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_embed_EntryInitModes_idl__
28#define __com_sun_star_embed_EntryInitModes_idl__
29
30
31//============================================================================
32
33module com { module sun { module star { module embed {
34
35//============================================================================
36/** This constant set contains possible modes to initialize object
37    persistance.
38
39    @see XEmbedPersist
40*/
41published constants EntryInitModes
42{
43    // -----------------------------------------------------------------------
44    /** In case object persistance is created based on existing entry,
45        the object should be initialized from this entry. Otherwise
46        the object should be initialized as a new one.
47     */
48    const long DEFAULT_INIT = 0;
49
50    // -----------------------------------------------------------------------
51    /** The object should be initialized as a new empty one.
52     */
53    const long TRUNCATE_INIT = 1;
54
55    // -----------------------------------------------------------------------
56    /** The object should be initialized as a new one only in case it still
57        was not initialized. If the object initialized already do not
58        reinitialize it.
59     */
60    const long NO_INIT = 2;
61
62    // -----------------------------------------------------------------------
63    /** The object should be initialized using additional arguments from
64        provided
65        <type scope="com::sun::star::document">MediaDescriptor</type>.
66     */
67    const long MEDIA_DESCRIPTOR_INIT = 3;
68
69    // -----------------------------------------------------------------------
70    /** The object should be initialized as a link using URL provided in
71        additional arguments.
72     */
73    const long URL_LINK_INIT = 4;
74};
75
76//============================================================================
77
78}; }; }; };
79
80#endif
81
82