|
LibreOffice
LibreOffice 24.8 SDK API Reference
|
receives a description of a configuration schema as a sequence of events. More...
import"XSchemaHandler.idl";
Public Member Functions | |
| void | startSchema () raises ( MalformedDataException, com::sun::star::lang::WrappedTargetException ) |
| receives notification that a schema description is started. More... | |
| void | endSchema () raises ( MalformedDataException, com::sun::star::lang::WrappedTargetException ) |
| receives notification that the current schema description is complete. More... | |
| void | importComponent ([in] string aName) raises ( MalformedDataException, com::sun::star::lang::WrappedTargetException ) |
| receives notification that the schema depends on templates from a different component. More... | |
| void | startComponent ([in] string aName) raises ( MalformedDataException, com::sun::star::lang::WrappedTargetException ) |
| receives notification that a component description is started. More... | |
| void | endComponent () raises ( MalformedDataException, com::sun::star::lang::WrappedTargetException ) |
| receives notification that a component description is complete. More... | |
| void | startGroupTemplate ([in] TemplateIdentifier aTemplate, [in] short aAttributes) raises ( MalformedDataException, com::sun::star::lang::WrappedTargetException ) |
| receives notification that a template description is started for a group. More... | |
| void | startSetTemplate ([in] TemplateIdentifier aTemplate, [in] short aAttributes, [in] TemplateIdentifier aItemType) raises ( MalformedDataException, com::sun::star::lang::WrappedTargetException ) |
| receives notification that a template description is started for a set. More... | |
| void | endTemplate () raises ( MalformedDataException, com::sun::star::lang::WrappedTargetException ) |
| receives notification that a template description is complete. More... | |
| void | startGroup ([in] string aName, [in] short aAttributes) raises ( MalformedDataException, com::sun::star::lang::WrappedTargetException ) |
| receives notification that a group description is started. More... | |
| void | startSet ([in] string aName, [in] short aAttributes, [in] TemplateIdentifier aItemType) raises ( MalformedDataException, com::sun::star::lang::WrappedTargetException ) |
| receives notification that a set description is started. More... | |
| void | endNode () raises ( MalformedDataException, com::sun::star::lang::WrappedTargetException ) |
| receives notification that a node description is complete. More... | |
| void | addProperty ([in] string aName, [in] short aAttributes, [in] type aType) raises ( MalformedDataException, com::sun::star::lang::WrappedTargetException ) |
| receives notification that a property is added to the current node. More... | |
| void | addPropertyWithDefault ([in] string aName, [in] short aAttributes, [in] any aDefaultValue) raises ( MalformedDataException, com::sun::star::lang::WrappedTargetException ) |
| receives notification that a property having a default value is added to the current node. More... | |
| void | addInstance ([in] string aName, [in] TemplateIdentifier aTemplate) raises ( MalformedDataException, com::sun::star::lang::WrappedTargetException ) |
| receives notification that the current group has a child node that is an instance of a specified template. More... | |
| void | addItemType ([in] TemplateIdentifier aItemType) raises ( MalformedDataException, com::sun::star::lang::WrappedTargetException ) |
| receives notification that the current set can contain items that are instances of a specified template. More... | |
Public Member Functions inherited from XInterface | |
| any | queryInterface ([in] type aType) |
| queries for a new interface to an existing UNO object. More... | |
| void | acquire () |
| increases the reference counter by one. More... | |
| void | release () |
| decreases the reference counter by one. More... | |
receives a description of a configuration schema as a sequence of events.
| void addInstance | ( | [in] string | aName, |
| [in] TemplateIdentifier | aTemplate | ||
| ) | |||
| raises | ( | MalformedDataException, | |
| com::sun::star::lang::WrappedTargetException | |||
| ) | |||
receives notification that the current group has a child node that is an instance of a specified template.
| aName | specifies the name of the new node. |
| aTemplate | specifies a template that describes the new node. |
| com::sun::star::configuration::backend::MalformedDataException |
|
Not every implementation can detect each condition
| com::sun::star::lang::WrappedTargetException | if an error occurs processing the event. |
| void addItemType | ( | [in] TemplateIdentifier | aItemType | ) | |
| raises | ( | MalformedDataException, | |||
| com::sun::star::lang::WrappedTargetException | |||||
| ) | |||||
receives notification that the current set can contain items that are instances of a specified template.
| aItemType | specifies a template that is accepted as valid item type for the current set node. |
| com::sun::star::configuration::backend::MalformedDataException |
|
Not every implementation can detect each condition
| com::sun::star::lang::WrappedTargetException | if an error occurs processing the event. |
| void addProperty | ( | [in] string | aName, |
| [in] short | aAttributes, | ||
| [in] type | aType | ||
| ) | |||
| raises | ( | MalformedDataException, | |
| com::sun::star::lang::WrappedTargetException | |||
| ) | |||
receives notification that a property is added to the current node.
The property will have a default value of NULL (unless it is SchemaAttribute::REQUIRED).
| aName | specifies the name of the new property. |
| aAttributes | specifies the attributes of the new property. |
The value is a combination of SchemaAttribute flags.
| aType | specifies the type of the new property. |
| com::sun::star::configuration::backend::MalformedDataException |
|
Not every implementation can detect each condition
| com::sun::star::lang::WrappedTargetException | if an error occurs processing the event. |
| void addPropertyWithDefault | ( | [in] string | aName, |
| [in] short | aAttributes, | ||
| [in] any | aDefaultValue | ||
| ) | |||
| raises | ( | MalformedDataException, | |
| com::sun::star::lang::WrappedTargetException | |||
| ) | |||
receives notification that a property having a default value is added to the current node.
| aName | specifies the name of the new property. |
| aAttributes | specifies the attributes of the new property. |
The value is a combination of SchemaAttribute flags.
| aDefaultValue | specifies the value of the new property. |
The value also determines the type. Therefore the value must not be VOID.
| com::sun::star::configuration::backend::MalformedDataException |
|
Not every implementation can detect each condition
| com::sun::star::lang::WrappedTargetException | if an error occurs processing the event. |
| void endComponent | ( | ) | ||
| raises | ( | MalformedDataException, | ||
| com::sun::star::lang::WrappedTargetException | ||||
| ) | ||||
receives notification that a component description is complete.
Must match a previous call to startComponent().
| com::sun::star::configuration::backend::MalformedDataException |
|
Not every implementation can detect each condition
| com::sun::star::lang::WrappedTargetException | if an error occurs processing the event. |
| void endNode | ( | ) | ||
| raises | ( | MalformedDataException, | ||
| com::sun::star::lang::WrappedTargetException | ||||
| ) | ||||
receives notification that a node description is complete.
Must match the last open call to startGroup() or startSet().
| com::sun::star::configuration::backend::MalformedDataException |
|
Not every implementation can detect each condition
| com::sun::star::lang::WrappedTargetException | if an error occurs processing the event. |
| void endSchema | ( | ) | ||
| raises | ( | MalformedDataException, | ||
| com::sun::star::lang::WrappedTargetException | ||||
| ) | ||||
receives notification that the current schema description is complete.
Must match a previous call to startSchema().
| com::sun::star::configuration::backend::MalformedDataException |
|
Not every implementation can detect each condition
| com::sun::star::lang::WrappedTargetException | if an error occurs processing the event. |
| void endTemplate | ( | ) | ||
| raises | ( | MalformedDataException, | ||
| com::sun::star::lang::WrappedTargetException | ||||
| ) | ||||
receives notification that a template description is complete.
Must match a previous call to startGroupTemplate() or startSetTemplate().
| com::sun::star::configuration::backend::MalformedDataException |
|
Not every implementation can detect each condition
| com::sun::star::lang::WrappedTargetException | if an error occurs processing the event. |
| void importComponent | ( | [in] string | aName | ) | |
| raises | ( | MalformedDataException, | |||
| com::sun::star::lang::WrappedTargetException | |||||
| ) | |||||
receives notification that the schema depends on templates from a different component.
| aName | specifies the name of the component. |
| com::sun::star::configuration::backend::MalformedDataException |
|
Not every implementation can detect each condition
| com::sun::star::lang::WrappedTargetException | if an error occurs processing the event. |
| void startComponent | ( | [in] string | aName | ) | |
| raises | ( | MalformedDataException, | |||
| com::sun::star::lang::WrappedTargetException | |||||
| ) | |||||
receives notification that a component description is started.
Subsequent calls describe the schema of the component until a matching call to endComponent() is encountered.
| aName | specifies the name of the component. |
| com::sun::star::configuration::backend::MalformedDataException |
|
Not every implementation can detect each condition
| com::sun::star::lang::WrappedTargetException | if an error occurs processing the event. |
| void startGroup | ( | [in] string | aName, |
| [in] short | aAttributes | ||
| ) | |||
| raises | ( | MalformedDataException, | |
| com::sun::star::lang::WrappedTargetException | |||
| ) | |||
receives notification that a group description is started.
Subsequent calls describe the members and properties of the group until a matching call to endNode() is encountered.
| aName | specifies the name of the group. |
| aAttributes | specifies the attributes of the node. |
The value is a combination of SchemaAttribute flags.
SchemaAttribute::EXTENSIBLE can be used to describe a group with an extensible set of properties.
| com::sun::star::configuration::backend::MalformedDataException |
|
Not every implementation can detect each condition
| com::sun::star::lang::WrappedTargetException | if an error occurs processing the event. |
| void startGroupTemplate | ( | [in] TemplateIdentifier | aTemplate, |
| [in] short | aAttributes | ||
| ) | |||
| raises | ( | MalformedDataException, | |
| com::sun::star::lang::WrappedTargetException | |||
| ) | |||
receives notification that a template description is started for a group.
Subsequent calls describe the members and properties of the template until a matching call to endTemplate() is encountered.
| aTemplate | specifies the identity of the template. |
| aAttributes | specifies the attributes of the template. |
The value is a combination of SchemaAttribute flags.
SchemaAttribute::EXTENSIBLE can be used to describe a template for a node with an extensible set of properties.
| com::sun::star::configuration::backend::MalformedDataException |
|
Not every implementation can detect each condition
| com::sun::star::lang::WrappedTargetException | if an error occurs processing the event. |
| void startSchema | ( | ) | ||
| raises | ( | MalformedDataException, | ||
| com::sun::star::lang::WrappedTargetException | ||||
| ) | ||||
receives notification that a schema description is started.
The schema description may comprise components templates or both.
| com::sun::star::configuration::backend::MalformedDataException | if a schema is already started (and has not been ended). |
| com::sun::star::lang::WrappedTargetException | if an error occurs processing the event. |
| void startSet | ( | [in] string | aName, |
| [in] short | aAttributes, | ||
| [in] TemplateIdentifier | aItemType | ||
| ) | |||
| raises | ( | MalformedDataException, | |
| com::sun::star::lang::WrappedTargetException | |||
| ) | |||
receives notification that a set description is started.
Subsequent calls describe the item-types and properties of the set until a matching call to endNode() is encountered.
| aName | specifies the name of the set. |
| aAttributes | specifies the attributes of the node. |
The value is a combination of SchemaAttribute flags.
SchemaAttribute::EXTENSIBLE can be used to describe a set with an extensible set of properties.
| aItemType | specifies the (default) template for set items. |
| com::sun::star::configuration::backend::MalformedDataException |
|
Not every implementation can detect each condition
| com::sun::star::lang::WrappedTargetException | if an error occurs processing the event. |
| void startSetTemplate | ( | [in] TemplateIdentifier | aTemplate, |
| [in] short | aAttributes, | ||
| [in] TemplateIdentifier | aItemType | ||
| ) | |||
| raises | ( | MalformedDataException, | |
| com::sun::star::lang::WrappedTargetException | |||
| ) | |||
receives notification that a template description is started for a set.
Subsequent calls describe the members and properties of the template until a matching call to endTemplate() is encountered.
| aTemplate | specifies the identity of the template. |
| aAttributes | specifies the attributes of the template. |
The value is a combination of SchemaAttribute flags.
SchemaAttribute::EXTENSIBLE can be used to describe a template for a node with an extensible set of properties.
| aItemType | specifies the (default) template for set items. |
| com::sun::star::configuration::backend::MalformedDataException |
|
Not every implementation can detect each condition
| com::sun::star::lang::WrappedTargetException | if an error occurs processing the event. |
1.8.14