summaryrefslogtreecommitdiffstats
path: root/udkapi/com/sun/star/container/XSet.idl
blob: 5302f9aca41874f1958af3290ab54b4e81611f72 (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
/* -*- 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_container_XSet_idl__
#define __com_sun_star_container_XSet_idl__

#include <com/sun/star/container/XEnumerationAccess.idl>

#include <com/sun/star/lang/IllegalArgumentException.idl>

#include <com/sun/star/container/ElementExistException.idl>

#include <com/sun/star/container/NoSuchElementException.idl>


module com {  module sun {  module star {  module container {


/** This is the generic interface for supporting the insertion and removal of
    elements.@see XContainer
 */
published interface XSet: com::sun::star::container::XEnumerationAccess
{

    /** @returns
        `TRUE` if the given element is a member of this container,
        otherwise `FALSE`.
     */
    boolean has( [in] any aElement );


    /** inserts the given element into this container.
     */
    void insert( [in] any aElement )
            raises( com::sun::star::lang::IllegalArgumentException,
                    com::sun::star::container::ElementExistException );


    /** removes the given element from this container.
     */
    void remove( [in] any aElement )
            raises( com::sun::star::lang::IllegalArgumentException,
                    com::sun::star::container::NoSuchElementException );

};


}; }; }; };

#endif

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