summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/document/XInteractionFilterSelect.idl
blob: 2e396f4aa1653f068ee2c2d91d7fb10e8a64829c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_document_XInteractionFilterSelect_idl__
#define __com_sun_star_document_XInteractionFilterSelect_idl__

#ifndef __com_sun_star_task_XInteractionContinuation_idl__
#include <com/sun/star/task/XInteractionContinuation.idl>
#endif

//=============================================================================

module com { module sun { module star { module document {

//=============================================================================
/** continuation used by interaction mechanism at filter detection during
    loading documents

    <p>
    If during loading time the filter can't be detected and wasn't given at calling time,
    a possible <type scope="com::sun::star::task">InteractionHandler</type> will be used.
    (it's a a part of used <type>MediaDescriptor</type>)
    A <type>NoSuchFilterRequest</type> will be used then to start right interaction on that to
    get a decision which filter should be used for given URL. A possible continuation
    of that can be this XInteractionFilterSelect. It will transport the decision back to
    generic filter detection and force using of it. Of course it's possible to abort
    the loading process by use another continuation <type scope="com::sun::star::task">XInteractionAbort</type>.
    </p>

    @see MediaDescriptor
    @see com::sun::star::task::InteractionHandler
    @see NoSuchFilterRequest
    @see com::sun::star::task::XInteractionAbort
 */
published interface XInteractionFilterSelect : com::sun::star::task::XInteractionContinuation
{
    //-------------------------------------------------------------------------
    /** used by interaction to set selected filter

        <p>
        This value must be save till another one will be set
        and must be provided on getFilter() for interest users.
        </p>
     */
    void setFilter( [in] string Name );

    //-------------------------------------------------------------------------
    /** used by detection to get selected filter
     */
    string getFilter();
};

//=============================================================================

}; }; }; };

#endif