summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/document/NoSuchFilterRequest.idl
blob: cafedad74ed1727377f1d94b22e4d7c7c2ef9e1c (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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_document_NoSuchFilterRequest_idl__
#define __com_sun_star_document_NoSuchFilterRequest_idl__

#include <com/sun/star/uno/Exception.idl>


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

/** should be used for interaction to handle states of unknown filter during detection

    <p>
    If during loading time the filter can't be detected and wasn't given at calling time,
    a possible com::sun::star::task::InteractionHandler will be used.
    (it's a part of used MediaDescriptor)
    Such "NoSuchFilterRequest" 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 type XInteractionFilterSelect will transport this 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 com::sun::star::task::XInteractionAbort.
    </p>

    @see MediaDescriptor
    @see com::sun::star::task::InteractionHandler
    @see XInteractionFilterSelect
    @see com::sun::star::task::XInteractionAbort
*/
published exception NoSuchFilterRequest : ::com::sun::star::uno::Exception
{
    /** transport URL which couldn't be detected
     */
    string URL;
};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */