summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/configuration/backend/XSchemaHandler.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/configuration/backend/XSchemaHandler.idl')
-rw-r--r--offapi/com/sun/star/configuration/backend/XSchemaHandler.idl256
1 files changed, 128 insertions, 128 deletions
diff --git a/offapi/com/sun/star/configuration/backend/XSchemaHandler.idl b/offapi/com/sun/star/configuration/backend/XSchemaHandler.idl
index 635eb6164bbd..8112541a8a1b 100644
--- a/offapi/com/sun/star/configuration/backend/XSchemaHandler.idl
+++ b/offapi/com/sun/star/configuration/backend/XSchemaHandler.idl
@@ -1,7 +1,7 @@
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
- *
+ *
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
@@ -24,39 +24,39 @@
* for a copy of the LGPLv3 License.
*
************************************************************************/
-#ifndef __com_sun_star_configuration_backend_XSchemaHandler_idl__
+#ifndef __com_sun_star_configuration_backend_XSchemaHandler_idl__
#define __com_sun_star_configuration_backend_XSchemaHandler_idl__
-
-#ifndef __com_sun_star_uno_XInterface_idl__
-#include <com/sun/star/uno/XInterface.idl>
-#endif
-
-#ifndef __com_sun_star_configuration_backend_TemplateIdentifier_idl__
-#include <com/sun/star/configuration/backend/TemplateIdentifier.idl>
-#endif
-
-#ifndef __com_sun_star_configuration_backend_MalformedDataException_idl__
-#include <com/sun/star/configuration/backend/MalformedDataException.idl>
-#endif
-
-#ifndef __com_sun_star_lang_WrappedTargetException_idl__
-#include <com/sun/star/lang/WrappedTargetException.idl>
-#endif
+
+#ifndef __com_sun_star_uno_XInterface_idl__
+#include <com/sun/star/uno/XInterface.idl>
+#endif
+
+#ifndef __com_sun_star_configuration_backend_TemplateIdentifier_idl__
+#include <com/sun/star/configuration/backend/TemplateIdentifier.idl>
+#endif
+
+#ifndef __com_sun_star_configuration_backend_MalformedDataException_idl__
+#include <com/sun/star/configuration/backend/MalformedDataException.idl>
+#endif
+
+#ifndef __com_sun_star_lang_WrappedTargetException_idl__
+#include <com/sun/star/lang/WrappedTargetException.idl>
+#endif
//=============================================================================
-
+
module com { module sun { module star { module configuration { module backend {
-
-//=============================================================================
-
+
+//=============================================================================
+
/** receives a description of a configuration schema as a sequence of events.
@since OOo 1.1.2
*/
published interface XSchemaHandler: ::com::sun::star::uno::XInterface
-{
- //-------------------------------------------------------------------------
-
+{
+ //-------------------------------------------------------------------------
+
/** receives notification that a schema description is started.
<p> The schema descrption may comprise components templates or both.
@@ -70,9 +70,9 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface
*/
void startSchema( )
raises( MalformedDataException,
- com::sun::star::lang::WrappedTargetException );
- //-------------------------------------------------------------------------
-
+ com::sun::star::lang::WrappedTargetException );
+ //-------------------------------------------------------------------------
+
/** receives notification that the current schema description is complete.
<p> Must match a previous call to <member>startSchema</member>.
@@ -91,9 +91,9 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface
*/
void endSchema( )
raises( MalformedDataException,
- com::sun::star::lang::WrappedTargetException );
- //-------------------------------------------------------------------------
-
+ com::sun::star::lang::WrappedTargetException );
+ //-------------------------------------------------------------------------
+
/** receives notification that the schema depends on templates
from a different component.
@@ -112,11 +112,11 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface
@throws com::sun::star::lang::WrappedTargetException
if an error occurs processing the event.
*/
- void importComponent( [in] string aName )
+ void importComponent( [in] string aName )
raises( MalformedDataException,
- com::sun::star::lang::WrappedTargetException );
- //-------------------------------------------------------------------------
-
+ com::sun::star::lang::WrappedTargetException );
+ //-------------------------------------------------------------------------
+
/** receives notification that a component description is started.
<p> Subsequent calls describe the schema of the component
@@ -140,11 +140,11 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface
@throws com::sun::star::lang::WrappedTargetException
if an error occurs processing the event.
*/
- void startComponent( [in] string aName )
+ void startComponent( [in] string aName )
raises( MalformedDataException,
- com::sun::star::lang::WrappedTargetException );
- //-------------------------------------------------------------------------
-
+ com::sun::star::lang::WrappedTargetException );
+ //-------------------------------------------------------------------------
+
/** receives notification that a component description is complete.
<p> Must match a previous call to <member>startComponent</member>.
@@ -162,11 +162,11 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface
@throws com::sun::star::lang::WrappedTargetException
if an error occurs processing the event.
*/
- void endComponent( )
+ void endComponent( )
raises( MalformedDataException,
- com::sun::star::lang::WrappedTargetException );
- //-------------------------------------------------------------------------
-
+ com::sun::star::lang::WrappedTargetException );
+ //-------------------------------------------------------------------------
+
/** receives notification that a template description is started for a group.
<p> Subsequent calls describe the members and properties of the template
@@ -180,11 +180,11 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface
@param aAttributes
specifies the attributes of the template.
- <p> The value is a combination of
+ <p> The value is a combination of
<type>SchemaAttribute</type> flags.
</p>
- <p> <const>SchemaAttribute::EXTENSIBLE</const> can be used
- to describe a template for a node with an extensible
+ <p> <const>SchemaAttribute::EXTENSIBLE</const> can be used
+ to describe a template for a node with an extensible
set of properties.
</p>
@@ -205,11 +205,11 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface
@see com::sun::star::configuration::backend::SchemaAttribute
*/
void startGroupTemplate( [in] TemplateIdentifier aTemplate,
- [in] short aAttributes )
+ [in] short aAttributes )
raises( MalformedDataException,
- com::sun::star::lang::WrappedTargetException );
- //-------------------------------------------------------------------------
-
+ com::sun::star::lang::WrappedTargetException );
+ //-------------------------------------------------------------------------
+
/** receives notification that a template description is started for a set.
<p> Subsequent calls describe the members and properties of the template
@@ -223,11 +223,11 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface
@param aAttributes
specifies the attributes of the template.
- <p> The value is a combination of
+ <p> The value is a combination of
<type>SchemaAttribute</type> flags.
</p>
- <p> <const>SchemaAttribute::EXTENSIBLE</const> can be used
- to describe a template for a node with an extensible
+ <p> <const>SchemaAttribute::EXTENSIBLE</const> can be used
+ to describe a template for a node with an extensible
set of properties.
</p>
@@ -251,13 +251,13 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface
@see com::sun::star::configuration::backend::SchemaAttribute
*/
- void startSetTemplate( [in] TemplateIdentifier aTemplate,
- [in] short aAttributes,
- [in] TemplateIdentifier aItemType )
+ void startSetTemplate( [in] TemplateIdentifier aTemplate,
+ [in] short aAttributes,
+ [in] TemplateIdentifier aItemType )
raises( MalformedDataException,
- com::sun::star::lang::WrappedTargetException );
- //-------------------------------------------------------------------------
-
+ com::sun::star::lang::WrappedTargetException );
+ //-------------------------------------------------------------------------
+
/** receives notification that a template description is complete.
<p> Must match a previous call to <member>startGroupTemplate</member>
@@ -276,11 +276,11 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface
@throws com::sun::star::lang::WrappedTargetException
if an error occurs processing the event.
*/
- void endTemplate( )
+ void endTemplate( )
raises( MalformedDataException,
- com::sun::star::lang::WrappedTargetException );
- //-------------------------------------------------------------------------
-
+ com::sun::star::lang::WrappedTargetException );
+ //-------------------------------------------------------------------------
+
/** receives notification that a group description is started.
<p> Subsequent calls describe the members and properties of the group
@@ -294,10 +294,10 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface
@param aAttributes
specifies the attributes of the node.
- <p> The value is a combination of
+ <p> The value is a combination of
<type>SchemaAttribute</type> flags.
</p>
- <p> <const>SchemaAttribute::EXTENSIBLE</const> can be used
+ <p> <const>SchemaAttribute::EXTENSIBLE</const> can be used
to describe a group with an extensible set of properties.
</p>
@@ -305,7 +305,7 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface
<ul>
<li>if there isn't a group node in progress currently</li>
<li>if there already is a node with that name</li>
- <li>if the name is not a valid node name</li>
+ <li>if the name is not a valid node name</li>
<li>if the attributes are not valid for a group</li>
</ul>
<p><em>Not every implementation can detect each condition</em></p>
@@ -316,11 +316,11 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface
@see com::sun::star::configuration::backend::SchemaAttribute
*/
void startGroup( [in] string aName,
- [in] short aAttributes )
+ [in] short aAttributes )
raises( MalformedDataException,
- com::sun::star::lang::WrappedTargetException );
- //-------------------------------------------------------------------------
-
+ com::sun::star::lang::WrappedTargetException );
+ //-------------------------------------------------------------------------
+
/** receives notification that a set description is started.
<p> Subsequent calls describe the item-types and properties of the set
@@ -334,10 +334,10 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface
@param aAttributes
specifies the attributes of the node.
- <p> The value is a combination of
+ <p> The value is a combination of
<type>SchemaAttribute</type> flags.
</p>
- <p> <const>SchemaAttribute::EXTENSIBLE</const> can be used
+ <p> <const>SchemaAttribute::EXTENSIBLE</const> can be used
to describe a set with an extensible set of properties.
</p>
@@ -350,7 +350,7 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface
<li>if there already is a node with that name</li>
<li>if the item-type template is not found</li>
<li>if the name is not a valid node name</li>
- <li>if the item-type is not a valid template identifier</li>
+ <li>if the item-type is not a valid template identifier</li>
<li>if the attributes are not valid for a set</li>
</ul>
<p><em>Not every implementation can detect each condition</em></p>
@@ -361,12 +361,12 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface
@see com::sun::star::configuration::backend::SchemaAttribute
*/
void startSet( [in] string aName,
- [in] short aAttributes,
- [in] TemplateIdentifier aItemType )
+ [in] short aAttributes,
+ [in] TemplateIdentifier aItemType )
raises( MalformedDataException,
- com::sun::star::lang::WrappedTargetException );
- //-------------------------------------------------------------------------
-
+ com::sun::star::lang::WrappedTargetException );
+ //-------------------------------------------------------------------------
+
/** receives notification that a node description is complete.
<p> Must match the last open call to <member>startGroup</member>
@@ -384,14 +384,14 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface
@throws com::sun::star::lang::WrappedTargetException
if an error occurs processing the event.
*/
- void endNode( )
+ void endNode( )
raises( MalformedDataException,
- com::sun::star::lang::WrappedTargetException );
- //-------------------------------------------------------------------------
-
- /** receives notification that a property is added to the current node.
+ com::sun::star::lang::WrappedTargetException );
+ //-------------------------------------------------------------------------
+
+ /** receives notification that a property is added to the current node.
- <p> The property will have a default value of <NULL/>
+ <p> The property will have a default value of <NULL/>
(unless it is <const>SchemaAttribute::REQUIRED</const>).
</p>
@@ -401,7 +401,7 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface
@param aAttributes
specifies the attributes of the new property.
- <p> The value is a combination of
+ <p> The value is a combination of
<type>SchemaAttribute</type> flags.
</p>
@@ -413,7 +413,7 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface
<li>if there isn't a group or extensible node in progress currently</li>
<li>if a property with the same name already exists</li>
<li>if the specified type is not allowed</li>
- <li>if the name is not a valid property name</li>
+ <li>if the name is not a valid property name</li>
<li>if the attributes are not valid for a property</li>
</ul>
<p><em>Not every implementation can detect each condition</em></p>
@@ -423,16 +423,16 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface
@see com::sun::star::configuration::backend::SchemaAttribute
*/
- void addProperty( [in] string aName,
- [in] short aAttributes,
- [in] type aType )
+ void addProperty( [in] string aName,
+ [in] short aAttributes,
+ [in] type aType )
raises( MalformedDataException,
- com::sun::star::lang::WrappedTargetException );
-
- //-------------------------------------------------------------------------
-
- /** receives notification that a property having a default value
- is added to the current node.
+ com::sun::star::lang::WrappedTargetException );
+
+ //-------------------------------------------------------------------------
+
+ /** receives notification that a property having a default value
+ is added to the current node.
@param aName
specifies the name of the new property.
@@ -440,14 +440,14 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface
@param aAttributes
specifies the attributes of the new property.
- <p> The value is a combination of
+ <p> The value is a combination of
<type>SchemaAttribute</type> flags.
</p>
@param aDefaultValue
specifies the value of the new property.
- <p> The value also determines the type.
+ <p> The value also determines the type.
Therefore the value must not be <void/>.
</p>
@@ -456,7 +456,7 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface
<li>if there isn't a group or extensible node in progress currently</li>
<li>if a property with the same name already exists</li>
<li>if the type of the default value is not an allowed type,
- or if the default value is <void/></li>
+ or if the default value is <void/></li>
<li>if the name is not a valid property name</li>
<li>if the attributes are not valid for a property</li>
</ul>
@@ -467,15 +467,15 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface
@see com::sun::star::configuration::backend::SchemaAttribute
*/
- void addPropertyWithDefault( [in] string aName,
- [in] short aAttributes,
- [in] any aDefaultValue )
+ void addPropertyWithDefault( [in] string aName,
+ [in] short aAttributes,
+ [in] any aDefaultValue )
raises( MalformedDataException,
- com::sun::star::lang::WrappedTargetException );
-
- //-------------------------------------------------------------------------
-
- /** receives notification that the current group has a child node
+ com::sun::star::lang::WrappedTargetException );
+
+ //-------------------------------------------------------------------------
+
+ /** receives notification that the current group has a child node
that is an instance of a specified template.
@param aName
@@ -496,18 +496,18 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface
@throws com::sun::star::lang::WrappedTargetException
if an error occurs processing the event.
*/
- void addInstance( [in] string aName,
- [in] TemplateIdentifier aTemplate )
+ void addInstance( [in] string aName,
+ [in] TemplateIdentifier aTemplate )
raises( MalformedDataException,
- com::sun::star::lang::WrappedTargetException );
-
- //-------------------------------------------------------------------------
-
- /** receives notification that the current set can contain items
+ com::sun::star::lang::WrappedTargetException );
+
+ //-------------------------------------------------------------------------
+
+ /** receives notification that the current set can contain items
that are instances of a specified template.
@param aItemType
- specifies a template that is accepted as valid item type
+ specifies a template that is accepted as valid item type
for the current set node.
@throws com::sun::star::configuration::backend::MalformedDataException
@@ -521,18 +521,18 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface
@throws com::sun::star::lang::WrappedTargetException
if an error occurs processing the event.
*/
- void addItemType( [in] TemplateIdentifier aItemType )
+ void addItemType( [in] TemplateIdentifier aItemType )
raises( MalformedDataException,
- com::sun::star::lang::WrappedTargetException );
-
- //-------------------------------------------------------------------------
-
-};
-
-//=============================================================================
-
-}; }; }; }; };
-
-//=============================================================================
-
-#endif
+ com::sun::star::lang::WrappedTargetException );
+
+ //-------------------------------------------------------------------------
+
+};
+
+//=============================================================================
+
+}; }; }; }; };
+
+//=============================================================================
+
+#endif
generated by cgit v1.2.3 (git 2.39.1) at 2024-04-24 14:43:20 +0000