summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/io/XConnectable.idl
blob: 4c56e64a331220f8ce86a0e18555228c760d312f (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
81
82
83
/* -*- 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_io_XConnectable_idl__
#define __com_sun_star_io_XConnectable_idl__

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


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

 module com {  module sun {  module star {  module io {

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

// DocMerge from xml: interface com::sun::star::io::XConnectable
/** makes it possible to connect data sinks and sources.

    <p>The predecessor-member is the element in the connection that is
    nearer to the source of the data. The successor-member is the element
    that is further away from the source of the data. (Note that this
    classification does not depend on whether the class implements
    <type>XInputStream</type> or <type>XOutputStream</type>; it only
    depends on the direction of data flow.) </p>
    <p>This interface allows generic services to navigate between
    arbitrary elements of a connection.</p>
 */
published interface XConnectable: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::io::XConnectable::setPredecessor
    /** sets the source of the data flow for this object.
     */
    void setPredecessor( [in] com::sun::star::io::XConnectable aPredecessor );

    //-------------------------------------------------------------------------

    // DocMerge from idl: method com::sun::star::io::XConnectable::getPredecessor
    /** @returns
            the predecessor of this object.
     */
    com::sun::star::io::XConnectable getPredecessor();

    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::io::XConnectable::setSuccessor
    /** sets the sink of the data flow for this object.
     */
    void setSuccessor( [in] com::sun::star::io::XConnectable aSuccessor );

    //-------------------------------------------------------------------------

    // DocMerge from idl: method com::sun::star::io::XConnectable::getSuccessor
    /** @returns
            the successor of this object.
     */
    com::sun::star::io::XConnectable getSuccessor();

};

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

}; }; }; };

#endif

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