LibreOffice: com/sun/star/ui/XUIElementFactoryRegistration.idl Source File

LibreOffice LibreOffice 7.2 SDK API Reference

XUIElementFactoryRegistration.idl
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#ifndef __com_sun_star_ui_XUIElementFactoryRegistration_idl__
21#define __com_sun_star_ui_XUIElementFactoryRegistration_idl__
22
23#include <com/sun/star/uno/XInterface.idl>
24#include <com/sun/star/ui/XUIElementFactory.idl>
25#include <com/sun/star/container/ElementExistException.idl>
26#include <com/sun/star/container/NoSuchElementException.idl>
27#include <com/sun/star/beans/PropertyValue.idl>
28
29
30module com { module sun { module star { module ui {
31
32
58 interface XUIElementFactoryRegistration : com::sun::star::uno::XInterface
59{
78 sequence< sequence< com::sun::star::beans::PropertyValue > > getRegisteredFactories();
79
96 ::com::sun::star::ui::XUIElementFactory getFactory( [in] string ResourceURL, [in] string ModuleIdentifier );
97
122 void registerFactory( [in] string aType, [in] string aName, [in] string aModuleIdentifier, [in] string aFactoryImplementationName ) raises (com::sun::star::container::ElementExistException);
123
151 void deregisterFactory( [in] string aType, [in] string aName, [in] string ModuleIdentifier ) raises (com::sun::star::container::NoSuchElementException);
152};
153
154}; }; }; };
155
156
157#endif
158
159/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
ElementExistException.idl
NoSuchElementException.idl
PropertyValue.idl
XInterface.idl
XUIElementFactory.idl
com::sun::star::container::ElementExistException
is thrown by container methods, if an element is added which is already a child of the container.
Definition: ElementExistException.idl:39
com::sun::star::container::NoSuchElementException
is thrown by child access methods of collections, if the addressed child does not exist.
Definition: NoSuchElementException.idl:35
com::sun::star::ui::XUIElementFactoryRegistration
is used to query, register and deregister user interface element factories.
Definition: XUIElementFactoryRegistration.idl:59
com::sun::star::ui::XUIElementFactoryRegistration::registerFactory
void registerFactory([in] string aType, [in] string aName, [in] string aModuleIdentifier, [in] string aFactoryImplementationName)
function to register a user interface element factory.
com::sun::star::ui::XUIElementFactoryRegistration::getRegisteredFactories
sequence< sequence< com::sun::star::beans::PropertyValue > > getRegisteredFactories()
function to retrieve a list of all registered user interface element factories
com::sun::star::ui::XUIElementFactoryRegistration::getFactory
::com::sun::star::ui::XUIElementFactory getFactory([in] string ResourceURL, [in] string ModuleIdentifier)
function to retrieve a previously registered user interface element factory.
com::sun::star::ui::XUIElementFactoryRegistration::deregisterFactory
void deregisterFactory([in] string aType, [in] string aName, [in] string ModuleIdentifier)
function to remove a previously defined user interface element factory.
com::sun::star::ui::XUIElementFactory
specifies a user interface element factory that can create and initialize user interface elements.
Definition: XUIElementFactory.idl:53
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:48
com
Definition: Ambiguous.idl:22