LibreOffice LibreOffice 5.3 SDK API Reference

XUpdateHandler.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 #ifndef __com_sun_star_configuration_backend_XUpdateHandler_idl__
20 #define __com_sun_star_configuration_backend_XUpdateHandler_idl__
21
22 #include <com/sun/star/uno/XInterface.idl>
23 #include <com/sun/star/configuration/backend/TemplateIdentifier.idl>
24
25 #include <com/sun/star/configuration/backend/MalformedDataException.idl>
26 #include <com/sun/star/lang/WrappedTargetException.idl>
27 #include <com/sun/star/lang/IllegalAccessException.idl>
28
29
30 module com { module sun { module star { module configuration { module backend {
31
32
38 published interface XUpdateHandler: ::com::sun::star::uno::XInterface
39 {
40
55 void startUpdate( )
56 raises( MalformedDataException,
57 com::sun::star::lang::IllegalAccessException,
58 com::sun::star::lang::WrappedTargetException );
59
80 void endUpdate( )
81 raises( MalformedDataException,
82 com::sun::star::lang::IllegalAccessException,
83 com::sun::star::lang::WrappedTargetException );
84
135 void modifyNode ( [in] string aName,
136 [in] short aAttributes,
137 [in] short aAttributeMask,
138 [in] boolean bReset )
139 raises( MalformedDataException,
140 com::sun::star::lang::WrappedTargetException );
141
183 void addOrReplaceNode ( [in] string aName,
184 [in] short aAttributes )
185 raises( MalformedDataException,
186 com::sun::star::lang::WrappedTargetException );
187
231 void addOrReplaceNodeFromTemplate( [in] string aName,
232 [in] short aAttributes,
233 [in] TemplateIdentifier aTemplate )
234 raises( MalformedDataException,
235 com::sun::star::lang::WrappedTargetException );
236
255 void endNode( )
256 raises( MalformedDataException,
257 com::sun::star::lang::WrappedTargetException );
258
281 void removeNode( [in] string aName )
282 raises( MalformedDataException,
283 com::sun::star::lang::WrappedTargetException );
284
339 void modifyProperty( [in] string aName,
340 [in] short aAttributes,
341 [in] short aAttributeMask,
342 [in] type aType )
343 raises( MalformedDataException,
344 com::sun::star::lang::WrappedTargetException );
345
372 void setPropertyValue( [in] any aValue )
373 raises( MalformedDataException,
374 com::sun::star::lang::WrappedTargetException );
375
407 void setPropertyValueForLocale( [in] any aValue, [in] string aLocale )
408 raises( MalformedDataException,
409 com::sun::star::lang::WrappedTargetException );
410
426 void resetPropertyValue( )
427 raises( MalformedDataException,
428 com::sun::star::lang::WrappedTargetException );
429
450 void resetPropertyValueForLocale( [in] string aLocale )
451 raises( MalformedDataException,
452 com::sun::star::lang::WrappedTargetException );
453
470 void endProperty( )
471 raises( MalformedDataException,
472 com::sun::star::lang::WrappedTargetException );
473
495 void resetProperty( [in] string aName )
496 raises( MalformedDataException,
497 com::sun::star::lang::WrappedTargetException );
498
542 void addOrReplaceProperty( [in] string aName,
543 [in] short aAttributes,
544 [in] type aType )
545 raises( MalformedDataException,
546 com::sun::star::lang::WrappedTargetException );
547
596 void addOrReplacePropertyWithValue( [in] string aName,
597 [in] short aAttributes,
598 [in] any aValue )
599 raises( MalformedDataException,
600 com::sun::star::lang::WrappedTargetException );
601
621 void removeProperty( [in] string aName )
622 raises( MalformedDataException,
623 com::sun::star::lang::WrappedTargetException );
624
625 };
626
627
628 }; }; }; }; };
629
630
631 #endif
632
633 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::configuration::backend::TemplateIdentifier
holds the data needed to identify a template.
Definition: TemplateIdentifier.idl:32
MalformedDataException.idl
com
Definition: Ambiguous.idl:22
IllegalAccessException.idl
TemplateIdentifier.idl
XInterface.idl
com::sun::star::lang::WrappedTargetException
This is a checked exception that wraps an exception thrown by the original target.
Definition: WrappedTargetException.idl:37
com::sun::star::configuration::backend::XUpdateHandler
receives a description of a configuration update or layer as a sequence of events.
Definition: XUpdateHandler.idl:38
com::sun::star::lang::IllegalAccessException
This exception is thrown when an application tries to change a constant property. ...
Definition: IllegalAccessException.idl:31
com::sun::star::configuration::backend::MalformedDataException
is raised when the data of a component schema, layer or update is not well-formed, violates the schema or is otherwise invalid.
Definition: MalformedDataException.idl:33
WrappedTargetException.idl
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:47