LibreOffice LibreOffice 25.8 SDK API Reference

Constant Groups | Classes | Typedefs | Enumerations
com::sun::star::beans Module Reference

Java beans-like property access and introspection. More...

## Constant Groups
constants | MethodConcept
| These constants are used to specify concepts of the introspection which apply to methods.
constants | PropertyAttribute
| These values are used to specify the behavior of a Property.
constants | PropertyConcept
| These constants are used to specify concepts of the introspection which apply to properties and to the methods which represent attributes.
constants | PropertySetInfoChange
| specifies reasons for sending PropertySetInfoChangeEvents.
constants | TolerantPropertySetResultType
| specifies the possible failure types when using the com::sun::star::beans::XTolerantMultiPropertySet interface.

## Classes
struct | Ambiguous< T >
| A value of a given type that can be ambiguous. More...
struct | Defaulted< T >
| A value of a given type that can be defaulted. More...
struct | GetDirectPropertyTolerantResult
| specifies information being retrieved about a single property. More...
struct | GetPropertyTolerantResult
| specifies information being retrieved about a single property. More...
exception | IllegalTypeException
| This exception is thrown to indicate the use of a type which is not appropriate. More...
service | Introspection
| A legacy (single-instance) service variant of theIntrospection singleton. More...
exception | IntrospectionException
| This exception is thrown when an exception happens during introspection. More...
struct | NamedValue
| specifies a pair assembled from a name and a value. More...
exception | NotRemoveableException
| This exception is thrown to indicate that removing a property from an XPropertyContainer is not allowed. More...
struct | Optional< T >
| An optional value of a given type. More...
struct | Pair< T, U >
| A tuple, or pair. More...
struct | Property
| This structure describes a property. More...
service | PropertyBag
| Implementation of this service can keep any properties and is useful when an XPropertySet is to be used, for example, as parameters for a method call. More...
struct | PropertyChangeEvent
| gets delivered whenever a "bound" or "constrained" property is changed. More...
exception | PropertyExistException
| This exception is thrown to indicate that a property with this name already exists in the object. More...
service | PropertySet
| This is a generic service which should be supported by all services which have properties. More...
struct | PropertySetInfoChangeEvent
| gets delivered whenever an XPropertySetInfo is changed. More...
struct | PropertyStateChangeEvent
| is delivered whenever the state of a "bound" property is changed. More...
struct | PropertyValue
| specifies a property value. More...
exception | PropertyVetoException
| This exception is thrown when a proposed change to a property represents an unacceptable value. More...
struct | SetPropertyTolerantFailed
| specifies information about a single property failed to be set. More...
struct | StringPair
| specifies a pair of two strings. More...
singleton | theIntrospection
| provides functionality to get information about an object's properties and methods. More...
exception | UnknownPropertyException
| This exception is thrown to indicate that the property name is unknown to the implementation. More...
interface | XExactName
| provides a method of changing names for converting an approximate name to an existing name. More...
interface | XFastPropertySet
| provides a fast way of accessing and changing property values. More...
interface | XHierarchicalPropertySet
| provides information about and access to the a hierarchy of properties from an implementation. More...
interface | XHierarchicalPropertySetInfo
| specifies a hierarchy of properties. More...
interface | XIntrospection
| allows the inspection of an object's properties and methods. More...
interface | XIntrospectionAccess
| represents the result of an introspection operation done by the inspect method of XIntrospection. More...
interface | XMaterialHolder
| gives access to the material a (tool-) object is working on. More...
interface | XMultiHierarchicalPropertySet
| provides access to multiple properties which form a hierarchy. More...
interface | XMultiPropertySet
| provides access to multiple properties with a single call. More...
interface | XMultiPropertyStates
| makes it possible to query information about the state of one or more properties. More...
interface | XPropertiesChangeListener
| receives events which get fired whenever a bound property is changed. More...
interface | XPropertiesChangeNotifier
| specifies a notifier for changed property values More...
interface | XProperty
| Is implemented by objects that also are a property of some other object. More...
interface | XPropertyAccess
| makes it possible to access all property values and to set them at once. More...
interface | XPropertyBag
interface | XPropertyChangeListener
| is used to receive PropertyChangeEvents whenever a bound property is changed. More...
interface | XPropertyContainer
| makes it possible to add and remove properties to or from an object. More...
interface | XPropertySet
| provides information about and access to the properties from an implementation. More...
interface | XPropertySetInfo
| specifies a set of properties. More...
interface | XPropertySetInfoChangeListener
| a listener for events related to XPropertySetInfos. More...
interface | XPropertySetInfoChangeNotifier
| a notifier for changes of XPropertySetInfos. More...
interface | XPropertySetOption
interface | XPropertyState
| makes it possible to query information about the state of one or more properties. More...
interface | XPropertyStateChangeListener
| receives events which get fired whenever the state of a bound property is changed. More...
interface | XPropertyWithState
| makes it possible to query information about the state of this object, seen as a property contained in a property set. More...
interface | XTolerantMultiPropertySet
| provides access to multiple iformation of a set of properties with a single call. More...
interface | XVetoableChangeListener
| is used to receive PropertyChangeEvents whenever a "constrained" property is changed. More...

## Typedefs
typedef sequence< PropertyValue > | PropertyValues
| specifies a sequence of PropertyValue instances. More...

## Enumerations
enum | PropertyState { DIRECT_VALUE , DEFAULT_VALUE , AMBIGUOUS_VALUE }
| This enumeration lists the states that a property value can have. More...

## Detailed Description

Java beans-like property access and introspection.

## Typedef Documentation

## ◆ PropertyValues

typedef sequence<PropertyValue> PropertyValues
| published

specifies a sequence of PropertyValue instances.

Such sequences are especially useful for remote interfaces.

## Enumeration Type Documentation

## ◆ PropertyState

enum PropertyState
| published

This enumeration lists the states that a property value can have.

The state consists of two aspects:

1. whether a value is available or void,
2. whether the value is stored in the property set itself or is a default, or ambiguous.

See also
  XPropertyState
  Property

Enumerator
DIRECT_VALUE | The value of the property is stored in the PropertySet itself.
    <p>The property value must be available and of the specified type.
    If the PropertyAttribute field in the struct
    Property contains PropertyAttribute::MAYBEVOID,
    then the value may be void. </p>
DEFAULT_VALUE | The value of the property is available from a master (e.g., template).
    <p>The PropertyAttribute field in the struct
    Property must contain the
    PropertyAttribute::MAYBEDEFAULT flag. The property
    value must be available and of the specified type. If the
    PropertyAttribute field in the struct Property
    contains PropertyAttribute::MAYBEVOID, then the
    value may be void. </p>
AMBIGUOUS_VALUE | The value of the property is only a recommendation because there are multiple values for this property (e.g., from a multi selection). The PropertyAttribute field in the struct Property must contain the PropertyAttribute::MAYBEAMBIGUOUS flag. The property value must be available and of the specified type. If the Attribute field in the struct Property contains PropertyAttribute::MAYBEVOID, then the value may be void.