LibreOffice
LibreOffice 7.2 SDK API Reference
Public Member Functions | List of all members
ObjectInspectorModel Service Reference

describes a default implementation of an ObjectInspectorModel More...

import"ObjectInspectorModel.idl";

Inheritance diagram for ObjectInspectorModel:
XObjectInspectorModel

Public Member Functions

 createDefault ()
 creates a default ObjectInspectorModel, whose one and only handler factory creates a GenericPropertyHandler. More...
 
 createWithHandlerFactories ([in] sequence< any > handlerFactories) raises ( ::com::sun::star::lang::IllegalArgumentException )
 creates a default ObjectInspectorModel, using an externally provided sequence of property handler factories. More...
 
 createWithHandlerFactoriesAndHelpSection ([in] sequence< any > handlerFactories, [in] long minHelpTextLines, [in] long maxHelpTextLines) raises ( ::com::sun::star::lang::IllegalArgumentException )
 creates a default ObjectInspectorModel, using an externally provided sequence of property handler factories, and describing an ObjectInspector which has a help section. More...
 
- Public Member Functions inherited from XObjectInspectorModel
sequence< PropertyCategoryDescriptordescribeCategories ()
 describes the property categories used by the property handlers. More...
 
long getPropertyOrderIndex ([in] string PropertyName)
 retrieves an index in a global property ordering, for a given property name More...
 

Additional Inherited Members

- Public Types inherited from XObjectInspectorModel
typedef sequence< any > HandlerFactories
 describes a set of factories for creating XPropertyHandlers More...
 
- Public Attributes inherited from XObjectInspectorModel
boolean HasHelpSection
 indicates that the object inspector should have a help section. More...
 
long MinHelpTextLines
 denotes the minimum number of lines of text to be reserved for the help section. More...
 
long MaxHelpTextLines
 denotes the maximum number of lines of text to be reserved for the help section. More...
 
boolean IsReadOnly
 determines whether the object inspector's UI should be read-only. More...
 

Detailed Description

describes a default implementation of an ObjectInspectorModel

This service simplifies usage of an ObjectInspector.

The XObjectInspectorModel implemented by this service will not provide any property categories, nor apply any particular order to the properties provided by its handler(s).

See also
ObjectInspector
XObjectInspectorModel
XObjectInspectorModel::describeCategories
XObjectInspectorModel::getPropertyOrderIndex
Since
OOo 2.0.3

Member Function Documentation

◆ createDefault()

createDefault ( )

creates a default ObjectInspectorModel, whose one and only handler factory creates a GenericPropertyHandler.

◆ createWithHandlerFactories()

createWithHandlerFactories ( [in] sequence< any >  handlerFactories)
raises (::com::sun::star::lang::IllegalArgumentException
)

creates a default ObjectInspectorModel, using an externally provided sequence of property handler factories.

Parameters
handlerFactoriesa sequence of handler factories, as to be provided in the XObjectInspectorModel::HandlerFactories method.
Exceptions
com::sun::star::lang::IllegalArgumentExceptionif the given sequence is empty.
See also
XObjectInspectorModel::HandlerFactories

◆ createWithHandlerFactoriesAndHelpSection()

createWithHandlerFactoriesAndHelpSection ( [in] sequence< any >  handlerFactories,
[in] long  minHelpTextLines,
[in] long  maxHelpTextLines 
)
raises (::com::sun::star::lang::IllegalArgumentException
)

creates a default ObjectInspectorModel, using an externally provided sequence of property handler factories, and describing an ObjectInspector which has a help section.

Parameters
handlerFactoriesa sequence of handler factories, as to be provided in the XObjectInspectorModel::HandlerFactories method.
minHelpTextLinesdenotes the minimum number of lines of text to be reserved for the help section.
maxHelpTextLinesdenotes the maximum number of lines of text to be reserved for the help section.
Exceptions
com::sun::star::lang::IllegalArgumentExceptionif handlerFactories is empty.
com::sun::star::lang::IllegalArgumentExceptionif minHelpTextLines or maxHelpTextLines are negative, or if minHelpTextLines is greater than maxHelpTextLines.
See also
XObjectInspectorModel::HandlerFactories
XObjectInspectorModel::HasHelpSection
XObjectInspectorModel::MinHelpTextLines
XObjectInspectorModel::MaxHelpTextLines
Since
OOo 2.2

The documentation for this service was generated from the following file: