summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/ui/XModuleUIConfigurationManagerSupplier.idl
blob: b538728ac7da589389e9bc68551aa151fe1488b4 (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
/* -*- 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_ui_XModuleUIConfigurationManagerSupplier_idl__
#define __com_sun_star_ui_XModuleUIConfigurationManagerSupplier_idl__

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

module com { module sun { module star { module ui {

/** allows to retrieve user interface configuration managers related to
    OpenOffice.org modules.

    @since OOo 2.0
*/

interface XModuleUIConfigurationManagerSupplier : ::com::sun::star::uno::XInterface
{
    /** returns the requested module based user interface configuration manager.

        @param ModuleIdentifier
            a module identifier which identifies an OpenOffice.org module. The
            module identifier can be retrieved from the
            com::sun::star::frame::ModuleManager service.

        @returns
            an object implementing
            ::com::sun::star::ui::ModuleUIConfigurationManager
            service. If the provided module identifier is unknown a
            com::sun::star::container::NoSuchElementException
            is thrown.
    */
    XUIConfigurationManager getUIConfigurationManager( [in] string ModuleIdentifier ) raises ( com::sun::star::container::NoSuchElementException );
};


}; }; }; };

#endif

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