specifies a component able to validate (the content of) other components More...

import"XValidator.idl";

Inheritance diagram for XValidator:

Public Member Functions
boolean	isValid ([in] any Value)
	determines whether the given value is valid More...

string	explainInvalid ([in] any Value)
	retrieves a justification for the invalidity of the given value More...

void	addValidityConstraintListener ([in] XValidityConstraintListener Listener) raises ( com::sun::star::lang::NullPointerException )
	registers the given validity listener. More...

void	removeValidityConstraintListener ([in] XValidityConstraintListener Listener) raises ( com::sun::star::lang::NullPointerException )
	revokes the given validity listener 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...

Detailed Description

specifies a component able to validate (the content of) other components

Validators support simple validity checks and retrieving justifications for invalidity.

Validators may additionally support dynamic validity constraints. In such a case, the validity of a given value may change, without the value changing itself.
To be notified about this, interested components should register as XValidityConstraintListener.

See also: XValidatable

Member Function Documentation

◆ addValidityConstraintListener()

void addValidityConstraintListener	(	[in] XValidityConstraintListener	Listener	)
raises	(	com::sun::star::lang::NullPointerException
	)

registers the given validity listener.

Usually, an XValidatable instance will also add itself as validity listener, as soon as the validator is introduced to it.

Implementations which do not support dynamic validity constraints should simply ignore this call.

Exceptions

com::sun::star::lang::NullPointerException if the given listener is NULL

See also: XValidityConstraintListener

◆ explainInvalid()

string explainInvalid ( [in] any Value )

retrieves a justification for the invalidity of the given value

Parameters

Value the value which has been recognized as being invalid

Returns: a human-readable string, which explains why the given value is considered invalid.

◆ isValid()

boolean isValid ( [in] any Value )

determines whether the given value is valid

Parameters

Value the value to check for validity

Returns: TRUE if and only if the value is considered valid.

◆ removeValidityConstraintListener()

void removeValidityConstraintListener	(	[in] XValidityConstraintListener	Listener	)
raises	(	com::sun::star::lang::NullPointerException
	)

revokes the given validity listener