LibreOffice
LibreOffice 24.2 SDK API Reference
Modules | Classes | Enumerations
com::sun::star::inspection Module Reference

interfaces for inspecting UNO objects via property handlers. More...

Constant Groups

constants  PropertyControlType
 describes pre-defined possible control types to be used to display and enter property values within an ObjectInspector.
 
constants  PropertyLineElement
 describes elements of a single line in an object inspector, used to represent a single property
 

Classes

service  DefaultHelpProvider
 implements a component which can default-fill the help section of an ObjectInspector. More...
 
service  GenericPropertyHandler
 implements a general-purpose XPropertyHandler More...
 
struct  LineDescriptor
 describes the appearance of a line representing a single property in an ObjectInspector. More...
 
service  ObjectInspector
 describes a com::sun::star::frame::Controller which can be used to browse and modify properties of components. More...
 
service  ObjectInspectorModel
 describes a default implementation of an ObjectInspectorModel More...
 
struct  PropertyCategoryDescriptor
 describes a category of properties More...
 
service  StringRepresentation
 
interface  XHyperlinkControl
 defines the interface for an XPropertyControl which displays its value in a hyperlink-like way More...
 
interface  XNumericControl
 defines the interface for an XPropertyControl which supports displaying and entering numerical values. More...
 
interface  XObjectInspector
 describes the main interface of an ObjectInspector. More...
 
interface  XObjectInspectorModel
 describes the model of an ObjectInspector More...
 
interface  XObjectInspectorUI
 grants access to certain aspects of the user interface of an object inspector More...
 
interface  XPropertyControl
 defines the interface for a single control in an ObjectInspector More...
 
interface  XPropertyControlContext
 specifies the interface of the context of an XPropertyControl. More...
 
interface  XPropertyControlFactory
 a factory for XPropertyControls More...
 
interface  XPropertyControlObserver
 specifies an interface for components to observer certain aspects of an XPropertyControl. More...
 
interface  XPropertyHandler
 is the basic interface for object inspection. More...
 
interface  XStringListControl
 defines the interface for an XPropertyControl which, additionally to the basic behavior, supports a list of strings interpreted as possible property values. More...
 
interface  XStringRepresentation
 handles string representations of property values. More...
 

Enumerations

enum  InteractiveSelectionResult { Cancelled, Success, ObtainedValue, Pending }
 describes possible results of an interactive selection of a property value in an object inspector More...
 

Detailed Description

interfaces for inspecting UNO objects via property handlers.

Enumeration Type Documentation

◆ InteractiveSelectionResult

describes possible results of an interactive selection of a property value in an object inspector

See also
XPropertyHandler::onInteractivePropertySelection
Since
OOo 2.0.3
Enumerator
Cancelled 

The interactive selection of a property value was canceled.

Success 

The interactive selection of a property value succeeded, and the new property value chosen by the user has already been set at the inspected component.

ObtainedValue 

The interactive selection of a property value succeeded, a new property value has been obtained, but not yet set at the inspected component.

In this case, the obtained value is passed to the caller of XPropertyHandler::onInteractivePropertySelection(), which is responsible for forwarding this value to the inspected component.

Pending 

The interactive selection of a property value is still pending.

This is usually used when this selection involves non-modal user interface.